neo-go/pkg/rpc/client/doc.go
Roman Khimov 685e34d83c rpc: update client documentation
Add missing methods, move example into something that can be compiled (and fix
it along the way).
2020-03-03 18:59:21 +03:00

69 lines
1.2 KiB
Go

/*
Package client implements NEO-specific JSON-RPC 2.0 client.
This package is currently in alpha and is subject to change.
Client
After creating a client instance with or without a ClientConfig
you can interact with the NEO blockchain by its exposed methods.
Some of the methods also allow to pass a verbose bool. This will
return a more pretty printed response from the server instead of
a raw hex string.
TODO:
Add missing methods to client.
Allow client to connect using client cert.
More in-depth examples.
Supported methods
getaccountstate
getclaimable
getunspents
invoke
invokefunction
invokescript
sendrawtransaction
Unsupported methods
claimgas
dumpprivkey
getapplicationlog
getassetstate
getbalance
getbestblockhash
getblock
getblockcount
getblockhash
getblockheader
getblocksysfee
getconnectioncount
getcontractstate
getmetricblocktimestamp
getnep5balances
getnep5transfers
getnewaddress
getpeers
getrawmempool
getrawtransaction
getstorage
gettransactionheight
gettxout
getunclaimed
getunclaimedgas
getvalidators
getversion
getwalletheight
importprivkey
listaddress
listplugins
sendfrom
sendmany
sendtoaddress
submitblock
validateaddress
*/
package client