wallet

Documentation

Index

• Variables
• type BlockProcessor
• type Builder
  • func New() *Builder
  • func (b *Builder) Build() *Wallet
  • func (b *Builder) SetABClient(abc client.ABClient) *Builder
  • func (b *Builder) SetABClientConf(abcConf client.AlphabillClientConfig) *Builder
  • func (b *Builder) SetBlockProcessor(bp BlockProcessor) *Builder
• type Predicate
• type Proof
• type PubKey
• type SendOpts
• type TxHash
• type UnitID
• type Wallet
  • func (w *Wallet) GetMaxBlockNumber(ctx context.Context) (uint64, error)
  • func (w *Wallet) SendTransaction(ctx context.Context, tx *txsystem.Transaction, opts *SendOpts) error
  • func (w *Wallet) Shutdown()
  • func (w *Wallet) Sync(ctx context.Context, lastBlockNumber uint64) error
  • func (w *Wallet) SyncToMaxBlockNumber(ctx context.Context, lastBlockNumber uint64) error

Variables

var (
	ErrWalletAlreadySynchronizing = errors.New("wallet is already synchronizing")
	ErrFailedToBroadcastTx        = errors.New("failed to broadcast transaction")
	ErrTxRetryCanceled            = errors.New("user canceled tx retry")
)

Types

type BlockProcessor

type BlockProcessor interface {

	// ProcessBlock signals given block to be processesed
	// any error returned here signals block processor to terminate,
	ProcessBlock(b *block.Block) error
}

type Builder

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

func New

func New() *Builder

func (*Builder) Build

func (b *Builder) Build() *Wallet

func (*Builder) SetABClient

func (b *Builder) SetABClient(abc client.ABClient) *Builder

func (*Builder) SetABClientConf

func (b *Builder) SetABClientConf(abcConf client.AlphabillClientConfig) *Builder

func (*Builder) SetBlockProcessor

func (b *Builder) SetBlockProcessor(bp BlockProcessor) *Builder

type Predicate

type Predicate []byte

type Proof

type Proof struct {
	BlockNumber uint64                `json:"blockNumber,string"`
	Tx          *txsystem.Transaction `json:"tx"`
	Proof       *block.BlockProof     `json:"proof"`
}

type PubKey

type PubKey []byte

type SendOpts

type SendOpts struct {
	// RetryOnFullTxBuffer retries to send transaction when tx buffer is full
	RetryOnFullTxBuffer bool
}

type TxHash

type TxHash []byte

type UnitID

type UnitID []byte

type Wallet

type Wallet struct {
	BlockProcessor  BlockProcessor
	AlphabillClient client.ABClient
	// contains filtered or unexported fields
}

Wallet To synchronize wallet with a node call Sync. Shutdown needs to be called to release resources used by wallet.

func (*Wallet) GetMaxBlockNumber

func (w *Wallet) GetMaxBlockNumber(ctx context.Context) (uint64, error)

GetMaxBlockNumber queries the node for latest block number

func (*Wallet) SendTransaction

func (w *Wallet) SendTransaction(ctx context.Context, tx *txsystem.Transaction, opts *SendOpts) error

SendTransaction broadcasts transaction to configured node. Returns nil if transaction was successfully accepted by node, otherwise returns error.

func (*Wallet) Shutdown

func (w *Wallet) Shutdown()

Shutdown terminates connection to alphabill node and cancels any background goroutines.

func (*Wallet) Sync

func (w *Wallet) Sync(ctx context.Context, lastBlockNumber uint64) error

Sync synchronises wallet from the last known block number with the given alphabill node. The function blocks forever or until alphabill connection is terminated. Returns error if wallet is already synchronizing or any error occured during syncrohronization, otherwise returns nil.

func (*Wallet) SyncToMaxBlockNumber

func (w *Wallet) SyncToMaxBlockNumber(ctx context.Context, lastBlockNumber uint64) error

SyncToMaxBlockNumber synchronises wallet from the last known block number with the given alphabill node. The function blocks until maximum block height, calculated at the start of the process, is reached. Returns error if wallet is already synchronizing or any error occured during syncrohronization, otherwise returns nil.