https://github.com/ellmetha/neojsonrpc

Python JSON-RPC client for the NEO blockchain.
https://github.com/ellmetha/neojsonrpc

blockchain json-rpc json-rpc-client neo python

Last synced: 2 months ago
JSON representation

Python JSON-RPC client for the NEO blockchain.

• Host: GitHub
• URL: https://github.com/ellmetha/neojsonrpc
• Owner: ellmetha
• License: mit
• Archived: true
• Created: 2018-01-02T19:06:09.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-02-24T23:49:07.000Z (about 7 years ago)
• Last Synced: 2025-09-07T08:32:45.168Z (7 months ago)
• Topics: blockchain, json-rpc, json-rpc-client, neo, python
• Language: Python
• Homepage: https://neojsonrpc.readthedocs.io
• Size: 76.2 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
NeoJsonRPC

##########

.. image:: https://readthedocs.org/projects/neojsonrpc/badge/?version=stable

    :target: https://neojsonrpc.readthedocs.org/en/stable/

    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/l/neojsonrpc.svg

    :target: https://pypi.python.org/pypi/neojsonrpc/

    :alt: License

.. image:: https://img.shields.io/pypi/pyversions/neojsonrpc.svg

    :target: https://pypi.python.org/pypi/neojsonrpc

.. image:: https://img.shields.io/pypi/v/neojsonrpc.svg

    :target: https://pypi.python.org/pypi/neojsonrpc/

    :alt: Latest Version

.. image:: https://img.shields.io/travis/ellmetha/neojsonrpc.svg

    :target: https://travis-ci.org/ellmetha/neojsonrpc

    :alt: Build status

.. image:: https://img.shields.io/codecov/c/github/ellmetha/neojsonrpc.svg

    :target: https://codecov.io/github/ellmetha/neojsonrpc

    :alt: Codecov status

|

**NeoJsonRPC** is a Python JSON-RPC client for the NEO blockchain. It implements the JSON-RPC

methods of the API interface provided by NEO nodes (minus the methods requiring an opened wallet).

The client also provides a high-level interface to invoke contract methods on the NEO blockchain.

.. contents:: Table of Contents

    :local:

Documentation

=============

Online browsable documentation is available at https://neojsonrpc.readthedocs.io.

Requirements

============

Python_ 3.4+, Requests_ 2.0+.

Installation

============

To install NeoJsonRPC, please use pip_ (or pipenv_) as follows:

.. code-block:: shell

    $ pip install neojsonrpc

Basic usage

===========

The first step to interact with the NEO JSON-RPC interface is to initialize a ``neojsonrpc.Client``

instance. The following examples respectively show how to get clients for the TestNet, the MainNet

and an hypothetical local PrivNet:

.. code-block:: python

    >>> from neojsonrpc import Client

    >>> testnet_client = Client.for_testnet()

    >>> mainnet_client = Client.for_mainnet()

    >>> privnet_client = Client(host='localhost', port='30333')

Then you can easily call some of the `JSON-RPC methods `_

provided by NEO nodes. Here are some examples:

.. code-block:: python

    >>> from neojsonrpc import Client

    >>> client = Client.for_testnet()

    >>> client.get_block_count()

    973369

    >>> client.get_contract_state('2c0fdfa9592814b0a938219e218e3a6b08615acd')

    {'author': 'foobar',

     'code_version': '0.3',

    # [...]

    }

You can also invoke smart contract functions using the following methods:

.. code-block:: python

    >>> from neojsonrpc import Client

    >>> client = Client.for_testnet()

    >>> result = client.invoke_function('34af1b6634fcd7cfcff0158965b18601d3837e32', 'symbol', [])

    {'gas_consumed': '0.217',

     'stack': [{'type': 'ByteArray', 'value': bytearray(b'TKN')}],

     'state': 'HALT, BREAK'}

    >>> # Another convenient way to do the same operation is as follows:

    >>> client.contract('34af1b6634fcd7cfcff0158965b18601d3837e32').symbol()

    {'gas_consumed': '0.217',

     'stack': [{'type': 'ByteArray', 'value': bytearray(b'TKN')}],

     'state': 'HALT, BREAK'}

Authors

=======

Morgan Aubert (`@ellmetha `_) and contributors_. See ``AUTHORS`` for

more details.

.. _contributors: https://github.com/ellmetha/neojsonrpc/contributors

License

=======

MIT. See ``LICENSE`` for more details.

.. _pip: https://github.com/pypa/pip

.. _pipenv: https://github.com/pypa/pipenv

.. _Python: https://www.python.org/

.. _Requests: http://docs.python-requests.org/en/master/