keeper

Documentation

Index

• func NewQuerier(k AccountKeeper, legacyQuerierCdc *codec.LegacyAmino) sdk.Querier
• type AccountKeeper
  • func NewAccountKeeper(cdc codec.BinaryMarshaler, key sdk.StoreKey, paramstore paramtypes.Subspace, ...) AccountKeeper
  • func (ak AccountKeeper) Account(c context.Context, req *types.QueryAccountRequest) (*types.QueryAccountResponse, error)
  • func (ak AccountKeeper) GetAccount(ctx sdk.Context, addr sdk.AccAddress) types.AccountI
  • func (ak AccountKeeper) GetAllAccounts(ctx sdk.Context) (accounts []types.AccountI)
  • func (ak AccountKeeper) GetCodec() codec.BinaryMarshaler
  • func (ak AccountKeeper) GetModuleAccount(ctx sdk.Context, moduleName string) types.ModuleAccountI
  • func (ak AccountKeeper) GetModuleAccountAndPermissions(ctx sdk.Context, moduleName string) (types.ModuleAccountI, []string)
  • func (ak AccountKeeper) GetModuleAddress(moduleName string) sdk.AccAddress
  • func (ak AccountKeeper) GetModuleAddressAndPermissions(moduleName string) (addr sdk.AccAddress, permissions []string)
  • func (ak AccountKeeper) GetNextAccountNumber(ctx sdk.Context) uint64
  • func (ak AccountKeeper) GetParams(ctx sdk.Context) (params types.Params)
  • func (ak AccountKeeper) GetPubKey(ctx sdk.Context, addr sdk.AccAddress) (crypto.PubKey, error)
  • func (ak AccountKeeper) GetSequence(ctx sdk.Context, addr sdk.AccAddress) (uint64, error)
  • func (ak AccountKeeper) IterateAccounts(ctx sdk.Context, cb func(account types.AccountI) (stop bool))
  • func (ak AccountKeeper) Logger(ctx sdk.Context) log.Logger
  • func (ak AccountKeeper) MarshalAccount(accountI types.AccountI) ([]byte, error)
  • func (ak AccountKeeper) NewAccount(ctx sdk.Context, acc types.AccountI) types.AccountI
  • func (ak AccountKeeper) NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) types.AccountI
  • func (ak AccountKeeper) Params(c context.Context, req *types.QueryParamsRequest) (*types.QueryParamsResponse, error)
  • func (ak AccountKeeper) RemoveAccount(ctx sdk.Context, acc types.AccountI)
  • func (ak AccountKeeper) SetAccount(ctx sdk.Context, acc types.AccountI)
  • func (ak AccountKeeper) SetModuleAccount(ctx sdk.Context, macc types.ModuleAccountI)
  • func (ak AccountKeeper) SetParams(ctx sdk.Context, params types.Params)
  • func (ak AccountKeeper) UnmarshalAccount(bz []byte) (types.AccountI, error)
  • func (ak AccountKeeper) ValidatePermissions(macc types.ModuleAccountI) error

Functions

func NewQuerier

func NewQuerier(k AccountKeeper, legacyQuerierCdc *codec.LegacyAmino) sdk.Querier

NewQuerier creates a querier for auth REST endpoints

Types

type AccountKeeper

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

AccountKeeper encodes/decodes accounts using the go-amino (binary) encoding/decoding library.

func NewAccountKeeper

func NewAccountKeeper(
	cdc codec.BinaryMarshaler, key sdk.StoreKey, paramstore paramtypes.Subspace, proto func() types.AccountI,
	maccPerms map[string][]string,
) AccountKeeper

NewAccountKeeper returns a new sdk.AccountKeeper that uses go-amino to (binary) encode and decode concrete sdk.Accounts.

func (AccountKeeper) Account

func (ak AccountKeeper) Account(c context.Context, req *types.QueryAccountRequest) (*types.QueryAccountResponse, error)

Account returns account details based on address

func (AccountKeeper) GetAccount

func (ak AccountKeeper) GetAccount(ctx sdk.Context, addr sdk.AccAddress) types.AccountI

GetAccount implements sdk.AccountKeeper.

func (AccountKeeper) GetAllAccounts

func (ak AccountKeeper) GetAllAccounts(ctx sdk.Context) (accounts []types.AccountI)

GetAllAccounts returns all accounts in the accountKeeper.

func (AccountKeeper) GetCodec

func (ak AccountKeeper) GetCodec() codec.BinaryMarshaler

func (AccountKeeper) GetModuleAccount

func (ak AccountKeeper) GetModuleAccount(ctx sdk.Context, moduleName string) types.ModuleAccountI

GetModuleAccount gets the module account from the auth account store, if the account does not exist in the AccountKeeper, then it is created.

func (AccountKeeper) GetModuleAccountAndPermissions

func (ak AccountKeeper) GetModuleAccountAndPermissions(ctx sdk.Context, moduleName string) (types.ModuleAccountI, []string)

GetModuleAccountAndPermissions gets the module account from the auth account store and its registered permissions

func (AccountKeeper) GetModuleAddress

func (ak AccountKeeper) GetModuleAddress(moduleName string) sdk.AccAddress

GetModuleAddress returns an address based on the module name

func (AccountKeeper) GetModuleAddressAndPermissions

func (ak AccountKeeper) GetModuleAddressAndPermissions(moduleName string) (addr sdk.AccAddress, permissions []string)

GetModuleAddressAndPermissions returns an address and permissions based on the module name

func (AccountKeeper) GetNextAccountNumber

func (ak AccountKeeper) GetNextAccountNumber(ctx sdk.Context) uint64

GetNextAccountNumber returns and increments the global account number counter. If the global account number is not set, it initializes it with value 0.

func (AccountKeeper) GetParams

func (ak AccountKeeper) GetParams(ctx sdk.Context) (params types.Params)

GetParams gets the auth module's parameters.

func (AccountKeeper) GetPubKey

func (ak AccountKeeper) GetPubKey(ctx sdk.Context, addr sdk.AccAddress) (crypto.PubKey, error)

GetPubKey Returns the PubKey of the account at address

func (AccountKeeper) GetSequence

func (ak AccountKeeper) GetSequence(ctx sdk.Context, addr sdk.AccAddress) (uint64, error)

GetSequence Returns the Sequence of the account at address

func (AccountKeeper) IterateAccounts

func (ak AccountKeeper) IterateAccounts(ctx sdk.Context, cb func(account types.AccountI) (stop bool))

IterateAccounts iterates over all the stored accounts and performs a callback function

func (AccountKeeper) Logger

func (ak AccountKeeper) Logger(ctx sdk.Context) log.Logger

Logger returns a module-specific logger.

func (AccountKeeper) MarshalAccount

func (ak AccountKeeper) MarshalAccount(accountI types.AccountI) ([]byte, error)

MarshalAccount marshals an Account interface. If the given type implements the Marshaler interface, it is treated as a Proto-defined message and serialized that way. Otherwise, it falls back on the internal Amino codec.

func (AccountKeeper) NewAccount

func (ak AccountKeeper) NewAccount(ctx sdk.Context, acc types.AccountI) types.AccountI

NewAccount sets the next account number to a given account interface

func (AccountKeeper) NewAccountWithAddress

func (ak AccountKeeper) NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) types.AccountI

NewAccountWithAddress implements sdk.AccountKeeper.

func (AccountKeeper) Params

func (ak AccountKeeper) Params(c context.Context, req *types.QueryParamsRequest) (*types.QueryParamsResponse, error)

Params returns parameters of auth module

func (AccountKeeper) RemoveAccount

func (ak AccountKeeper) RemoveAccount(ctx sdk.Context, acc types.AccountI)

RemoveAccount removes an account for the account mapper store. NOTE: this will cause supply invariant violation if called

func (AccountKeeper) SetAccount

func (ak AccountKeeper) SetAccount(ctx sdk.Context, acc types.AccountI)

SetAccount implements sdk.AccountKeeper.

func (AccountKeeper) SetModuleAccount

func (ak AccountKeeper) SetModuleAccount(ctx sdk.Context, macc types.ModuleAccountI)

SetModuleAccount sets the module account to the auth account store

func (AccountKeeper) SetParams

func (ak AccountKeeper) SetParams(ctx sdk.Context, params types.Params)

SetParams sets the auth module's parameters.

func (AccountKeeper) UnmarshalAccount

func (ak AccountKeeper) UnmarshalAccount(bz []byte) (types.AccountI, error)

UnmarshalAccount returns an Account interface from raw encoded account bytes of a Proto-based Account type. An error is returned upon decoding failure.

func (AccountKeeper) ValidatePermissions

func (ak AccountKeeper) ValidatePermissions(macc types.ModuleAccountI) error

ValidatePermissions validates that the module account has been granted permissions within its set of allowed permissions.