cosmos-sdk: github.com/cosmos/cosmos-sdk/x/auth Index | Files | Directories

package auth

import "github.com/cosmos/cosmos-sdk/x/auth"

nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: github.com/cosmos/cosmos-sdk/x/auth/types

nolint

Index

Package Files

alias.go ante.go genesis.go keeper.go module.go querier.go test_common.go

Constants

const (
    ModuleName                    = types.ModuleName
    StoreKey                      = types.StoreKey
    FeeCollectorName              = types.FeeCollectorName
    QuerierRoute                  = types.QuerierRoute
    DefaultParamspace             = types.DefaultParamspace
    DefaultMaxMemoCharacters      = types.DefaultMaxMemoCharacters
    DefaultTxSigLimit             = types.DefaultTxSigLimit
    DefaultTxSizeCostPerByte      = types.DefaultTxSizeCostPerByte
    DefaultSigVerifyCostED25519   = types.DefaultSigVerifyCostED25519
    DefaultSigVerifyCostSecp256k1 = types.DefaultSigVerifyCostSecp256k1
    QueryAccount                  = types.QueryAccount
)

Variables

var (
    // functions aliases
    NewBaseAccount                 = types.NewBaseAccount
    ProtoBaseAccount               = types.ProtoBaseAccount
    NewBaseAccountWithAddress      = types.NewBaseAccountWithAddress
    NewBaseVestingAccount          = types.NewBaseVestingAccount
    NewContinuousVestingAccountRaw = types.NewContinuousVestingAccountRaw
    NewContinuousVestingAccount    = types.NewContinuousVestingAccount
    NewDelayedVestingAccountRaw    = types.NewDelayedVestingAccountRaw
    NewDelayedVestingAccount       = types.NewDelayedVestingAccount
    RegisterCodec                  = types.RegisterCodec
    NewGenesisState                = types.NewGenesisState
    DefaultGenesisState            = types.DefaultGenesisState
    ValidateGenesis                = types.ValidateGenesis
    AddressStoreKey                = types.AddressStoreKey
    NewParams                      = types.NewParams
    ParamKeyTable                  = types.ParamKeyTable
    DefaultParams                  = types.DefaultParams
    NewQueryAccountParams          = types.NewQueryAccountParams
    NewStdTx                       = types.NewStdTx
    CountSubKeys                   = types.CountSubKeys
    NewStdFee                      = types.NewStdFee
    StdSignBytes                   = types.StdSignBytes
    DefaultTxDecoder               = types.DefaultTxDecoder
    DefaultTxEncoder               = types.DefaultTxEncoder
    NewTxBuilder                   = types.NewTxBuilder
    NewTxBuilderFromCLI            = types.NewTxBuilderFromCLI
    MakeSignature                  = types.MakeSignature
    NewAccountRetriever            = types.NewAccountRetriever

    // variable aliases
    ModuleCdc                 = types.ModuleCdc
    AddressStoreKeyPrefix     = types.AddressStoreKeyPrefix
    GlobalAccountNumberKey    = types.GlobalAccountNumberKey
    KeyMaxMemoCharacters      = types.KeyMaxMemoCharacters
    KeyTxSigLimit             = types.KeyTxSigLimit
    KeyTxSizeCostPerByte      = types.KeyTxSizeCostPerByte
    KeySigVerifyCostED25519   = types.KeySigVerifyCostED25519
    KeySigVerifyCostSecp256k1 = types.KeySigVerifyCostSecp256k1
)

func DeductFees Uses

func DeductFees(supplyKeeper types.SupplyKeeper, ctx sdk.Context, acc Account, fees sdk.Coins) sdk.Result

DeductFees deducts fees from the given account.

NOTE: We could use the CoinKeeper (in addition to the AccountKeeper, because the CoinKeeper doesn't give us accounts), but it seems easier to do this.

func DefaultSigVerificationGasConsumer Uses

func DefaultSigVerificationGasConsumer(
    meter sdk.GasMeter, sig []byte, pubkey crypto.PubKey, params Params,
) sdk.Result

DefaultSigVerificationGasConsumer is the default implementation of SignatureVerificationGasConsumer. It consumes gas for signature verification based upon the public key type. The cost is fetched from the given params and is matched by the concrete type.

func EnsureSufficientMempoolFees Uses

func EnsureSufficientMempoolFees(ctx sdk.Context, stdFee StdFee) sdk.Result

EnsureSufficientMempoolFees verifies that the given transaction has supplied enough fees to cover a proposer's minimum fees. A result object is returned indicating success or failure.

Contract: This should only be called during CheckTx as it cannot be part of consensus.

func GetSignBytes Uses

func GetSignBytes(chainID string, stdTx StdTx, acc Account, genesis bool) []byte

GetSignBytes returns a slice of bytes to sign over for a given transaction and an account.

func InitGenesis Uses

func InitGenesis(ctx sdk.Context, ak AccountKeeper, data GenesisState)

InitGenesis - Init store state from genesis data

CONTRACT: old coins from the FeeCollectionKeeper need to be transferred through a genesis port script to the new fee collector account

func NewAnteHandler Uses

func NewAnteHandler(ak AccountKeeper, supplyKeeper types.SupplyKeeper, sigGasConsumer SignatureVerificationGasConsumer) sdk.AnteHandler

NewAnteHandler returns an AnteHandler that checks and increments sequence numbers, checks signatures & account numbers, and deducts fees from the first signer.

func NewQuerier Uses

func NewQuerier(keeper AccountKeeper) sdk.Querier

creates a querier for auth REST endpoints

func ProcessPubKey Uses

func ProcessPubKey(acc Account, sig StdSignature, simulate bool) (crypto.PubKey, sdk.Result)

ProcessPubKey verifies that the given account address matches that of the StdSignature. In addition, it will set the public key of the account if it has not been set.

func SetGasMeter Uses

func SetGasMeter(simulate bool, ctx sdk.Context, gasLimit uint64) sdk.Context

SetGasMeter returns a new context with a gas meter set from a given context.

func ValidateMemo Uses

func ValidateMemo(stdTx StdTx, params Params) sdk.Result

ValidateMemo validates the memo size.

func ValidateSigCount Uses

func ValidateSigCount(stdTx StdTx, params Params) sdk.Result

ValidateSigCount validates that the transaction has a valid cumulative total amount of signatures.

type Account Uses

type Account = exported.Account

func GetSignerAcc Uses

func GetSignerAcc(ctx sdk.Context, ak AccountKeeper, addr sdk.AccAddress) (Account, sdk.Result)

GetSignerAcc returns an account for a given address that is expected to sign a transaction.

type AccountKeeper Uses

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

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

func NewAccountKeeper Uses

func NewAccountKeeper(
    cdc *codec.Codec, key sdk.StoreKey, paramstore subspace.Subspace, proto func() exported.Account,
) AccountKeeper

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

func (AccountKeeper) GetAccount Uses

func (ak AccountKeeper) GetAccount(ctx sdk.Context, addr sdk.AccAddress) exported.Account

GetAccount implements sdk.AccountKeeper.

func (AccountKeeper) GetAllAccounts Uses

func (ak AccountKeeper) GetAllAccounts(ctx sdk.Context) []exported.Account

GetAllAccounts returns all accounts in the accountKeeper.

func (AccountKeeper) GetNextAccountNumber Uses

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

GetNextAccountNumber Returns and increments the global account number counter

func (AccountKeeper) GetParams Uses

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

GetParams gets the auth module's parameters.

func (AccountKeeper) GetPubKey Uses

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

GetPubKey Returns the PubKey of the account at address

func (AccountKeeper) GetSequence Uses

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

GetSequence Returns the Sequence of the account at address

func (AccountKeeper) IterateAccounts Uses

func (ak AccountKeeper) IterateAccounts(ctx sdk.Context, process func(exported.Account) (stop bool))

IterateAccounts implements sdk.AccountKeeper.

func (AccountKeeper) Logger Uses

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

Logger returns a module-specific logger.

func (AccountKeeper) NewAccount Uses

func (ak AccountKeeper) NewAccount(ctx sdk.Context, acc exported.Account) exported.Account

NewAccount creates a new account

func (AccountKeeper) NewAccountWithAddress Uses

func (ak AccountKeeper) NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) exported.Account

NewAccountWithAddress implements sdk.AccountKeeper.

func (AccountKeeper) RemoveAccount Uses

func (ak AccountKeeper) RemoveAccount(ctx sdk.Context, acc exported.Account)

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

func (AccountKeeper) SetAccount Uses

func (ak AccountKeeper) SetAccount(ctx sdk.Context, acc exported.Account)

SetAccount implements sdk.AccountKeeper.

func (AccountKeeper) SetParams Uses

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

SetParams sets the auth module's parameters.

type AppModule Uses

type AppModule struct {
    AppModuleBasic
    // contains filtered or unexported fields
}

___________________________ app module object

func NewAppModule Uses

func NewAppModule(accountKeeper AccountKeeper) AppModule

NewAppModule creates a new AppModule object

func (AppModule) BeginBlock Uses

func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock)

module begin-block

func (AppModule) EndBlock Uses

func (AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate

module end-block

func (AppModule) ExportGenesis Uses

func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage

module export genesis

func (AppModule) InitGenesis Uses

func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate

module init-genesis

func (AppModule) Name Uses

func (AppModule) Name() string

module name

func (AppModule) NewHandler Uses

func (AppModule) NewHandler() sdk.Handler

module handler

func (AppModule) NewQuerierHandler Uses

func (am AppModule) NewQuerierHandler() sdk.Querier

module querier

func (AppModule) QuerierRoute Uses

func (AppModule) QuerierRoute() string

module querier route name

func (AppModule) RegisterInvariants Uses

func (AppModule) RegisterInvariants(_ sdk.InvariantRegistry)

register invariants

func (AppModule) Route Uses

func (AppModule) Route() string

module message route name

type AppModuleBasic Uses

type AppModuleBasic struct{}

app module basics object

func (AppModuleBasic) DefaultGenesis Uses

func (AppModuleBasic) DefaultGenesis() json.RawMessage

default genesis state

func (AppModuleBasic) GetQueryCmd Uses

func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command

get the root query command of this module

func (AppModuleBasic) GetTxCmd Uses

func (AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command

get the root tx command of this module

func (AppModuleBasic) Name Uses

func (AppModuleBasic) Name() string

module name

func (AppModuleBasic) RegisterCodec Uses

func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)

register module codec

func (AppModuleBasic) RegisterRESTRoutes Uses

func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router)

register rest routes

func (AppModuleBasic) ValidateGenesis Uses

func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error

module validate genesis

type BaseAccount Uses

type BaseAccount = types.BaseAccount

type BaseVestingAccount Uses

type BaseVestingAccount = types.BaseVestingAccount

type ContinuousVestingAccount Uses

type ContinuousVestingAccount = types.ContinuousVestingAccount

type DelayedVestingAccount Uses

type DelayedVestingAccount = types.DelayedVestingAccount

type DummySupplyKeeper Uses

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

DummySupplyKeeper defines a supply keeper used only for testing to avoid circle dependencies

func NewDummySupplyKeeper Uses

func NewDummySupplyKeeper(ak AccountKeeper) DummySupplyKeeper

NewDummySupplyKeeper creates a DummySupplyKeeper instance

func (DummySupplyKeeper) GetModuleAccount Uses

func (sk DummySupplyKeeper) GetModuleAccount(ctx sdk.Context, moduleName string) exported.ModuleAccountI

GetModuleAccount for dummy supply keeper

func (DummySupplyKeeper) GetModuleAddress Uses

func (sk DummySupplyKeeper) GetModuleAddress(moduleName string) sdk.AccAddress

GetModuleAddress for dummy supply keeper

func (DummySupplyKeeper) SendCoinsFromAccountToModule Uses

func (sk DummySupplyKeeper) SendCoinsFromAccountToModule(ctx sdk.Context, fromAddr sdk.AccAddress, recipientModule string, amt sdk.Coins) sdk.Error

SendCoinsFromAccountToModule for the dummy supply keeper

type GenesisState Uses

type GenesisState = types.GenesisState

func ExportGenesis Uses

func ExportGenesis(ctx sdk.Context, ak AccountKeeper) GenesisState

ExportGenesis returns a GenesisState for a given context and keeper

type Params Uses

type Params = types.Params

type QueryAccountParams Uses

type QueryAccountParams = types.QueryAccountParams

type SignatureVerificationGasConsumer Uses

type SignatureVerificationGasConsumer = func(meter sdk.GasMeter, sig []byte, pubkey crypto.PubKey, params Params) sdk.Result

SignatureVerificationGasConsumer is the type of function that is used to both consume gas when verifying signatures and also to accept or reject different types of PubKey's. This is where apps can define their own PubKey

type StdFee Uses

type StdFee = types.StdFee

type StdSignDoc Uses

type StdSignDoc = types.StdSignDoc

type StdSignMsg Uses

type StdSignMsg = types.StdSignMsg

type StdSignature Uses

type StdSignature = types.StdSignature

type StdTx Uses

type StdTx = types.StdTx

type TxBuilder Uses

type TxBuilder = types.TxBuilder

type VestingAccount Uses

type VestingAccount = exported.VestingAccount

Directories

PathSynopsis
client/cli
client/rest
client/utils
exported
simulation
typesnolint noalias

Package auth imports 24 packages (graph) and is imported by 64 packages. Updated 2019-07-18. Refresh now. Tools for package owners.