TrueCloudLab/neoneo-go
7
0
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity

neorpc: adjust and extend event filters documentation

Browse source
This commit is contained in:
Anna Shaleva 2022-10-26 10:24:08 +03:00
parent 0d39602a50
commit 2a53db42af
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
pkg/neorpc/types.go
View file

@ -72,29 +72,34 @@ type (
} }
// BlockFilter is a wrapper structure for the block event filter. It allows // BlockFilter is a wrapper structure for the block event filter. It allows
// to filter blocks by primary index and by block index (allowing blocks since // to filter blocks by primary index and/or by block index (allowing blocks
// the specified index). // since/till the specified index inclusively). nil value treated as missing
// filter.
BlockFilter struct { BlockFilter struct {
Primary *int `json:"primary,omitempty"` Primary *int `json:"primary,omitempty"`
Since *uint32 `json:"since,omitempty"` Since *uint32 `json:"since,omitempty"`
Till *uint32 `json:"till,omitempty"` Till *uint32 `json:"till,omitempty"`
} }
// TxFilter is a wrapper structure for the transaction event filter. It // TxFilter is a wrapper structure for the transaction event filter. It
// allows to filter transactions by senders and signers. // allows to filter transactions by senders and/or signers. nil value treated
// as missing filter.
TxFilter struct { TxFilter struct {
Sender *util.Uint160 `json:"sender,omitempty"` Sender *util.Uint160 `json:"sender,omitempty"`
Signer *util.Uint160 `json:"signer,omitempty"` Signer *util.Uint160 `json:"signer,omitempty"`
} }
// NotificationFilter is a wrapper structure representing a filter used for // NotificationFilter is a wrapper structure representing a filter used for
// notifications generated during transaction execution. Notifications can // notifications generated during transaction execution. Notifications can
// be filtered by contract hash and by name. // be filtered by contract hash and/or by name. nil value treated as missing
// filter.
NotificationFilter struct { NotificationFilter struct {
Contract *util.Uint160 `json:"contract,omitempty"` Contract *util.Uint160 `json:"contract,omitempty"`
Name *string `json:"name,omitempty"` Name *string `json:"name,omitempty"`
} }
// ExecutionFilter is a wrapper structure used for transaction execution // ExecutionFilter is a wrapper structure used for transaction and persisting
// events. It allows to choose failing or successful transactions based // scripts execution events. It allows to choose failing or successful
// on their VM state. // transactions and persisting scripts based on their VM state and/or to
// choose execution event with the specified container. nil value treated as
// missing filter.
ExecutionFilter struct { ExecutionFilter struct {
State *string `json:"state,omitempty"` State *string `json:"state,omitempty"`
Container *util.Uint256 `json:"container,omitempty"` Container *util.Uint256 `json:"container,omitempty"`