alphabet

Documentation

Overview

Package alphabet contains RPC wrappers for NeoFS Alphabet contract.

Code generated by neo-go contract generate-rpcwrapper --manifest <file.json> --out <file.go> [--hash <hash>] [--config <config>]; DO NOT EDIT.

Index

• type Actor
• type CommonBallot
  • func (res *CommonBallot) FromStackItem(item stackitem.Item) error
• type Contract
  • func New(actor Actor, hash util.Uint160) *Contract
  • func (c *Contract) Emit() (util.Uint256, uint32, error)
  • func (c *Contract) EmitTransaction() (*transaction.Transaction, error)
  • func (c *Contract) EmitUnsigned() (*transaction.Transaction, error)
  • func (c *Contract) Update(script []byte, manifest []byte, data any) (util.Uint256, uint32, error)
  • func (c *Contract) UpdateTransaction(script []byte, manifest []byte, data any) (*transaction.Transaction, error)
  • func (c *Contract) UpdateUnsigned(script []byte, manifest []byte, data any) (*transaction.Transaction, error)
  • func (c *Contract) Vote(epoch *big.Int, candidates keys.PublicKeys) (util.Uint256, uint32, error)
  • func (c *Contract) VoteTransaction(epoch *big.Int, candidates keys.PublicKeys) (*transaction.Transaction, error)
  • func (c *Contract) VoteUnsigned(epoch *big.Int, candidates keys.PublicKeys) (*transaction.Transaction, error)
• type ContractReader
  • func NewReader(invoker Invoker, hash util.Uint160) *ContractReader
  • func (c *ContractReader) Gas() (*big.Int, error)
  • func (c *ContractReader) Name() (string, error)
  • func (c *ContractReader) Neo() (*big.Int, error)
  • func (c *ContractReader) Version() (*big.Int, error)
• type Invoker

Types

type Actor

type Actor interface {
	Invoker

	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)
}

Actor is used by Contract to call state-changing methods.

type CommonBallot

type CommonBallot struct {
	ID     []byte
	Voters keys.PublicKeys
	Height *big.Int
}

CommonBallot is a contract-specific common.Ballot type used by its methods.

func (*CommonBallot) FromStackItem

func (res *CommonBallot) FromStackItem(item stackitem.Item) error

FromStackItem retrieves fields of CommonBallot from the given stackitem.Item or returns an error if it's not possible to do to so.

type Contract

type Contract struct {
	ContractReader
	// contains filtered or unexported fields
}

Contract implements all contract methods.

func New

func New(actor Actor, hash util.Uint160) *Contract

New creates an instance of Contract using provided contract hash and the given Actor.

func (*Contract) Emit

func (c *Contract) Emit() (util.Uint256, uint32, error)

Emit creates a transaction invoking `emit` 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 (*Contract) EmitTransaction

func (c *Contract) EmitTransaction() (*transaction.Transaction, error)

EmitTransaction creates a transaction invoking `emit` method of the contract. This transaction is signed, but not sent to the network, instead it's returned to the caller.

func (*Contract) EmitUnsigned

func (c *Contract) EmitUnsigned() (*transaction.Transaction, error)

EmitUnsigned creates a transaction invoking `emit` 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 (*Contract) Update

func (c *Contract) Update(script []byte, manifest []byte, data any) (util.Uint256, uint32, error)

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 (*Contract) UpdateTransaction

func (c *Contract) UpdateTransaction(script []byte, manifest []byte, data any) (*transaction.Transaction, error)

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 (*Contract) UpdateUnsigned

func (c *Contract) UpdateUnsigned(script []byte, manifest []byte, data any) (*transaction.Transaction, error)

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 (*Contract) Vote

func (c *Contract) Vote(epoch *big.Int, candidates keys.PublicKeys) (util.Uint256, uint32, error)

Vote creates a transaction invoking `vote` 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 (*Contract) VoteTransaction

func (c *Contract) VoteTransaction(epoch *big.Int, candidates keys.PublicKeys) (*transaction.Transaction, error)

VoteTransaction creates a transaction invoking `vote` method of the contract. This transaction is signed, but not sent to the network, instead it's returned to the caller.

func (*Contract) VoteUnsigned

func (c *Contract) VoteUnsigned(epoch *big.Int, candidates keys.PublicKeys) (*transaction.Transaction, error)

VoteUnsigned creates a transaction invoking `vote` 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.

type ContractReader

type ContractReader struct {
	// contains filtered or unexported fields
}

ContractReader implements safe contract methods.

func NewReader

func NewReader(invoker Invoker, hash util.Uint160) *ContractReader

NewReader creates an instance of ContractReader using provided contract hash and the given Invoker.

func (*ContractReader) Gas

func (c *ContractReader) Gas() (*big.Int, error)

Gas invokes `gas` method of contract.

func (*ContractReader) Name

func (c *ContractReader) Name() (string, error)

Name invokes `name` method of contract.

func (*ContractReader) Neo

func (c *ContractReader) Neo() (*big.Int, error)

Neo invokes `neo` method of contract.

func (*ContractReader) Version

func (c *ContractReader) Version() (*big.Int, error)

Version invokes `version` method of contract.

type Invoker

type Invoker interface {
	Call(contract util.Uint160, operation string, params ...any) (*result.Invoke, error)
}

Invoker is used by ContractReader to call various safe methods.