// Code generated by neo-go contract generate-rpcwrapper --manifest --out [--hash ] [--config ]; DO NOT EDIT. // Package balance contains RPC wrappers for Balance contract. package balance import ( "errors" "fmt" "github.com/nspcc-dev/neo-go/pkg/core/transaction" "github.com/nspcc-dev/neo-go/pkg/neorpc/result" "github.com/nspcc-dev/neo-go/pkg/rpcclient/nep17" "github.com/nspcc-dev/neo-go/pkg/rpcclient/unwrap" "github.com/nspcc-dev/neo-go/pkg/util" "github.com/nspcc-dev/neo-go/pkg/vm/stackitem" "math/big" ) // LockEvent represents "Lock" event emitted by the contract. type LockEvent struct { TxID []byte From util.Uint160 To util.Uint160 Amount *big.Int Until *big.Int } // TransferXEvent represents "TransferX" event emitted by the contract. type TransferXEvent struct { From util.Uint160 To util.Uint160 Amount *big.Int Details []byte } // MintEvent represents "Mint" event emitted by the contract. type MintEvent struct { To util.Uint160 Amount *big.Int } // BurnEvent represents "Burn" event emitted by the contract. type BurnEvent struct { From util.Uint160 Amount *big.Int } // Invoker is used by ContractReader to call various safe methods. type Invoker interface { nep17.Invoker } // Actor is used by Contract to call state-changing methods. type Actor interface { Invoker nep17.Actor MakeCall(contract util.Uint160, method string, params ...any) (*transaction.Transaction, error) MakeRun(script []byte) (*transaction.Transaction, error) MakeUnsignedCall(contract util.Uint160, method string, attrs []transaction.Attribute, params ...any) (*transaction.Transaction, error) MakeUnsignedRun(script []byte, attrs []transaction.Attribute) (*transaction.Transaction, error) SendCall(contract util.Uint160, method string, params ...any) (util.Uint256, uint32, error) SendRun(script []byte) (util.Uint256, uint32, error) } // ContractReader implements safe contract methods. type ContractReader struct { nep17.TokenReader invoker Invoker hash util.Uint160 } // Contract implements all contract methods. type Contract struct { ContractReader nep17.TokenWriter actor Actor hash util.Uint160 } // NewReader creates an instance of ContractReader using provided contract hash and the given Invoker. func NewReader(invoker Invoker, hash util.Uint160) *ContractReader { return &ContractReader{*nep17.NewReader(invoker, hash), invoker, hash} } // New creates an instance of Contract using provided contract hash and the given Actor. func New(actor Actor, hash util.Uint160) *Contract { var nep17t = nep17.New(actor, hash) return &Contract{ContractReader{nep17t.TokenReader, actor, hash}, nep17t.TokenWriter, actor, hash} } // Version invokes `version` method of contract. func (c *ContractReader) Version() (*big.Int, error) { return unwrap.BigInt(c.invoker.Call(c.hash, "version")) } // Burn creates a transaction invoking `burn` method of the contract. // This transaction is signed and immediately sent to the network. // The values returned are its hash, ValidUntilBlock value and error if any. func (c *Contract) Burn(from util.Uint160, amount *big.Int, txDetails []byte) (util.Uint256, uint32, error) { return c.actor.SendCall(c.hash, "burn", from, amount, txDetails) } // BurnTransaction creates a transaction invoking `burn` method of the contract. // This transaction is signed, but not sent to the network, instead it's // returned to the caller. func (c *Contract) BurnTransaction(from util.Uint160, amount *big.Int, txDetails []byte) (*transaction.Transaction, error) { return c.actor.MakeCall(c.hash, "burn", from, amount, txDetails) } // BurnUnsigned creates a transaction invoking `burn` method of the contract. // This transaction is not signed, it's simply returned to the caller. // Any fields of it that do not affect fees can be changed (ValidUntilBlock, // Nonce), fee values (NetworkFee, SystemFee) can be increased as well. func (c *Contract) BurnUnsigned(from util.Uint160, amount *big.Int, txDetails []byte) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(c.hash, "burn", nil, from, amount, txDetails) } // Lock creates a transaction invoking `lock` method of the contract. // This transaction is signed and immediately sent to the network. // The values returned are its hash, ValidUntilBlock value and error if any. func (c *Contract) Lock(txDetails []byte, from util.Uint160, to util.Uint160, amount *big.Int, until *big.Int) (util.Uint256, uint32, error) { return c.actor.SendCall(c.hash, "lock", txDetails, from, to, amount, until) } // LockTransaction creates a transaction invoking `lock` method of the contract. // This transaction is signed, but not sent to the network, instead it's // returned to the caller. func (c *Contract) LockTransaction(txDetails []byte, from util.Uint160, to util.Uint160, amount *big.Int, until *big.Int) (*transaction.Transaction, error) { return c.actor.MakeCall(c.hash, "lock", txDetails, from, to, amount, until) } // LockUnsigned creates a transaction invoking `lock` method of the contract. // This transaction is not signed, it's simply returned to the caller. // Any fields of it that do not affect fees can be changed (ValidUntilBlock, // Nonce), fee values (NetworkFee, SystemFee) can be increased as well. func (c *Contract) LockUnsigned(txDetails []byte, from util.Uint160, to util.Uint160, amount *big.Int, until *big.Int) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(c.hash, "lock", nil, txDetails, from, to, amount, until) } // Mint creates a transaction invoking `mint` method of the contract. // This transaction is signed and immediately sent to the network. // The values returned are its hash, ValidUntilBlock value and error if any. func (c *Contract) Mint(to util.Uint160, amount *big.Int, txDetails []byte) (util.Uint256, uint32, error) { return c.actor.SendCall(c.hash, "mint", to, amount, txDetails) } // MintTransaction creates a transaction invoking `mint` method of the contract. // This transaction is signed, but not sent to the network, instead it's // returned to the caller. func (c *Contract) MintTransaction(to util.Uint160, amount *big.Int, txDetails []byte) (*transaction.Transaction, error) { return c.actor.MakeCall(c.hash, "mint", to, amount, txDetails) } // MintUnsigned creates a transaction invoking `mint` method of the contract. // This transaction is not signed, it's simply returned to the caller. // Any fields of it that do not affect fees can be changed (ValidUntilBlock, // Nonce), fee values (NetworkFee, SystemFee) can be increased as well. func (c *Contract) MintUnsigned(to util.Uint160, amount *big.Int, txDetails []byte) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(c.hash, "mint", nil, to, amount, txDetails) } // NewEpoch creates a transaction invoking `newEpoch` method of the contract. // This transaction is signed and immediately sent to the network. // The values returned are its hash, ValidUntilBlock value and error if any. func (c *Contract) NewEpoch(epochNum *big.Int) (util.Uint256, uint32, error) { return c.actor.SendCall(c.hash, "newEpoch", epochNum) } // NewEpochTransaction creates a transaction invoking `newEpoch` method of the contract. // This transaction is signed, but not sent to the network, instead it's // returned to the caller. func (c *Contract) NewEpochTransaction(epochNum *big.Int) (*transaction.Transaction, error) { return c.actor.MakeCall(c.hash, "newEpoch", epochNum) } // NewEpochUnsigned creates a transaction invoking `newEpoch` method of the contract. // This transaction is not signed, it's simply returned to the caller. // Any fields of it that do not affect fees can be changed (ValidUntilBlock, // Nonce), fee values (NetworkFee, SystemFee) can be increased as well. func (c *Contract) NewEpochUnsigned(epochNum *big.Int) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(c.hash, "newEpoch", nil, epochNum) } // TransferX creates a transaction invoking `transferX` method of the contract. // This transaction is signed and immediately sent to the network. // The values returned are its hash, ValidUntilBlock value and error if any. func (c *Contract) TransferX(from util.Uint160, to util.Uint160, amount *big.Int, details []byte) (util.Uint256, uint32, error) { return c.actor.SendCall(c.hash, "transferX", from, to, amount, details) } // TransferXTransaction creates a transaction invoking `transferX` method of the contract. // This transaction is signed, but not sent to the network, instead it's // returned to the caller. func (c *Contract) TransferXTransaction(from util.Uint160, to util.Uint160, amount *big.Int, details []byte) (*transaction.Transaction, error) { return c.actor.MakeCall(c.hash, "transferX", from, to, amount, details) } // TransferXUnsigned creates a transaction invoking `transferX` method of the contract. // This transaction is not signed, it's simply returned to the caller. // Any fields of it that do not affect fees can be changed (ValidUntilBlock, // Nonce), fee values (NetworkFee, SystemFee) can be increased as well. func (c *Contract) TransferXUnsigned(from util.Uint160, to util.Uint160, amount *big.Int, details []byte) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(c.hash, "transferX", nil, from, to, amount, details) } // Update creates a transaction invoking `update` method of the contract. // This transaction is signed and immediately sent to the network. // The values returned are its hash, ValidUntilBlock value and error if any. func (c *Contract) Update(script []byte, manifest []byte, data any) (util.Uint256, uint32, error) { return c.actor.SendCall(c.hash, "update", script, manifest, data) } // UpdateTransaction creates a transaction invoking `update` method of the contract. // This transaction is signed, but not sent to the network, instead it's // returned to the caller. func (c *Contract) UpdateTransaction(script []byte, manifest []byte, data any) (*transaction.Transaction, error) { return c.actor.MakeCall(c.hash, "update", script, manifest, data) } // UpdateUnsigned creates a transaction invoking `update` method of the contract. // This transaction is not signed, it's simply returned to the caller. // Any fields of it that do not affect fees can be changed (ValidUntilBlock, // Nonce), fee values (NetworkFee, SystemFee) can be increased as well. func (c *Contract) UpdateUnsigned(script []byte, manifest []byte, data any) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(c.hash, "update", nil, script, manifest, data) } // LockEventsFromApplicationLog retrieves a set of all emitted events // with "Lock" name from the provided [result.ApplicationLog]. func LockEventsFromApplicationLog(log *result.ApplicationLog) ([]*LockEvent, error) { if log == nil { return nil, errors.New("nil application log") } var res []*LockEvent for i, ex := range log.Executions { for j, e := range ex.Events { if e.Name != "Lock" { continue } event := new(LockEvent) err := event.FromStackItem(e.Item) if err != nil { return nil, fmt.Errorf("failed to deserialize LockEvent from stackitem (execution #%d, event #%d): %w", i, j, err) } res = append(res, event) } } return res, nil } // FromStackItem converts provided [stackitem.Array] to LockEvent or // returns an error if it's not possible to do to so. func (e *LockEvent) FromStackItem(item *stackitem.Array) error { if item == nil { return errors.New("nil item") } arr, ok := item.Value().([]stackitem.Item) if !ok { return errors.New("not an array") } if len(arr) != 5 { return errors.New("wrong number of structure elements") } var ( index = -1 err error ) index++ e.TxID, err = arr[index].TryBytes() if err != nil { return fmt.Errorf("field TxID: %w", err) } index++ e.From, err = func(item stackitem.Item) (util.Uint160, error) { b, err := item.TryBytes() if err != nil { return util.Uint160{}, err } u, err := util.Uint160DecodeBytesBE(b) if err != nil { return util.Uint160{}, err } return u, nil }(arr[index]) if err != nil { return fmt.Errorf("field From: %w", err) } index++ e.To, err = func(item stackitem.Item) (util.Uint160, error) { b, err := item.TryBytes() if err != nil { return util.Uint160{}, err } u, err := util.Uint160DecodeBytesBE(b) if err != nil { return util.Uint160{}, err } return u, nil }(arr[index]) if err != nil { return fmt.Errorf("field To: %w", err) } index++ e.Amount, err = arr[index].TryInteger() if err != nil { return fmt.Errorf("field Amount: %w", err) } index++ e.Until, err = arr[index].TryInteger() if err != nil { return fmt.Errorf("field Until: %w", err) } return nil } // TransferXEventsFromApplicationLog retrieves a set of all emitted events // with "TransferX" name from the provided [result.ApplicationLog]. func TransferXEventsFromApplicationLog(log *result.ApplicationLog) ([]*TransferXEvent, error) { if log == nil { return nil, errors.New("nil application log") } var res []*TransferXEvent for i, ex := range log.Executions { for j, e := range ex.Events { if e.Name != "TransferX" { continue } event := new(TransferXEvent) err := event.FromStackItem(e.Item) if err != nil { return nil, fmt.Errorf("failed to deserialize TransferXEvent from stackitem (execution #%d, event #%d): %w", i, j, err) } res = append(res, event) } } return res, nil } // FromStackItem converts provided [stackitem.Array] to TransferXEvent or // returns an error if it's not possible to do to so. func (e *TransferXEvent) FromStackItem(item *stackitem.Array) error { if item == nil { return errors.New("nil item") } arr, ok := item.Value().([]stackitem.Item) if !ok { return errors.New("not an array") } if len(arr) != 4 { return errors.New("wrong number of structure elements") } var ( index = -1 err error ) index++ e.From, err = func(item stackitem.Item) (util.Uint160, error) { b, err := item.TryBytes() if err != nil { return util.Uint160{}, err } u, err := util.Uint160DecodeBytesBE(b) if err != nil { return util.Uint160{}, err } return u, nil }(arr[index]) if err != nil { return fmt.Errorf("field From: %w", err) } index++ e.To, err = func(item stackitem.Item) (util.Uint160, error) { b, err := item.TryBytes() if err != nil { return util.Uint160{}, err } u, err := util.Uint160DecodeBytesBE(b) if err != nil { return util.Uint160{}, err } return u, nil }(arr[index]) if err != nil { return fmt.Errorf("field To: %w", err) } index++ e.Amount, err = arr[index].TryInteger() if err != nil { return fmt.Errorf("field Amount: %w", err) } index++ e.Details, err = arr[index].TryBytes() if err != nil { return fmt.Errorf("field Details: %w", err) } return nil } // MintEventsFromApplicationLog retrieves a set of all emitted events // with "Mint" name from the provided [result.ApplicationLog]. func MintEventsFromApplicationLog(log *result.ApplicationLog) ([]*MintEvent, error) { if log == nil { return nil, errors.New("nil application log") } var res []*MintEvent for i, ex := range log.Executions { for j, e := range ex.Events { if e.Name != "Mint" { continue } event := new(MintEvent) err := event.FromStackItem(e.Item) if err != nil { return nil, fmt.Errorf("failed to deserialize MintEvent from stackitem (execution #%d, event #%d): %w", i, j, err) } res = append(res, event) } } return res, nil } // FromStackItem converts provided [stackitem.Array] to MintEvent or // returns an error if it's not possible to do to so. func (e *MintEvent) FromStackItem(item *stackitem.Array) error { if item == nil { return errors.New("nil item") } arr, ok := item.Value().([]stackitem.Item) if !ok { return errors.New("not an array") } if len(arr) != 2 { return errors.New("wrong number of structure elements") } var ( index = -1 err error ) index++ e.To, err = func(item stackitem.Item) (util.Uint160, error) { b, err := item.TryBytes() if err != nil { return util.Uint160{}, err } u, err := util.Uint160DecodeBytesBE(b) if err != nil { return util.Uint160{}, err } return u, nil }(arr[index]) if err != nil { return fmt.Errorf("field To: %w", err) } index++ e.Amount, err = arr[index].TryInteger() if err != nil { return fmt.Errorf("field Amount: %w", err) } return nil } // BurnEventsFromApplicationLog retrieves a set of all emitted events // with "Burn" name from the provided [result.ApplicationLog]. func BurnEventsFromApplicationLog(log *result.ApplicationLog) ([]*BurnEvent, error) { if log == nil { return nil, errors.New("nil application log") } var res []*BurnEvent for i, ex := range log.Executions { for j, e := range ex.Events { if e.Name != "Burn" { continue } event := new(BurnEvent) err := event.FromStackItem(e.Item) if err != nil { return nil, fmt.Errorf("failed to deserialize BurnEvent from stackitem (execution #%d, event #%d): %w", i, j, err) } res = append(res, event) } } return res, nil } // FromStackItem converts provided [stackitem.Array] to BurnEvent or // returns an error if it's not possible to do to so. func (e *BurnEvent) FromStackItem(item *stackitem.Array) error { if item == nil { return errors.New("nil item") } arr, ok := item.Value().([]stackitem.Item) if !ok { return errors.New("not an array") } if len(arr) != 2 { return errors.New("wrong number of structure elements") } var ( index = -1 err error ) index++ e.From, err = func(item stackitem.Item) (util.Uint160, error) { b, err := item.TryBytes() if err != nil { return util.Uint160{}, err } u, err := util.Uint160DecodeBytesBE(b) if err != nil { return util.Uint160{}, err } return u, nil }(arr[index]) if err != nil { return fmt.Errorf("field From: %w", err) } index++ e.Amount, err = arr[index].TryInteger() if err != nil { return fmt.Errorf("field Amount: %w", err) } return nil }