Skip to main content

A neo-python RPC Server with plugable commands.

Project description

An RPC server that extends the default neo-python RPC server with plugable commands.

Installation

Install the package via pip

pip install neopython-extended-rpc-server

Next, open your neo-python’s protocol.<network>.json, find the RPCServer key and set it as follows

"RPCServer": "neopython_ext_rpc_server.ExtRpcServer.ExtendedJsonRpcApi"

Note that the default installation has not additional commands over neo-python’s build-in RPC Server.

Extending with new commands

You can extend the RPC server with your own commands by creating a plugin. This has 2 requirements:

  1. Your plugin must extend the ExtendedRpcCommand class and implement the required methods.
  2. Your plugin must be installed using setuptools and register an entrypoint under neopython.extrpc.plugins. See the entry_points key in /extrpc-plugin-example/setup.py for an example.

If your plugin does not adhere to the above 2 requirements it will not be picked up by the loader. The easiest approach is probably to copy the example plugin folder and adjust it to your needs.

Once your done you can either share your plugin via PyPi (Instructions) to make it installable via pip or you can install it directly using python setup.py install.

Note: you have to restart the RPC server for new commands to be picked up.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for neopython-extended-rpc-server, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size neopython_extended_rpc_server-0.1.0-py3-none-any.whl (6.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size neopython-extended-rpc-server-0.1.0.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page