wrapper

Documentation

Index

• type BurnPrm
  • func (b *BurnPrm) SetAmount(amount int64)
  • func (b *BurnPrm) SetID(id []byte)
  • func (b *BurnPrm) SetTo(to util.Uint160)
• type LockPrm
  • func (l *LockPrm) SetAmount(amount int64)
  • func (l *LockPrm) SetDueEpoch(dueEpoch int64)
  • func (l *LockPrm) SetID(id []byte)
  • func (l *LockPrm) SetLock(lock util.Uint160)
  • func (l *LockPrm) SetUser(user util.Uint160)
• type MintPrm
  • func (m *MintPrm) SetAmount(amount int64)
  • func (m *MintPrm) SetID(id []byte)
  • func (m *MintPrm) SetTo(to util.Uint160)
• type Option
  • func AsAlphabet() Option
  • func TryNotary() Option
• type TransferPrm
• type Wrapper
  • func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Wrapper, error)
  • func (w *Wrapper) BalanceOf(id *owner.ID) (*big.Int, error)
  • func (w *Wrapper) Burn(prm BurnPrm) error
  • func (w *Wrapper) Decimals() (uint32, error)
  • func (w *Wrapper) Lock(prm LockPrm) error
  • func (w *Wrapper) Mint(prm MintPrm) error
  • func (w *Wrapper) TransferX(p TransferPrm) error

Types

type BurnPrm

type BurnPrm struct {
	client.InvokePrmOptional
	// contains filtered or unexported fields
}

BurnPrm groups parameters of Burn operation.

func (*BurnPrm) SetAmount

func (b *BurnPrm) SetAmount(amount int64)

SetAmount sets amount.

func (*BurnPrm) SetID

func (b *BurnPrm) SetID(id []byte)

SetID sets ID

func (*BurnPrm) SetTo

func (b *BurnPrm) SetTo(to util.Uint160)

SetTo sets receiver.

type LockPrm

type LockPrm struct {
	client.InvokePrmOptional
	// contains filtered or unexported fields
}

LockPrm groups parameters of Lock operation.

func (*LockPrm) SetAmount

func (l *LockPrm) SetAmount(amount int64)

SetAmount sets amount.

func (*LockPrm) SetDueEpoch

func (l *LockPrm) SetDueEpoch(dueEpoch int64)

SetDueEpoch sets end of the lock.

func (*LockPrm) SetID

func (l *LockPrm) SetID(id []byte)

SetID sets ID.

func (*LockPrm) SetLock

func (l *LockPrm) SetLock(lock util.Uint160)

SetLock sets lock.

func (*LockPrm) SetUser

func (l *LockPrm) SetUser(user util.Uint160)

SetUser set user.

type MintPrm

type MintPrm struct {
	client.InvokePrmOptional
	// contains filtered or unexported fields
}

MintPrm groups parameters of Mint operation.

func (*MintPrm) SetAmount

func (m *MintPrm) SetAmount(amount int64)

SetAmount sets amount of the transfer.

func (*MintPrm) SetID

func (m *MintPrm) SetID(id []byte)

SetID sets ID.

func (*MintPrm) SetTo

func (m *MintPrm) SetTo(to util.Uint160)

SetTo sets receiver of the transfer.

type Option

type Option func(*opts)

Option allows to set an optional parameter of Wrapper.

func AsAlphabet

func AsAlphabet() Option

AsAlphabet returns option to sign main TX of notary requests with client's private key.

Considered to be used by IR nodes only.

func TryNotary

func TryNotary() Option

TryNotary returns option to enable notary invocation tries.

type TransferPrm

type TransferPrm struct {
	Amount int64

	From, To *owner.ID

	Details []byte

	client.InvokePrmOptional
}

TransferPrm groups parameters of TransferX method.

type Wrapper

type Wrapper struct {
	internal.StaticClient
	// 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 NewFromMorph

func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Wrapper, error)

NewFromMorph returns the wrapper instance from the raw morph client.

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

func (w *Wrapper) Burn(prm BurnPrm) error

Burn destroys funds from the account.

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

func (w *Wrapper) Lock(prm LockPrm) error

Lock locks fund on the user account.

func (*Wrapper) Mint

func (w *Wrapper) Mint(prm MintPrm) error

Mint sends funds to the account.

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.

If TryNotary is provided, calls notary contract.