Documentation ¶
Index ¶
- Constants
- func AddressStoreKey(addr sdk.AccAddress) []byte
- func DefaultTxDecoder(cdc *codec.Codec) sdk.TxDecoder
- func GetSigners(ctx types.Context) []types.Account
- func NewAccountCache(parent sdk.AccountStoreCache) sdk.AccountCache
- func NewAccountStoreCache(cdc *codec.Codec, store sdk.KVStore, cap int) sdk.AccountStoreCache
- func NewAnteHandler(am AccountKeeper) sdk.AnteHandler
- func ProtoBaseAccount() sdk.Account
- func RegisterBaseAccount(cdc *codec.Codec)
- func RegisterCodec(cdc *codec.Codec)
- func StdSignBytes(chainID string, accnum int64, sequence int64, msgs []sdk.Msg, memo string, ...) []byte
- func WithSigners(ctx types.Context, accounts []types.Account) types.Context
- type AccountDecoder
- type AccountKeeper
- func (am AccountKeeper) GetAccount(ctx sdk.Context, addr sdk.AccAddress) sdk.Account
- func (am AccountKeeper) GetNextAccountNumber(ctx sdk.Context) int64
- func (am AccountKeeper) GetPubKey(ctx sdk.Context, addr sdk.AccAddress) (crypto.PubKey, sdk.Error)
- func (am AccountKeeper) GetSequence(ctx sdk.Context, addr sdk.AccAddress) (int64, sdk.Error)
- func (am AccountKeeper) IterateAccounts(ctx sdk.Context, process func(sdk.Account) (stop bool))
- func (am AccountKeeper) NewAccount(ctx sdk.Context, acc sdk.Account) sdk.Account
- func (am AccountKeeper) NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) sdk.Account
- func (am AccountKeeper) RemoveAccount(ctx sdk.Context, acc sdk.Account)
- func (am AccountKeeper) SetAccount(ctx sdk.Context, acc sdk.Account)
- type BaseAccount
- func (acc *BaseAccount) Clone() sdk.Account
- func (acc *BaseAccount) GetAccountNumber() int64
- func (acc BaseAccount) GetAddress() sdk.AccAddress
- func (acc *BaseAccount) GetCoins() sdk.Coins
- func (acc BaseAccount) GetPubKey() crypto.PubKey
- func (acc *BaseAccount) GetSequence() int64
- func (acc *BaseAccount) SetAccountNumber(accNumber int64) error
- func (acc *BaseAccount) SetAddress(addr sdk.AccAddress) error
- func (acc *BaseAccount) SetCoins(coins sdk.Coins) error
- func (acc *BaseAccount) SetPubKey(pubKey crypto.PubKey) error
- func (acc *BaseAccount) SetSequence(seq int64) error
- type FeeCollectionKeeper
- type StdSignDoc
- type StdSignature
- type StdTx
Constants ¶
const (
DefaultSource = 0
)
Variables ¶
This section is empty.
Functions ¶
func AddressStoreKey ¶ added in v0.19.0
func AddressStoreKey(addr sdk.AccAddress) []byte
Turn an address to key used to get it from the account store
func DefaultTxDecoder ¶ added in v0.24.0
logic for standard transaction decoding
func GetSigners ¶
get the signers from the context
func NewAccountCache ¶
func NewAccountCache(parent sdk.AccountStoreCache) sdk.AccountCache
func NewAccountStoreCache ¶
func NewAnteHandler ¶
func NewAnteHandler(am AccountKeeper) sdk.AnteHandler
NewAnteHandler returns an AnteHandler that checks and increments sequence numbers, checks signatures & account numbers
func ProtoBaseAccount ¶ added in v0.21.0
Prototype function for BaseAccount
func RegisterBaseAccount ¶ added in v0.15.0
Most users shouldn't use this, but this comes in handy for tests.
func RegisterCodec ¶
Register concrete types on codec codec for default AppAccount
Types ¶
type AccountDecoder ¶ added in v0.18.0
AccountDecoder unmarshals account bytes
type AccountKeeper ¶
type AccountKeeper struct {
// contains filtered or unexported fields
}
This AccountKeeper encodes/decodes accounts using the go-amino (binary) encoding/decoding library.
func NewAccountKeeper ¶
NewAccountKeeper returns a new sdk.AccountKeeper that uses go-amino to (binary) encode and decode concrete sdk.Accounts. nolint
func (AccountKeeper) GetAccount ¶
func (am AccountKeeper) GetAccount(ctx sdk.Context, addr sdk.AccAddress) sdk.Account
Implements sdk.AccountKeeper.
func (AccountKeeper) GetNextAccountNumber ¶
func (am AccountKeeper) GetNextAccountNumber(ctx sdk.Context) int64
Returns and increments the global account number counter
func (AccountKeeper) GetPubKey ¶
func (am AccountKeeper) GetPubKey(ctx sdk.Context, addr sdk.AccAddress) (crypto.PubKey, sdk.Error)
Returns the PubKey of the account at address
func (AccountKeeper) GetSequence ¶
func (am AccountKeeper) GetSequence(ctx sdk.Context, addr sdk.AccAddress) (int64, sdk.Error)
Returns the Sequence of the account at address
func (AccountKeeper) IterateAccounts ¶
Implements sdk.AccountKeeper.
func (AccountKeeper) NewAccount ¶
New Account
func (AccountKeeper) NewAccountWithAddress ¶
func (am AccountKeeper) NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) sdk.Account
Implaements sdk.AccountKeeper.
func (AccountKeeper) RemoveAccount ¶
func (am AccountKeeper) RemoveAccount(ctx sdk.Context, acc sdk.Account)
RemoveAccount removes an account for the account mapper store.
func (AccountKeeper) SetAccount ¶
func (am AccountKeeper) SetAccount(ctx sdk.Context, acc sdk.Account)
Implements sdk.AccountKeeper.
type BaseAccount ¶
type BaseAccount struct { Address sdk.AccAddress `json:"address"` Coins sdk.Coins `json:"coins"` PubKey crypto.PubKey `json:"public_key"` AccountNumber int64 `json:"account_number"` Sequence int64 `json:"sequence"` }
BaseAccount - a base account structure. This can be extended by embedding within in your AppAccount. There are examples of this in: examples/basecoin/types/account.go. However one doesn't have to use BaseAccount as long as your struct implements Account.
func NewBaseAccountWithAddress ¶
func NewBaseAccountWithAddress(addr sdk.AccAddress) BaseAccount
func (*BaseAccount) GetAccountNumber ¶ added in v0.19.0
func (acc *BaseAccount) GetAccountNumber() int64
Implements Account
func (BaseAccount) GetAddress ¶
func (acc BaseAccount) GetAddress() sdk.AccAddress
Implements sdk.Account.
func (BaseAccount) GetPubKey ¶
func (acc BaseAccount) GetPubKey() crypto.PubKey
Implements sdk.Account.
func (*BaseAccount) GetSequence ¶
func (acc *BaseAccount) GetSequence() int64
Implements sdk.Account.
func (*BaseAccount) SetAccountNumber ¶ added in v0.19.0
func (acc *BaseAccount) SetAccountNumber(accNumber int64) error
Implements Account
func (*BaseAccount) SetAddress ¶
func (acc *BaseAccount) SetAddress(addr sdk.AccAddress) error
Implements sdk.Account.
func (*BaseAccount) SetCoins ¶
func (acc *BaseAccount) SetCoins(coins sdk.Coins) error
Implements sdk.Account.
func (*BaseAccount) SetPubKey ¶
func (acc *BaseAccount) SetPubKey(pubKey crypto.PubKey) error
Implements sdk.Account.
func (*BaseAccount) SetSequence ¶
func (acc *BaseAccount) SetSequence(seq int64) error
Implements sdk.Account.
type FeeCollectionKeeper ¶ added in v0.18.0
type FeeCollectionKeeper struct {
// contains filtered or unexported fields
}
This FeeCollectionKeeper handles collection of fees in the anteHandler and setting of MinFees for different fee tokens
func NewFeeCollectionKeeper ¶ added in v0.18.0
func NewFeeCollectionKeeper(cdc *codec.Codec, key sdk.StoreKey) FeeCollectionKeeper
func (FeeCollectionKeeper) AddCollectedFees ¶
add to the fee pool
func (FeeCollectionKeeper) ClearCollectedFees ¶ added in v0.18.0
func (fck FeeCollectionKeeper) ClearCollectedFees(ctx sdk.Context)
clear the fee pool
func (FeeCollectionKeeper) GetCollectedFees ¶ added in v0.18.0
func (fck FeeCollectionKeeper) GetCollectedFees(ctx sdk.Context) sdk.Coins
retrieves the collected fee pool
type StdSignDoc ¶ added in v0.18.0
type StdSignDoc struct { AccountNumber int64 `json:"account_number"` ChainID string `json:"chain_id"` Memo string `json:"memo"` Msgs []json.RawMessage `json:"msgs"` Sequence int64 `json:"sequence"` Source int64 `json:"source"` Data []byte `json:"data"` }
StdSignDoc is replay-prevention structure. It includes the result of msg.GetSignBytes(), as well as the ChainID (prevent cross chain replay) and the Sequence numbers for each signature (prevent inchain replay and enforce tx ordering per account).
type StdSignature ¶ added in v0.18.0
type StdSignature struct { crypto.PubKey `json:"pub_key"` // optional Signature []byte `json:"signature"` AccountNumber int64 `json:"account_number"` Sequence int64 `json:"sequence"` }
Standard Signature
type StdTx ¶ added in v0.18.0
type StdTx struct { Msgs []sdk.Msg `json:"msg"` Signatures []StdSignature `json:"signatures"` Memo string `json:"memo"` Source int64 `json:"source"` Data []byte `json:"data"` }
StdTx is a standard way to wrap a Msg with Signatures.
func (StdTx) GetSignatures ¶ added in v0.18.0
func (tx StdTx) GetSignatures() []StdSignature
Signatures returns the signature of signers who signed the Msg. GetSignatures returns the signature of signers who signed the Msg. CONTRACT: Length returned is same as length of pubkeys returned from MsgKeySigners, and the order matches. CONTRACT: If the signature is missing (ie the Msg is invalid), then the corresponding signature is .Empty().
func (StdTx) GetSigners ¶ added in v0.20.0
func (tx StdTx) GetSigners() []sdk.AccAddress
GetSigners returns the addresses that must sign the transaction. Addresses are returned in a determistic order. They are accumulated from the GetSigners method for each Msg in the order they appear in tx.GetMsgs(). Duplicate addresses will be omitted.