exported

Documentation

Index

• func GetAccountGas(ak SizerAccountKeeper, acc Account) (sdk.Gas, bool)
• func TryAddGetAccountGas(gasMeter sdk.GasMeter, ak SizerAccountKeeper, acc Account) (bool, sdk.Gas)
• type Account
  • func GetAccountAndGas(ctx *sdk.Context, keeper AccountKeeper, addr sdk.AccAddress) (Account, sdk.Gas)
• type AccountKeeper
• type GenesisAccount
• type GenesisAccounts
  • func (ga GenesisAccounts) Contains(addr sdk.Address) bool
• type SizerAccountKeeper

Functions

func GetAccountGas

func GetAccountGas(ak SizerAccountKeeper, acc Account) (sdk.Gas, bool)

func TryAddGetAccountGas

func TryAddGetAccountGas(gasMeter sdk.GasMeter, ak SizerAccountKeeper, acc Account) (bool, sdk.Gas)

Types

type Account

type Account interface {
	Copy() interface{}
	GetAddress() sdk.AccAddress
	SetAddress(sdk.AccAddress) error // errors if already set.

	GetPubKey() crypto.PubKey // can return nil.
	SetPubKey(crypto.PubKey) error

	GetAccountNumber() uint64
	SetAccountNumber(uint64) error

	GetSequence() uint64
	SetSequence(uint64) error

	GetCoins() sdk.Coins
	SetCoins(sdk.Coins) error

	// Calculates the amount of coins that can be sent to other accounts given
	// the current time.
	SpendableCoins(blockTime time.Time) sdk.Coins

	// Ensure that account implements stringer
	String() string
}

Account is an interface used to store coins at a given address within state. It presumes a notion of sequence numbers for replay protection, a notion of account numbers for replay protection for previously pruned accounts, and a pubkey for authentication purposes.

Many complex conditions can be used in the concrete struct which implements Account.

func GetAccountAndGas

func GetAccountAndGas(ctx *sdk.Context, keeper AccountKeeper, addr sdk.AccAddress) (Account, sdk.Gas)

type AccountKeeper

type AccountKeeper interface {
	GetAccount(ctx sdk.Context, addr sdk.AccAddress) Account
}

type GenesisAccount

type GenesisAccount interface {
	Account
	Validate() error
}

GenesisAccount defines a genesis account that embeds an Account with validation capabilities.

type GenesisAccounts

type GenesisAccounts []GenesisAccount

GenesisAccounts defines a slice of GenesisAccount objects

func (GenesisAccounts) Contains

func (ga GenesisAccounts) Contains(addr sdk.Address) bool

Contains returns true if the given address exists in a slice of GenesisAccount objects.

type SizerAccountKeeper

type SizerAccountKeeper interface {
	GetEncodedAccountSize(acc Account) int
}