types

package
v0.50.4 Latest Latest
Warning

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

 Go to latest Published: Feb 19, 2024 License: Apache-2.0 Imports: 48 Imported by: 47,619

Documentation

Index

Constants

View Source 
const (

	// Bech32MainPrefix defines the main SDK Bech32 prefix of an account's address
	Bech32MainPrefix = "cosmos"

	// Purpose is the ATOM purpose as defined in SLIP44 (https://github.com/satoshilabs/slips/blob/master/slip-0044.md)
	Purpose = 44

	// CoinType is the ATOM coin type as defined in SLIP44 (https://github.com/satoshilabs/slips/blob/master/slip-0044.md)
	CoinType = 118

	// FullFundraiserPath is the parts of the BIP44 HD path that are fixed by
	// what we used during the ATOM fundraiser.
	FullFundraiserPath = "m/44'/118'/0'/0/0"

	// PrefixAccount is the prefix for account keys
	PrefixAccount = "acc"
	// PrefixValidator is the prefix for validator keys
	PrefixValidator = "val"
	// PrefixConsensus is the prefix for consensus keys
	PrefixConsensus = "cons"
	// PrefixPublic is the prefix for public keys
	PrefixPublic = "pub"
	// PrefixOperator is the prefix for operator keys
	PrefixOperator = "oper"

	// PrefixAddress is the prefix for addresses
	PrefixAddress = "addr"

	// Bech32PrefixAccAddr defines the Bech32 prefix of an account's address
	Bech32PrefixAccAddr = Bech32MainPrefix
	// Bech32PrefixAccPub defines the Bech32 prefix of an account's public key
	Bech32PrefixAccPub = Bech32MainPrefix + PrefixPublic
	// Bech32PrefixValAddr defines the Bech32 prefix of a validator's operator address
	Bech32PrefixValAddr = Bech32MainPrefix + PrefixValidator + PrefixOperator
	// Bech32PrefixValPub defines the Bech32 prefix of a validator's operator public key
	Bech32PrefixValPub = Bech32MainPrefix + PrefixValidator + PrefixOperator + PrefixPublic
	// Bech32PrefixConsAddr defines the Bech32 prefix of a consensus node address
	Bech32PrefixConsAddr = Bech32MainPrefix + PrefixValidator + PrefixConsensus
	// Bech32PrefixConsPub defines the Bech32 prefix of a consensus node public key
	Bech32PrefixConsPub = Bech32MainPrefix + PrefixValidator + PrefixConsensus + PrefixPublic
)
View Source 
const (
	EventTypeTx = "tx"

	AttributeKeyAccountSequence = "acc_seq"
	AttributeKeySignature       = "signature"
	AttributeKeyFee             = "fee"
	AttributeKeyFeePayer        = "fee_payer"

	EventTypeMessage = "message"

	AttributeKeyAction = "action"
	AttributeKeyModule = "module"
	AttributeKeySender = "sender"
	AttributeKeyAmount = "amount"
)

Common event types and attribute keys

View Source 
const DefaultKeyringServiceName = "cosmos"

DefaultKeyringServiceName defines a default service name for the keyring.

View Source 
const (
	// MsgInterfaceProtoName defines the protobuf name of the cosmos Msg interface
	MsgInterfaceProtoName = "cosmos.base.v1beta1.Msg"
)
View Source 
const SortableTimeFormat = "2006-01-02T15:04:05.000000000"

Slight modification of the RFC3339Nano but it right pads all zeros and drops the time zone info

View Source 
const ValidatorUpdateDelay int64 = 1

Delay, in blocks, between when validator updates are returned to the consensus-engine and when they are applied. For example, if ValidatorUpdateDelay is set to X, and if a validator set update is returned with new validators at the end of block 10, then the new validators are expected to sign blocks beginning at block 11+X.

This value is constant as this should not change without a hard fork. For CometBFT this should be set to 1 block, for more details see: https://github.com/cometbft/cometbft/blob/main/spec/abci/abci%2B%2B_basic_concepts.md#consensusblock-execution-methods

Variables

View Source 
var (
	ErrInvalidLengthAbci        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowAbci          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupAbci = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	ErrInvalidLengthCoin        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowCoin          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupCoin = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	// AccAddressKey follows the same semantics of collections.BytesKey.
	// It just uses humanized format for the String() and EncodeJSON().
	AccAddressKey collcodec.KeyCodec[AccAddress] = genericAddressKey[AccAddress]{
					// contains filtered or unexported fields
	}

	// ValAddressKey follows the same semantics as AccAddressKey.
	ValAddressKey collcodec.KeyCodec[ValAddress] = genericAddressKey[ValAddress]{
					// contains filtered or unexported fields
	}

	// ConsAddressKey follows the same semantics as ConsAddressKey.
	ConsAddressKey collcodec.KeyCodec[ConsAddress] = genericAddressKey[ConsAddress]{
					// contains filtered or unexported fields
	}

	// IntValue represents a collections.ValueCodec to work with Int.
	IntValue collcodec.ValueCodec[math.Int] = intValueCodec{}

	// TimeKey represents a collections.KeyCodec to work with time.Time
	// Deprecated: exists only for state compatibility reasons, should not
	// be used for new storage keys using time. Please use the time KeyCodec
	// provided in the collections package.
	TimeKey collcodec.KeyCodec[time.Time] = timeKeyCodec{}
)
View Source 
var (
	// DefaultBondDenom is the default bondable coin denomination (defaults to stake)
	// Overwriting this value has the side effect of changing the default denomination in genesis
	DefaultBondDenom = "stake"

	// DefaultPowerReduction is the default amount of staking tokens required for 1 unit of consensus-engine power
	DefaultPowerReduction = sdkmath.NewIntFromUint64(1000000)
)
View Source 
var (
	ErrEmptyHexAddress = errors.New("decoding address from hex string failed: empty address")
)

sentinel errors

View Source 
var IsAlphaNumeric = regexp.MustCompile(`^[a-zA-Z0-9]+$`).MatchString

IsAlphaNumeric defines a regular expression for matching against alpha-numeric values.

View Source 
var MsgTypeURL = codectypes.MsgTypeURL

MsgTypeURL returns the TypeURL of a `sdk.Msg`.

Functions

func AppendLengthPrefixedBytes added in v0.46.0 

func AppendLengthPrefixedBytes(args ...[]byte) []byte

AppendLengthPrefixedBytes combines the slices of bytes to one slice of bytes.

func Bech32ifyAddressBytes 

func Bech32ifyAddressBytes(prefix string, bs []byte) (string, error)

Bech32ifyAddressBytes returns a bech32 representation of address bytes. Returns an empty sting if the byte slice is 0-length. Returns an error if the bech32 conversion fails or the prefix is empty.

func BigEndianToUint64 

func BigEndianToUint64(bz []byte) uint64

BigEndianToUint64 returns an uint64 from big endian encoded bytes. If encoding is empty, zero is returned.

func CopyBytes 

func CopyBytes(bz []byte) (ret []byte)

copy bytes

func DefaultCoinDenomRegex added in v0.39.2 

func DefaultCoinDenomRegex() string

DefaultCoinDenomRegex returns the default regex string

func FormatInvariant 

func FormatInvariant(module, name, msg string) string

FormatInvariant returns a standardized invariant message.

func FormatTimeBytes 

func FormatTimeBytes(t time.Time) []byte

Formats a time.Time into a []byte that can be sorted

func FormatTimeString added in v0.47.0 

func FormatTimeString(t time.Time) string

Formats a time.Time into a string

func GetBaseDenom added in v0.40.0 

func GetBaseDenom() (string, error)

GetBaseDenom returns the denom of smallest unit registered

func GetDenomUnit 

func GetDenomUnit(denom string) (math.LegacyDec, bool)

GetDenomUnit returns a unit for a given denomination if it exists. A boolean is returned if the denomination is registered.

func GetFromBech32 

func GetFromBech32(bech32str, prefix string) ([]byte, error)

GetFromBech32 decodes a bytestring from a Bech32 encoded string.

func GetModuleNameFromTypeURL added in v0.50.0 

func GetModuleNameFromTypeURL(input string) string

GetModuleNameFromTypeURL assumes that module name is the second element of the msg type URL e.g. "cosmos.bank.v1beta1.MsgSend" => "bank" It returns an empty string if the input is not a valid type URL

func IsAddrCacheEnabled added in v0.46.14 

func IsAddrCacheEnabled() bool

IsAddrCacheEnabled returns if the address caches are enabled.

func KeyringServiceName 

func KeyringServiceName() string

func LengthPrefixedAddressKey deprecated added in v0.50.0 

func LengthPrefixedAddressKey[T addressUnion](keyCodec collcodec.KeyCodec[T]) collcodec.KeyCodec[T]

Deprecated: LengthPrefixedAddressKey implements an SDK backwards compatible indexing key encoder for addresses. The status quo in the SDK is that address keys are length prefixed even when they're the last part of a composite key. This should never be used unless to retain state compatibility. For example, a composite key composed of `[string, address]` in theory would need you only to define a way to understand when the string part finishes, we usually do this by appending a null byte to the string, then when you know when the string part finishes, it's logical that the part which remains is the address key. In the SDK instead we prepend to the address key its length too.

func LogDeferred added in v0.47.0 

func LogDeferred(logger log.Logger, f func() error)

LogDeferred logs an error in a deferred function call if the returned error is non-nil.

func MarkEventsToIndex added in v0.40.0 

func MarkEventsToIndex(events []abci.Event, indexSet map[string]struct{}) []abci.Event

MarkEventsToIndex returns the set of ABCI events, where each event's attribute has it's index value marked based on the provided set of events to index.

func MustBech32ifyAddressBytes 

func MustBech32ifyAddressBytes(prefix string, bs []byte) string

MustBech32ifyAddressBytes returns a bech32 representation of address bytes. Returns an empty sting if the byte slice is 0-length. It panics if the bech32 conversion fails or the prefix is empty.

func MustSortJSON 

func MustSortJSON(toSortJSON []byte) []byte

MustSortJSON is like SortJSON but panic if an error occurs, e.g., if the passed JSON isn't valid. Deprecated: SortJSON was used for GetSignbytes, this is now automatic with amino signing

func NewResponseResultBlock added in v0.50.0 

func NewResponseResultBlock(res *coretypes.ResultBlock, timestamp string) *cmtproto.Block

NewResponseResultBlock returns a BlockResponse given a ResultBlock from CometBFT

func ParseLengthPrefixedBytes added in v0.46.0 

func ParseLengthPrefixedBytes(key []byte, startIndex, sliceLength int) ([]byte, int)

ParseLengthPrefixedBytes panics when store key length is not equal to the given length.

func ParseTime added in v0.47.0 

func ParseTime(t any) (time.Time, error)

Parses an encoded type using FormatTimeKey back into a time.Time

func ParseTimeBytes 

func ParseTimeBytes(bz []byte) (time.Time, error)

Parses a []byte encoded using FormatTimeKey back into a time.Time

func ParseTypedEvent added in v0.40.0 

func ParseTypedEvent(event abci.Event) (proto.Message, error)

ParseTypedEvent converts abci.Event back to a typed event.

func RegisterDenom 

func RegisterDenom(denom string, unit math.LegacyDec) error

RegisterDenom registers a denomination with a corresponding unit. If the denomination is already registered, an error will be returned.

func RegisterInterfaces 

func RegisterInterfaces(registry types.InterfaceRegistry)

RegisterInterfaces registers the sdk message type.

func RegisterLegacyAminoCodec added in v0.40.0 

func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

RegisterLegacyAminoCodec registers the sdk message type.

func SetAddrCacheEnabled added in v0.46.14 

func SetAddrCacheEnabled(enabled bool)

SetAddrCacheEnabled enables or disables accAddrCache, consAddrCache, and valAddrCache. By default, caches are enabled.

func SetBaseDenom added in v0.50.1 

func SetBaseDenom(denom string) error

SetBaseDenom allow overwritting the base denom if the denom has registered before, otherwise return error

func SetCoinDenomRegex added in v0.39.2 

func SetCoinDenomRegex(reFn func() string)

SetCoinDenomRegex allows for coin's custom validation by overriding the regular expression string used for denom validation.

func SortJSON 

func SortJSON(toSortJSON []byte) ([]byte, error)

SortedJSON takes any JSON and returns it sorted by keys. Also, all white-spaces are removed. This method can be used to canonicalize JSON to be returned by GetSignBytes, e.g. for the ledger integration. If the passed JSON isn't valid it will return an error. Deprecated: SortJSON was used for GetSignbytes, this is now automatic with amino signing

func TokensFromConsensusPower 

func TokensFromConsensusPower(power int64, powerReduction sdkmath.Int) sdkmath.Int

TokensFromConsensusPower - convert input power to tokens

func TokensToConsensusPower 

func TokensToConsensusPower(tokens, powerReduction sdkmath.Int) int64

TokensToConsensusPower - convert input tokens to potential consensus-engine power

func Uint64ToBigEndian 

func Uint64ToBigEndian(i uint64) []byte

Uint64ToBigEndian - marshals uint64 to a bigendian byte slice so it can be sorted

func ValidateDenom 

func ValidateDenom(denom string) error

ValidateDenom is the default validation function for Coin.Denom.

func VerifyAddressFormat 

func VerifyAddressFormat(bz []byte) error

VerifyAddressFormat verifies that the provided bytes form a valid address according to the default address rules or a custom address verifier set by GetConfig().SetAddressVerifier(). TODO make an issue to get rid of global Config ref: https://github.com/cosmos/cosmos-sdk/issues/9690

func WrapSDKContext deprecated added in v0.40.0 

func WrapSDKContext(ctx Context) context.Context

WrapSDKContext returns a stdlib context.Context with the provided sdk.Context's internal context as a value. It is useful for passing an sdk.Context through methods that take a stdlib context.Context parameter such as generated gRPC methods. To get the original sdk.Context back, call UnwrapSDKContext.

Deprecated: there is no need to wrap anymore as the Cosmos SDK context implements context.Context.

Types

type ABCIMessageLog 

type ABCIMessageLog struct {
	MsgIndex uint32 `protobuf:"varint,1,opt,name=msg_index,json=msgIndex,proto3" json:"msg_index"`
	Log      string `protobuf:"bytes,2,opt,name=log,proto3" json:"log,omitempty"`
	// Events contains a slice of Event objects that were emitted during some
	// execution.
	Events StringEvents `protobuf:"bytes,3,rep,name=events,proto3,castrepeated=StringEvents" json:"events"`
}

ABCIMessageLog defines a structure containing an indexed tx ABCI message log.

func NewABCIMessageLog 

func NewABCIMessageLog(i uint32, log string, events Events) ABCIMessageLog

func (*ABCIMessageLog) Descriptor added in v0.40.0 

func (*ABCIMessageLog) Descriptor() ([]byte, []int)

func (*ABCIMessageLog) GetEvents added in v0.40.0 

func (m *ABCIMessageLog) GetEvents() StringEvents

func (*ABCIMessageLog) GetLog added in v0.40.0 

func (m *ABCIMessageLog) GetLog() string

func (*ABCIMessageLog) GetMsgIndex added in v0.40.0 

func (m *ABCIMessageLog) GetMsgIndex() uint32

func (*ABCIMessageLog) Marshal added in v0.40.0 

func (m *ABCIMessageLog) Marshal() (dAtA []byte, err error)

func (*ABCIMessageLog) MarshalTo added in v0.40.0 

func (m *ABCIMessageLog) MarshalTo(dAtA []byte) (int, error)

func (*ABCIMessageLog) MarshalToSizedBuffer added in v0.40.0 

func (m *ABCIMessageLog) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ABCIMessageLog) ProtoMessage added in v0.40.0 

func (*ABCIMessageLog) ProtoMessage()

func (*ABCIMessageLog) Reset added in v0.40.0 

func (m *ABCIMessageLog) Reset()

func (*ABCIMessageLog) Size added in v0.40.0 

func (m *ABCIMessageLog) Size() (n int)

func (*ABCIMessageLog) String added in v0.40.0 

func (this *ABCIMessageLog) String() string

func (*ABCIMessageLog) Unmarshal added in v0.40.0 

func (m *ABCIMessageLog) Unmarshal(dAtA []byte) error

func (*ABCIMessageLog) XXX_DiscardUnknown added in v0.40.0 

func (m *ABCIMessageLog) XXX_DiscardUnknown()

func (*ABCIMessageLog) XXX_Marshal added in v0.40.0 

func (m *ABCIMessageLog) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ABCIMessageLog) XXX_Merge added in v0.40.0 

func (m *ABCIMessageLog) XXX_Merge(src proto.Message)

func (*ABCIMessageLog) XXX_Size added in v0.40.0 

func (m *ABCIMessageLog) XXX_Size() int

func (*ABCIMessageLog) XXX_Unmarshal added in v0.40.0 

func (m *ABCIMessageLog) XXX_Unmarshal(b []byte) error

type ABCIMessageLogs 

type ABCIMessageLogs []ABCIMessageLog

ABCIMessageLogs represents a slice of ABCIMessageLog.

func ParseABCILogs 

func ParseABCILogs(logs string) (res ABCIMessageLogs, err error)

ParseABCILogs attempts to parse a stringified ABCI tx log into a slice of ABCIMessageLog types. It returns an error upon JSON decoding failure.

func (ABCIMessageLogs) String 

func (logs ABCIMessageLogs) String() (str string)

String implements the fmt.Stringer interface for the ABCIMessageLogs type.

type AccAddress 

type AccAddress []byte

AccAddress a wrapper around bytes meant to represent an account address. When marshaled to a string or JSON, it uses Bech32.

func AccAddressFromBech32 

func AccAddressFromBech32(address string) (addr AccAddress, err error)

AccAddressFromBech32 creates an AccAddress from a Bech32 string.

func AccAddressFromHexUnsafe added in v0.46.0 

func AccAddressFromHexUnsafe(address string) (addr AccAddress, err error)

AccAddressFromHexUnsafe creates an AccAddress from a HEX-encoded string.

Note, this function is considered unsafe as it may produce an AccAddress from otherwise invalid input, such as a transaction hash. Please use AccAddressFromBech32.

func MustAccAddressFromBech32 added in v0.45.5 

func MustAccAddressFromBech32(address string) AccAddress

MustAccAddressFromBech32 calls AccAddressFromBech32 and panics on error.

func (AccAddress) Bytes 

func (aa AccAddress) Bytes() []byte

Bytes returns the raw address bytes.

func (AccAddress) Empty 

func (aa AccAddress) Empty() bool

Returns boolean for whether an AccAddress is empty

func (AccAddress) Equals 

func (aa AccAddress) Equals(aa2 Address) bool

Returns boolean for whether two AccAddresses are Equal

func (AccAddress) Format 

func (aa AccAddress) Format(s fmt.State, verb rune)

func (AccAddress) Marshal 

func (aa AccAddress) Marshal() ([]byte, error)

Marshal returns the raw address bytes. It is needed for protobuf compatibility.

func (AccAddress) MarshalJSON 

func (aa AccAddress) MarshalJSON() ([]byte, error)

MarshalJSON marshals to JSON using Bech32.

func (AccAddress) MarshalYAML 

func (aa AccAddress) MarshalYAML() (interface{}, error)

MarshalYAML marshals to YAML using Bech32.

func (AccAddress) String 

func (aa AccAddress) String() string

String implements the Stringer interface.

func (*AccAddress) Unmarshal 

func (aa *AccAddress) Unmarshal(data []byte) error

Unmarshal sets the address to the given data. It is needed for protobuf compatibility.

func (*AccAddress) UnmarshalJSON 

func (aa *AccAddress) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals from JSON assuming Bech32 encoding.

func (*AccAddress) UnmarshalYAML 

func (aa *AccAddress) UnmarshalYAML(data []byte) error

UnmarshalYAML unmarshals from JSON assuming Bech32 encoding.

type AccountI added in v0.50.0 

type AccountI interface {
	proto.Message

	GetAddress() AccAddress
	SetAddress(AccAddress) error // errors if already set.

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

	GetAccountNumber() uint64
	SetAccountNumber(uint64) error

	GetSequence() uint64
	SetSequence(uint64) error

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

AccountI 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 AccountI.

type Address 

type Address interface {
	Equals(Address) bool
	Empty() bool
	Marshal() ([]byte, error)
	MarshalJSON() ([]byte, error)
	Bytes() []byte
	String() string
	Format(s fmt.State, verb rune)
}

Address is a common interface for different types of addresses used by the SDK

type AnteDecorator 

type AnteDecorator interface {
	AnteHandle(ctx Context, tx Tx, simulate bool, next AnteHandler) (newCtx Context, err error)
}

AnteDecorator wraps the next AnteHandler to perform custom pre-processing.

type AnteHandler 

type AnteHandler func(ctx Context, tx Tx, simulate bool) (newCtx Context, err error)

AnteHandler authenticates transactions, before their internal messages are handled. If newCtx.IsZero(), ctx is used instead.

func ChainAnteDecorators 

func ChainAnteDecorators(chain ...AnteDecorator) AnteHandler

ChainAnteDecorators ChainDecorator chains AnteDecorators together with each AnteDecorator wrapping over the decorators further along chain and returns a single AnteHandler.

NOTE: The first element is outermost decorator, while the last element is innermost decorator. Decorator ordering is critical since some decorators will expect certain checks and updates to be performed (e.g. the Context) before the decorator is run. These expectations should be documented clearly in a CONTRACT docline in the decorator's godoc.

NOTE: Any application that uses GasMeter to limit transaction processing cost MUST set GasMeter with the FIRST AnteDecorator. Failing to do so will cause transactions to be processed with an infinite gasmeter and open a DOS attack vector. Use `ante.SetUpContextDecorator` or a custom Decorator with similar functionality. Returns nil when no AnteDecorator are supplied.

type Attribute 

type Attribute struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
}

Attribute defines an attribute wrapper where the key and value are strings instead of raw bytes.

func NewAttribute 

func NewAttribute(k, v string) Attribute

NewAttribute returns a new key/value Attribute object.

func (*Attribute) Descriptor added in v0.40.0 

func (*Attribute) Descriptor() ([]byte, []int)

func (*Attribute) GetKey added in v0.40.0 

func (m *Attribute) GetKey() string

func (*Attribute) GetValue added in v0.40.0 

func (m *Attribute) GetValue() string

func (*Attribute) Marshal added in v0.40.0 

func (m *Attribute) Marshal() (dAtA []byte, err error)

func (*Attribute) MarshalTo added in v0.40.0 

func (m *Attribute) MarshalTo(dAtA []byte) (int, error)

func (*Attribute) MarshalToSizedBuffer added in v0.40.0 

func (m *Attribute) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Attribute) ProtoMessage added in v0.40.0 

func (*Attribute) ProtoMessage()

func (*Attribute) Reset added in v0.40.0 

func (m *Attribute) Reset()

func (*Attribute) Size added in v0.40.0 

func (m *Attribute) Size() (n int)

func (Attribute) String 

func (a Attribute) String() string

func (Attribute) ToKVPair 

func (a Attribute) ToKVPair() abci.EventAttribute

ToKVPair converts an Attribute object into a CometBFT key/value pair.

func (*Attribute) Unmarshal added in v0.40.0 

func (m *Attribute) Unmarshal(dAtA []byte) error

func (*Attribute) XXX_DiscardUnknown added in v0.40.0 

func (m *Attribute) XXX_DiscardUnknown()

func (*Attribute) XXX_Marshal added in v0.40.0 

func (m *Attribute) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Attribute) XXX_Merge added in v0.40.0 

func (m *Attribute) XXX_Merge(src proto.Message)

func (*Attribute) XXX_Size added in v0.40.0 

func (m *Attribute) XXX_Size() int

func (*Attribute) XXX_Unmarshal added in v0.40.0 

func (m *Attribute) XXX_Unmarshal(b []byte) error

type BeginBlock added in v0.50.0 

type BeginBlock struct {
	Events []abci.Event
}

BeginBlock defines a type which contains beginBlock events

type BeginBlocker 

type BeginBlocker func(Context) (BeginBlock, error)

BeginBlocker defines a function type alias for executing application business logic before transactions are executed.

Note: The BeginBlock ABCI method no longer exists in the ABCI specification as of CometBFT v0.38.0. This function type alias is provided for backwards compatibility with applications that still use the BeginBlock ABCI method and allows for existing BeginBlock functionality within applications.

type Coin 

type Coin struct {
	Denom  string                `protobuf:"bytes,1,opt,name=denom,proto3" json:"denom,omitempty"`
	Amount cosmossdk_io_math.Int `protobuf:"bytes,2,opt,name=amount,proto3,customtype=cosmossdk.io/math.Int" json:"amount"`
}

Coin defines a token with a denomination and an amount.

NOTE: The amount field is an Int which implements the custom method signatures required by gogoproto.

func ConvertCoin 

func ConvertCoin(coin Coin, denom string) (Coin, error)

ConvertCoin attempts to convert a coin to a given denomination. If the given denomination is invalid or if neither denomination is registered, an error is returned.

func NewCoin 

func NewCoin(denom string, amount math.Int) Coin

NewCoin returns a new coin with a denomination and amount. It will panic if the amount is negative or if the denomination is invalid.

func NewInt64Coin 

func NewInt64Coin(denom string, amount int64) Coin

NewInt64Coin returns a new coin with a denomination and amount. It will panic if the amount is negative.

func NormalizeCoin added in v0.40.0 

func NormalizeCoin(coin Coin) Coin

NormalizeCoin try to convert a coin to the smallest unit registered, returns original one if failed.

func ParseCoinNormalized added in v0.40.0 

func ParseCoinNormalized(coinStr string) (coin Coin, err error)

ParseCoinNormalized parses and normalize a cli input for one coin type, returning errors if invalid or on an empty string as well. Expected format: "{amount}{denomination}"

func (Coin) Add 

func (coin Coin) Add(coinB Coin) Coin

Add adds amounts of two coins with same denom. If the coins differ in denom then it panics.

func (Coin) AddAmount added in v0.43.0 

func (coin Coin) AddAmount(amount math.Int) Coin

AddAmount adds an amount to the Coin.

func (*Coin) Descriptor 

func (*Coin) Descriptor() ([]byte, []int)

func (*Coin) Equal 

func (this *Coin) Equal(that interface{}) bool

func (*Coin) GetDenom 

func (m *Coin) GetDenom() string

func (Coin) IsEqual 

func (coin Coin) IsEqual(other Coin) bool

IsEqual returns true if the two sets of Coins have the same value Deprecated: Use Coin.Equal instead.

func (Coin) IsGTE 

func (coin Coin) IsGTE(other Coin) bool

IsGTE returns true if they are the same type and the receiver is an equal or greater value

func (Coin) IsLT 

func (coin Coin) IsLT(other Coin) bool

IsLT returns true if they are the same type and the receiver is a smaller value

func (Coin) IsLTE added in v0.46.0 

func (coin Coin) IsLTE(other Coin) bool

IsLTE returns true if they are the same type and the receiver is an equal or smaller value

func (Coin) IsNegative 

func (coin Coin) IsNegative() bool

IsNegative returns true if the coin amount is negative and false otherwise.

TODO: Remove once unsigned integers are used.

func (Coin) IsNil added in v0.42.11 

func (coin Coin) IsNil() bool

IsNil returns true if the coin amount is nil and false otherwise.

func (Coin) IsPositive 

func (coin Coin) IsPositive() bool

IsPositive returns true if coin amount is positive.

TODO: Remove once unsigned integers are used.

func (Coin) IsValid 

func (coin Coin) IsValid() bool

IsValid returns true if the Coin has a non-negative amount and the denom is valid.

func (Coin) IsZero 

func (coin Coin) IsZero() bool

IsZero returns if this represents no money

func (*Coin) Marshal 

func (m *Coin) Marshal() (dAtA []byte, err error)

func (*Coin) MarshalTo 

func (m *Coin) MarshalTo(dAtA []byte) (int, error)

func (*Coin) MarshalToSizedBuffer 

func (m *Coin) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Coin) ProtoMessage 

func (*Coin) ProtoMessage()

func (*Coin) Reset 

func (m *Coin) Reset()

func (Coin) SafeSub added in v0.46.0 

func (coin Coin) SafeSub(coinB Coin) (Coin, error)

SafeSub safely subtracts the amounts of two coins. It returns an error if the coins differ in denom or subtraction results in negative coin denom.

func (*Coin) Size 

func (m *Coin) Size() (n int)

func (Coin) String 

func (coin Coin) String() string

String provides a human-readable representation of a coin

func (Coin) Sub 

func (coin Coin) Sub(coinB Coin) Coin

Sub subtracts amounts of two coins with same denom and panics on error.

func (Coin) SubAmount added in v0.43.0 

func (coin Coin) SubAmount(amount math.Int) Coin

SubAmount subtracts an amount from the Coin.

func (*Coin) Unmarshal 

func (m *Coin) Unmarshal(dAtA []byte) error

func (Coin) Validate added in v0.40.0 

func (coin Coin) Validate() error

Validate returns an error if the Coin has a negative amount or if the denom is invalid.

func (*Coin) XXX_DiscardUnknown 

func (m *Coin) XXX_DiscardUnknown()

func (*Coin) XXX_Marshal 

func (m *Coin) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Coin) XXX_Merge 

func (m *Coin) XXX_Merge(src proto.Message)

func (*Coin) XXX_Size 

func (m *Coin) XXX_Size() int

func (*Coin) XXX_Unmarshal 

func (m *Coin) XXX_Unmarshal(b []byte) error

type Coins 

type Coins []Coin

Coins is a set of Coin, one per currency

func NewCoins 

func NewCoins(coins ...Coin) Coins

NewCoins constructs a new coin set. The provided coins will be sanitized by removing zero coins and sorting the coin set. A panic will occur if the coin set is not valid.

func NormalizeCoins added in v0.40.0 

func NormalizeCoins(coins []DecCoin) Coins

NormalizeCoins normalize and truncate a list of decimal coins

func ParseCoinsNormalized added in v0.40.0 

func ParseCoinsNormalized(coinStr string) (Coins, error)

ParseCoinsNormalized will parse out a list of coins separated by commas, and normalize them by converting to the smallest unit. If the parsing is successful, the provided coins will be sanitized by removing zero coins and sorting the coin set. Lastly a validation of the coin set is executed. If the check passes, ParseCoinsNormalized will return the sanitized coins. Otherwise, it will return an error. If an empty string is provided to ParseCoinsNormalized, it returns nil Coins. ParseCoinsNormalized supports decimal coins as inputs, and truncate them to int after converted to the smallest unit. Expected format: "{amount0}{denomination},...,{amountN}{denominationN}"

func (Coins) Add 

func (coins Coins) Add(coinsB ...Coin) Coins

Add adds two sets of coins.

e.g. {2A} + {A, 2B} = {3A, 2B} {2A} + {0B} = {2A}

NOTE: Add operates under the invariant that coins are sorted by denominations.

CONTRACT: Add will never return Coins where one Coin has a non-positive amount. In otherwords, IsValid will always return true. The function panics if `coins` or `coinsB` are not sorted (ascending).

func (Coins) AmountOf 

func (coins Coins) AmountOf(denom string) math.Int

AmountOf returns the amount of a denom from coins

func (Coins) AmountOfNoDenomValidation added in v0.44.1 

func (coins Coins) AmountOfNoDenomValidation(denom string) math.Int

AmountOfNoDenomValidation returns the amount of a denom from coins without validating the denomination.

func (Coins) Denoms added in v0.47.0 

func (coins Coins) Denoms() []string

Denoms returns all denoms associated with a Coins object

func (Coins) DenomsSubsetOf 

func (coins Coins) DenomsSubsetOf(coinsB Coins) bool

DenomsSubsetOf returns true if receiver's denom set is subset of coinsB's denoms.

func (Coins) Empty 

func (coins Coins) Empty() bool

Empty returns true if there are no coins and false otherwise.

func (Coins) Equal added in v0.50.0 

func (coins Coins) Equal(coinsB Coins) bool

Equal returns true if the two sets of Coins have the same value

func (Coins) Find added in v0.46.0 

func (coins Coins) Find(denom string) (bool, Coin)

Find returns true and coin if the denom exists in coins. Otherwise it returns false and a zero coin. Uses binary search. CONTRACT: coins must be valid (sorted).

func (Coins) GetDenomByIndex 

func (coins Coins) GetDenomByIndex(i int) string

GetDenomByIndex returns the Denom of the certain coin to make the findDup generic

func (Coins) IsAllGT 

func (coins Coins) IsAllGT(coinsB Coins) bool

IsAllGT returns true if for every denom in coinsB, the denom is present at a greater amount in coins.

func (Coins) IsAllGTE 

func (coins Coins) IsAllGTE(coinsB Coins) bool

IsAllGTE returns false if for any denom in coinsB, the denom is present at a smaller amount in coins; else returns true.

func (Coins) IsAllLT 

func (coins Coins) IsAllLT(coinsB Coins) bool

IsAllLT returns True iff for every denom in coins, the denom is present at a smaller amount in coinsB.

func (Coins) IsAllLTE 

func (coins Coins) IsAllLTE(coinsB Coins) bool

IsAllLTE returns true iff for every denom in coins, the denom is present at a smaller or equal amount in coinsB.

func (Coins) IsAllPositive 

func (coins Coins) IsAllPositive() bool

IsAllPositive returns true if there is at least one coin and all currencies have a positive value.

func (Coins) IsAnyGT 

func (coins Coins) IsAnyGT(coinsB Coins) bool

IsAnyGT returns true iff for any denom in coins, the denom is present at a greater amount in coinsB.

e.g. {2A, 3B}.IsAnyGT{A} = true {2A, 3B}.IsAnyGT{5C} = false {}.IsAnyGT{5C} = false {2A, 3B}.IsAnyGT{} = false

func (Coins) IsAnyGTE 

func (coins Coins) IsAnyGTE(coinsB Coins) bool

IsAnyGTE returns true iff coins contains at least one denom that is present at a greater or equal amount in coinsB; it returns false otherwise.

NOTE: IsAnyGTE operates under the invariant that both coin sets are sorted by denominations and there exists no zero coins.

func (Coins) IsAnyNegative 

func (coins Coins) IsAnyNegative() bool

IsAnyNegative returns true if there is at least one coin whose amount is negative; returns false otherwise. It returns false if the coin set is empty too.

TODO: Remove once unsigned integers are used.

func (Coins) IsAnyNil added in v0.42.11 

func (coins Coins) IsAnyNil() bool

IsAnyNil returns true if there is at least one coin whose amount is nil; returns false otherwise. It returns false if the coin set is empty too.

func (Coins) IsValid 

func (coins Coins) IsValid() bool

IsValid calls Validate and returns true when the Coins are sorted, have positive amount, with a valid and unique denomination (i.e no duplicates).

func (Coins) IsZero 

func (coins Coins) IsZero() bool

IsZero returns true if there are no coins or all coins are zero.

func (Coins) Len 

func (coins Coins) Len() int

Len implements sort.Interface for Coins

func (Coins) Less 

func (coins Coins) Less(i, j int) bool

Less implements sort.Interface for Coins

func (Coins) MarshalJSON 

func (coins Coins) MarshalJSON() ([]byte, error)

MarshalJSON implements a custom JSON marshaller for the Coins type to allow nil Coins to be encoded as an empty array.

func (Coins) Max added in v0.45.2 

func (coins Coins) Max(coinsB Coins) Coins

Max takes two valid Coins inputs and returns a valid Coins result where for every denom D, AmountOf(D) of the result is the maximum of AmountOf(D) of the inputs. Note that the result might be not be equal to either input. For any valid Coins a, b, and c, the following are always true: 

a.IsAllLTE(a.Max(b))
b.IsAllLTE(a.Max(b))
a.IsAllLTE(c) && b.IsAllLTE(c) == a.Max(b).IsAllLTE(c)
a.Add(b...).Equal(a.Min(b).Add(a.Max(b)...))

E.g. {1A, 3B, 2C}.Max({4A, 2B, 2C} == {4A, 3B, 2C}) {2A, 3B}.Max({1B, 4C}) == {2A, 3B, 4C} {1A, 2B}.Max({}) == {1A, 2B}

func (Coins) Min added in v0.45.2 

func (coins Coins) Min(coinsB Coins) Coins

Min takes two valid Coins inputs and returns a valid Coins result where for every denom D, AmountOf(D) of the result is the minimum of AmountOf(D) of the inputs. Note that the result might be not be equal to either input. For any valid Coins a, b, and c, the following are always true: 

a.Min(b).IsAllLTE(a)
a.Min(b).IsAllLTE(b)
c.IsAllLTE(a) && c.IsAllLTE(b) == c.IsAllLTE(a.Min(b))
a.Add(b...).Equal(a.Min(b).Add(a.Max(b)...))

E.g. {1A, 3B, 2C}.Min({4A, 2B, 2C} == {1A, 2B, 2C}) {2A, 3B}.Min({1B, 4C}) == {1B} {1A, 2B}.Min({3C}) == empty

See also DecCoins.Intersect().

func (Coins) MulInt added in v0.46.0 

func (coins Coins) MulInt(x math.Int) Coins

MulInt performs the scalar multiplication of coins with a `multiplier` All coins are multiplied by x e.g. {2A, 3B} * 2 = {4A, 6B} {2A} * 0 panics Note, if IsValid was true on Coins, IsValid stays true.

func (Coins) QuoInt added in v0.46.0 

func (coins Coins) QuoInt(x math.Int) Coins

QuoInt performs the scalar division of coins with a `divisor` All coins are divided by x and truncated. e.g. {2A, 30B} / 2 = {1A, 15B} {2A} / 2 = {1A} {4A} / {8A} = {0A} {2A} / 0 = panics Note, if IsValid was true on Coins, IsValid stays true, unless the `divisor` is greater than the smallest coin amount.

func (Coins) SafeMulInt added in v0.46.0 

func (coins Coins) SafeMulInt(x math.Int) (Coins, bool)

SafeMulInt performs the same arithmetic as MulInt but returns false if the `multiplier` is zero because it makes IsValid return false.

func (Coins) SafeQuoInt added in v0.46.0 

func (coins Coins) SafeQuoInt(x math.Int) (Coins, bool)

SafeQuoInt performs the same arithmetic as QuoInt but returns an error if the division cannot be done.

func (Coins) SafeSub 

func (coins Coins) SafeSub(coinsB ...Coin) (Coins, bool)

SafeSub performs the same arithmetic as Sub but returns a boolean if any negative coin amount was returned. The function panics if `coins` or `coinsB` are not sorted (ascending).

func (Coins) Sort 

func (coins Coins) Sort() Coins

Sort is a helper function to sort the set of coins in-place

func (Coins) String 

func (coins Coins) String() string

func (Coins) Sub 

func (coins Coins) Sub(coinsB ...Coin) Coins

Sub subtracts a set of coins from another.

e.g. {2A, 3B} - {A} = {A, 3B} {2A} - {0B} = {2A} {A, B} - {A} = {B}

CONTRACT: Sub will never return Coins where one Coin has a non-positive amount. In otherwords, IsValid will always return true.

func (Coins) Swap 

func (coins Coins) Swap(i, j int)

Swap implements sort.Interface for Coins

func (Coins) Validate added in v0.40.0 

func (coins Coins) Validate() error

Validate checks that the Coins are sorted, have positive amount, with a valid and unique denomination (i.e no duplicates). Otherwise, it returns an error.

type Config 

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

Config is the structure that holds the SDK configuration parameters. This could be used to initialize certain configuration parameters for the SDK.

func GetConfig 

func GetConfig() *Config

GetConfig returns the config instance for the SDK.

func GetSealedConfig 

func GetSealedConfig(ctx context.Context) (*Config, error)

GetSealedConfig returns the config instance for the SDK if/once it is sealed.

func NewConfig 

func NewConfig() *Config

New returns a new Config with default values.

func (*Config) GetAddressVerifier 

func (config *Config) GetAddressVerifier() func([]byte) error

GetAddressVerifier returns the function to verify that addresses have the correct format

func (*Config) GetBech32AccountAddrPrefix 

func (config *Config) GetBech32AccountAddrPrefix() string

GetBech32AccountAddrPrefix returns the Bech32 prefix for account address

func (*Config) GetBech32AccountPubPrefix 

func (config *Config) GetBech32AccountPubPrefix() string

GetBech32AccountPubPrefix returns the Bech32 prefix for account public key

func (*Config) GetBech32ConsensusAddrPrefix 

func (config *Config) GetBech32ConsensusAddrPrefix() string

GetBech32ConsensusAddrPrefix returns the Bech32 prefix for consensus node address

func (*Config) GetBech32ConsensusPubPrefix 

func (config *Config) GetBech32ConsensusPubPrefix() string

GetBech32ConsensusPubPrefix returns the Bech32 prefix for consensus node public key

func (*Config) GetBech32ValidatorAddrPrefix 

func (config *Config) GetBech32ValidatorAddrPrefix() string

GetBech32ValidatorAddrPrefix returns the Bech32 prefix for validator address

func (*Config) GetBech32ValidatorPubPrefix 

func (config *Config) GetBech32ValidatorPubPrefix() string

GetBech32ValidatorPubPrefix returns the Bech32 prefix for validator public key

func (*Config) GetCoinType 

func (config *Config) GetCoinType() uint32

GetCoinType returns the BIP-0044 CoinType code on the config.

func (*Config) GetFullBIP44Path added in v0.43.0 

func (config *Config) GetFullBIP44Path() string

GetFullBIP44Path returns the BIP44Prefix.

func (*Config) GetFullFundraiserPath deprecated 

func (config *Config) GetFullFundraiserPath() string

GetFullFundraiserPath returns the BIP44Prefix.

Deprecated: This method is supported for backward compatibility only and will be removed in a future release. Use GetFullBIP44Path instead.

func (*Config) GetPurpose added in v0.43.0 

func (config *Config) GetPurpose() uint32

GetPurpose returns the BIP-0044 Purpose code on the config.

func (*Config) GetTxEncoder 

func (config *Config) GetTxEncoder() TxEncoder

GetTxEncoder return function to encode transactions

func (*Config) Seal 

func (config *Config) Seal() *Config

Seal seals the config such that the config state could not be modified further

func (*Config) SetAddressVerifier 

func (config *Config) SetAddressVerifier(addressVerifier func([]byte) error)

SetAddressVerifier builds the Config with the provided function for verifying that addresses have the correct format

func (*Config) SetBech32PrefixForAccount 

func (config *Config) SetBech32PrefixForAccount(addressPrefix, pubKeyPrefix string)

SetBech32PrefixForAccount builds the Config with Bech32 addressPrefix and publKeyPrefix for accounts and returns the config instance

func (*Config) SetBech32PrefixForConsensusNode 

func (config *Config) SetBech32PrefixForConsensusNode(addressPrefix, pubKeyPrefix string)

SetBech32PrefixForConsensusNode builds the Config with Bech32 addressPrefix and publKeyPrefix for consensus nodes and returns the config instance

func (*Config) SetBech32PrefixForValidator 

func (config *Config) SetBech32PrefixForValidator(addressPrefix, pubKeyPrefix string)

SetBech32PrefixForValidator builds the Config with Bech32 addressPrefix and publKeyPrefix for validators 

and returns the config instance

func (*Config) SetCoinType 

func (config *Config) SetCoinType(coinType uint32)

Set the BIP-0044 CoinType code on the config

func (*Config) SetFullFundraiserPath deprecated 

func (config *Config) SetFullFundraiserPath(fullFundraiserPath string)

Set the FullFundraiserPath (BIP44Prefix) on the config.

Deprecated: This method is supported for backward compatibility only and will be removed in a future release. Use SetPurpose and SetCoinType instead.

func (*Config) SetPurpose added in v0.43.0 

func (config *Config) SetPurpose(purpose uint32)

Set the BIP-0044 Purpose code on the config

func (*Config) SetTxEncoder 

func (config *Config) SetTxEncoder(encoder TxEncoder)

SetTxEncoder builds the Config with TxEncoder used to marshal StdTx to bytes

type ConsAddress 

type ConsAddress []byte

ConsAddress defines a wrapper around bytes meant to present a consensus node. When marshaled to a string or JSON, it uses Bech32.

func ConsAddressFromBech32 

func ConsAddressFromBech32(address string) (addr ConsAddress, err error)

ConsAddressFromBech32 creates a ConsAddress from a Bech32 string.

func ConsAddressFromHex 

func ConsAddressFromHex(address string) (addr ConsAddress, err error)

ConsAddressFromHex creates a ConsAddress from a hex string. Deprecated: use ConsensusAddressCodec from Staking keeper

func GetConsAddress 

func GetConsAddress(pubkey cryptotypes.PubKey) ConsAddress

get ConsAddress from pubkey

func (ConsAddress) Bytes 

func (ca ConsAddress) Bytes() []byte

Bytes returns the raw address bytes.

func (ConsAddress) Empty 

func (ca ConsAddress) Empty() bool

Returns boolean for whether an ConsAddress is empty

func (ConsAddress) Equals 

func (ca ConsAddress) Equals(ca2 Address) bool

Returns boolean for whether two ConsAddress are Equal

func (ConsAddress) Format 

func (ca ConsAddress) Format(s fmt.State, verb rune)

func (ConsAddress) Marshal 

func (ca ConsAddress) Marshal() ([]byte, error)

Marshal returns the raw address bytes. It is needed for protobuf compatibility.

func (ConsAddress) MarshalJSON 

func (ca ConsAddress) MarshalJSON() ([]byte, error)

MarshalJSON marshals to JSON using Bech32.

func (ConsAddress) MarshalYAML 

func (ca ConsAddress) MarshalYAML() (interface{}, error)

MarshalYAML marshals to YAML using Bech32.

func (ConsAddress) String 

func (ca ConsAddress) String() string

String implements the Stringer interface.

func (*ConsAddress) Unmarshal 

func (ca *ConsAddress) Unmarshal(data []byte) error

Unmarshal sets the address to the given data. It is needed for protobuf compatibility.

func (*ConsAddress) UnmarshalJSON 

func (ca *ConsAddress) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals from JSON assuming Bech32 encoding.

func (*ConsAddress) UnmarshalYAML 

func (ca *ConsAddress) UnmarshalYAML(data []byte) error

UnmarshalYAML unmarshals from YAML assuming Bech32 encoding.

type Context 

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

Context is an immutable object contains all information needed to process a request.

It contains a context.Context object inside if you want to use that, but please do not over-use it. We try to keep all data structured and standard additions here would be better just to add to the Context struct

func NewContext 

func NewContext(ms storetypes.MultiStore, header cmtproto.Header, isCheckTx bool, logger log.Logger) Context

create a new context

func UnwrapSDKContext added in v0.40.0 

func UnwrapSDKContext(ctx context.Context) Context

UnwrapSDKContext retrieves a Context from a context.Context instance attached with WrapSDKContext. It panics if a Context was not properly attached

func (Context) BlockGasMeter 

func (c Context) BlockGasMeter() storetypes.GasMeter

func (Context) BlockHeader 

func (c Context) BlockHeader() cmtproto.Header

clone the header before returning

func (Context) BlockHeight 

func (c Context) BlockHeight() int64

func (Context) BlockTime 

func (c Context) BlockTime() time.Time

func (Context) CacheContext 

func (c Context) CacheContext() (cc Context, writeCache func())

CacheContext returns a new Context with the multi-store cached and a new EventManager. The cached context is written to the context when writeCache is called. Note, events are automatically emitted on the parent context's EventManager when the caller executes the write.

func (Context) ChainID 

func (c Context) ChainID() string

func (Context) CometInfo added in v0.50.0 

func (c Context) CometInfo() comet.BlockInfo

func (Context) ConsensusParams 

func (c Context) ConsensusParams() cmtproto.ConsensusParams

func (Context) Context 

func (c Context) Context() context.Context

Read-only accessors

func (Context) Deadline added in v0.46.0 

func (c Context) Deadline() (deadline time.Time, ok bool)

func (Context) Done added in v0.46.0 

func (c Context) Done() <-chan struct{}

func (Context) Err added in v0.46.0 

func (c Context) Err() error

func (Context) EventManager 

func (c Context) EventManager() EventManagerI

func (Context) ExecMode added in v0.50.0 

func (c Context) ExecMode() ExecMode

func (Context) GasMeter 

func (c Context) GasMeter() storetypes.GasMeter

func (Context) HeaderHash added in v0.42.6 

func (c Context) HeaderHash() []byte

HeaderHash returns a copy of the header hash obtained during abci.RequestBeginBlock

func (Context) HeaderInfo added in v0.50.0 

func (c Context) HeaderInfo() header.Info

func (Context) IsCheckTx 

func (c Context) IsCheckTx() bool

func (Context) IsReCheckTx 

func (c Context) IsReCheckTx() bool

func (Context) IsZero 

func (c Context) IsZero() bool

TODO: remove???

func (Context) KVGasConfig added in v0.46.5 

func (c Context) KVGasConfig() storetypes.GasConfig

func (Context) KVStore 

func (c Context) KVStore(key storetypes.StoreKey) storetypes.KVStore

KVStore fetches a KVStore from the MultiStore.

func (Context) Logger 

func (c Context) Logger() log.Logger

func (Context) MinGasPrices 

func (c Context) MinGasPrices() DecCoins

func (Context) MultiStore 

func (c Context) MultiStore() storetypes.MultiStore

func (Context) Priority added in v0.46.0 

func (c Context) Priority() int64

func (Context) StreamingManager added in v0.50.0 

func (c Context) StreamingManager() storetypes.StreamingManager

func (Context) TransientKVGasConfig added in v0.46.5 

func (c Context) TransientKVGasConfig() storetypes.GasConfig

func (Context) TransientStore 

func (c Context) TransientStore(key storetypes.StoreKey) storetypes.KVStore

TransientStore fetches a TransientStore from the MultiStore.

func (Context) TxBytes 

func (c Context) TxBytes() []byte

func (Context) Value 

func (c Context) Value(key interface{}) interface{}

func (Context) VoteInfos 

func (c Context) VoteInfos() []abci.VoteInfo

func (Context) WithBlockGasMeter 

func (c Context) WithBlockGasMeter(meter storetypes.GasMeter) Context

WithBlockGasMeter returns a Context with an updated block GasMeter

func (Context) WithBlockHeader 

func (c Context) WithBlockHeader(header cmtproto.Header) Context

WithBlockHeader returns a Context with an updated CometBFT block header in UTC time.

func (Context) WithBlockHeight 

func (c Context) WithBlockHeight(height int64) Context

WithBlockHeight returns a Context with an updated block height.

func (Context) WithBlockTime 

func (c Context) WithBlockTime(newTime time.Time) Context

WithBlockTime returns a Context with an updated CometBFT block header time in UTC with no monotonic component. Stripping the monotonic component is for time equality.

func (Context) WithChainID 

func (c Context) WithChainID(chainID string) Context

WithChainID returns a Context with an updated chain identifier.

func (Context) WithCometInfo added in v0.50.0 

func (c Context) WithCometInfo(cometInfo comet.BlockInfo) Context

WithCometInfo returns a Context with an updated comet info

func (Context) WithConsensusParams 

func (c Context) WithConsensusParams(params cmtproto.ConsensusParams) Context

WithConsensusParams returns a Context with an updated consensus params

func (Context) WithContext 

func (c Context) WithContext(ctx context.Context) Context

WithContext returns a Context with an updated context.Context.

func (Context) WithEventManager 

func (c Context) WithEventManager(em EventManagerI) Context

WithEventManager returns a Context with an updated event manager

func (Context) WithExecMode added in v0.50.0 

func (c Context) WithExecMode(m ExecMode) Context

WithExecMode returns a Context with an updated ExecMode.

func (Context) WithGasMeter 

func (c Context) WithGasMeter(meter storetypes.GasMeter) Context

WithGasMeter returns a Context with an updated transaction GasMeter.

func (Context) WithHeaderHash added in v0.42.6 

func (c Context) WithHeaderHash(hash []byte) Context

WithHeaderHash returns a Context with an updated CometBFT block header hash.

func (Context) WithHeaderInfo added in v0.50.0 

func (c Context) WithHeaderInfo(headerInfo header.Info) Context

WithHeaderInfo returns a Context with an updated header info

func (Context) WithIsCheckTx 

func (c Context) WithIsCheckTx(isCheckTx bool) Context

WithIsCheckTx enables or disables CheckTx value for verifying transactions and returns an updated Context

func (Context) WithIsReCheckTx 

func (c Context) WithIsReCheckTx(isRecheckTx bool) Context

WithIsRecheckTx called with true will also set true on checkTx in order to enforce the invariant that if recheckTx = true then checkTx = true as well.

func (Context) WithKVGasConfig added in v0.46.5 

func (c Context) WithKVGasConfig(gasConfig storetypes.GasConfig) Context

WithKVGasConfig returns a Context with an updated gas configuration for the KVStore

func (Context) WithLogger 

func (c Context) WithLogger(logger log.Logger) Context

WithLogger returns a Context with an updated logger.

func (Context) WithMinGasPrices 

func (c Context) WithMinGasPrices(gasPrices DecCoins) Context

WithMinGasPrices returns a Context with an updated minimum gas price value

func (Context) WithMultiStore 

func (c Context) WithMultiStore(ms storetypes.MultiStore) Context

WithMultiStore returns a Context with an updated MultiStore.

func (Context) WithPriority added in v0.46.0 

func (c Context) WithPriority(p int64) Context

WithPriority returns a Context with an updated tx priority

func (Context) WithProposer 

func (c Context) WithProposer(addr ConsAddress) Context

WithProposer returns a Context with an updated proposer consensus address.

func (Context) WithStreamingManager added in v0.50.0 

func (c Context) WithStreamingManager(sm storetypes.StreamingManager) Context

WithStreamingManager returns a Context with an updated streaming manager

func (Context) WithTransientKVGasConfig added in v0.46.5 

func (c Context) WithTransientKVGasConfig(gasConfig storetypes.GasConfig) Context

WithTransientKVGasConfig returns a Context with an updated gas configuration for the transient KVStore

func (Context) WithTxBytes 

func (c Context) WithTxBytes(txBytes []byte) Context

WithTxBytes returns a Context with an updated txBytes.

func (Context) WithValue 

func (c Context) WithValue(key, value interface{}) Context

func (Context) WithVoteInfos 

func (c Context) WithVoteInfos(voteInfo []abci.VoteInfo) Context

WithVoteInfos returns a Context with an updated consensus VoteInfo.

type ContextKey added in v0.40.0 

type ContextKey string

ContextKey defines a type alias for a stdlib Context key. 

const SdkContextKey ContextKey = "sdk-context"

SdkContextKey is the key in the context.Context which holds the sdk.Context.

type CustomProtobufType 

type CustomProtobufType interface {
	Marshal() ([]byte, error)
	MarshalTo(data []byte) (n int, err error)
	Unmarshal(data []byte) error
	Size() int

	MarshalJSON() ([]byte, error)
	UnmarshalJSON(data []byte) error
}

CustomProtobufType defines the interface custom gogo proto types must implement in order to be used as a "customtype" extension.

ref: https://github.com/cosmos/gogoproto/blob/master/custom_types.md

type DecCoin 

type DecCoin struct {
	Denom  string                      `protobuf:"bytes,1,opt,name=denom,proto3" json:"denom,omitempty"`
	Amount cosmossdk_io_math.LegacyDec `protobuf:"bytes,2,opt,name=amount,proto3,customtype=cosmossdk.io/math.LegacyDec" json:"amount"`
}

DecCoin defines a token with a denomination and a decimal amount.

NOTE: The amount field is an Dec which implements the custom method signatures required by gogoproto.

func ConvertDecCoin added in v0.40.0 

func ConvertDecCoin(coin DecCoin, denom string) (DecCoin, error)

ConvertDecCoin attempts to convert a decimal coin to a given denomination. If the given denomination is invalid or if neither denomination is registered, an error is returned.

func NewDecCoin 

func NewDecCoin(denom string, amount math.Int) DecCoin

NewDecCoin creates a new DecCoin instance from an Int.

func NewDecCoinFromCoin 

func NewDecCoinFromCoin(coin Coin) DecCoin

NewDecCoinFromCoin creates a new DecCoin from a Coin.

func NewDecCoinFromDec 

func NewDecCoinFromDec(denom string, amount math.LegacyDec) DecCoin

NewDecCoinFromDec creates a new DecCoin instance from a Dec.

func NewInt64DecCoin 

func NewInt64DecCoin(denom string, amount int64) DecCoin

NewInt64DecCoin returns a new DecCoin with a denomination and amount. It will panic if the amount is negative or denom is invalid.

func NormalizeDecCoin added in v0.40.0 

func NormalizeDecCoin(coin DecCoin) DecCoin

NormalizeDecCoin try to convert a decimal coin to the smallest unit registered, returns original one if failed.

func ParseDecCoin 

func ParseDecCoin(coinStr string) (coin DecCoin, err error)

ParseDecCoin parses a decimal coin from a string, returning an error if invalid. An empty string is considered invalid.

func (DecCoin) Add 

func (coin DecCoin) Add(coinB DecCoin) DecCoin

Add adds amounts of two decimal coins with same denom.

func (*DecCoin) Descriptor 

func (*DecCoin) Descriptor() ([]byte, []int)

func (*DecCoin) Equal 

func (this *DecCoin) Equal(that interface{}) bool

func (*DecCoin) GetDenom 

func (m *DecCoin) GetDenom() string

func (DecCoin) IsEqual 

func (coin DecCoin) IsEqual(other DecCoin) bool

IsEqual returns true if the two sets of Coins have the same value. Deprecated: Use DecCoin.Equal instead.

func (DecCoin) IsGTE 

func (coin DecCoin) IsGTE(other DecCoin) bool

IsGTE returns true if they are the same type and the receiver is an equal or greater value.

func (DecCoin) IsLT 

func (coin DecCoin) IsLT(other DecCoin) bool

IsLT returns true if they are the same type and the receiver is a smaller value.

func (DecCoin) IsNegative 

func (coin DecCoin) IsNegative() bool

IsNegative returns true if the coin amount is negative and false otherwise.

TODO: Remove once unsigned integers are used.

func (DecCoin) IsPositive 

func (coin DecCoin) IsPositive() bool

IsPositive returns true if coin amount is positive.

TODO: Remove once unsigned integers are used.

func (DecCoin) IsValid 

func (coin DecCoin) IsValid() bool

IsValid returns true if the DecCoin has a non-negative amount and the denom is valid.

func (DecCoin) IsZero 

func (coin DecCoin) IsZero() bool

IsZero returns if the DecCoin amount is zero.

func (*DecCoin) Marshal 

func (m *DecCoin) Marshal() (dAtA []byte, err error)

func (*DecCoin) MarshalTo 

func (m *DecCoin) MarshalTo(dAtA []byte) (int, error)

func (*DecCoin) MarshalToSizedBuffer 

func (m *DecCoin) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DecCoin) ProtoMessage 

func (*DecCoin) ProtoMessage()

func (*DecCoin) Reset 

func (m *DecCoin) Reset()

func (*DecCoin) Size 

func (m *DecCoin) Size() (n int)

func (DecCoin) String 

func (coin DecCoin) String() string

String implements the Stringer interface for DecCoin. It returns a human-readable representation of a decimal coin.

func (DecCoin) Sub 

func (coin DecCoin) Sub(coinB DecCoin) DecCoin

Sub subtracts amounts of two decimal coins with same denom.

func (DecCoin) TruncateDecimal 

func (coin DecCoin) TruncateDecimal() (Coin, DecCoin)

TruncateDecimal returns a Coin with a truncated decimal and a DecCoin for the change. Note, the change may be zero.

func (*DecCoin) Unmarshal 

func (m *DecCoin) Unmarshal(dAtA []byte) error

func (DecCoin) Validate added in v0.40.0 

func (coin DecCoin) Validate() error

Validate returns an error if the DecCoin has a negative amount or if the denom is invalid.

func (*DecCoin) XXX_DiscardUnknown 

func (m *DecCoin) XXX_DiscardUnknown()

func (*DecCoin) XXX_Marshal 

func (m *DecCoin) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DecCoin) XXX_Merge 

func (m *DecCoin) XXX_Merge(src proto.Message)

func (*DecCoin) XXX_Size 

func (m *DecCoin) XXX_Size() int

func (*DecCoin) XXX_Unmarshal 

func (m *DecCoin) XXX_Unmarshal(b []byte) error

type DecCoins 

type DecCoins []DecCoin

DecCoins defines a slice of coins with decimal values

func NewDecCoins 

func NewDecCoins(decCoins ...DecCoin) DecCoins

NewDecCoins constructs a new coin set with with decimal values from DecCoins. The provided coins will be sanitized by removing zero coins and sorting the coin set. A panic will occur if the coin set is not valid.

func NewDecCoinsFromCoins 

func NewDecCoinsFromCoins(coins ...Coin) DecCoins

NewDecCoinsFromCoins constructs a new coin set with decimal values from regular Coins.

func ParseDecCoins 

func ParseDecCoins(coinsStr string) (DecCoins, error)

ParseDecCoins will parse out a list of decimal coins separated by commas. If the parsing is successuful, the provided coins will be sanitized by removing zero coins and sorting the coin set. Lastly a validation of the coin set is executed. If the check passes, ParseDecCoins will return the sanitized coins. Otherwise it will return an error. If an empty string is provided to ParseDecCoins, it returns nil Coins. Expected format: "{amount0}{denomination},...,{amountN}{denominationN}"

func (DecCoins) Add 

func (coins DecCoins) Add(coinsB ...DecCoin) DecCoins

Add adds two sets of DecCoins.

NOTE: Add operates under the invariant that coins are sorted by denominations.

CONTRACT: Add will never return Coins where one Coin has a non-positive amount. In otherwords, IsValid will always return true.

func (DecCoins) AmountOf 

func (coins DecCoins) AmountOf(denom string) math.LegacyDec

AmountOf returns the amount of a denom from deccoins

func (DecCoins) Empty 

func (coins DecCoins) Empty() bool

Empty returns true if there are no coins and false otherwise.

func (DecCoins) Equal added in v0.50.0 

func (coins DecCoins) Equal(coinsB DecCoins) bool

Equal returns true if the two sets of DecCoins have the same value.

func (DecCoins) GetDenomByIndex 

func (coins DecCoins) GetDenomByIndex(i int) string

GetDenomByIndex returns the Denom to make the findDup generic

func (DecCoins) Intersect 

func (coins DecCoins) Intersect(coinsB DecCoins) DecCoins

Intersect will return a new set of coins which contains the minimum DecCoin for common denoms found in both `coins` and `coinsB`. For denoms not common to both `coins` and `coinsB` the minimum is considered to be 0, thus they are not added to the final set. In other words, trim any denom amount from coin which exceeds that of coinB, such that (coin.Intersect(coinB)).IsLTE(coinB). See also Coins.Min().

func (DecCoins) IsAllPositive 

func (coins DecCoins) IsAllPositive() bool

IsAllPositive returns true if there is at least one coin and all currencies have a positive value.

TODO: Remove once unsigned integers are used.

func (DecCoins) IsAnyNegative 

func (coins DecCoins) IsAnyNegative() bool

IsAnyNegative returns true if there is at least one coin whose amount is negative; returns false otherwise. It returns false if the DecCoins set is empty too.

TODO: Remove once unsigned integers are used.

func (DecCoins) IsValid 

func (coins DecCoins) IsValid() bool

IsValid calls Validate and returns true when the DecCoins are sorted, have positive amount, with a valid and unique denomination (i.e no duplicates).

func (DecCoins) IsZero 

func (coins DecCoins) IsZero() bool

IsZero returns whether all coins are zero

func (DecCoins) Len 

func (coins DecCoins) Len() int

Len implements sort.Interface for DecCoins

func (DecCoins) Less 

func (coins DecCoins) Less(i, j int) bool

Less implements sort.Interface for DecCoins

func (DecCoins) MulDec 

func (coins DecCoins) MulDec(d math.LegacyDec) DecCoins

MulDec multiplies all the coins by a decimal.

CONTRACT: No zero coins will be returned.

func (DecCoins) MulDecTruncate 

func (coins DecCoins) MulDecTruncate(d math.LegacyDec) DecCoins

MulDecTruncate multiplies all the decimal coins by a decimal, truncating. It returns nil DecCoins if d is zero.

CONTRACT: No zero coins will be returned.

func (DecCoins) QuoDec 

func (coins DecCoins) QuoDec(d math.LegacyDec) DecCoins

QuoDec divides all the decimal coins by a decimal. It panics if d is zero.

CONTRACT: No zero coins will be returned.

func (DecCoins) QuoDecTruncate 

func (coins DecCoins) QuoDecTruncate(d math.LegacyDec) DecCoins

QuoDecTruncate divides all the decimal coins by a decimal, truncating. It panics if d is zero.

CONTRACT: No zero coins will be returned.

func (DecCoins) SafeSub 

func (coins DecCoins) SafeSub(coinsB DecCoins) (DecCoins, bool)

SafeSub performs the same arithmetic as Sub but returns a boolean if any negative coin amount was returned.

func (DecCoins) Sort 

func (coins DecCoins) Sort() DecCoins

Sort is a helper function to sort the set of decimal coins in-place.

func (DecCoins) String 

func (coins DecCoins) String() string

String implements the Stringer interface for DecCoins. It returns a human-readable representation of decimal coins.

func (DecCoins) Sub 

func (coins DecCoins) Sub(coinsB DecCoins) DecCoins

Sub subtracts a set of DecCoins from another (adds the inverse).

func (DecCoins) Swap 

func (coins DecCoins) Swap(i, j int)

Swap implements sort.Interface for DecCoins

func (DecCoins) TruncateDecimal 

func (coins DecCoins) TruncateDecimal() (truncatedCoins Coins, changeCoins DecCoins)

TruncateDecimal returns the coins with truncated decimals and returns the change. Note, it will not return any zero-amount coins in either the truncated or change coins.

func (DecCoins) Validate added in v0.40.0 

func (coins DecCoins) Validate() error

Validate checks that the DecCoins are sorted, have positive amount, with a valid and unique denomination (i.e no duplicates). Otherwise, it returns an error.

type DecProto 

type DecProto struct {
	Dec cosmossdk_io_math.LegacyDec `protobuf:"bytes,1,opt,name=dec,proto3,customtype=cosmossdk.io/math.LegacyDec" json:"dec"`
}

DecProto defines a Protobuf wrapper around a Dec object. Deprecated: Prefer to use math.LegacyDec directly. It supports binary Marshal and Unmarshal.

func (*DecProto) Descriptor 

func (*DecProto) Descriptor() ([]byte, []int)

func (*DecProto) Marshal 

func (m *DecProto) Marshal() (dAtA []byte, err error)

func (*DecProto) MarshalTo 

func (m *DecProto) MarshalTo(dAtA []byte) (int, error)

func (*DecProto) MarshalToSizedBuffer 

func (m *DecProto) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DecProto) ProtoMessage 

func (*DecProto) ProtoMessage()

func (*DecProto) Reset 

func (m *DecProto) Reset()

func (*DecProto) Size 

func (m *DecProto) Size() (n int)

func (DecProto) String 

func (dp DecProto) String() string

func (*DecProto) Unmarshal 

func (m *DecProto) Unmarshal(dAtA []byte) error

func (*DecProto) XXX_DiscardUnknown 

func (m *DecProto) XXX_DiscardUnknown()

func (*DecProto) XXX_Marshal 

func (m *DecProto) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DecProto) XXX_Merge 

func (m *DecProto) XXX_Merge(src proto.Message)

func (*DecProto) XXX_Size 

func (m *DecProto) XXX_Size() int

func (*DecProto) XXX_Unmarshal 

func (m *DecProto) XXX_Unmarshal(b []byte) error

type EndBlock added in v0.50.0 

type EndBlock struct {
	ValidatorUpdates []abci.ValidatorUpdate
	Events           []abci.Event
}

EndBlock defines a type which contains endblock events and validator set updates

type EndBlocker 

type EndBlocker func(Context) (EndBlock, error)

EndBlocker defines a function type alias for executing application business logic after transactions are executed but before committing.

Note: The EndBlock ABCI method no longer exists in the ABCI specification as of CometBFT v0.38.0. This function type alias is provided for backwards compatibility with applications that still use the EndBlock ABCI method and allows for existing EndBlock functionality within applications.

type Event 

type Event abci.Event

Event is a type alias for an ABCI Event

func NewEvent 

func NewEvent(ty string, attrs ...Attribute) Event

NewEvent creates a new Event object with a given type and slice of one or more attributes.

func TypedEventToEvent added in v0.40.0 

func TypedEventToEvent(tev proto.Message) (Event, error)

TypedEventToEvent takes typed event and converts to Event object

func (Event) AppendAttributes 

func (e Event) AppendAttributes(attrs ...Attribute) Event

AppendAttributes adds one or more attributes to an Event.

func (Event) GetAttribute added in v0.47.0 

func (e Event) GetAttribute(key string) (Attribute, bool)

GetAttribute returns an attribute for a given key present in an event. If the key is not found, the boolean value will be false.

type EventManager 

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

EventManager implements a simple wrapper around a slice of Event objects that can be emitted from.

func NewEventManager 

func NewEventManager() *EventManager

func (EventManager) ABCIEvents 

func (em EventManager) ABCIEvents() []abci.Event

ABCIEvents returns all stored Event objects as abci.Event objects.

func (*EventManager) EmitEvent 

func (em *EventManager) EmitEvent(event Event)

EmitEvent stores a single Event object. Deprecated: Use EmitTypedEvent

func (*EventManager) EmitEvents 

func (em *EventManager) EmitEvents(events Events)

EmitEvents stores a series of Event objects. Deprecated: Use EmitTypedEvents

func (*EventManager) EmitTypedEvent added in v0.40.0 

func (em *EventManager) EmitTypedEvent(tev proto.Message) error

EmitTypedEvent takes typed event and emits converting it into Event

func (*EventManager) EmitTypedEvents added in v0.40.0 

func (em *EventManager) EmitTypedEvents(tevs ...proto.Message) error

EmitTypedEvents takes series of typed events and emit

func (*EventManager) Events 

func (em *EventManager) Events() Events

type EventManagerI added in v0.50.0 

type EventManagerI interface {
	Events() Events
	ABCIEvents() []abci.Event
	EmitTypedEvent(tev proto.Message) error
	EmitTypedEvents(tevs ...proto.Message) error
	EmitEvent(event Event)
	EmitEvents(events Events)
}

type Events 

type Events []Event

Events defines a slice of Event objects

func EmptyEvents 

func EmptyEvents() Events

EmptyEvents returns an empty slice of events.

func (Events) AppendEvent 

func (e Events) AppendEvent(event Event) Events

AppendEvent adds an Event to a slice of events.

func (Events) AppendEvents 

func (e Events) AppendEvents(events Events) Events

AppendEvents adds a slice of Event objects to an exist slice of Event objects.

func (Events) GetAttributes added in v0.47.0 

func (e Events) GetAttributes(key string) ([]Attribute, bool)

GetAttributes returns all attributes matching a given key present in events. If the key is not found, the boolean value will be false.

func (Events) ToABCIEvents 

func (e Events) ToABCIEvents() []abci.Event

ToABCIEvents converts a slice of Event objects to a slice of abci.Event objects.

type ExecMode added in v0.50.0 

type ExecMode uint8

ExecMode defines the execution mode which can be set on a Context. 

const (
	ExecModeCheck ExecMode = iota
	ExecModeReCheck
	ExecModeSimulate
	ExecModePrepareProposal
	ExecModeProcessProposal
	ExecModeVoteExtension
	ExecModeVerifyVoteExtension
	ExecModeFinalize
)

All possible execution modes.

type ExtendVoteHandler added in v0.50.0 

type ExtendVoteHandler func(Context, *abci.RequestExtendVote) (*abci.ResponseExtendVote, error)

ExtendVoteHandler defines a function type alias for extending a pre-commit vote.

type Fee 

type Fee interface {
	GetGas() uint64
	GetAmount() Coins
}

Fee defines an interface for an application application-defined concrete transaction type to be able to set and return the transaction fee.

type FeeTx added in v0.40.0 

type FeeTx interface {
	Tx
	GetGas() uint64
	GetFee() Coins
	FeePayer() []byte
	FeeGranter() []byte
}

FeeTx defines the interface to be implemented by Tx to use the FeeDecorators

type GasInfo 

type GasInfo struct {
	// GasWanted is the maximum units of work we allow this tx to perform.
	GasWanted uint64 `protobuf:"varint,1,opt,name=gas_wanted,json=gasWanted,proto3" json:"gas_wanted,omitempty"`
	// GasUsed is the amount of gas actually consumed.
	GasUsed uint64 `protobuf:"varint,2,opt,name=gas_used,json=gasUsed,proto3" json:"gas_used,omitempty"`
}

GasInfo defines tx execution gas context.

func (*GasInfo) Descriptor 

func (*GasInfo) Descriptor() ([]byte, []int)

func (*GasInfo) GetGasUsed 

func (m *GasInfo) GetGasUsed() uint64

func (*GasInfo) GetGasWanted 

func (m *GasInfo) GetGasWanted() uint64

func (*GasInfo) Marshal 

func (m *GasInfo) Marshal() (dAtA []byte, err error)

func (*GasInfo) MarshalTo 

func (m *GasInfo) MarshalTo(dAtA []byte) (int, error)

func (*GasInfo) MarshalToSizedBuffer 

func (m *GasInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*GasInfo) ProtoMessage 

func (*GasInfo) ProtoMessage()

func (*GasInfo) Reset 

func (m *GasInfo) Reset()

func (*GasInfo) Size 

func (m *GasInfo) Size() (n int)

func (GasInfo) String 

func (gi GasInfo) String() string

func (*GasInfo) Unmarshal 

func (m *GasInfo) Unmarshal(dAtA []byte) error

func (*GasInfo) XXX_DiscardUnknown 

func (m *GasInfo) XXX_DiscardUnknown()

func (*GasInfo) XXX_Marshal 

func (m *GasInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GasInfo) XXX_Merge 

func (m *GasInfo) XXX_Merge(src proto.Message)

func (*GasInfo) XXX_Size 

func (m *GasInfo) XXX_Size() int

func (*GasInfo) XXX_Unmarshal 

func (m *GasInfo) XXX_Unmarshal(b []byte) error

type HasMsgs added in v0.50.0 

type HasMsgs interface {
	// GetMsgs gets the all the transaction's messages.
	GetMsgs() []Msg
}

HasMsgs defines an interface a transaction must fulfill.

type HasValidateBasic added in v0.50.0 

type HasValidateBasic interface {
	// ValidateBasic does a simple validation check that
	// doesn't require access to any other information.
	ValidateBasic() error
}

HasValidateBasic defines a type that has a ValidateBasic method. ValidateBasic is deprecated and now facultative. Prefer validating messages directly in the msg server.

type InitChainer 

type InitChainer func(ctx Context, req *abci.RequestInitChain) (*abci.ResponseInitChain, error)

InitChainer initializes application state at genesis

type IntProto 

type IntProto struct {
	Int cosmossdk_io_math.Int `protobuf:"bytes,1,opt,name=int,proto3,customtype=cosmossdk.io/math.Int" json:"int"`
}

IntProto defines a Protobuf wrapper around an Int object. Deprecated: Prefer to use math.Int directly. It supports binary Marshal and Unmarshal.

func (*IntProto) Descriptor 

func (*IntProto) Descriptor() ([]byte, []int)

func (*IntProto) Marshal 

func (m *IntProto) Marshal() (dAtA []byte, err error)

func (*IntProto) MarshalTo 

func (m *IntProto) MarshalTo(dAtA []byte) (int, error)

func (*IntProto) MarshalToSizedBuffer 

func (m *IntProto) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*IntProto) ProtoMessage 

func (*IntProto) ProtoMessage()

func (*IntProto) Reset 

func (m *IntProto) Reset()

func (*IntProto) Size 

func (m *IntProto) Size() (n int)

func (IntProto) String 

func (ip IntProto) String() string

func (*IntProto) Unmarshal 

func (m *IntProto) Unmarshal(dAtA []byte) error

func (*IntProto) XXX_DiscardUnknown 

func (m *IntProto) XXX_DiscardUnknown()

func (*IntProto) XXX_Marshal 

func (m *IntProto) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*IntProto) XXX_Merge 

func (m *IntProto) XXX_Merge(src proto.Message)

func (*IntProto) XXX_Size 

func (m *IntProto) XXX_Size() int

func (*IntProto) XXX_Unmarshal 

func (m *IntProto) XXX_Unmarshal(b []byte) error

type Invariant 

type Invariant func(ctx Context) (string, bool)

An Invariant is a function which tests a particular invariant. The invariant returns a descriptive message about what happened and a boolean indicating whether the invariant has been broken. The simulator will then halt and print the logs.

type InvariantRegistry 

type InvariantRegistry interface {
	RegisterRoute(moduleName, route string, invar Invariant)
}

expected interface for registering invariants

type Invariants 

type Invariants []Invariant

Invariants defines a group of invariants

type LegacyMsg added in v0.50.0 

type LegacyMsg interface {
	Msg

	// GetSigners returns the addrs of signers that must sign.
	// CONTRACT: All signatures must be present to be valid.
	// CONTRACT: Returns addrs in some deterministic order.
	GetSigners() []AccAddress
}

LegacyMsg defines the interface a transaction message needed to fulfill up through v0.47.

type MapCoins added in v0.50.0 

type MapCoins map[string]math.Int

map coins is a map representation of sdk.Coins intended solely for use in bulk additions. All serialization and iteration should be done after conversion to sdk.Coins.

func NewMapCoins added in v0.50.0 

func NewMapCoins(coins Coins) MapCoins

func (MapCoins) Add added in v0.50.0 

func (m MapCoins) Add(coins ...Coin)

func (MapCoins) ToCoins added in v0.50.0 

func (m MapCoins) ToCoins() Coins

type ModuleAccountI added in v0.50.0 

type ModuleAccountI interface {
	AccountI

	GetName() string
	GetPermissions() []string
	HasPermission(string) bool
}

ModuleAccountI defines an account interface for modules that hold tokens in an escrow.

type Msg 

type Msg = proto.Message

Msg defines the interface a transaction message needed to fulfill.

func GetMsgFromTypeURL added in v0.46.2 

func GetMsgFromTypeURL(cdc codec.Codec, input string) (Msg, error)

GetMsgFromTypeURL returns a `sdk.Msg` message type from a type URL

type MsgData deprecated added in v0.40.0 

type MsgData struct {
	MsgType string `protobuf:"bytes,1,opt,name=msg_type,json=msgType,proto3" json:"msg_type,omitempty"`
	Data    []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
}

MsgData defines the data returned in a Result object during message execution.

Deprecated: Do not use.

func (*MsgData) Descriptor added in v0.40.0 

func (*MsgData) Descriptor() ([]byte, []int)

func (*MsgData) GetData added in v0.40.0 

func (m *MsgData) GetData() []byte

func (*MsgData) GetMsgType added in v0.40.0 

func (m *MsgData) GetMsgType() string

func (*MsgData) Marshal added in v0.40.0 

func (m *MsgData) Marshal() (dAtA []byte, err error)

func (*MsgData) MarshalTo added in v0.40.0 

func (m *MsgData) MarshalTo(dAtA []byte) (int, error)

func (*MsgData) MarshalToSizedBuffer added in v0.40.0 

func (m *MsgData) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*MsgData) ProtoMessage added in v0.40.0 

func (*MsgData) ProtoMessage()

func (*MsgData) Reset added in v0.40.0 

func (m *MsgData) Reset()

func (*MsgData) Size added in v0.40.0 

func (m *MsgData) Size() (n int)

func (*MsgData) String added in v0.40.0 

func (this *MsgData) String() string

func (*MsgData) Unmarshal added in v0.40.0 

func (m *MsgData) Unmarshal(dAtA []byte) error

func (*MsgData) XXX_DiscardUnknown added in v0.40.0 

func (m *MsgData) XXX_DiscardUnknown()

func (*MsgData) XXX_Marshal added in v0.40.0 

func (m *MsgData) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MsgData) XXX_Merge added in v0.40.0 

func (m *MsgData) XXX_Merge(src proto.Message)

func (*MsgData) XXX_Size added in v0.40.0 

func (m *MsgData) XXX_Size() int

func (*MsgData) XXX_Unmarshal added in v0.40.0 

func (m *MsgData) XXX_Unmarshal(b []byte) error

type PeerFilter 

type PeerFilter func(info string) *abci.ResponseQuery

PeerFilter responds to p2p filtering queries from Tendermint

type PostDecorator added in v0.47.0 

type PostDecorator interface {
	PostHandle(ctx Context, tx Tx, simulate, success bool, next PostHandler) (newCtx Context, err error)
}

PostDecorator wraps the next PostHandler to perform custom post-processing.

type PostHandler added in v0.47.0 

type PostHandler func(ctx Context, tx Tx, simulate, success bool) (newCtx Context, err error)

PostHandler like AnteHandler but it executes after RunMsgs. Runs on success or failure and enables use cases like gas refunding.

func ChainPostDecorators added in v0.47.0 

func ChainPostDecorators(chain ...PostDecorator) PostHandler

ChainPostDecorators chains PostDecorators together with each PostDecorator wrapping over the decorators further along chain and returns a single PostHandler.

NOTE: The first element is outermost decorator, while the last element is innermost decorator. Decorator ordering is critical since some decorators will expect certain checks and updates to be performed (e.g. the Context) before the decorator is run. These expectations should be documented clearly in a CONTRACT docline in the decorator's godoc.

type PreBlocker added in v0.50.0 

type PreBlocker func(Context, *abci.RequestFinalizeBlock) (*ResponsePreBlock, error)

PreBlocker runs code before the `BeginBlocker` and defines a function type alias for executing logic right before FinalizeBlock is called (but after its context has been set up). It is intended to allow applications to perform computation on vote extensions and persist their results in state.

Note: returning an error will make FinalizeBlock fail.

type Precommiter added in v0.50.0 

type Precommiter func(ctx Context)

Precommiter runs code during commit immediately before the `deliverState` is written to the `rootMultiStore`.

type PrepareCheckStater added in v0.50.0 

type PrepareCheckStater func(ctx Context)

PrepareCheckStater runs code during commit after the block has been committed, and the `checkState` has been branched for the new block.

type PrepareProposalHandler added in v0.47.0 

type PrepareProposalHandler func(Context, *abci.RequestPrepareProposal) (*abci.ResponsePrepareProposal, error)

PrepareProposalHandler defines a function type alias for preparing a proposal

type ProcessProposalHandler added in v0.47.0 

type ProcessProposalHandler func(Context, *abci.RequestProcessProposal) (*abci.ResponseProcessProposal, error)

ProcessProposalHandler defines a function type alias for processing a proposer

type Request 

type Request = Context

Proposed rename, not done to avoid API breakage

type ResponsePreBlock added in v0.50.0 

type ResponsePreBlock struct {
	ConsensusParamsChanged bool
}

func (ResponsePreBlock) IsConsensusParamsChanged added in v0.50.0 

func (r ResponsePreBlock) IsConsensusParamsChanged() bool

type Result 

type Result struct {
	// Data is any data returned from message or handler execution. It MUST be
	// length prefixed in order to separate data from multiple message executions.
	// Deprecated. This field is still populated, but prefer msg_response instead
	// because it also contains the Msg response typeURL.
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` // Deprecated: Do not use.
	// Log contains the log information from message or handler execution.
	Log string `protobuf:"bytes,2,opt,name=log,proto3" json:"log,omitempty"`
	// Events contains a slice of Event objects that were emitted during message
	// or handler execution.
	Events []types1.Event `protobuf:"bytes,3,rep,name=events,proto3" json:"events"`
	// msg_responses contains the Msg handler responses type packed in Anys.
	//
	// Since: cosmos-sdk 0.46
	MsgResponses []*types.Any `protobuf:"bytes,4,rep,name=msg_responses,json=msgResponses,proto3" json:"msg_responses,omitempty"`
}

Result is the union of ResponseFormat and ResponseCheckTx.

func WrapServiceResult added in v0.40.0 

func WrapServiceResult(ctx Context, res proto.Message, err error) (*Result, error)

WrapServiceResult wraps a result from a protobuf RPC service method call (res proto.Message, err error) in a Result object or error. This method takes care of marshaling the res param to protobuf and attaching any events on the ctx.EventManager() to the Result.

func (*Result) Descriptor 

func (*Result) Descriptor() ([]byte, []int)

func (Result) GetEvents 

func (r Result) GetEvents() Events

func (*Result) Marshal 

func (m *Result) Marshal() (dAtA []byte, err error)

func (*Result) MarshalTo 

func (m *Result) MarshalTo(dAtA []byte) (int, error)

func (*Result) MarshalToSizedBuffer 

func (m *Result) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Result) ProtoMessage 

func (*Result) ProtoMessage()

func (*Result) Reset 

func (m *Result) Reset()

func (*Result) Size 

func (m *Result) Size() (n int)

func (Result) String 

func (r Result) String() string

func (*Result) Unmarshal 

func (m *Result) Unmarshal(dAtA []byte) error

func (*Result) XXX_DiscardUnknown 

func (m *Result) XXX_DiscardUnknown()

func (*Result) XXX_Marshal 

func (m *Result) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Result) XXX_Merge 

func (m *Result) XXX_Merge(src proto.Message)

func (*Result) XXX_Size 

func (m *Result) XXX_Size() int

func (*Result) XXX_Unmarshal 

func (m *Result) XXX_Unmarshal(b []byte) error

type SearchBlocksResult added in v0.50.0 

type SearchBlocksResult struct {
	// Count of all blocks
	TotalCount int64 `protobuf:"varint,1,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// Count of blocks in current page
	Count int64 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	// Index of current page, start from 1
	PageNumber int64 `protobuf:"varint,3,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
	// Count of total pages
	PageTotal int64 `protobuf:"varint,4,opt,name=page_total,json=pageTotal,proto3" json:"page_total,omitempty"`
	// Max count blocks per page
	Limit int64 `protobuf:"varint,5,opt,name=limit,proto3" json:"limit,omitempty"`
	// List of blocks in current page
	Blocks []*types2.Block `protobuf:"bytes,6,rep,name=blocks,proto3" json:"blocks,omitempty"`
}

SearchBlocksResult defines a structure for querying blocks pageable

func NewSearchBlocksResult added in v0.50.0 

func NewSearchBlocksResult(totalCount, count, page, limit int64, blocks []*cmtproto.Block) *SearchBlocksResult

func (*SearchBlocksResult) Descriptor added in v0.50.0 

func (*SearchBlocksResult) Descriptor() ([]byte, []int)

func (*SearchBlocksResult) GetBlocks added in v0.50.0 

func (m *SearchBlocksResult) GetBlocks() []*types2.Block

func (*SearchBlocksResult) GetCount added in v0.50.0 

func (m *SearchBlocksResult) GetCount() int64

func (*SearchBlocksResult) GetLimit added in v0.50.0 

func (m *SearchBlocksResult) GetLimit() int64

func (*SearchBlocksResult) GetPageNumber added in v0.50.0 

func (m *SearchBlocksResult) GetPageNumber() int64

func (*SearchBlocksResult) GetPageTotal added in v0.50.0 

func (m *SearchBlocksResult) GetPageTotal() int64

func (*SearchBlocksResult) GetTotalCount added in v0.50.0 

func (m *SearchBlocksResult) GetTotalCount() int64

func (*SearchBlocksResult) Marshal added in v0.50.0 

func (m *SearchBlocksResult) Marshal() (dAtA []byte, err error)

func (*SearchBlocksResult) MarshalTo added in v0.50.0 

func (m *SearchBlocksResult) MarshalTo(dAtA []byte) (int, error)

func (*SearchBlocksResult) MarshalToSizedBuffer added in v0.50.0 

func (m *SearchBlocksResult) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*SearchBlocksResult) ProtoMessage added in v0.50.0 

func (*SearchBlocksResult) ProtoMessage()

func (*SearchBlocksResult) Reset added in v0.50.0 

func (m *SearchBlocksResult) Reset()

func (*SearchBlocksResult) Size added in v0.50.0 

func (m *SearchBlocksResult) Size() (n int)

func (*SearchBlocksResult) String added in v0.50.0 

func (this *SearchBlocksResult) String() string

func (*SearchBlocksResult) Unmarshal added in v0.50.0 

func (m *SearchBlocksResult) Unmarshal(dAtA []byte) error

func (*SearchBlocksResult) XXX_DiscardUnknown added in v0.50.0 

func (m *SearchBlocksResult) XXX_DiscardUnknown()

func (*SearchBlocksResult) XXX_Marshal added in v0.50.0 

func (m *SearchBlocksResult) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SearchBlocksResult) XXX_Merge added in v0.50.0 

func (m *SearchBlocksResult) XXX_Merge(src proto.Message)

func (*SearchBlocksResult) XXX_Size added in v0.50.0 

func (m *SearchBlocksResult) XXX_Size() int

func (*SearchBlocksResult) XXX_Unmarshal added in v0.50.0 

func (m *SearchBlocksResult) XXX_Unmarshal(b []byte) error

type SearchTxsResult 

type SearchTxsResult struct {
	// Count of all txs
	TotalCount uint64 `protobuf:"varint,1,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// Count of txs in current page
	Count uint64 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	// Index of current page, start from 1
	PageNumber uint64 `protobuf:"varint,3,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
	// Count of total pages
	PageTotal uint64 `protobuf:"varint,4,opt,name=page_total,json=pageTotal,proto3" json:"page_total,omitempty"`
	// Max count txs per page
	Limit uint64 `protobuf:"varint,5,opt,name=limit,proto3" json:"limit,omitempty"`
	// List of txs in current page
	Txs []*TxResponse `protobuf:"bytes,6,rep,name=txs,proto3" json:"txs,omitempty"`
}

SearchTxsResult defines a structure for querying txs pageable

func NewSearchTxsResult 

func NewSearchTxsResult(totalCount, count, page, limit uint64, txs []*TxResponse) *SearchTxsResult

func (*SearchTxsResult) Descriptor added in v0.40.0 

func (*SearchTxsResult) Descriptor() ([]byte, []int)

func (*SearchTxsResult) GetCount added in v0.40.0 

func (m *SearchTxsResult) GetCount() uint64

func (*SearchTxsResult) GetLimit added in v0.40.0 

func (m *SearchTxsResult) GetLimit() uint64

func (*SearchTxsResult) GetPageNumber added in v0.40.0 

func (m *SearchTxsResult) GetPageNumber() uint64

func (*SearchTxsResult) GetPageTotal added in v0.40.0 

func (m *SearchTxsResult) GetPageTotal() uint64

func (*SearchTxsResult) GetTotalCount added in v0.40.0 

func (m *SearchTxsResult) GetTotalCount() uint64

func (*SearchTxsResult) GetTxs added in v0.40.0 

func (m *SearchTxsResult) GetTxs() []*TxResponse

func (*SearchTxsResult) Marshal added in v0.40.0 

func (m *SearchTxsResult) Marshal() (dAtA []byte, err error)

func (*SearchTxsResult) MarshalTo added in v0.40.0 

func (m *SearchTxsResult) MarshalTo(dAtA []byte) (int, error)

func (*SearchTxsResult) MarshalToSizedBuffer added in v0.40.0 

func (m *SearchTxsResult) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*SearchTxsResult) ProtoMessage added in v0.40.0 

func (*SearchTxsResult) ProtoMessage()

func (*SearchTxsResult) Reset added in v0.40.0 

func (m *SearchTxsResult) Reset()

func (*SearchTxsResult) Size added in v0.40.0 

func (m *SearchTxsResult) Size() (n int)

func (*SearchTxsResult) String added in v0.40.0 

func (this *SearchTxsResult) String() string

func (*SearchTxsResult) Unmarshal added in v0.40.0 

func (m *SearchTxsResult) Unmarshal(dAtA []byte) error

func (SearchTxsResult) UnpackInterfaces added in v0.40.0 

func (s SearchTxsResult) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error

UnpackInterfaces implements UnpackInterfacesMessage.UnpackInterfaces

types.UnpackInterfaces needs to be called for each nested Tx because there are generally interfaces to unpack in Tx's

func (*SearchTxsResult) XXX_DiscardUnknown added in v0.40.0 

func (m *SearchTxsResult) XXX_DiscardUnknown()

func (*SearchTxsResult) XXX_Marshal added in v0.40.0 

func (m *SearchTxsResult) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SearchTxsResult) XXX_Merge added in v0.40.0 

func (m *SearchTxsResult) XXX_Merge(src proto.Message)

func (*SearchTxsResult) XXX_Size added in v0.40.0 

func (m *SearchTxsResult) XXX_Size() int

func (*SearchTxsResult) XXX_Unmarshal added in v0.40.0 

func (m *SearchTxsResult) XXX_Unmarshal(b []byte) error

type Signature 

type Signature interface {
	GetPubKey() cryptotypes.PubKey
	GetSignature() []byte
}

Signature defines an interface for an application application-defined concrete transaction type to be able to set and return transaction signatures.

type SimulationResponse 

type SimulationResponse struct {
	GasInfo `protobuf:"bytes,1,opt,name=gas_info,json=gasInfo,proto3,embedded=gas_info" json:"gas_info"`
	Result  *Result `protobuf:"bytes,2,opt,name=result,proto3" json:"result,omitempty"`
}

SimulationResponse defines the response generated when a transaction is successfully simulated.

func (*SimulationResponse) Descriptor 

func (*SimulationResponse) Descriptor() ([]byte, []int)

func (*SimulationResponse) GetResult 

func (m *SimulationResponse) GetResult() *Result

func (*SimulationResponse) Marshal 

func (m *SimulationResponse) Marshal() (dAtA []byte, err error)

func (*SimulationResponse) MarshalTo 

func (m *SimulationResponse) MarshalTo(dAtA []byte) (int, error)

func (*SimulationResponse) MarshalToSizedBuffer 

func (m *SimulationResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*SimulationResponse) ProtoMessage 

func (*SimulationResponse) ProtoMessage()

func (*SimulationResponse) Reset 

func (m *SimulationResponse) Reset()

func (*SimulationResponse) Size 

func (m *SimulationResponse) Size() (n int)

func (*SimulationResponse) Unmarshal 

func (m *SimulationResponse) Unmarshal(dAtA []byte) error

func (*SimulationResponse) XXX_DiscardUnknown 

func (m *SimulationResponse) XXX_DiscardUnknown()

func (*SimulationResponse) XXX_Marshal 

func (m *SimulationResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SimulationResponse) XXX_Merge 

func (m *SimulationResponse) XXX_Merge(src proto.Message)

func (*SimulationResponse) XXX_Size 

func (m *SimulationResponse) XXX_Size() int

func (*SimulationResponse) XXX_Unmarshal 

func (m *SimulationResponse) XXX_Unmarshal(b []byte) error

type StringEvent 

type StringEvent struct {
	Type       string      `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Attributes []Attribute `protobuf:"bytes,2,rep,name=attributes,proto3" json:"attributes"`
}

StringEvent defines en Event object wrapper where all the attributes contain key/value pairs that are strings instead of raw bytes.

func StringifyEvent 

func StringifyEvent(e abci.Event) StringEvent

StringifyEvent converts an Event object to a StringEvent object.

func (*StringEvent) Descriptor added in v0.40.0 

func (*StringEvent) Descriptor() ([]byte, []int)

func (*StringEvent) GetAttributes added in v0.40.0 

func (m *StringEvent) GetAttributes() []Attribute

func (*StringEvent) GetType added in v0.40.0 

func (m *StringEvent) GetType() string

func (*StringEvent) Marshal added in v0.40.0 

func (m *StringEvent) Marshal() (dAtA []byte, err error)

func (*StringEvent) MarshalTo added in v0.40.0 

func (m *StringEvent) MarshalTo(dAtA []byte) (int, error)

func (*StringEvent) MarshalToSizedBuffer added in v0.40.0 

func (m *StringEvent) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*StringEvent) ProtoMessage added in v0.40.0 

func (*StringEvent) ProtoMessage()

func (*StringEvent) Reset added in v0.40.0 

func (m *StringEvent) Reset()

func (*StringEvent) Size added in v0.40.0 

func (m *StringEvent) Size() (n int)

func (*StringEvent) String added in v0.40.0 

func (this *StringEvent) String() string

func (*StringEvent) Unmarshal added in v0.40.0 

func (m *StringEvent) Unmarshal(dAtA []byte) error

func (*StringEvent) XXX_DiscardUnknown added in v0.40.0 

func (m *StringEvent) XXX_DiscardUnknown()

func (*StringEvent) XXX_Marshal added in v0.40.0 

func (m *StringEvent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StringEvent) XXX_Merge added in v0.40.0 

func (m *StringEvent) XXX_Merge(src proto.Message)

func (*StringEvent) XXX_Size added in v0.40.0 

func (m *StringEvent) XXX_Size() int

func (*StringEvent) XXX_Unmarshal added in v0.40.0 

func (m *StringEvent) XXX_Unmarshal(b []byte) error

type StringEvents 

type StringEvents []StringEvent

StringAttributes defines a slice of StringEvents objects.

func StringifyEvents 

func StringifyEvents(events []abci.Event) StringEvents

StringifyEvents converts a slice of Event objects into a slice of StringEvent objects.

func (StringEvents) String 

func (se StringEvents) String() string

type Terminator deprecated 

type Terminator struct{}

Terminator AnteDecorator will get added to the chain to simplify decorator code Don't need to check if next == nil further up the chain 

                      ______
                   <((((((\\\
                   /      . }\
                   ;--..--._|}
(\                 '--/\--'  )
 \\                | '-'  :'|
  \\               . -==- .-|
   \\               \.__.'   \--._
   [\\          __.--|       //  _/'--.
   \ \\       .'-._ ('-----'/ __/      \
    \ \\     /   __>|      | '--.       |
     \ \\   |   \   |     /    /       /
      \ '\ /     \  |     |  _/       /
       \  \       \ |     | /        /
 snd    \  \      \        /

Deprecated: Terminator is retired (ref https://github.com/cosmos/cosmos-sdk/pull/16076).

func (Terminator) AnteHandle 

func (t Terminator) AnteHandle(ctx Context, _ Tx, _ bool, _ AnteHandler) (Context, error)

AnteHandle returns the provided Context and nil error

func (Terminator) PostHandle added in v0.47.0 

func (t Terminator) PostHandle(ctx Context, _ Tx, _, _ bool, _ PostHandler) (Context, error)

PostHandle returns the provided Context and nil error

type Tx 

type Tx interface {
	HasMsgs

	// GetMsgsV2 gets the transaction's messages as google.golang.org/protobuf/proto.Message's.
	GetMsgsV2() ([]protov2.Message, error)
}

Tx defines an interface a transaction must fulfill.

type TxDecoder 

type TxDecoder func(txBytes []byte) (Tx, error)

TxDecoder unmarshals transaction bytes

type TxEncoder 

type TxEncoder func(tx Tx) ([]byte, error)

TxEncoder marshals transaction to bytes

type TxMsgData added in v0.40.0 

type TxMsgData struct {
	// data field is deprecated and not populated.
	Data []*MsgData `protobuf:"bytes,1,rep,name=data,proto3" json:"data,omitempty"` // Deprecated: Do not use.
	// msg_responses contains the Msg handler responses packed into Anys.
	//
	// Since: cosmos-sdk 0.46
	MsgResponses []*types.Any `protobuf:"bytes,2,rep,name=msg_responses,json=msgResponses,proto3" json:"msg_responses,omitempty"`
}

TxMsgData defines a list of MsgData. A transaction will have a MsgData object for each message.

func (*TxMsgData) Descriptor added in v0.40.0 

func (*TxMsgData) Descriptor() ([]byte, []int)

func (*TxMsgData) GetData deprecated added in v0.40.0 

func (m *TxMsgData) GetData() []*MsgData

Deprecated: Do not use.

func (*TxMsgData) GetMsgResponses added in v0.46.0 

func (m *TxMsgData) GetMsgResponses() []*types.Any

func (*TxMsgData) Marshal added in v0.40.0 

func (m *TxMsgData) Marshal() (dAtA []byte, err error)

func (*TxMsgData) MarshalTo added in v0.40.0 

func (m *TxMsgData) MarshalTo(dAtA []byte) (int, error)

func (*TxMsgData) MarshalToSizedBuffer added in v0.40.0 

func (m *TxMsgData) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*TxMsgData) ProtoMessage added in v0.40.0 

func (*TxMsgData) ProtoMessage()

func (*TxMsgData) Reset added in v0.40.0 

func (m *TxMsgData) Reset()

func (*TxMsgData) Size added in v0.40.0 

func (m *TxMsgData) Size() (n int)

func (*TxMsgData) String added in v0.40.0 

func (this *TxMsgData) String() string

func (*TxMsgData) Unmarshal added in v0.40.0 

func (m *TxMsgData) Unmarshal(dAtA []byte) error

func (*TxMsgData) XXX_DiscardUnknown added in v0.40.0 

func (m *TxMsgData) XXX_DiscardUnknown()

func (*TxMsgData) XXX_Marshal added in v0.40.0 

func (m *TxMsgData) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TxMsgData) XXX_Merge added in v0.40.0 

func (m *TxMsgData) XXX_Merge(src proto.Message)

func (*TxMsgData) XXX_Size added in v0.40.0 

func (m *TxMsgData) XXX_Size() int

func (*TxMsgData) XXX_Unmarshal added in v0.40.0 

func (m *TxMsgData) XXX_Unmarshal(b []byte) error

type TxResponse 

type TxResponse struct {
	// The block height
	Height int64 `protobuf:"varint,1,opt,name=height,proto3" json:"height,omitempty"`
	// The transaction hash.
	TxHash string `protobuf:"bytes,2,opt,name=txhash,proto3" json:"txhash,omitempty"`
	// Namespace for the Code
	Codespace string `protobuf:"bytes,3,opt,name=codespace,proto3" json:"codespace,omitempty"`
	// Response code.
	Code uint32 `protobuf:"varint,4,opt,name=code,proto3" json:"code,omitempty"`
	// Result bytes, if any.
	Data string `protobuf:"bytes,5,opt,name=data,proto3" json:"data,omitempty"`
	// The output of the application's logger (raw string). May be
	// non-deterministic.
	RawLog string `protobuf:"bytes,6,opt,name=raw_log,json=rawLog,proto3" json:"raw_log,omitempty"`
	// The output of the application's logger (typed). May be non-deterministic.
	Logs ABCIMessageLogs `protobuf:"bytes,7,rep,name=logs,proto3,castrepeated=ABCIMessageLogs" json:"logs"`
	// Additional information. May be non-deterministic.
	Info string `protobuf:"bytes,8,opt,name=info,proto3" json:"info,omitempty"`
	// Amount of gas requested for transaction.
	GasWanted int64 `protobuf:"varint,9,opt,name=gas_wanted,json=gasWanted,proto3" json:"gas_wanted,omitempty"`
	// Amount of gas consumed by transaction.
	GasUsed int64 `protobuf:"varint,10,opt,name=gas_used,json=gasUsed,proto3" json:"gas_used,omitempty"`
	// The request transaction bytes.
	Tx *types.Any `protobuf:"bytes,11,opt,name=tx,proto3" json:"tx,omitempty"`
	// Time of the previous block. For heights > 1, it's the weighted median of
	// the timestamps of the valid votes in the block.LastCommit. For height == 1,
	// it's genesis time.
	Timestamp string `protobuf:"bytes,12,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Events defines all the events emitted by processing a transaction. Note,
	// these events include those emitted by processing all the messages and those
	// emitted from the ante. Whereas Logs contains the events, with
	// additional metadata, emitted only by processing the messages.
	//
	// Since: cosmos-sdk 0.42.11, 0.44.5, 0.45
	Events []types1.Event `protobuf:"bytes,13,rep,name=events,proto3" json:"events"`
}

TxResponse defines a structure containing relevant tx data and metadata. The tags are stringified and the log is JSON decoded.

func NewResponseFormatBroadcastTx 

func NewResponseFormatBroadcastTx(res *coretypes.ResultBroadcastTx) *TxResponse

NewResponseFormatBroadcastTx returns a TxResponse given a ResultBroadcastTx from tendermint

func NewResponseResultTx 

func NewResponseResultTx(res *coretypes.ResultTx, anyTx *codectypes.Any, timestamp string) *TxResponse

NewResponseResultTx returns a TxResponse given a ResultTx from tendermint

func (*TxResponse) Descriptor added in v0.40.0 

func (*TxResponse) Descriptor() ([]byte, []int)

func (TxResponse) Empty 

func (r TxResponse) Empty() bool

Empty returns true if the response is empty

func (TxResponse) GetTx added in v0.40.0 

func (r TxResponse) GetTx() HasMsgs

GetTx unpacks the Tx from within a TxResponse and returns it

func (*TxResponse) Marshal added in v0.40.0 

func (m *TxResponse) Marshal() (dAtA []byte, err error)

func (*TxResponse) MarshalTo added in v0.40.0 

func (m *TxResponse) MarshalTo(dAtA []byte) (int, error)

func (*TxResponse) MarshalToSizedBuffer added in v0.40.0 

func (m *TxResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*TxResponse) ProtoMessage added in v0.40.0 

func (*TxResponse) ProtoMessage()

func (*TxResponse) Reset added in v0.40.0 

func (m *TxResponse) Reset()

func (*TxResponse) Size added in v0.40.0 

func (m *TxResponse) Size() (n int)

func (TxResponse) String 

func (r TxResponse) String() string

func (*TxResponse) Unmarshal added in v0.40.0 

func (m *TxResponse) Unmarshal(dAtA []byte) error

func (TxResponse) UnpackInterfaces added in v0.40.0 

func (r TxResponse) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error

UnpackInterfaces implements UnpackInterfacesMessage.UnpackInterfaces

func (*TxResponse) XXX_DiscardUnknown added in v0.40.0 

func (m *TxResponse) XXX_DiscardUnknown()

func (*TxResponse) XXX_Marshal added in v0.40.0 

func (m *TxResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TxResponse) XXX_Merge added in v0.40.0 

func (m *TxResponse) XXX_Merge(src proto.Message)

func (*TxResponse) XXX_Size added in v0.40.0 

func (m *TxResponse) XXX_Size() int

func (*TxResponse) XXX_Unmarshal added in v0.40.0 

func (m *TxResponse) XXX_Unmarshal(b []byte) error

type TxWithMemo added in v0.40.0 

type TxWithMemo interface {
	Tx
	GetMemo() string
}

TxWithMemo must have GetMemo() method to use ValidateMemoDecorator

type TxWithTimeoutHeight added in v0.40.0 

type TxWithTimeoutHeight interface {
	Tx

	GetTimeoutHeight() uint64
}

TxWithTimeoutHeight extends the Tx interface by allowing a transaction to set a height timeout.

type ValAddress 

type ValAddress []byte

ValAddress defines a wrapper around bytes meant to present a validator's operator. When marshaled to a string or JSON, it uses Bech32.

func ValAddressFromBech32 

func ValAddressFromBech32(address string) (addr ValAddress, err error)

ValAddressFromBech32 creates a ValAddress from a Bech32 string.

func ValAddressFromHex 

func ValAddressFromHex(address string) (addr ValAddress, err error)

ValAddressFromHex creates a ValAddress from a hex string.

func (ValAddress) Bytes 

func (va ValAddress) Bytes() []byte

Bytes returns the raw address bytes.

func (ValAddress) Empty 

func (va ValAddress) Empty() bool

Returns boolean for whether an ValAddress is empty

func (ValAddress) Equals 

func (va ValAddress) Equals(va2 Address) bool

Returns boolean for whether two ValAddresses are Equal

func (ValAddress) Format 

func (va ValAddress) Format(s fmt.State, verb rune)

func (ValAddress) Marshal 

func (va ValAddress) Marshal() ([]byte, error)

Marshal returns the raw address bytes. It is needed for protobuf compatibility.

func (ValAddress) MarshalJSON 

func (va ValAddress) MarshalJSON() ([]byte, error)

MarshalJSON marshals to JSON using Bech32.

func (ValAddress) MarshalYAML 

func (va ValAddress) MarshalYAML() (interface{}, error)

MarshalYAML marshals to YAML using Bech32.

func (ValAddress) String 

func (va ValAddress) String() string

String implements the Stringer interface.

func (*ValAddress) Unmarshal 

func (va *ValAddress) Unmarshal(data []byte) error

Unmarshal sets the address to the given data. It is needed for protobuf compatibility.

func (*ValAddress) UnmarshalJSON 

func (va *ValAddress) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals from JSON assuming Bech32 encoding.

func (*ValAddress) UnmarshalYAML 

func (va *ValAddress) UnmarshalYAML(data []byte) error

UnmarshalYAML unmarshals from YAML assuming Bech32 encoding.

type VerifyVoteExtensionHandler added in v0.50.0 

type VerifyVoteExtensionHandler func(Context, *abci.RequestVerifyVoteExtension) (*abci.ResponseVerifyVoteExtension, error)

VerifyVoteExtensionHandler defines a function type alias for verifying a pre-commit vote extension.

Source Files

View all Source files

Directories

Path Synopsis
legacybech32
Deprecated: The module provides legacy bech32 functions which will be removed in a future release.
 Deprecated: The module provides legacy bech32 functions which will be removed in a future release.
Package errors provides a shared set of errors for use in the SDK, aliases functionality in the cosmossdk.io/errors module that used to be in this package, and provides some helpers for converting errors to ABCI response code.
 Package errors provides a shared set of errors for use in the SDK, aliases functionality in the cosmossdk.io/errors module that used to be in this package, and provides some helpers for converting errors to ABCI response code.
Package module contains application module patterns and associated "manager" functionality.
 Package module contains application module patterns and associated "manager" functionality.
testutil
tx
Package tx is a reverse proxy.
 Package tx is a reverse proxy.
amino
signing

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.