Skip to main content

An Ethereum simulator for aiding smart contract development.

Project description

## Ethereum Test RPC

Limited RPC client intended for use with automated testing. Uses [pythereum](https://github.com/ethereum/pyethereum) to run an Ethereum client behind the scenes without the need for mining or networking. The result is an Ethereum client that provides instant results and quick feedback during development.

### Install

Installing is easy, through pip:

` $ pip install eth-testrpc `

Or, to upgrade:

` pip install eth-testrpc --upgrade `

### Run

Installing through pip will make the testrpc command available on your machine:

` $ testrpc `

This will run testrpc on localhost:8545. You can pass through a different port (-p, –port) or domain (-d, –domain).

### Implemented methods

The RPC methods currently implemented are:

  • eth_coinbase

  • eth_accounts

  • eth_gasPrice

  • eth_blockNumber

  • eth_sendTransaction

  • eth_sendRawTransaction

  • eth_call

  • eth_getCompilers

  • eth_compileSolidity

  • eth_getCode (only supports block number “latest”)

  • eth_getBalance

  • eth_getTransactionCount

  • eth_getTransactionByHash

  • eth_getTransactionReceipt

  • eth_newBlockFilter

  • eth_getFilterChanges (only supports block filters)

  • eth_uninstallFilter

  • web3_sha3

  • web3_clientVersion

There’s also special non-standard methods that aren’t included within the original RPC specification:

  • evm_reset : No params, no return value.

  • evm_snapshot : No params. Returns the integer id of the snapshot created.

  • evm_revert : One optional param. Reverts to the snapshot id passed, or the latest snapshot.

When calling evm_reset, the testrpc will revert the state of its internal chain back to the genesis block and it will act as if no processing of transactions has taken place. Similarly, you can use evm_snapshot and evm_revert methods to save and restore the evm state as desired. Example use cases for these methods are as follows:

  • evm_reset : Run once at the beginning of your test suite.

  • evm_snapshot : Run at the beginning of each test, snapshotting the state of the evm.

  • evm_revert : Run at the end of each test, reverting back to a known clean state.

### Releasing a new version (for eth-testrpc developers)

So we don’t forget. :)

Install seed if you haven’t already:

` $ pip install seed `

Commit any changes you’ve made first. Then, to make the release:

` $ seed release `

Afterward, commit the changes it made for you:

` git push && git push --tags `

All done! No need to update a version number.

### License

MIT

Project details


Download files

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

Source Distribution

eth-testrpc-0.1.17.tar.gz (7.7 kB view details)

Uploaded Source

File details

Details for the file eth-testrpc-0.1.17.tar.gz.

File metadata

File hashes

Hashes for eth-testrpc-0.1.17.tar.gz
Algorithm Hash digest
SHA256 dff82d565b0348094bbc76a4996bd15157607a5fd4992697cb0ab8d2470536ff
MD5 6d667d379a6b204bb79d370a665b44a5
BLAKE2b-256 0279e563790ad30cf12d358dea54e9ba5680d552f344489e392095cc7ad3dc9f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page