wrapper

Documentation

Index

• Variables
• type Client
• type TransferPrm
• type Wrapper
  • func New(c *Client) (*Wrapper, error)
  • func (w *Wrapper) BalanceOf(id *owner.ID) (*big.Int, error)
  • func (w *Wrapper) Decimals() (uint32, error)
  • func (w *Wrapper) TransferX(p TransferPrm) error
  • func (w *Wrapper) TransferXNotary(p TransferPrm) error

Variables

var ErrNilWrapper = errors.New("balance contract client wrapper is nil")

ErrNilWrapper is returned by functions that expect a non-nil Wrapper pointer, but received nil.

Types

type Client

type Client = balance.Client

Client represents the Balance contract client.

It is a type alias of github.com/nspcc-dev/neofs-node/pkg/morph/client/balance.Client.

type TransferPrm

type TransferPrm struct {
	Amount int64

	From, To *owner.ID

	Details []byte
}

TransferPrm groups parameters of TransferX method.

type Wrapper

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

Wrapper is a wrapper over balance contract client which implements:

• tool for obtaining the amount of funds in the client's account;
• tool for obtaining decimal precision of currency transactions.

Working wrapper must be created via constructor New. Using the Wrapper that has been created with new(Wrapper) expression (or just declaring a Wrapper variable) is unsafe and can lead to panic.

func New

func New(c *Client) (*Wrapper, error)

New creates, initializes and returns the Wrapper instance.

If Client is nil, balance.ErrNilClient is returned.

func (*Wrapper) BalanceOf

func (w *Wrapper) BalanceOf(id *owner.ID) (*big.Int, error)

BalanceOf receives the amount of funds in the client's account through the Balance contract call, and returns it.

func (*Wrapper) Decimals

func (w *Wrapper) Decimals() (uint32, error)

Decimals decimal precision of currency transactions through the Balance contract call, and returns it.

func (*Wrapper) TransferX

func (w *Wrapper) TransferX(p TransferPrm) error

TransferX transfers p.Amount of GASe-12 from p.From to p.To with details p.Details through direct smart contract call.

func (*Wrapper) TransferXNotary

func (w *Wrapper) TransferXNotary(p TransferPrm) error

TransferXNotary transfers p.Amount of GASe-12 from p.From to p.To with details p.Details via notary contract.