Seele JSON-RPC ============== JSON is a lightweight data exchange format. It can represent numbers, strings, ordered value sequences and key-value pairs. JSON-RPC is a stateless, lightweight Remote Procedure Call (RPC) protocol. It defines several data structures and the relevant rules to handle them. JSON-RPC is transmission-agnostic, because it can be used in situations like process, socket, HTTP, or different message transmission environments. It uses JSON(RFC 4627) as the data format. Curl Examples Explained ----------------------- The curl options below might return a response where the node complains about the content type, this is because the –data option sets the content type to application/x-www-form-urlencoded . If your node does complain, manually set the header by placing -H “Content-Type: application/json” at the start of the call. JSON-RPC Support ---------------- ============== ========== Type Supported? ============== ========== JSON-RPC 1.0 ✓ JSON-RPC 2.0 ✓ Batch Requests ✓ HTTP ✓ WS ✓ ============== ========== JSON-RPC Port ------------- Default port: ====== =========== ===================== Client Type Address ====== =========== ===================== Go jsonrpc-2.0 http://localhost:8027 Go http http://localhost:8037 Go websocket http://localhost:8047 ====== =========== ===================== JSON-RPC List ------------- Currently, there are several RPCs with different namespaces： - ``seele``:node data manipulation and procurement / acquisition - ``txpool``:transaction pool management - ``download``:RPC collection provided for internal inquiry of blockchain node synchronization state. - ``network``:connection management - ``miner``:miner manipulation - ``debug``:node debugging - ``monitor``:node monitor JSON-RPC Contents ----------------- - `seele <#seele>`__ ======================================== ==== ===== ====== ======= Command Full Light public private ======================================== ==== ===== ====== ======= `GetInfo <#getinfo>`__ ✓ ✓ `GetBalance <#getbalance>`__ ✓ ✓ ✓ `AddTx <#addtx>`__ ✓ ✓ ✓ `GetAccountNonce <#getaccountnonce>`__ ✓ ✓ ✓ `GetBlockHeight <#getblockheight>`__ ✓ ✓ ✓ `GetBlock <#getblock>`__ ✓ ✓ ✓ `GetBlockByHash <#getblockbyhash>`__ ✓ ✓ ✓ `GetBlockByHeight <#getblockbyheight>`__ ✓ ✓ ✓ `Call <#call>`__ ✓ ✓ GetLogs(Being Written) ✓ ✓ `GeneratePayload <#generatepayload>`__ ✓ ✓ `EstimateGas <#estimategas>`__ ✓ ✓ ======================================== ==== ===== ====== ======= - `txpool <#txpool>`__ ============================================================================== ==== ===== ====== ======= Command Full Light public private ============================================================================== ==== ===== ====== ======= `GetBlockTransactionCount <#getblocktransactioncount>`__ ✓ ✓ ✓ `GetBlockTransactionCountByHeight <#getblockTransactioncountbyheight>`__ ✓ ✓ ✓ `GetBlockTransactionCountByHash <#getBlockTransactionCountByHash>`__ ✓ ✓ ✓ `GetTransactionByBlockIndex <#getTransactionbyblockindex>`__ ✓ ✓ ✓ `GetTransactionByBlockHeightAndIndex <#getTransactionbyblockheightandindex>`__ ✓ ✓ ✓ `GetTransactionByBlockHashAndIndex <#getTransactionbyblockhashandindex>`__ ✓ ✓ ✓ `GetReceiptByTxHash <#getreceiptbytxhash>`__ ✓ ✓ ✓ `GetTransactionByHash <#getTransactionbyhash>`__ ✓ ✓ ✓ `GetDebtByHash <#getdebtbyhash>`__ ✓ ✓ ============================================================================== ==== ===== ====== ======= - `download <#download>`__ ========================== ==== ===== ====== ======= Command Full Light public private ========================== ==== ===== ====== ======= `GetStatus <#getstatus>`__ ✓ ✓ ========================== ==== ===== ====== ======= - `network <#network>`__ ============================================ ==== ===== ====== ======= Command Full Light public private ============================================ ==== ===== ====== ======= `GetPeersInfo <#getpeersinfo>`__ ✓ ✓ ✓ `GetPeerCount <#getpeercount>`__ ✓ ✓ ✓ `GetNetVersion <#getnetversion>`__ ✓ ✓ ✓ `GetProtocolVersion <#getprotocolversion>`__ ✓ ✓ ✓ `GetNetworkID <#getnetworkid>`__ ✓ ✓ ✓ ============================================ ==== ===== ====== ======= - `miner <#miner>`__ ============================== ==== ===== ====== ======= Command Full Light public private ============================== ==== ===== ====== ======= `Start <#start>`__ ✓ ✓ `Stop <#stop>`__ ✓ ✓ `Status <#status>`__ ✓ ✓ `GetCoinbase <#getcoinbase>`__ ✓ ✓ `SetThreads <#setthreads>`__ ✓ ✓ `SetCoinbase <#setcoinbase>`__ ✓ ✓ `GetThreads <#getthreads>`__ ✓ ✓ `GetHashrate <#gethashrate>`__ ✓ ✓ ============================== ==== ===== ====== ======= - `debug <#debug>`__ ======================================== ==== ===== ====== ======= Command Full Light public private ======================================== ==== ===== ====== ======= `PrintBlock <#printblock>`__ ✓ ✓ `GetTxPoolContent <#gettxpoolcontent>`__ ✓ ✓ ✓ `GetTxPoolTxCount <#gettxpooltxcount>`__ ✓ ✓ ✓ `GetPendingTxs <#getpendingtxs>`__ ✓ ✓ ✓ `GetPendingDebts <#getpendingdebts>`__ ✓ ✓ `DumpHeap <#dumpheap>`__ ✓ ✓ `GetTPS <#gettps>`__ ✓ ✓ ======================================== ==== ===== ====== ======= - `monitor <#monitor>`__ ========================== ==== ===== ====== ======= Command Full Light public private ========================== ==== ===== ====== ======= `NodeInfo <#nodeinfo>`__ ✓ ✓ `NodeStats <#nodestats>`__ ✓ ✓ ========================== ==== ===== ====== ======= seele ~~~~~ RPC collection provided for public for blockchain node and transaction manipulation. -------------- GetInfo ^^^^^^^ This method returns the node information. ==== ================================================================= Type Template ==== ================================================================= RPC ``{"jsonrpc":"2.0","method":"seele_getInfo","params":[],"id":2}`` ==== ================================================================= Parameters '''''''''' none Returns ''''''' - ``Coinbase``:``string`` - node address - ``CurrentBlockHeight``:``uint64`` - current block height - ``HeaderHash``:``string`` - block hash - ``MinerStatus``:``string`` - miner status - ``Shard``:``int`` - shard number Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_getInfo","params":[],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "Coinbase": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21", "CurrentBlockHeight": 1722, "HeaderHash": "0x000001fa4cb11751fea2d4f7f9356303d44d2a02f37c3e62e657ffe29e5cb5fe", "Shard": 1, "MinerStatus": "Running" } } -------------- GetBalance ^^^^^^^^^^ This method returns the account balance give the account address. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_getBalance","params":[string,st | | | ring ,uint64],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-1: Parameters '''''''''' - ``Account``:``string`` - account - ``hexHash``:``string`` - hex form of a block hash, set to "" for the latest balance - ``height`` :``uint64`` - height of a block, set to -1 for the latest balance ##### Returns - ``Account``:``string`` - account - ``Balance``:``big.Int`` - account balance .. _example-1: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_getBalance","params":["0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21","",-1],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "Account": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21", "Balance": 265499990000 } } -------------- AddTx ^^^^^ This method submits a transaction to the node. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_addTx","params":[types.Transact | | | ion],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-2: Parameters '''''''''' - ``tx``:``types.Transaction`` - transaction struct (client command ``sign`` could be used to get transaction hash and signature) - ``Hash``:``string`` - transaction hash - ``Data``:``json`` - transaction data - ``From``:``string`` - transaction sender - ``To``:``string`` - transaction receiver - ``Amount``:``uint64`` - amount value, unit is fan - ``Fee``:``uint64`` - transaction fee - ``Payload``:``string`` - transaction payload - ``AccountNonce``:``uint64`` - transaction nonce - ``Signature`` : ``crypto.Signature`` - transaction signature struct :: type Signature struct { Sig []byte // [R || S || V] format signature in 65 bytes. } .. _returns-1: Returns ''''''' - ``result``:``bool`` - transaction send result .. _example-2: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_addTx","params":[{"Hash": "0x3393e5566cb905d714599f2f888ecc6d223b83403887460fa5b2771e89a0436e","Data": {"From": "0x3b691130ec4166bfc9ec7240217fc8d08903cf21","To":"0x2a87b6504cd00af95a83b9887112016a2a991cf1","Amount": 1,"AccountNonce":0,"Fee": 0,"GasPrice":10, "GasLimit":21000},"Signature":{"Sig":"fAvgVTXDyJZbfv07NYBK4aSolfY4ycBPQRwnQFpHRMc7ooOZw27U50o4TBoRelYX3QCRyvKpbxVlxhu7AnSB6QE="}}],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": true } -------------- GetAccountNonce ^^^^^^^^^^^^^^^ This method is used to obtain the account nonce. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_getAccountNonce","params":[stri | | | ng,string ,uint64],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-3: Parameters '''''''''' - ``account``:``string`` - account - ``hexHash``:``string`` - hex form of a block hash, set to "" for the latest nonce - ``height`` :``uint64`` - height of a block, set to -1 for the latest nonce ##### Returns - ``result``:``uint64`` - account nonce .. _example-3: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_getAccountNonce","params":["0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21","",-1],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": 3 } -------------- GetBlockHeight ^^^^^^^^^^^^^^ This method is used to obtain the height of the blockchain. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_getBlockHeight","params":[strin | | | g],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-4: Parameters '''''''''' none .. _returns-2: Returns ''''''' - ``result``:``uint64`` - block height .. _example-4: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_getBlockHeight","params":[],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": 1928 } -------------- GetBlock ^^^^^^^^ This method is used to obtain the block content based on block height or block hash. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_getBlock","params":[string,stri | | | ng,bool],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-5: Parameters '''''''''' - ``hash``:``string`` - block hash - ``height``:``string`` - block height - ``fulltx, f``:``bool`` - whether to include detailed transaction information .. _returns-3: Returns ''''''' - ``debts``:``array`` - debts in block - ``Hash``:``string`` - debts hash - ``Data``:``json`` - debts data - ``TxHash``:``string`` - txhash in debt - ``Shard``:``int`` - shard number of seele node where debts on - ``Account``:``array`` - debt account - ``Amount``:``int64`` - debt amount - ``Fee``:``int64`` - debt fee - ``Code``:``string`` - debt code - ``hash``:``string`` - block hash - ``header``:``json`` - block header - ``PreviousBlockHash``:``string`` - previous block hash - ``Creator``:``string`` - creator address - ``TxHash``:``string`` - tx hash - ``ReceiptHash``:``string`` - Receipts hash - ``stateHash``:``string`` - state tree hash - ``TxDebtHash``:``string`` - debts hash - ``DebtHash``:``string`` - debts hash - ``Difficulty``:``big.Int`` - block difficulty - ``Height``:``unit64`` - block height - ``CreateTimestamp``:``uint64`` - create timestamp - ``Witness``:``string`` - block nonce - ``Consensus``:``int`` - consensus algorithm - ``ExtraData``:``string`` - extra data - ``totalDifficulty``:``big.Int`` - total difficulty - ``transactions``:``array`` - transaction array - ``accountNonce``:``unit64`` - account nonce - ``amount``:``Int`` - transaction amount - ``from``:``string`` - transaction provider - ``gasLimit``:``Int`` - transaction gas limit - ``gasPrice``:``Int`` - transaction gas price - ``hash``:``string`` - transaction hash - ``payload``:``array`` - transaction payload - ``to``:``string`` - transaction receiver - ``txDebts``:``array`` - transaction debts - ``Hash``:``string`` - txDebts hash - ``Data``:``json`` - txDebts data - ``TxHash``:``string`` - transaction hash - ``From``:``string`` - transaction sender - ``Nonce``:``unit64`` - sender nonce - ``Account``:``string`` - transaction account - ``Amount``:``int`` - transaction amount - ``Price``:``int`` - transaction gas price - ``Code``:``string`` - transaction code .. _example-5: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_getBlock","params":["",19018,true],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "debts": [], "hash": "0x000002f75910694bf33a9a2f3e0cab454ac4b14ff9d32aee7b59efc20260f00c", "header": { "PreviousBlockHash": "0x000005f39610211ad1e888940a0e6affb538ea2397f73e08f1f894537997118c", "Creator": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21", "StateHash": "0xde119fb11c8c74b34a71ce376589a1711af5acef99aaf36827fbaafaeb9fe617", "TxHash": "0xa5dea280e6e880af7547ffea5c54526b0a3fae9dcd977a0a5a00e14852eb08ce", "ReceiptHash": "0xd6efdf2db85d6a5ab3fdc14925f67b9c97fb7ebdb733e5b2bb5776c694bc9073", "TxDebtHash": "0x8fde2b990967a9e51cb5218acc3318faea7a50429760cef37867b12c62f30b78", "DebtHash": "0x0000000000000000000000000000000000000000000000000000000000000000", "Difficulty": 2258387, "Height": 19018, "CreateTimestamp": 1548821456, "Witness": "MTI4ODU5Njk2MTcyODI5NzQ3MzM=", "Consensus": 0, "ExtraData": "" }, "totalDifficulty": 52970343102, "transactions": [ { "accountNonce": 0, "amount": 1200000000, "from": "0x0000000000000000000000000000000000000000", "gasLimit": 0, "gasPrice": 0, "hash": "0x0071c67a94f3619d9c7acb6fd40750956df24beb5dfaa5372e87a83bc06e219c", "payload": "", "to": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21" }, { "accountNonce": 100, "amount": 88, "from": "0x3b691130ec4166bfc9ec7240217fc8d08903cf21", "gasLimit": 63000, "gasPrice": 10, "hash": "0xf7288fbc1ab3bea992dd5f311644f220b1accf8011f59df4778ca526843d1f68", "payload": "", "to": "0x007d1b1ea335e8e4a74c0be781d828dc7db934b1" } ], "txDebts": [ { "Hash": "0xa0089462915e0a1b99ce3d75f6b51cdd5caf9a52691f327c9a27d222e0e38d57", "Data": { "TxHash": "0xf7288fbc1ab3bea992dd5f311644f220b1accf8011f59df4778ca526843d1f68", "From": "0x3b691130ec4166bfc9ec7240217fc8d08903cf21", "Nonce": 100, "Account": "0x007d1b1ea335e8e4a74c0be781d828dc7db934b1", "Amount": 88, "Price": 10, "Code": "" } } ] } } -------------- GetBlockByHash ^^^^^^^^^^^^^^ This method is used to obtain the block content based on block hash. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_getBlockByHash","params":[strin | | | g,bool],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-6: Parameters '''''''''' - ``hash``:``string`` - block hash - ``fulltx, f``:``bool`` - whether to include detailed transaction information .. _returns-4: Returns ''''''' - ``debts``:``array`` - debts in block - ``Hash``:``string`` - debts hash - ``Data``:``json`` - debts data - ``TxHash``:``string`` - txhash in debt - ``Shard``:``int`` - shard number of seele node where debts on - ``Account``:``array`` - debt account - ``Amount``:``int64`` - debt amount - ``Fee``:``int64`` - debt fee - ``Code``:``string`` - debt code - ``hash``:``string`` - block hash - ``header``:``json`` - block header - ``PreviousBlockHash``:``string`` - previous block hash - ``Creator``:``string`` - creator address - ``TxHash``:``string`` - tx hash - ``ReceiptHash``:``string`` - Receipts hash - ``stateHash``:``string`` - state tree hash - ``TxDebtHash``:``string`` - debts hash - ``DebtHash``:``string`` - debts hash - ``Difficulty``:``big.Int`` - block difficulty - ``Height``:``unit64`` - block height - ``CreateTimestamp``:``uint64`` - create timestamp - ``Witness``:``string`` - block nonce - ``Consensus``:``int`` - consensus algorithm - ``ExtraData``:``string`` - extra data - ``totalDifficulty``:``big.Int`` - total difficulty - ``transactions``:``array`` - transaction array - ``accountNonce``:``unit64`` - account nonce - ``amount``:``Int`` - transaction amount - ``from``:``string`` - transaction provider - ``gasLimit``:``Int`` - transaction gas limit - ``gasPrice``:``Int`` - transaction gas price - ``hash``:``string`` - transaction hash - ``payload``:``array`` - transaction payload - ``to``:``string`` - transaction receiver - ``txDebts``:``array`` - transaction debts - ``Hash``:``string`` - txDebts hash - ``Data``:``json`` - txDebts data - ``TxHash``:``string`` - transaction hash - ``From``:``string`` - transaction sender - ``Nonce``:``unit64`` - sender nonce - ``Account``:``string`` - transaction account - ``Amount``:``int`` - transaction amount - ``Price``:``int`` - transaction gas price - ``Code``:``string`` - transaction code .. _example-6: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_getBlockByHash","params":["0x000002f75910694bf33a9a2f3e0cab454ac4b14ff9d32aee7b59efc20260f00c",true],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "debts": [], "hash": "0x000002f75910694bf33a9a2f3e0cab454ac4b14ff9d32aee7b59efc20260f00c", "header": { "PreviousBlockHash": "0x000005f39610211ad1e888940a0e6affb538ea2397f73e08f1f894537997118c", "Creator": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21", "StateHash": "0xde119fb11c8c74b34a71ce376589a1711af5acef99aaf36827fbaafaeb9fe617", "TxHash": "0xa5dea280e6e880af7547ffea5c54526b0a3fae9dcd977a0a5a00e14852eb08ce", "ReceiptHash": "0xd6efdf2db85d6a5ab3fdc14925f67b9c97fb7ebdb733e5b2bb5776c694bc9073", "TxDebtHash": "0x8fde2b990967a9e51cb5218acc3318faea7a50429760cef37867b12c62f30b78", "DebtHash": "0x0000000000000000000000000000000000000000000000000000000000000000", "Difficulty": 2258387, "Height": 19018, "CreateTimestamp": 1548821456, "Witness": "MTI4ODU5Njk2MTcyODI5NzQ3MzM=", "Consensus": 0, "ExtraData": "" }, "totalDifficulty": 52970343102, "transactions": [ { "accountNonce": 0, "amount": 1200000000, "from": "0x0000000000000000000000000000000000000000", "gasLimit": 0, "gasPrice": 0, "hash": "0x0071c67a94f3619d9c7acb6fd40750956df24beb5dfaa5372e87a83bc06e219c", "payload": "", "to": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21" }, { "accountNonce": 100, "amount": 88, "from": "0x3b691130ec4166bfc9ec7240217fc8d08903cf21", "gasLimit": 63000, "gasPrice": 10, "hash": "0xf7288fbc1ab3bea992dd5f311644f220b1accf8011f59df4778ca526843d1f68", "payload": "", "to": "0x007d1b1ea335e8e4a74c0be781d828dc7db934b1" } ], "txDebts": [ { "Hash": "0xa0089462915e0a1b99ce3d75f6b51cdd5caf9a52691f327c9a27d222e0e38d57", "Data": { "TxHash": "0xf7288fbc1ab3bea992dd5f311644f220b1accf8011f59df4778ca526843d1f68", "From": "0x3b691130ec4166bfc9ec7240217fc8d08903cf21", "Nonce": 100, "Account": "0x007d1b1ea335e8e4a74c0be781d828dc7db934b1", "Amount": 88, "Price": 10, "Code": "" } } ] } } -------------- GetBlockByHeight ^^^^^^^^^^^^^^^^ This method is used to obtain the block content based on block height. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_getBlockByHeight","params":[str | | | ing,bool],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-7: Parameters '''''''''' - ``height``:``string`` - block height - ``fulltx, f``:``bool`` - whether to include detailed transaction information .. _returns-5: Returns ''''''' - ``debts``:``array`` - debts in block - ``Hash``:``string`` - debts hash - ``Data``:``json`` - debts data - ``TxHash``:``string`` - txhash in debt - ``Shard``:``int`` - shard number of seele node where debts on - ``Account``:``array`` - debt account - ``Amount``:``int64`` - debt amount - ``Fee``:``int64`` - debt fee - ``Code``:``string`` - debt code - ``hash``:``string`` - block hash - ``header``:``json`` - block header - ``PreviousBlockHash``:``string`` - previous block hash - ``Creator``:``string`` - creator address - ``TxHash``:``string`` - tx hash - ``ReceiptHash``:``string`` - Receipts hash - ``stateHash``:``string`` - state tree hash - ``TxDebtHash``:``string`` - debts hash - ``DebtHash``:``string`` - debts hash - ``Difficulty``:``big.Int`` - block difficulty - ``Height``:``unit64`` - block height - ``CreateTimestamp``:``uint64`` - create timestamp - ``Witness``:``string`` - block nonce - ``Consensus``:``int`` - consensus algorithm - ``ExtraData``:``string`` - extra data - ``totalDifficulty``:``big.Int`` - total difficulty - ``transactions``:``array`` - transaction array - ``accountNonce``:``unit64`` - account nonce - ``amount``:``Int`` - transaction amount - ``from``:``string`` - transaction provider - ``gasLimit``:``Int`` - transaction gas limit - ``gasPrice``:``Int`` - transaction gas price - ``hash``:``string`` - transaction hash - ``payload``:``array`` - transaction payload - ``to``:``string`` - transaction receiver - ``txDebts``:``array`` - transaction debts - ``Hash``:``string`` - txDebts hash - ``Data``:``json`` - txDebts data - ``TxHash``:``string`` - transaction hash - ``From``:``string`` - transaction sender - ``Nonce``:``unit64`` - sender nonce - ``Account``:``string`` - transaction account - ``Amount``:``int`` - transaction amount - ``Price``:``int`` - transaction gas price - ``Code``:``string`` - transaction code .. _example-7: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_getBlockByHeight","params":[19018,true],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "debts": [], "hash": "0x000002f75910694bf33a9a2f3e0cab454ac4b14ff9d32aee7b59efc20260f00c", "header": { "PreviousBlockHash": "0x000005f39610211ad1e888940a0e6affb538ea2397f73e08f1f894537997118c", "Creator": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21", "StateHash": "0xde119fb11c8c74b34a71ce376589a1711af5acef99aaf36827fbaafaeb9fe617", "TxHash": "0xa5dea280e6e880af7547ffea5c54526b0a3fae9dcd977a0a5a00e14852eb08ce", "ReceiptHash": "0xd6efdf2db85d6a5ab3fdc14925f67b9c97fb7ebdb733e5b2bb5776c694bc9073", "TxDebtHash": "0x8fde2b990967a9e51cb5218acc3318faea7a50429760cef37867b12c62f30b78", "DebtHash": "0x0000000000000000000000000000000000000000000000000000000000000000", "Difficulty": 2258387, "Height": 19018, "CreateTimestamp": 1548821456, "Witness": "MTI4ODU5Njk2MTcyODI5NzQ3MzM=", "Consensus": 0, "ExtraData": "" }, "totalDifficulty": 52970343102, "transactions": [ { "accountNonce": 0, "amount": 1200000000, "from": "0x0000000000000000000000000000000000000000", "gasLimit": 0, "gasPrice": 0, "hash": "0x0071c67a94f3619d9c7acb6fd40750956df24beb5dfaa5372e87a83bc06e219c", "payload": "", "to": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21" }, { "accountNonce": 100, "amount": 88, "from": "0x3b691130ec4166bfc9ec7240217fc8d08903cf21", "gasLimit": 63000, "gasPrice": 10, "hash": "0xf7288fbc1ab3bea992dd5f311644f220b1accf8011f59df4778ca526843d1f68", "payload": "", "to": "0x007d1b1ea335e8e4a74c0be781d828dc7db934b1" } ], "txDebts": [ { "Hash": "0xa0089462915e0a1b99ce3d75f6b51cdd5caf9a52691f327c9a27d222e0e38d57", "Data": { "TxHash": "0xf7288fbc1ab3bea992dd5f311644f220b1accf8011f59df4778ca526843d1f68", "From": "0x3b691130ec4166bfc9ec7240217fc8d08903cf21", "Nonce": 100, "Account": "0x007d1b1ea335e8e4a74c0be781d828dc7db934b1", "Amount": 88, "Price": 10, "Code": "" } } ] } } -------------- Call ^^^^ This method is used to execute a given transaction on a statedb of a given block height. It does not affect the statedb or blockchain and is useful for executing and retrieving values. However, the height currently does not support optional and will remove the from parameter in the next version or more. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_call ","params":[CallRequest]," | | | id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-8: Parameters '''''''''' - ``to``:``string`` - to address - ``payload``:``string`` - transaction payload info - ``Height``:``int64`` - block height (default: -1) .. _returns-6: Returns ''''''' - ``contract``:``string`` - contract address - ``failed``:``bool`` - contract executes successfully or not - ``poststate``:``string`` - state trie root hash after transaction execution - ``result``:``string`` - transaction result - ``totalFee``:``int64`` - transaction fee - ``txhash``:``string`` - transaction hash - ``usedGas``:``int64`` - transaction gas .. _example-8: Example ''''''' When using the example below, the contract must be deployed first. The solidity code file: :: pragma solidity ^0.4.0; contract SimpleStorage { uint storedData=23; function set(uint x) { storedData=x; } function get() constant returns(uint) { return storedData; } } As you can see, the example is testing the get function. .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_call","params":["0x9df8ed11ea024183bd584480e80952c9b04e0122","0x6d4ce63c",-1],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "contract": "0x", "failed": false, "poststate": "0xb724c37fd2047d26c7e22da0f43d8c520aa15d9fc9358872583eb4a11b9c6787", "result": "0x0000000000000000000000000000000000000000000000000000000000000005", "totalFee": 101, "txhash": "0xefaa679d7b6bbbf2b56b198f45156a82a737a352cb1d42f2f5357ed3a4f91a16", "usedGas": 424 } } -------------- GetLogs ^^^^^^^ This method gets the event logs by block height, the contract address, and the event name. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_getLogs ","params":[GetLogsRequ | | | est],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-9: Parameters '''''''''' - ``height``:``int64`` - block height (default: -1) - ``contract``:``string`` - contract code in hex - ``topic``:``string`` - topic .. _returns-7: Returns ''''''' TODO .. _example-9: Example ''''''' When using the example below, the contract must be deployed first. The solidity code file: :: pragma solidity ^0.4.0; contract simple_storage_1 { uint storedData=23; event getLog(address addr, string message); event getLog1(string message); event getLog2(string message); function set(uint x) public{ getLog1("set getLog1"); getLog2("set getLog2"); storedData=x; } function get() constant public returns(uint) { getLog(msg.sender, "get getLog"); getLog1("get getLog1"); set(16); return storedData; } } As you can see, this example is testing the get function. In this situation, the height is the block height of the block containing the get transaction. .. code:: js // Request TODO // Result TODO -------------- GeneratePayload ^^^^^^^^^^^^^^^ This method generate the contract method payload. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_generatePayload","params":[stri | | | ng, string, []string],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-10: Parameters '''''''''' - ``abiJSON``:``string`` - contract json string - ``methodName``:``string`` - contract method name - ``args``:``string`` - args of contract method .. _returns-8: Returns ''''''' - ``result``:``string`` payload of contract method with args .. _example-10: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_generatePayload","params":["[{\"constant\":false,\"inputs\":[{\"name\":\"x\",\"type\":\"uint256\"}],\"name\":\"set\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"name\":\"\",\"type\":\"uint256\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"inputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"constructor\"}]", "set", ["1"]],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": "0x60fe47b10000000000000000000000000000000000000000000000000000000000000001" } -------------- EstimateGas ^^^^^^^^^^^ This method Estimate the gas of a transaction. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"seel | | | e_estimateGas","params":[types.Tr | | | ansaction],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-11: Parameters '''''''''' - ``Hash``:``string`` - transaction hash - ``Data``:``json`` - transaction data - ``From``:``string`` - transaction sender - ``To``:``string`` - transaction receiver - ``Amount``:``uint64`` - amount value, unit is fan - ``GasPrice``:``uint64`` - transaction gas price in Fan - ``GasLimit``:``uint64`` - maximum gas for transaction - ``Payload``:``string`` - transaction payload - ``AccountNonce``:``uint64`` - transaction nonce .. _returns-9: Returns ''''''' - ``result``:uint64 - gas amount .. _example-11: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"seele_estimateGas","params":[{"Hash": "0xd02530a4126ecea2787d59bf5e9611907c6043dd900f894554624bd1d25bcb32","Data": {"From": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21","To": "0x0ea2a45ab5a909c309439b0e004c61b7b2a3e831","Amount": 20000,"AccountNonce": 1,"GasPrice": 10,"GasLimit": 200000,"Payload": ""}}],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": 63000 } -------------- txpool ~~~~~~ RPC collection provided for internal use for transaction pool inquiry manipulation. \**\* GetBlockTransactionCount ^^^^^^^^^^^^^^^^^^^^^^^^ This method is used to obtain the number of transactions in the transaction pool based on block height or hash. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"txpo | | | ol_getBlockTransactionCount","par | | | ams":[string,int64],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-12: Parameters '''''''''' - ``hash``:``string`` - hash value in hex - ``height``:``int64`` - block height (default: -1) .. _returns-10: Returns ''''''' - ``result``:``int`` - transactions count .. _example-12: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"txpool_getBlockTransactionCount","params":["0x0000015592fab87d6efa10e63d7722f6f359d90a1aff9e70930b291931c34922",-1],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": 2 } -------------- GetBlockTransactionCountByHeight ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This method is used to obtain the number of transactions in the transaction pool based on block height. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"txpo | | | ol_getBlockTransactionCountByHeig | | | ht","params":[int64],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-13: Parameters '''''''''' - ``height``:``int64`` - block height (default: -1) .. _returns-11: Returns ''''''' - ``result``:``int`` - transactions count .. _example-13: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"txpool_getBlockTransactionCountByHeight","params":[-1],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": 2 } -------------- GetBlockTransactionCountByHash ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This method is used to obtain the number of transactions in the transaction pool based on block hash. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"txpo | | | ol_getBlockTransactionCountByHash | | | ","params":[string],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-14: Parameters '''''''''' - ``hash``:``string`` - hash value in hex .. _returns-12: Returns ''''''' - ``result``:``int`` - transactions count .. _example-14: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"txpool_getBlockTransactionCountByHash","params":["0x0000004c0336e63f76e7bd2b7888514eff47b3528df67ca6ee95edb9dff79c00"],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": 2 } -------------- GetTransactionByBlockIndex ^^^^^^^^^^^^^^^^^^^^^^^^^^ This method is used to obtain the transaction content based on block height or hash and transaction index. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"txpo | | | ol_getTransactionByBlockIndex","p | | | arams":[string,int,int],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-15: Parameters '''''''''' - ``hash``:``string`` - block hash - ``height``:``int`` - block height (default: -1) - ``index``:``int`` - transaction index, start with 0 (default: 0) .. _returns-13: Returns ''''''' - ``accountNonce``:``unit64`` - account nonce - ``amount``:``Int`` - transaction amount - ``gasLimit``:``Int`` - transaction gas limit - ``gasPrice``:``Int`` - transaction gas price - ``from``:``string`` - transaction provider - ``to``:``string`` - transaction receiver - ``hash``:``string`` - transaction hash - ``payload``:``array`` - transaction payload .. _example-15: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"txpool_getTransactionByBlockIndex","params":["0x0000015592fab87d6efa10e63d7722f6f359d90a1aff9e70930b291931c34922", -1, 1],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "accountNonce": 0, "amount": 150000000, "from": "0x0000000000000000000000000000000000000000", "gasLimit": 0, "gasPrice": 0, "hash": "0x473ea3667d073491d5896a93fcf84d7dd822988d07482f21e7a875787539e62e", "payload": "", "to": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21" } } -------------- GetTransactionByBlockHeightAndIndex ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This method is used to obtain the transaction content based on block height and transaction index. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"txpo | | | ol_getTransactionByBlockHeightAnd | | | Index","params":[int,int],"id":1} | | | `` | +-----------------------------------+-----------------------------------+ .. _parameters-16: Parameters '''''''''' - ``height``:``int`` - block height (default: -1) - ``index``:``int`` - transaction index, start with 0 (default: 0) .. _returns-14: Returns ''''''' - ``accountNonce``:``unit64`` - account nonce - ``amount``:``Int`` - transaction amount - ``gasLimit``:``Int`` - transaction gas limit - ``gasPrice``:``Int`` - transaction gas price - ``from``:``string`` - transaction provider - ``to``:``string`` - transaction receiver - ``hash``:``string`` - transaction hash - ``payload``:``array`` - transaction payload .. _example-16: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"txpool_getTransactionByBlockHeightAndIndex","params":[4202, 1],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "accountNonce": 0, "amount": 150000000, "from": "0x0000000000000000000000000000000000000000", "gasLimit": 0, "gasPrice": 0, "hash": "0x473ea3667d073491d5896a93fcf84d7dd822988d07482f21e7a875787539e62e", "payload": "", "to": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21" } } -------------- GetTransactionByBlockHashAndIndex ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This method is used to obtain the transaction content based on block hash and transaction index. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"txpo | | | ol_getTransactionByBlockHashAndIn | | | dex","params":[string,int],"id":1 | | | }`` | +-----------------------------------+-----------------------------------+ .. _parameters-17: Parameters '''''''''' - ``hash``:``string`` - block hash - ``index``:``int`` - transaction index, start with 0 (default: 0) .. _returns-15: Returns ''''''' - ``accountNonce``:``unit64`` - account nonce - ``amount``:``Int`` - transaction amount - ``gasLimit``:``Int`` - transaction gas limit - ``gasPrice``:``Int`` - transaction gas price - ``from``:``string`` - transaction provider - ``to``:``string`` - transaction receiver - ``hash``:``string`` - transaction hash - ``payload``:``array`` - transaction payload .. _example-17: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"txpool_getTransactionByBlockHashAndIndex","params":["0x0000015592fab87d6efa10e63d7722f6f359d90a1aff9e70930b291931c34922", 1],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "accountNonce": 0, "amount": 150000000, "from": "0x0000000000000000000000000000000000000000", "gasLimit": 0, "gasPrice": 0, "hash": "0x473ea3667d073491d5896a93fcf84d7dd822988d07482f21e7a875787539e62e", "payload": "", "to": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21" } } -------------- GetTransactionByHash ^^^^^^^^^^^^^^^^^^^^ This method returns transaction information by hash. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"txpo | | | ol_getTransactionByHash","params" | | | :[string],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-18: Parameters '''''''''' - ``hash``:``string`` - hash value in hex .. _returns-16: Returns ''''''' - ``blockHash``:``string`` - block hash - ``blockHeight``:``int`` - block height - ``status``:``string`` - transaction status - ``accountNonce``:``unit64`` - account nonce - ``amount``:``Int`` - transaction amount - ``gasLimit``:``Int`` - transaction gas limit - ``gasPrice``:``Int`` - transaction gas price - ``from``:``string`` - transaction provider - ``to``:``string`` - transaction receiver - ``hash``:``string`` - transaction hash - ``payload``:``array`` - transaction payload - ``txIndex``:``int`` - transaction index in block .. _example-18: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"txpool_getTransactionByHash","params":["0xbd2ca4f9869c714e589ad6a3b16731c8cb066de40d0e27e220cc1e014577baff"],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "blockHash": "0x0000009c753570436b0bdd4ea1b9cfb1611f181f7aae82d4ba265761c50c8479", "blockHeight": 3608, "status": "block", "transaction": { "accountNonce": 0, "amount": 150000000, "from": "0x0000000000000000000000000000000000000000", "gasLimit": 0, "gasPrice": 0, "hash": "0x473ea3667d073491d5896a93fcf84d7dd822988d07482f21e7a875787539e62e", "payload": "", "to": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21" }, "txIndex": 0 } } -------------- GetReceiptByTxHash ^^^^^^^^^^^^^^^^^^ This method is used to obtain the receipt contents based on transaction hash. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"txpo | | | ol_getReceiptByTxHash","params":[ | | | string,string],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-19: Parameters '''''''''' - ``hash``:``string`` - hash value in hex - ``abi``:``string`` - the abi file of contract .. _returns-17: Returns ''''''' - ``contract``:``string`` - contract address - ``failed``:``bool`` - transaction executes successfully or not - ``poststate``:``string`` - state trie root hash after transaction execution - ``result``:``string`` - transaction result - ``totalFee``:``int`` - transaction fee - ``txhash``:``string`` - transaction hash - ``usedGas``:``int`` - transaction gas .. _example-19: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"txpool_getReceiptByTxHash","params":["0xbd2ca4f9869c714e589ad6a3b16731c8cb066de40d0e27e220cc1e014577baff","""],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "contract": "0x", "failed": false, "poststate": "0xdd0b0fc6605bbb2e76b8c22ccd466ea5eaa1a80e4860fbdf971be58ded3d782b", "result": "0x", "totalFee": 1, "txhash": "0xbd2ca4f9869c714e589ad6a3b16731c8cb066de40d0e27e220cc1e014577baff", "usedGas": 0 } } -------------- GetDebtByHash ^^^^^^^^^^^^^ This method is used to obtain the debt contents based on debt hash. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"txpo | | | ol_getDebtByHash","params":[strin | | | g],"id":1}`` | +-----------------------------------+-----------------------------------+ .. _parameters-20: Parameters '''''''''' - ``hash``:``string`` - debt hash value in hex .. _returns-18: Returns ''''''' - ``blockHash``:``string`` - block hash of the debt on - ``blockHeight``:``int64`` - block height of the debt on - ``debt``:``json`` - debt json - ``Hash``:``string`` - debt hash - ``Data``:``json`` - debt data - ``TxHash``:``string`` - txhash in debt - ``From``:``string`` - address of the sender - ``Nonce``: ``uint64`` - nonce of From address - ``Account``:``string`` - debt account - ``Amount``:``int64`` - debt amount - ``Price``:``int64`` - debt price - ``Code``:``string`` - debt contract code - ``debtIndex``:``int`` - debt index of the block debts - ``status``:``string`` - debt status .. _example-20: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"txpool_getDebtByHash","params":["0x0da1ed893e7f0ca2558c193b3b82ed20575a6978bea5b14f282309c69fee368e"],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "blockHash": "0x000001fb7817c8d9eeaa9bbed6670f8db62b605ad174f561e74afc60ac18c97b", "blockHeight": 170, "debt": { "Hash": "0xa0089462915e0a1b99ce3d75f6b51cdd5caf9a52691f327c9a27d222e0e38d57", "Data": { "TxHash": "0xf7288fbc1ab3bea992dd5f311644f220b1accf8011f59df4778ca526843d1f68", "From": "0x3b691130ec4166bfc9ec7240217fc8d08903cf21", "Nonce": 100, "Account": "0x007d1b1ea335e8e4a74c0be781d828dc7db934b1", "Amount": 88, "Price": 10, "Code": "" } }, "debtIndex": 0, "status": "block" } } -------------- download ~~~~~~~~ RPC collection provided for internal inquiry of blockchain node synchronization state. -------------- GetStatus ^^^^^^^^^ This method returns synchronization information. ==== ====================================================================== Type Template ==== ====================================================================== RPC ``{"jsonrpc":"2.0","method":"download_getStatus","params":[],"id":2}`` ==== ====================================================================== .. _parameters-21: Parameters '''''''''' none .. _returns-19: Returns ''''''' - ``Status``:``string`` - synchronization state - ``Duration``:``string`` - synchronization duration (seconds) - ``StartNum``:``uint64`` - synchronization initial block height - ``Amount``:``uint64`` - synchronization value - ``Downloaded``:``uint64`` - Synchronization number of times .. _example-21: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"download_getStatus","params":[],"id":2}' localhost:8037 //Result { "jsonrpc": "2.0", "id": 2, "result": { "Status": "NotSyncing", "Duration": "", "StartNum": 0, "Amount": 0, "Downloaded": 0 } } -------------- network ~~~~~~~ RPC collection provided for internal inquiry of network node information. -------------- GetPeersInfo ^^^^^^^^^^^^ This method returns the information of peer nodes. ==== ======================================================================== Type Template ==== ======================================================================== RPC ``{"jsonrpc":"2.0","method":"network_getPeersInfo","params":[],"id":2}`` ==== ======================================================================== .. _parameters-22: Parameters '''''''''' none .. _returns-20: Returns ''''''' - ``id``:``string`` - node ID - ``caps``:``array`` - peer node protocol and version array - ``network``:``struct`` - network access address collection - ``localAddress``:``string`` - local address - ``remoteAddress``:``string`` - remote address - ``protocols``:``map`` - node collection, key is the node name - ``version``:``int`` - node protocal - ``difficulty``:``big.Int`` - node difficulty - ``head``:``string`` - current block hash of the node - ``shard``:``uint`` - shard id of the node ##### Example .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"network_getPeersInfo","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": [ { "id": "0x0ea2a45ab5a909c309439b0e004c61b7b2a3e831", "caps": [ "lightSeele_1/1", "lightSeele_2/1", "seele/1" ], "network": { "localAddress": "127.0.0.1:54652", "remoteAddress": "127.0.0.1:8058" }, "protocols": { "lightSeele_1": { "version": 1, "difficulty": 54618694483, "head": "0000040c0c7af9b83736210e0f177998e61d2ec8b314fd2d4f49b8a11c4a28b7" }, "lightSeele_2": { "version": 1, "difficulty": 2395409154, "head": "0000030e2940702b853faa83f01cf34d7324de11ad0e52b4f33851c41e41ecf0" }, "seele": { "version": 1, "difficulty": 2395409154, "head": "0000030e2940702b853faa83f01cf34d7324de11ad0e52b4f33851c41e41ecf0" } }, "shard": 2 } ] } -------------- GetPeerCount ^^^^^^^^^^^^ This method returns the number of peer nodes. ==== ======================================================================== Type Template ==== ======================================================================== RPC ``{"jsonrpc":"2.0","method":"network_getPeerCount","params":[],"id":2}`` ==== ======================================================================== .. _parameters-23: Parameters '''''''''' none .. _returns-21: Returns ''''''' - ``result``:``int`` - peer number of node .. _example-22: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"network_getPeerCount","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": 1 } -------------- GetNetVersion ^^^^^^^^^^^^^ This method returns the network version. ==== ========================================================================= Type Template ==== ========================================================================= RPC ``{"jsonrpc":"2.0","method":"network_getNetVersion","params":[],"id":2}`` ==== ========================================================================= .. _parameters-24: Parameters '''''''''' none .. _returns-22: Returns ''''''' - ``result``:``string`` - version number .. _example-23: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"network_getNetVersion","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": 1.0 } -------------- GetProtocolVersion ^^^^^^^^^^^^^^^^^^ This method returns the protocol version. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"netw | | | ork_getProtocolVersion","params": | | | [],"id":2}`` | +-----------------------------------+-----------------------------------+ .. _parameters-25: Parameters '''''''''' none .. _returns-23: Returns ''''''' - ``result``:``int`` - version number .. _example-24: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"network_getProtocolVersion","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": 1 } -------------- GetNetworkID ^^^^^^^^^^^^ This method returns the network id. ==== ======================================================================== Type Template ==== ======================================================================== RPC ``{"jsonrpc":"2.0","method":"network_getNetworkID","params":[],"id":2}`` ==== ======================================================================== .. _parameters-26: Parameters '''''''''' none .. _returns-24: Returns ''''''' - ``result``:``string`` - network id .. _example-25: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"network_getNetworkID","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": "seele" } -------------- miner ~~~~~ RPC collection provided for internal inquiry of miner information. \**\* Start ^^^^^ This method starts the miner with an input number of threads. ==== ================================================================== Type Template ==== ================================================================== RPC ``{"jsonrpc":"2.0","method":"miner_start","params":[int],"id":2}`` ==== ================================================================== .. _parameters-27: Parameters '''''''''' - ``threads``:``int`` - number of threads .. _returns-25: Returns ''''''' - ``result``:``bool`` - start result .. _example-26: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"miner_start","params":[2],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": true } -------------- Stop ^^^^ This method stops the miner. ==== ============================================================== Type Template ==== ============================================================== RPC ``{"jsonrpc":"2.0","method":"miner_stop","params":[],"id":2}`` ==== ============================================================== .. _parameters-28: Parameters '''''''''' none .. _returns-26: Returns ''''''' - ``result``:``bool`` - stop result .. _example-27: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"miner_stop","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": true } -------------- Status ^^^^^^ This method returns the miner status. ==== ================================================================ Type Template ==== ================================================================ RPC ``{"jsonrpc":"2.0","method":"miner_status","params":[],"id":2}`` ==== ================================================================ .. _parameters-29: Parameters '''''''''' none .. _returns-27: Returns ''''''' - ``result``:``string`` - miner status .. _example-28: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"miner_status","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": "running" } -------------- GetCoinbase ^^^^^^^^^^^ This method is used to obtain the node coinbase. ==== ===================================================================== Type Template ==== ===================================================================== RPC ``{"jsonrpc":"2.0","method":"miner_getCoinbase","params":[],"id":2}`` ==== ===================================================================== .. _parameters-30: Parameters '''''''''' none .. _returns-28: Returns ''''''' - ``result``:``string`` - coinbase .. _example-29: Example ''''''' .. code:: js curl -X POST --data '{"jsonrpc":"2.0","method":"miner.getCoinbase","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21" } SetThreads ^^^^^^^^^^ This method is used to set the threads of miner consensus. ==== ==================================================================== Type Template ==== ==================================================================== RPC ``{"jsonrpc":"2.0","method":"miner_setThreads","params":[],"id":2}`` ==== ==================================================================== .. _parameters-31: Parameters '''''''''' - ``threads``:``int`` - miner threads .. _returns-29: Returns ''''''' - ``result``:``bool`` - SetThreads result .. _example-30: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"miner_setThreads","params":[4],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": true } -------------- SetCoinbase ^^^^^^^^^^^ This method is used to set the coinbase +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"mine | | | r_setCoinbase","params":["string" | | | ],"id":2}`` | +-----------------------------------+-----------------------------------+ .. _parameters-32: Parameters '''''''''' - ``coinbase``:``string`` coinbase of the miner .. _returns-30: Returns ''''''' - ``result``:``bool`` - SetCoinbase result .. _example-31: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"miner_setCoinbase","params":["0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21"],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": true } -------------- GetThreads ^^^^^^^^^^ This method is used to get the threads of miner consensus. ==== ==================================================================== Type Template ==== ==================================================================== RPC ``{"jsonrpc":"2.0","method":"miner_getThreads","params":[],"id":2}`` ==== ==================================================================== .. _parameters-33: Parameters '''''''''' none .. _returns-31: Returns ''''''' - ``result``:``int`` - miner threads .. _example-32: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"miner_getThreads","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": 2 } -------------- GetHashrate ^^^^^^^^^^^ This method is used to get the current hashrate (Rate1). ==== ===================================================================== Type Template ==== ===================================================================== RPC ``{"jsonrpc":"2.0","method":"miner_getHashrate","params":[],"id":2}`` ==== ===================================================================== .. _parameters-34: Parameters '''''''''' none .. _returns-32: Returns ''''''' - ``result``:``uint64`` - hashrate .. _example-33: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"miner_getHashrate","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": 200064 } -------------- debug ~~~~~ RPC collection provided for internal debugging. \**\* PrintBlock ^^^^^^^^^^ This method is used to print block information in dump format based on block height. ==== ========================================================================= Type Template ==== ========================================================================= RPC ``{"jsonrpc":"2.0","method":"debug_printBlock","params":[int64],"id":2}`` ==== ========================================================================= .. _parameters-35: Parameters '''''''''' - ``height``:``int64`` - block height .. _returns-33: Returns ''''''' - ``HeaderHash``:``string`` - block header hash - ``Header``:``json`` - block header - ``PreviousBlockHash``:``string`` - previous block hash - ``Creator``:``string`` - block creator - ``StateHash``:``string`` - state hash - ``TxHash``:``string`` - transactions hash - ``ReceiptHash``:``string`` - receipts hash - ``TxDebtHash``:``string`` - transaction debts hash - ``DebtHash``:``string`` - debts hash - ``Difficulty``:``big.Int`` - block td - ``Height``:``uint64`` - block height - ``CreateTimestamp``:``big.Int`` - create timestamp - ``Witness``:``string`` - block nonce - ``Consensus``:``int`` - 0 for POW consensus - ``ExtraData``:``string`` - extra data - ``Transactions``:``array`` - transactions on block - ``Hash``:``string`` - transaction hash - ``Data``:``string`` - transaction data - ``Type``:``int`` - transaction type, 0 for regular type, 1 for reward type - ``From``:``string`` - amount sender - ``To``:``string`` - amount receiver - ``Amount``:``int64`` - transaction amount - ``AccountNonce``:``int64`` - account nonce - ``GasPrice``:``int64`` - transaction gas price - ``GasLimit``:``int64`` - maximum gas for contract creation/execution - ``Timestamp``:``int64`` - transaction timestamp - ``Payload``:``string`` - payload - ``Signature``:``json`` - transaction signature json - ``Sig``:``string`` - transaction sig - ``Debts``:``array`` - dump format of block information - ``Hash``:``string`` - debts hash - ``Data``:``json`` - debts data - ``TxHash``:``string`` - txhash in debt - ``From``:``string`` - sender address - ``Nonce``:``int64`` - sender nonce - ``Account``:``string`` - debt account - ``Amount``:``int64`` - debt amount - ``Price``:``int64`` - debt gas price - ``Code``:``string`` - debt code .. _example-34: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"debug_printBlock","params":[10368],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "HeaderHash": "0x000001a8946d75258f9e269d516e797779ca6bd4b190c701f81456c60958c688", "Header": { "PreviousBlockHash": "0x000001f2ba4bc08c6a39fb35fa193698f35066c6ca14ca773b944eae25a6c360", "Creator": "0x0ea2a45ab5a909c309439b0e004c61b7b2a3e831", "StateHash": "0x875cd1618715a8414eb48f957b8a92b70699a9b3a94848d92da2fa278494ecc3", "TxHash": "0x390b401fa139861dcc7b7d78f18b043672a729b6d688b8cba38946b2b4114bb9", "ReceiptHash": "0x62db1441782a734fa65ee8f0678a8dd028fc813a11e4784ad24b596f5a071f01", "TxDebtHash": "0x0000000000000000000000000000000000000000000000000000000000000000", "DebtHash": "0x5b240a1f3d6369489307fee52be9bc759312f873bde832bda975ee774ecacfaa", "Difficulty": 6348338, "Height": 1112, "CreateTimestamp": 1539147474, "Nonce": 16880251435180988161, "ExtraData": "" }, "Transactions": [ { "Hash": "0x8bb8afe4222ed759af503ab95417015321b4992c7913b440f1be47536929d3b4", "Data": { "From": "0x0000000000000000000000000000000000000000", "To": "0x0ea2a45ab5a909c309439b0e004c61b7b2a3e831", "Amount": 150000000, "AccountNonce": 0, "Fee": 0, "Timestamp": 1539147474, "Payload": "" }, "Signature": { "Sig": "" } } ], "Debts": [ { "Hash": "0x0da1ed893e7f0ca2558c193b3b82ed20575a6978bea5b14f282309c69fee368e", "Data": { "TxHash": "0x58752f8aeb2c69dd2c32059d3ad8b2d3d860c6d92aa2b3b30ff985e564f60fae", "Shard": 2, "Account": "0x0ea2a45ab5a909c309439b0e004c61b7b2a3e831", "Amount": 10000, "Fee": 0, "Code": "" } } ] } } -------------- GetTxPoolContent ^^^^^^^^^^^^^^^^ This method is used to obtain the transaction pool content. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"debu | | | g_getTxPoolContent","params":[]," | | | id":2}`` | +-----------------------------------+-----------------------------------+ .. _parameters-36: Parameters '''''''''' none .. _returns-34: Returns ''''''' - ``accountNonce``:``unit64`` - account nonce - ``amount``:``Int`` - transaction amount - ``from``:``string`` - transaction provider - ``to``:``string`` - transaction receiver - ``hash``:``string`` - transaction hash - ``payload``:``array`` - transaction payload - ``timestamp``:``string`` - transaction timestamp - ``fee``:``int`` - transaction fee .. _example-35: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"debug_getTxPoolContent","params":[],"id":2}' localhost:8037 // Result { "jsonrpc":"2.0", "id":2, "result":{ "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21": [ { "accountNonce": 4, "amount": 10000, "fee": 1, "from": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21", "hash": "0x1d9579c07e8cbcab36efdd810d2ebd27585c1b79eb379afde5e077c22ad46e44", "payload": "", "timestamp": 0, "to": "0x16fba5fcb9bc4ee7c3b7fed667e41c9a0248da71" } ] ] } } -------------- GetTxPoolTxCount ^^^^^^^^^^^^^^^^ This method is used to obtain the number of transactions in the transaction pool. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"debu | | | g_getTxPoolTxCount","params":[]," | | | id":2}`` | +-----------------------------------+-----------------------------------+ .. _parameters-37: Parameters '''''''''' none .. _returns-35: Returns ''''''' - ``result``:``uint64`` - number of transactions .. _example-36: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"debug_getTxPoolTxCount","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": 1 } -------------- GetPendingTxs ^^^^^^^^^^^^^ This method is used to obtain pending transactions in the transaction pool. +-----------------------------------+-----------------------------------+ | Type | Template | +===================================+===================================+ | RPC | ``{"jsonrpc":"2.0","method":"debu | | | g_getPendingTransactions","params | | | ":[],"id":2}`` | +-----------------------------------+-----------------------------------+ .. _parameters-38: Parameters '''''''''' none .. _returns-36: Returns ''''''' - ``accountNonce``:``unit64`` - account nonce - ``amount``:``Int`` - transaction amount - ``from``:``string`` - transaction provider - ``to``:``string`` - transaction receiver - ``hash``:``string`` - transaction hash - ``payload``:``array`` - transaction payload - ``timestamp``:``string`` - transaction timestamp - ``fee``:``int`` - transaction fee .. _example-37: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"debug_getPendingTransactions","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 2, "result": [ { "accountNonce": 6, "amount": 10000, "fee": 1, "from": "0x4c10f2cd2159bb432094e3be7e17904c2b4aeb21", "hash": "0x4ad5843af174d32e31b54ef81ddcbfeec43f4eb5d01885dfe9828f9ce907fb80", "payload": "", "timestamp": 0, "to": "0x16fba5fcb9bc4ee7c3b7fed667e41c9a0248da71" } ] } -------------- GetPendingDebts ^^^^^^^^^^^^^^^ This method is used to obtain pending transactions in the transaction pool. ==== ========================================================================= Type Template ==== ========================================================================= RPC ``{"jsonrpc":"2.0","method":"debug_getPendingDebts","params":[],"id":2}`` ==== ========================================================================= .. _parameters-39: Parameters '''''''''' none .. _returns-37: Returns ''''''' - ``Data``:``json`` - debt data - ``Account``:``array`` - debt account - ``Amount``:``int64`` - debt amount - ``Code``:``string`` - debt code - ``Fee``:``int64`` - debt fee - ``Shard``:``int`` - shard number of seele node where debts on - ``TxHash``:``string`` - txhash in debt - ``Hash``:``string`` - debts hash .. _example-38: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"debug_getPendingDebts","params":[],"id":2}' localhost:8037 // Result [ { "Data": { "Account": "0x0ea2a45ab5a909c309439b0e004c61b7b2a3e831", "Amount": 10000, "Code": "", "Fee": 0, "Shard": 2, "TxHash": "0x049305964eac1c62b19f0a6a0841b1d24683c4c4f9a3f23c69c87dcca9ec3e28" }, "Hash": "0xdcf8489c27e934c3f289c4a1d843b86dbd3445e8943903613ce640d7fb043e87" } ] -------------- DumpHeap ^^^^^^^^ This method dump heap for profiling and returns the file path. ==== ================================================================== Type Template ==== ================================================================== RPC ``{"jsonrpc":"2.0","method":"debug_dumpHeap","params":[],"id":2}`` ==== ================================================================== .. _parameters-40: Parameters '''''''''' none .. _returns-38: Returns ''''''' - ``result``:``string`` file path .. _example-39: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"debug_dumpHeap","params":[],"id":2}' url // Result { "jsonrpc":"2.0", "id":2, "result":"C:\Users\dell-2\.seele\heap.dump" } -------------- GetTPS ^^^^^^ This method returns TPS of seele node. ==== ================================================================ Type Template ==== ================================================================ RPC ``{"jsonrpc":"2.0","method":"debug_getTPS","params":[],"id":2}`` ==== ================================================================ .. _parameters-41: Parameters '''''''''' none .. _returns-39: Returns ''''''' - ``StartHeight``:``int64`` start height - ``EndHeight``:``int64`` end height - ``Count``:``int`` tps - ``Duration``:``int`` elapsed time from start height to end height .. _example-40: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"debug_dumpHeap","params":[],"id":2}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "StartHeight": 13929, "EndHeight": 13941, "Count": 0, "Duration": 166 } } -------------- monitor ~~~~~~~ node monitor. -------------- NodeInfo ^^^^^^^^ This method returns the node information of the node ==== ==================================================================== Type Template ==== ==================================================================== RPC ``{"jsonrpc":"2.0","method":"monitor_nodeInfo","params":[],"id":1}`` ==== ==================================================================== .. _parameters-42: Parameters '''''''''' none .. _returns-40: Returns ''''''' - ``name``:``string`` monitor name - ``node``:``string`` node name - ``port``:``int`` port - ``netVersion``:``string`` node network version - ``protocol``:``string`` node network protocol - ``api``:``string`` monitor api - ``os``:``string`` system os - ``os_v``:``string`` system os architecture - ``client``:``string`` client version - ``canUpdateHistory``:``bool`` can update history? - ``shard``:``int`` shard number .. _example-41: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"monitor_nodeInfo","params":[],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "name": "Test monitor", "node": "seele node1", "port": 0, "netVersion": "1.0", "protocol": "1.0", "api": "No", "os": "windows", "os_v": "amd64", "client": "1.0", "canUpdateHistory": true, "shard": 1 } } -------------- NodeStats ^^^^^^^^^ This method returns the information of the node ==== ===================================================================== Type Template ==== ===================================================================== RPC ``{"jsonrpc":"2.0","method":"monitor_nodeStats","params":[],"id":1}`` ==== ===================================================================== .. _parameters-43: Parameters '''''''''' none .. _returns-41: Returns ''''''' - ``active``:``string`` is node actively? - ``syncing``:``string`` is node syncing? - ``mining``:``int`` is node mining? - ``peers``:``string`` node peers number .. _example-42: Example ''''''' .. code:: js // Request curl -X POST --data '{"jsonrpc":"2.0","method":"monitor_nodeStats","params":[],"id":1}' localhost:8037 // Result { "jsonrpc": "2.0", "id": 1, "result": { "active": true, "syncing": true, "mining": true, "peers": 0 } } --------------