custodianunit

package
v0.9.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 20, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source
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
	QueryCU                       = types.QueryCU
)
View Source
const (
	DefaultGasUsedForRefund = uint64(20000)
)

Variables

View Source
var (
	// functions aliases
	NewBaseCU             = types.NewBaseCU
	ProtoBaseCU           = types.ProtoBaseCU
	NewBaseCUWithAddress  = types.NewBaseCUWithAddress
	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.NewQueryCUParams
	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.NewCURetriever

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

	QueryCUForTest = queryCU
)

Functions

func CheckCUType

func CheckCUType(ctx sdk.Context, ck CUKeeper, signers []sdk.CUAddress) sdk.Result

func DeductFees

func DeductFees(supplyKeeper internal.SupplyKeeper, ctx sdk.Context, cu CU, fees sdk.Coins) sdk.Result

DeductFees deducts fees from the given CU.

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

func DefaultSigVerificationGasConsumer

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

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

func GetSignBytes(chainID string, stdTx StdTx, cu CU, genesis bool) []byte

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

func InitGenesis

func InitGenesis(ctx sdk.Context, ak CUKeeper, 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 CU

func NewAnteHandler

func NewAnteHandler(ck CUKeeper, supplyKeeper internal.SupplyKeeper, stakingKeeper internal.StakingKeeper, sigGasConsumer SignatureVerificationGasConsumer) sdk.AnteHandler

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

func NewGasRefundHandler added in v0.9.3

func NewGasRefundHandler(supplyKeeper internal.SupplyKeeper) sdk.GasRefundHandler

func NewQuerier

func NewQuerier(keeper CUKeeper) sdk.Querier

creates a querier for auth REST endpoints

func ProcessPubKey

func ProcessPubKey(cu CU, sig StdSignature, simulate bool) (crypto.PubKey, sdk.Result)

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

func SetGasMeter

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

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

ValidateMemo validates the memo size.

func ValidateSigCount

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

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

Types

type AppModule

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

___________________________ app module object

func NewAppModule

func NewAppModule(cuKeeper CUKeeper) AppModule

NewAppModule creates a new AppModule object

func (AppModule) BeginBlock

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

module begin-block

func (AppModule) EndBlock

module end-block

func (AppModule) ExportGenesis

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

module export genesis

func (AppModule) InitGenesis

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

module init-genesis

func (AppModule) Name

func (AppModule) Name() string

module name

func (AppModule) NewHandler

func (AppModule) NewHandler() sdk.Handler

module handler

func (AppModule) NewQuerierHandler

func (am AppModule) NewQuerierHandler() sdk.Querier

module querier

func (AppModule) QuerierRoute

func (AppModule) QuerierRoute() string

module querier route name

func (AppModule) RegisterInvariants

func (AppModule) RegisterInvariants(_ sdk.InvariantRegistry)

register invariants

func (AppModule) Route

func (AppModule) Route() string

module message route name

type AppModuleBasic

type AppModuleBasic struct{}

app module basics object

func (AppModuleBasic) DefaultGenesis

func (AppModuleBasic) DefaultGenesis() json.RawMessage

default genesis state

func (AppModuleBasic) GetQueryCmd

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

get the root query command of this module

func (AppModuleBasic) GetTxCmd

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

get the root tx command of this module

func (AppModuleBasic) Name

func (AppModuleBasic) Name() string

module name

func (AppModuleBasic) RegisterCodec

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

register module codec

func (AppModuleBasic) RegisterRESTRoutes

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

register rest routes

func (AppModuleBasic) ValidateGenesis

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

module validate genesis

type BaseCU

type BaseCU = types.BaseCU

type CU

type CUKeeper

type CUKeeper struct {
	ParamSubspace subspace.Subspace
	// contains filtered or unexported fields
}

CUKeeper encodes/decodes CUs using the go-amino (binary) encoding/decoding library.

func NewCUKeeper

func NewCUKeeper(
	cdc *codec.Codec, key sdk.StoreKey, paramstore subspace.Subspace, proto func() exported.CustodianUnit,
) CUKeeper

NewCUKeeper returns a new CUKeeper that uses go-amino to (binary) encode and decode concrete sdk.CustodianUnits. nolint

func (CUKeeper) GetAllCUs

func (ck CUKeeper) GetAllCUs(ctx sdk.Context) []exported.CustodianUnit

GetAllCUs returns all custodian units in the CUKeeper.

func (CUKeeper) GetCU

func (ck CUKeeper) GetCU(context sdk.Context, addresses sdk.CUAddress) exported.CustodianUnit

func (CUKeeper) GetCUFromExtAddress

func (ck CUKeeper) GetCUFromExtAddress(ctx sdk.Context, chain, extAddress string) (sdk.CUAddress, error)

------------------------------------------------ GetCUFromExtAddresse get the CU's address which has the etxAddress,

func (CUKeeper) GetOpCUs

func (ck CUKeeper) GetOpCUs(ctx sdk.Context, symbol string) []exported.CustodianUnit

GetOpCUs returns all operation custodian units of the symbol . if symbol is empty return all operation custodian units of the symbol.

func (CUKeeper) GetOrNewCU

func (ck CUKeeper) GetOrNewCU(context sdk.Context, cuType sdk.CUType, addr sdk.CUAddress) exported.CustodianUnit

GetOrNewCU get or new a CustodianUnit. If CustodianUnit is not found, and CU type is user, new one but not yet save it. If CustodianUnit is not found, and CU type not user, return CustodianUnit(nil).

func (CUKeeper) GetParams

func (ck CUKeeper) GetParams(ctx sdk.Context) (params types.Params)

GetParams gets the auth module's parameters.

func (CUKeeper) IterateCUs

func (ck CUKeeper) IterateCUs(ctx sdk.Context, process func(exported.CustodianUnit) (stop bool))

IterateCUs implements sdk.CUKeeper.

func (CUKeeper) Logger

func (ck CUKeeper) Logger(ctx sdk.Context) log.Logger

Logger returns a module-specific logger.

func (CUKeeper) NewCU

NewCU set CUNumber for the CustodianUnit the CustodianUnit may not created by the proto func, for example: ModuleAccountI

func (CUKeeper) NewCUWithAddress

func (ck CUKeeper) NewCUWithAddress(ctx sdk.Context, cuType sdk.CUType, addr sdk.CUAddress) exported.CustodianUnit

func (CUKeeper) NewCUWithPubkey

func (ck CUKeeper) NewCUWithPubkey(ctx sdk.Context, cuType sdk.CUType, pub crypto.PubKey) exported.CustodianUnit

------implement CUKeeperI---

func (CUKeeper) NewOpCUWithAddress

func (ck CUKeeper) NewOpCUWithAddress(ctx sdk.Context, symbol string, addr sdk.CUAddress) exported.CustodianUnit

NewOpCUWithAddress create OP CU

func (CUKeeper) RemoveCU

func (ck CUKeeper) RemoveCU(ctx sdk.Context, cu exported.CustodianUnit)

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

func (CUKeeper) SetCU

func (ck CUKeeper) SetCU(ctx sdk.Context, cu exported.CustodianUnit)

SetCU implements sdk.CUKeeper.

func (CUKeeper) SetExtAddressWithCU added in v0.9.3

func (ck CUKeeper) SetExtAddressWithCU(ctx sdk.Context, chain, extAddress string, cuAddress sdk.CUAddress)

SetExtAddresseWithCU

func (CUKeeper) SetParams

func (ck CUKeeper) SetParams(ctx sdk.Context, params types.Params)

SetParams sets the auth module's parameters.

func (*CUKeeper) SetStakingKeeper

func (ck *CUKeeper) SetStakingKeeper(sk internal.StakingKeeper)

type CUKeeperI

type CUKeeperI interface {
	// CU functions
	NewCUWithPubkey(ctx sdk.Context, cuType sdk.CUType, pub crypto.PubKey) exported.CustodianUnit

	NewCUWithAddress(ctx sdk.Context, cuType sdk.CUType, cuaddr sdk.CUAddress) exported.CustodianUnit

	NewCU(ctx sdk.Context, cu exported.CustodianUnit) exported.CustodianUnit

	NewOpCUWithAddress(ctx sdk.Context, symbol string, addr sdk.CUAddress) exported.CustodianUnit

	GetCU(context sdk.Context, addresses sdk.CUAddress) exported.CustodianUnit

	GetOrNewCU(context sdk.Context, cuType sdk.CUType, addresses sdk.CUAddress) exported.CustodianUnit

	SetCU(ctx sdk.Context, cu exported.CustodianUnit)

	GetAllCUs(ctx sdk.Context) []exported.CustodianUnit

	GetOpCUs(ctx sdk.Context, symbol string) []exported.CustodianUnit

	RemoveCU(ctx sdk.Context, cu exported.CustodianUnit)

	IterateCUs(ctx sdk.Context, process func(exported.CustodianUnit) (stop bool))

	// param funcsions
	SetParams(ctx sdk.Context, params types.Params)

	GetParams(ctx sdk.Context) (params types.Params)

	Logger(ctx sdk.Context) log.Logger

	SetExtAddressWithCU(ctx sdk.Context, symbol, extAddress string, cuAddress sdk.CUAddress)

	GetCUFromExtAddress(ctx sdk.Context, symbol, extAddress string) (sdk.CUAddress, error)
}

type GenesisState

type GenesisState = types.GenesisState

func ExportGenesis

func ExportGenesis(ctx sdk.Context, ck CUKeeper) GenesisState

ExportGenesis returns a GenesisState for a given context and keeper

type Params

type Params = types.Params

type QueryAccountParams

type QueryAccountParams = types.QueryCUParams

type SignatureVerificationGasConsumer

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

type StdFee = types.StdFee

type StdSignDoc

type StdSignDoc = types.StdSignDoc

type StdSignMsg

type StdSignMsg = types.StdSignMsg

type StdSignature

type StdSignature = types.StdSignature

type StdTx

type StdTx = types.StdTx

type TxBuilder

type TxBuilder = types.TxBuilder

type VestingAccount

type VestingAccount = exported.VestingCU

Directories

Path Synopsis
client
cli
nolint
nolint
nolint noalias
nolint noalias

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL