Skip to content

Commit

Permalink
Add Nodesmith specific docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Samm Desmond committed Mar 24, 2019
1 parent a6f291e commit 838c7f6
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Features
- Support for Parity's
`Personal <https://github.com/paritytech/parity/wiki/JSONRPC-personal-module>`__, and Geth's
`Personal <https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal>`__ client APIs
- Support for `Infura <https://infura.io/>`_, so you don't have to run an Ethereum client yourself
- Support for `Infura <https://infura.io/>`_ & `Nodesmith <https://nodesmith.io/>`_, so you don't have to run an Ethereum client yourself
- Support for ERC20 and ERC721 token standards
- Comprehensive integration tests demonstrating a number of the above scenarios
- Command line tools
Expand Down Expand Up @@ -93,6 +93,7 @@ Contents:
command_line.rst
management_apis.rst
infura.rst
nodesmith.rst
ens.rst
contracts.rst
trouble.rst
Expand Down
38 changes: 38 additions & 0 deletions docs/source/nodesmith.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Using Nodesmith with web3j
==========================

Getting started
----------

The `Nodesmith <https://nodesmith.io/>`_ service provides hosted access to the Ethereum JSON RPC API
so you don't have to run one yourself to work with Ethereum.

After signing up, you'll be given an Ethereum API key and endpoints for the mainnet and several test
networks. To connect to a specific network, change the url to specify that network.

The url will follow the pattern
``https://ethereum.nodesmith.io/v1/<network_name>/jsonrpc?apiKey=<your_api_key>``

For obtaining ether to use in these networks, you can refer to :ref:`ethereum-testnets`


NodesmithHttpService
--------------------

The ``hosted-providers`` module contains a ``NodesmithHTTPService`` which provides specific information which is returned
in the headers from the Nodesmith service. Nodesmith's service is rate limited to provide a stable and reliable service.
Using the NodesmithHTTPService you can receive information about your API key's current rate limit status.

See `Rate Limiting <https://beta.docs.nodesmith.io/#/ethereum/rateLimiting>`_ for more info

If you want to test a number of the JSON RPC calls against Nodesmith, update the integration test
`CoreIT <https://github.com/web3j/web3j/blob/master/integration-tests/src/test/java/org/web3j/protocol/core/CoreIT.java>`_
with your Infura URL & run it.

Sending Transactions
--------------------

Because Nodesmith doesn't hold any private keys, in order to send transactions they need to be created and signed locally.
They are then sent to Nodesmith's servers to be broadcast to the network.

Refer to the :ref:`offline-signing` and :doc:`management_apis` sections for further details.

0 comments on commit 838c7f6

Please sign in to comment.