dstepanov-yadro/neoneo-go
1
0
Fork 0
forked from TrueCloudLab/neoneo-go
Code Pull requests Activity

rpcclient: improve comments for some methods

Browse source
This commit is contained in:
Roman Khimov 2022-09-07 19:59:33 +03:00
parent 3e8e6857e5
commit 3c02177d3c
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
pkg/rpcclient/rpc.go
View file

@ -209,6 +209,7 @@ func (c *Client) GetBlockHeaderVerbose(hash util.Uint256) (*result.Header, error
} }
// GetBlockSysFee returns the system fees of the block based on the specified index. // GetBlockSysFee returns the system fees of the block based on the specified index.
// This method is only supported by NeoGo servers.
func (c *Client) GetBlockSysFee(index uint32) (fixedn.Fixed8, error) { func (c *Client) GetBlockSysFee(index uint32) (fixedn.Fixed8, error) {
var ( var (
params = []interface{}{index} params = []interface{}{index}
@ -245,12 +246,16 @@ func (c *Client) GetContractStateByHash(hash util.Uint160) (*state.Contract, err
return c.getContractState(hash.StringLE()) return c.getContractState(hash.StringLE())
} }
// GetContractStateByAddressOrName queries contract information according to the contract address or name. // GetContractStateByAddressOrName queries contract information using the contract
// address or name. Notice that name-based queries work only for native contracts,
// non-native ones can't be requested this way.
func (c *Client) GetContractStateByAddressOrName(addressOrName string) (*state.Contract, error) { func (c *Client) GetContractStateByAddressOrName(addressOrName string) (*state.Contract, error) {
return c.getContractState(addressOrName) return c.getContractState(addressOrName)
} }
// GetContractStateByID queries contract information according to the contract ID. // GetContractStateByID queries contract information according to the contract ID.
// Notice that this is supported by all servers only for native contracts,
// non-native ones can be requested only from NeoGo servers.
func (c *Client) GetContractStateByID(id int32) (*state.Contract, error) { func (c *Client) GetContractStateByID(id int32) (*state.Contract, error) {
return c.getContractState(id) return c.getContractState(id)
} }
@ -997,6 +1002,7 @@ func (c *Client) SubmitP2PNotaryRequest(req *payload.P2PNotaryRequest) (util.Uin
} }
// ValidateAddress verifies that the address is a correct NEO address. // ValidateAddress verifies that the address is a correct NEO address.
// Consider using [address] package instead to do it locally.
func (c *Client) ValidateAddress(address string) error { func (c *Client) ValidateAddress(address string) error {
var ( var (
params = []interface{}{address} params = []interface{}{address}