TrueCloudLab/neo-go
8
0
Fork 0
mirror of https://github.com/nspcc-dev/neo-go.git synced 2024-11-25 13:47:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: update RPC server document

Browse source
This commit is contained in:
Roman Khimov 2021-03-19 00:11:38 +03:00
parent 8db7700fe7
commit ebf4062c85
1 changed files with 33 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
docs/rpc.md
View file

@ -41,31 +41,37 @@ which would yield the response:
| `getblockhash` | | `getblockhash` |
| `getblockheader` | | `getblockheader` |
| `getblockheadercount` | | `getblockheadercount` |
| `getblocksysfee` | | `getcommittee` |
| `getconnectioncount` | | `getconnectioncount` |
| `getcontractstate` | | `getcontractstate` |
| `getnativecontracts` |
| `getnep17balances` | | `getnep17balances` |
| `getnep17transfers` | | `getnep17transfers` |
| `getnextblockvalidators` |
| `getpeers` | | `getpeers` |
| `getproof` |
| `getrawmempool` | | `getrawmempool` |
| `getrawtransaction` | | `getrawtransaction` |
| `getstateheight` |
| `getstateroot` |
| `getstorage` | | `getstorage` |
| `gettransactionheight` | | `gettransactionheight` |
| `getunclaimedgas` | | `getunclaimedgas` |
| `getvalidators` |
| `getversion` | | `getversion` |
| `invoke` | | `invokecontractverify` |
| `invokefunction` | | `invokefunction` |
| `invokescript` | | `invokescript` |
| `sendrawtransaction` | | `sendrawtransaction` |
| `submitblock` | | `submitblock` |
| `submitoracleresponse` |
| `validateaddress` | | `validateaddress` |
| `verifyproof` |
#### Implementation notices #### Implementation notices
##### `invokefunction` and `invoke` ##### `invokefunction`
neo-go's implementation of `invokefunction` and `invoke` does not return `tx` neo-go's implementation of `invokefunction` does not return `tx`
field in the answer because that requires signing the transaction with some field in the answer because that requires signing the transaction with some
key in the server which doesn't fit the model of our node-client interactions. key in the server which doesn't fit the model of our node-client interactions.
Lacking this signature the transaction is almost useless, so there is no point Lacking this signature the transaction is almost useless, so there is no point
@ -97,23 +103,35 @@ and we're not accepting issues related to them.
| Method | Reason | | Method | Reason |
| ------- | ------------| | ------- | ------------|
| `claimgas` | Doesn't fit neo-go wallet model, use CLI to do that | | `closewallet` | Doesn't fit neo-go wallet model |
| `dumpprivkey` | Shouldn't exist for security reasons, see `claimgas` comment also | | `dumpprivkey` | Shouldn't exist for security reasons, see `closewallet` comment also |
| `getbalance` | To be implemented | | `getnewaddress` | See `closewallet` comment, use CLI to do that |
| `getmetricblocktimestamp` | Not really useful, use other means for node monitoring | | `getwalletbalance` | See `closewallet` comment, use `getnep17balances` for that |
| `getnewaddress` | See `claimgas` comment | | `getwalletunclaimedgas` | See `closewallet` comment, use `getunclaimedgas` for that |
| `getwalletheight` | Not applicable to neo-go, see `claimgas` comment | | `importprivkey` | Not applicable to neo-go, see `closewallet` comment |
| `importprivkey` | Not applicable to neo-go, see `claimgas` comment | | `listaddress` | Not applicable to neo-go, see `closewallet` comment |
| `listaddress` | Not applicable to neo-go, see `claimgas` comment |
| `listplugins` | neo-go doesn't have any plugins, so it makes no sense | | `listplugins` | neo-go doesn't have any plugins, so it makes no sense |
| `sendfrom` | Not applicable to neo-go, see `claimgas` comment | | `openwallet` | Doesn't fit neo-go wallet model |
| `sendmany` | Not applicable to neo-go, see `claimgas` comment | | `sendfrom` | Not applicable to neo-go, see `openwallet` comment |
| `sendmany` | Not applicable to neo-go, see `openwallet` comment |
| `sendtoaddress` | Not applicable to neo-go, see `claimgas` comment | | `sendtoaddress` | Not applicable to neo-go, see `claimgas` comment |
### Extensions ### Extensions
Some additional extensions are implemented as a part of this RPC server. Some additional extensions are implemented as a part of this RPC server.
#### `getblocksysfee` call
This method returns cumulative system fee for all transactions included in a
block. It can be removed in future versions, but at the moment you can use it
to see how much GAS is burned with particular block (because system fees are
burned).
#### `submitnotaryrequest` call
This method can be used on P2P Notary enabled networks to submit new notary
payloads to be relayed from RPC to P2P.
#### Limits and paging for getnep17transfers #### Limits and paging for getnep17transfers
`getnep17transfers` RPC call never returns more than 1000 results for one `getnep17transfers` RPC call never returns more than 1000 results for one