Test RPC Configuration and usage
ATTENTION: The Truffle team has recently replaced Test RPC with Ganache we recommend reading our Ganache setup instructions here.
Ethereum TestRPC is a fast and customizable blockchain emulator. It allows making calls to the blockchain without the overheads of running an actual Ethereum node.
See Also
Web3 Is the Future of the Internet—Here’s Why You Need to Know About ItRPC vs. Messaging – which is faster?What are Nodes and Clients in Ethereum? - GeeksforGeeksgRPC vs REST: A Comparison Guide for 2024- Accounts can be re-cycled, reset and instantiated with a fixed amount of Ether (no need for faucets or mining).
- Gas price and mining speed can be modified.
Get started
| Install Method | Command |
|---|---|
| via NPM | npm install -g ethereumjs-testrpc |
| Quicks start using Docker image (unsupported) | docker run -d -p 8545:8545 ethereumjs/testrpc:latest |
| Passing options to testrpc through Docker | docker run -d -p 8545:8545 ethereumjs/testrpc:latest -a 10 --debug |
| Build the Docker container from source | git clone https://github.com/ethereumjs/testrpc.git && cd testrpc docker build -t ethereumjs/testrpc |
Starting Test RPC
The following command will start an instance of testrpc. Testrpc will automatically generate accounts from the seed phrases passed in with the -m switch.
testrpc -m "small failure organs crooks zero delivery fired extreme lost twenty alpha terror"
Implemented Methods
Some of the RPC methods currently implemented are:
bzz_hive (stub)bzz_info (stub)debug_traceTransactioneth_accountseth_blockNumbereth_calleth_coinbaseeth_estimateGaseth_gasPriceeth_getBalanceeth_getBlockByNumbereth_getBlockByHasheth_getBlockTransactionCountByHasheth_getBlockTransactionCountByNumbereth_getCode (only supports block number “latest”)eth_getCompilerseth_getFilterChangeseth_getFilterLogseth_getLogseth_getStorageAteth_getTransactionByHasheth_getTransactionByBlockHashAndIndexeth_getTransactionByBlockNumberAndIndexeth_getTransactionCounteth_getTransactionReceipteth_hashrateeth_miningeth_newBlockFiltereth_newFilter (includes log/event filters)eth_protocolVersioneth_sendTransactioneth_sendRawTransactioneth_signeth_syncingeth_uninstallFilternet_listeningnet_peerCountnet_versionminer_startminer_stoppersonal_listAccountspersonal_lockAccountpersonal_newAccountpersonal_unlockAccountpersonal_sendTransactionshh_versionrpc_modulesweb3_clientVersionweb3_sha3
There’s also special non-standard methods that aren’t included within the original RPC specification:
| Method | Definition |
|---|---|
| evm_snapshot : | Snapshot the state of the blockchain at the current block. Takes no parameters. Returns the integer id of the snapshot created. |
| evm_revert : | Revert the state of the blockchain to a previous snapshot. Takes a single parameter, which is the snapshot id to revert to. If no snapshot id is passed it will revert to the latest snapshot. Returns true. |
| evm_increaseTime: | Jump forward in time. Takes one parameter, which is the amount of time to increase in seconds. Returns the total time adjustment, in seconds. |
| evm_mine : | Force a block to be mined. Takes no parameters. Mines a block independent of whether or not mining is started or stopped. Unsupported Methods. |
| eth_compileSolidity: | If you’d like Solidity compilation in Javascript, please see the solc-js project. Docker. |
