transaction

Documentation

Index

• type Codec
• type ExecMode
• type GenericMsg
• type Identity
• type Msg
• type Service
• type Tx

Types

type Codec

type Codec[T Tx] interface {
	// Decode decodes the tx bytes into a DecodedTx, containing
	// both concrete and bytes representation of the tx.
	Decode([]byte) (T, error)
	// DecodeJSON decodes the tx JSON bytes into a DecodedTx
	DecodeJSON([]byte) (T, error)
}

Codec defines the TX codec, which converts a TX from bytes to its concrete representation.

type ExecMode

type ExecMode uint8

ExecMode defines the execution mode

const (
	ExecModeCheck ExecMode = iota
	ExecModeReCheck
	ExecModeSimulate

	ExecModeFinalize
)

All possible execution modes. For backwards compatibility and easier casting, the exec mode values must be the same as in cosmos/cosmos-sdk/types package.

type GenericMsg

type GenericMsg[T any] interface {
	*T
	Msg
}

GenericMsg defines a generic version of a Msg. The GenericMsg refers to the non pointer version of Msg, and is required to allow its instantiations in generic contexts.

type Identity

type Identity = []byte

type Msg

type Msg = interface {
	Reset()
	String() string
	ProtoMessage()
}

Msg uses structural types to define the interface for a message.

type Service

type Service interface {
	// ExecMode returns the current execution mode.
	ExecMode(ctx context.Context) ExecMode
}

Service creates a transaction service.

type Tx

type Tx interface {
	// Hash returns the unique identifier for the Tx.
	Hash() [32]byte
	// GetMessages returns the list of state transitions of the Tx.
	GetMessages() ([]Msg, error)
	// GetSenders returns the tx state transition sender.
	GetSenders() ([]Identity, error) // TODO reduce this to a single identity if accepted
	// GetGasLimit returns the gas limit of the tx. Must return math.MaxUint64 for infinite gas
	// txs.
	GetGasLimit() (uint64, error)
	// Bytes returns the encoded version of this tx. Note: this is ideally cached
	// from the first instance of the decoding of the tx.
	Bytes() []byte
}

Tx defines the interface for a transaction. All custom transactions must implement this interface.