Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type AuthInfo ¶
type AuthInfo struct {
// signer_infos defines the signing modes for the required signers. The number
// and order of elements must match the required signers from TxBody's
// messages. The first element is the primary signer and the one which pays
// the fee.
SignerInfos []*SignerInfo `protobuf:"bytes,1,rep,name=signer_infos,json=signerInfos,proto3" json:"signer_infos,omitempty"`
// Fee is the fee and gas limit for the transaction. The first signer is the
// primary signer and the one which pays the fee. The fee can be calculated
// based on the cost of evaluating the body and doing signature verification
// of the signers. This can be estimated via simulation.
Fee *Fee `protobuf:"bytes,2,opt,name=fee,proto3" json:"fee,omitempty"`
}
AuthInfo describes the fee and signer modes that are used to sign a transaction.
func (*AuthInfo) MarshalToSizedBuffer ¶
type Fee ¶
type Fee struct {
// amount is the amount of coins to be paid as a fee
Amount types.Coins `protobuf:"bytes,1,rep,name=amount,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"amount"`
// gas_limit is the maximum gas that can be used in transaction processing
// before an out of gas error occurs
GasLimit uint64 `protobuf:"varint,2,opt,name=gas_limit,json=gasLimit,proto3" json:"gas_limit,omitempty"`
// if unset, the first signer is responsible for paying the fees. If set, the specified account must pay the fees.
// the payer must be a tx signer (and thus have signed this field in AuthInfo).
// setting this field does *not* change the ordering of required signers for the transaction.
Payer string `protobuf:"bytes,3,opt,name=payer,proto3" json:"payer,omitempty"`
// if set, the fee payer (either the first signer or the value of the payer field) requests that a fee grant be used
// to pay fees instead of the fee payer's own balance. If an appropriate fee grant does not exist or the chain does
// not support fee grants, this will fail
Granter string `protobuf:"bytes,4,opt,name=granter,proto3" json:"granter,omitempty"`
}
Fee includes the amount of coins paid in fees and the maximum gas to be used by the transaction. The ratio yields an effective "gasprice", which must be above some miminum to be accepted into the mempool.
type ModeInfo ¶
type ModeInfo struct {
// sum is the oneof that specifies whether this represents a single or nested
// multisig signer
//
// Types that are valid to be assigned to Sum:
// *ModeInfo_Single_
// *ModeInfo_Multi_
Sum isModeInfo_Sum `protobuf_oneof:"sum"`
}
ModeInfo describes the signing mode of a single or nested multisig signer.
func (*ModeInfo) MarshalToSizedBuffer ¶
type ModeInfo_Multi ¶
type ModeInfo_Multi struct {
// bitarray specifies which keys within the multisig are signing
Bitarray *types.CompactBitArray `protobuf:"bytes,1,opt,name=bitarray,proto3" json:"bitarray,omitempty"`
// mode_infos is the corresponding modes of the signers of the multisig
// which could include nested multisig public keys
ModeInfos []*ModeInfo `protobuf:"bytes,2,rep,name=mode_infos,json=modeInfos,proto3" json:"mode_infos,omitempty"`
}
Multi is the mode info for a multisig public key
func (*ModeInfo_Multi) Marshal ¶
func (m *ModeInfo_Multi) Marshal() (dAtA []byte, err error)
func (*ModeInfo_Multi) MarshalToSizedBuffer ¶
func (m *ModeInfo_Multi) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ModeInfo_Multi) Size ¶
func (m *ModeInfo_Multi) Size() (n int)
func (*ModeInfo_Multi) Unmarshal ¶
func (m *ModeInfo_Multi) Unmarshal(dAtA []byte) error
type ModeInfo_Multi_ ¶
type ModeInfo_Multi_ struct {
Multi *ModeInfo_Multi `protobuf:"bytes,2,opt,name=multi,proto3,oneof" json:"multi,omitempty"`
}
func (*ModeInfo_Multi_) MarshalToSizedBuffer ¶
func (m *ModeInfo_Multi_) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ModeInfo_Multi_) Size ¶
func (m *ModeInfo_Multi_) Size() (n int)
type ModeInfo_Single ¶
type ModeInfo_Single struct {
// mode is the signing mode of the single signer
Mode types.SignMode `protobuf:"varint,1,opt,name=mode,proto3,enum=cosmos.tx.signing.v1beta1.SignMode" json:"mode,omitempty"`
}
Single is the mode info for a single signer. It is structured as a message to allow for additional fields such as locale for SIGN_MODE_TEXTUAL in the future
func (*ModeInfo_Single) Marshal ¶
func (m *ModeInfo_Single) Marshal() (dAtA []byte, err error)
func (*ModeInfo_Single) MarshalToSizedBuffer ¶
func (m *ModeInfo_Single) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ModeInfo_Single) Size ¶
func (m *ModeInfo_Single) Size() (n int)
func (*ModeInfo_Single) Unmarshal ¶
func (m *ModeInfo_Single) Unmarshal(dAtA []byte) error
type ModeInfo_Single_ ¶
type ModeInfo_Single_ struct {
Single *ModeInfo_Single `protobuf:"bytes,1,opt,name=single,proto3,oneof" json:"single,omitempty"`
}
func (*ModeInfo_Single_) MarshalToSizedBuffer ¶
func (m *ModeInfo_Single_) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*ModeInfo_Single_) Size ¶
func (m *ModeInfo_Single_) Size() (n int)
type SignDoc ¶
type SignDoc struct {
// body_bytes is protobuf serialization of a TxBody that matches the
// representation in TxRaw.
BodyBytes []byte `protobuf:"bytes,1,opt,name=body_bytes,json=bodyBytes,proto3" json:"body_bytes,omitempty"`
// auth_info_bytes is a protobuf serialization of an AuthInfo that matches the
// representation in TxRaw.
AuthInfoBytes []byte `protobuf:"bytes,2,opt,name=auth_info_bytes,json=authInfoBytes,proto3" json:"auth_info_bytes,omitempty"`
// chain_id is the unique identifier of the chain this transaction targets.
// It prevents signed transactions from being used on another chain by an
// attacker
ChainId string `protobuf:"bytes,3,opt,name=chain_id,json=chainId,proto3" json:"chain_id,omitempty"`
// account_number is the account number of the account in state
AccountNumber uint64 `protobuf:"varint,4,opt,name=account_number,json=accountNumber,proto3" json:"account_number,omitempty"`
}
SignDoc is the type used for generating sign bytes for SIGN_MODE_DIRECT.
func (*SignDoc) MarshalToSizedBuffer ¶
type SignerInfo ¶
type SignerInfo struct {
// public_key is the public key of the signer. It is optional for accounts
// that already exist in state. If unset, the verifier can use the required \
// signer address for this position and lookup the public key.
PublicKey *types.Any `protobuf:"bytes,1,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"`
// mode_info describes the signing mode of the signer and is a nested
// structure to support nested multisig pubkey's
ModeInfo *ModeInfo `protobuf:"bytes,2,opt,name=mode_info,json=modeInfo,proto3" json:"mode_info,omitempty"`
// sequence is the sequence of the account, which describes the
// number of committed transactions signed by a given address. It is used to
// prevent replay attacks.
Sequence uint64 `protobuf:"varint,3,opt,name=sequence,proto3" json:"sequence,omitempty"`
}
SignerInfo describes the public key and signing mode of a single top-level signer.
func (*SignerInfo) Marshal ¶
func (m *SignerInfo) Marshal() (dAtA []byte, err error)
func (*SignerInfo) MarshalToSizedBuffer ¶
func (m *SignerInfo) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*SignerInfo) Size ¶
func (m *SignerInfo) Size() (n int)
func (*SignerInfo) Unmarshal ¶
func (m *SignerInfo) Unmarshal(dAtA []byte) error
type Tx ¶
type Tx struct {
// body is the processable content of the transaction
Body *TxBody `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
// auth_info is the authorization related content of the transaction,
// specifically signers, signer modes and fee
AuthInfo *AuthInfo `protobuf:"bytes,2,opt,name=auth_info,json=authInfo,proto3" json:"auth_info,omitempty"`
// signatures is a list of signatures that matches the length and order of
// AuthInfo's signer_infos to allow connecting signature meta information like
// public key and signing mode by position.
Signatures [][]byte `protobuf:"bytes,3,rep,name=signatures,proto3" json:"signatures,omitempty"`
}
Tx is the standard type used for broadcasting transactions.
func (*Tx) MessageName ¶
type TxBody ¶
type TxBody struct {
// messages is a list of messages to be executed. The required signers of
// those messages define the number and order of elements in AuthInfo's
// signer_infos and Tx's signatures. Each required signer address is added to
// the list only the first time it occurs.
// By convention, the first required signer (usually from the first message)
// is referred to as the primary signer and pays the fee for the whole
// transaction.
Messages []*types.Any `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
// memo is any arbitrary note/comment to be added to the transaction.
// WARNING: in clients, any publicly exposed text should not be called memo,
// but should be called `note` instead (see https://github.com/cosmos/cosmos-sdk/issues/9122).
Memo string `protobuf:"bytes,2,opt,name=memo,proto3" json:"memo,omitempty"`
// timeout is the block height after which this transaction will not
// be processed by the chain
TimeoutHeight uint64 `protobuf:"varint,3,opt,name=timeout_height,json=timeoutHeight,proto3" json:"timeout_height,omitempty"`
// extension_options are arbitrary options that can be added by chains
// when the default options are not sufficient. If any of these are present
// and can't be handled, the transaction will be rejected
ExtensionOptions []*types.Any `protobuf:"bytes,1023,rep,name=extension_options,json=extensionOptions,proto3" json:"extension_options,omitempty"`
// extension_options are arbitrary options that can be added by chains
// when the default options are not sufficient. If any of these are present
// and can't be handled, they will be ignored
NonCriticalExtensionOptions []*types.Any `` /* 149-byte string literal not displayed */
}
TxBody is the body of a transaction that all signers sign over.
func (*TxBody) MarshalToSizedBuffer ¶
type TxRaw ¶
type TxRaw struct {
// body_bytes is a protobuf serialization of a TxBody that matches the
// representation in SignDoc.
BodyBytes []byte `protobuf:"bytes,1,opt,name=body_bytes,json=bodyBytes,proto3" json:"body_bytes,omitempty"`
// auth_info_bytes is a protobuf serialization of an AuthInfo that matches the
// representation in SignDoc.
AuthInfoBytes []byte `protobuf:"bytes,2,opt,name=auth_info_bytes,json=authInfoBytes,proto3" json:"auth_info_bytes,omitempty"`
// signatures is a list of signatures that matches the length and order of
// AuthInfo's signer_infos to allow connecting signature meta information like
// public key and signing mode by position.
Signatures [][]byte `protobuf:"bytes,3,rep,name=signatures,proto3" json:"signatures,omitempty"`
}
TxRaw is a variant of Tx that pins the signer's exact binary representation of body and auth_info. This is used for signing, broadcasting and verification. The binary `serialize(tx: TxRaw)` is stored in Tendermint and the hash `sha256(serialize(tx: TxRaw))` becomes the "txhash", commonly used as the transaction ID.
Source Files
Click to show internal directories.
Click to hide internal directories.