Methods

TestRPC API is the extension of EthRPC API which relies on new features of simplified block generator and integrated test wallet.
eth_mining
Returns true if client is generating new blocks, otherwise false.
Example
1
// Request
2
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_mining","params":[],"id":1}'
3
​
4
// Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": true
9
}
Copied!
miner_start
Start the block generation process.
Example
1
// Request
2
curl -X POST --data '{"jsonrpc":"2.0","method":"miner_start","params":[],"id":1}'
3
​
4
// Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": null
9
}
Copied!
miner_stop
Stop the block generation process.
Example
1
// Request
2
curl -X POST --data '{"jsonrpc":"2.0","method":"miner_stop","params":[],"id":1}'
3
​
4
// Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": null
9
}
Copied!
personal_newAccount
Generates a new private key and create new account with it.
Option
Description
string passphrase
Passphrase which is used to unlock account
Returns
The address of the new account
Example
1
// Request
2
curl -X POST --data '{"jsonrpc":"2.0","method":"personal_newAccount","params":["swordfish"],"id":1}'
3
​
4
// Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": "0x000000000000000000000000000000000000001a"
9
}
Copied!
personal_listAccounts
Returns list of all account addresses in the integrated test wallet.
Example
1
// Request
2
curl -X POST --data '{"jsonrpc":"2.0","method":"personal_listAccounts","params":[],"id":1}'
3
​
4
// Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": [
9
    "0x000000000000000000000000000000000000001a"
10
  ]
11
}
Copied!
eth_accounts
Same as personal_listAccounts​
personal_listRawAccounts
Non-standard method to extract raw test accounts. Returns list of objects with address, private key, passphrase and lock status of test accounts.
Example
1
// Request
2
curl -X POST --data '{"jsonrpc":"2.0","method":"personal_listRawAccounts","params":[],"id":1}'
3
​
4
// Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": [
9
    {
10
      "address": "0x000000000000000000000000000000000000001a",
11
      "privkey": "0x2261f3980a845d125667c6ed176a2fc7a8007588f41f509051e31445babeb928",
12
      "passprase", "swordfish",
13
      "locked": false
14
    }
15
  ]
16
}
Copied!
personal_lockAccount
Locks the account's private key so, it can no longer be used to send transactions. Returns true.
Option
Description
string address
Account address to lock
Returns
true or error
Example
1
// Request
2
curl -X POST --data '{"jsonrpc":"2.0","method":"personal_lockAccount","params":["0x000000000000000000000000000000000000001a"],"id":1}'
3
​
4
// Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": true
9
}
Copied!
personal_unlockAccount
Decrypts the key with the given address from the integrated test wallet.
The account can be used with eth_sign and eth_sendTransaction while it is unlocked.
Option
Description
string address
Account address to unlock
string passphrase
Account's passphrase
number duration
(optional) Unlock duration in seconds
Returns
true or error
Example
1
// Request
2
curl -X POST --data '{"jsonrpc":"2.0","method":"personal_unlockAccount","params":["0x000000000000000000000000000000000000001a", "swordfish", "0x12c"],"id":1}'
3
​
4
// Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": true
9
}
Copied!
eth_sign
The sign method calculates an Ethereum specific signature with: sign(keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))).
Note the address to sign with must be unlocked.
Option
Description
string address
Account address
string message
Message to sign
Returns
Hex-encoded signature
Example
1
curl -X POST --data '{"id":1,"jsonrpc":"2.0","method":"eth_sign","params":["0x000000000000000000000000000000000000001a","0xdeadbeaf"]}'
2
​
3
// Result
4
{
5
  "id": 1,
6
  "jsonrpc": "2.0",
7
  "result": "0xa3f20717a250c2b0b729b7e5becbff67fdaef7e0699da4de7ca5895b02a170a12d887fd3b17bfdce3481f10bea41f45ba9f709d39ce8325427b57afcfc994cee1b"
8
}
Copied!
eth_sendTransaction
Creates new message call transaction or a contract creation, if the data field contains code.
Returns hex-encoded transaction id.
Parameters object options:
Option
Description
string from
Address of the account the transaction is send from
string to
(optional when creating new contract) Address of the account or contract the transaction is directed to.
string gas
(optional, default: estimated) Integer of the fee provided for the transaction execution.
string value
(optional) Integer of the value sent with this transaction
string data
The compiled code of a contract OR the hash of the invoked method signature and encoded parameters.
Example parameters:
1
params: [{
2
  "from": "0x000000000000000000000000000000000000001a",
3
  "to": "0100000000000000000000000000000000000005",
4
  "gas": "0x76c0", // 30400
5
  "value": "0x9184e72a", // 2441406250
6
  "data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"
7
}]
Copied!
Example
1
// Request
2
curl -X POST --data '{"id":1,"jsonrpc":"2.0","method":"eth_sendTransaction","params":[{see above}]}'
3
​
4
// Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": "0x0000000000000000000000004ca35a1a6b75ee3d5145a99d05921026d1527331"
9
}
Copied!
personal_sendTransaction
Validate the given passphrase and submit transaction.
The transaction is the same argument as for eth_sendTransaction and contains the from address. If the passphrase can be used to decrypt the private key belogging to tx.from the transaction is verified, signed and send onto the network. The account is not unlocked globally in the node and cannot be used in other RPC calls.
evm_mine
Force a block to be mined. Takes no parameters. Mines a block independent of whether or not mining is started or stopped.
Parameters
none
Returns
null - block is mined or error
Example
1
//Request
2
curl -X POST --data '{"id":1,"jsonrpc":"2.0","method":"evm_mine","params":[]}'
3
​
4
//Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": null
9
}
Copied!
evm_increaseTime
Jump forward in time
Option
Description
number time_diff
Amount of time to increase in seconds
Returns
the total time adjustment, seconds in hex, or error
Example
1
//Request
2
curl -X POST --data '{"id":1,"jsonrpc":"2.0","method":"evm_increaseTime","params":[60]}'
3
​
4
//Result
5
{
6
  "id":1,
7
  "jsonrpc": "2.0",
8
  "result": "0x3c"
9
}
Copied!
TestRPC
Changelogs
Last modified 1yr ago