wrapper

package
v0.24.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 7, 2021 License: GPL-3.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Option added in v0.21.0

type Option func(*opts)

Option allows to set an optional parameter of ClientWrapper.

func TryNotary added in v0.21.0

func TryNotary() Option

TryNotary returns option to enable notary invocation tries.

type TransferPrm added in v0.15.0

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 NewFromMorph added in v0.21.0

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 added in v0.22.0

func (w *Wrapper) Burn(to util.Uint160, amount int64, id []byte) 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 added in v0.22.0

func (w *Wrapper) Lock(id []byte, user, lock util.Uint160, amount, dueEpoch int64) error

Lock locks fund on the user account.

func (*Wrapper) Mint added in v0.22.0

func (w *Wrapper) Mint(to util.Uint160, amount int64, id []byte) error

Mint sends funds to the account.

func (*Wrapper) TransferX added in v0.15.0

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL