frostfscontract

Documentation

Index

• type AlphabetUpdatePrm
  • func (a *AlphabetUpdatePrm) SetID(id []byte)
  • func (a *AlphabetUpdatePrm) SetPubs(pubs keys.PublicKeys)
• type ChequePrm
  • func (c *ChequePrm) SetAmount(amount int64)
  • func (c *ChequePrm) SetID(id []byte)
  • func (c *ChequePrm) SetLock(lock util.Uint160)
  • func (c *ChequePrm) SetUser(user util.Uint160)
• type Client
  • func NewFromMorph(cli *client.Client, contract util.Uint160, fee fixedn.Fixed8, opts ...Option) (*Client, error)
  • func (x *Client) AlphabetUpdate(p AlphabetUpdatePrm) error
  • func (x *Client) Cheque(p ChequePrm) error
  • func (x *Client) ContractAddress() util.Uint160
• type Option
  • func AsAlphabet() Option
  • func TryNotary() Option

Types

type AlphabetUpdatePrm

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

AlphabetUpdatePrm groups parameters of AlphabetUpdate operation.

func (*AlphabetUpdatePrm) SetID

func (a *AlphabetUpdatePrm) SetID(id []byte)

SetID sets update ID.

func (*AlphabetUpdatePrm) SetPubs

func (a *AlphabetUpdatePrm) SetPubs(pubs keys.PublicKeys)

SetPubs sets new alphabet public keys.

type ChequePrm

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

ChequePrm groups parameters of Cheque operation.

func (*ChequePrm) SetAmount

func (c *ChequePrm) SetAmount(amount int64)

SetAmount sets amount.

func (*ChequePrm) SetID

func (c *ChequePrm) SetID(id []byte)

SetID sets ID of the cheque.

func (*ChequePrm) SetLock

func (c *ChequePrm) SetLock(lock util.Uint160)

SetLock sets lock.

func (*ChequePrm) SetUser

func (c *ChequePrm) SetUser(user util.Uint160)

SetUser sets user.

type Client

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

Client is a wrapper over StaticClient which makes calls with the names and arguments of the FrostFS contract.

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

func NewFromMorph

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

NewFromMorph wraps client to work with FrostFS contract.

func (*Client) AlphabetUpdate

func (x *Client) AlphabetUpdate(p AlphabetUpdatePrm) error

AlphabetUpdate update list of alphabet nodes.

func (*Client) Cheque

func (x *Client) Cheque(p ChequePrm) error

Cheque invokes `cheque` method of FrostFS contract.

func (*Client) ContractAddress

func (x *Client) ContractAddress() util.Uint160

ContractAddress returns the address of the associated contract.

type Option

type Option func(*opts)

Option allows to set an optional parameter of ClientWrapper.

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.