cosmpy.aerial.tx

Transaction.

TxState Objects

class TxState(Enum)

Transaction state.

Arguments:

• Enum: Draft, Sealed, Final

SigningMode Objects

class SigningMode(Enum)

Signing mode.

Arguments:

• Enum: Direct

SigningCfg Objects

@dataclass
class SigningCfg()

Transaction signing configuration.

direct

@staticmethod
def direct(public_key: PublicKey, sequence_num: int) -> "SigningCfg"

Transaction signing configuration using direct mode.

Arguments:

• public_key: public key
• sequence_num: sequence number

Returns:

Transaction signing configuration

Transaction Objects

class Transaction()

Transaction.

__init__

def __init__()

Init the Transactions with transaction message, state, fee and body.

state

@property
def state() -> TxState

Get the transaction state.

Returns:

current state of the transaction

msgs

@property
def msgs()

Get the transaction messages.

Returns:

transaction messages

fee

@property
def fee() -> Optional[str]

Get the transaction fee.

Returns:

transaction fee

tx

@property
def tx()

Initialize.

Raises:

• RuntimeError: If the transaction has not been completed.

Returns:

transaction

add_message

def add_message(msg: Any) -> "Transaction"

Initialize.

Arguments:

• msg: transaction message (memo)

Raises:

• RuntimeError: If the transaction is not in the draft state.

Returns:

transaction with message added

seal

def seal(signing_cfgs: Union[SigningCfg, List[SigningCfg]],
         fee: str,
         gas_limit: int,
         memo: Optional[str] = None) -> "Transaction"

Seal the transaction.

Arguments:

• signing_cfgs: signing configs
• fee: transaction fee
• gas_limit: transaction gas limit
• memo: transaction memo, defaults to None

Returns:

sealed transaction.

sign

def sign(signer: Signer,
         chain_id: str,
         account_number: int,
         deterministic: bool = False) -> "Transaction"

Sign the transaction.

Arguments:

• signer: Signer
• chain_id: chain id
• account_number: account number
• deterministic: deterministic, defaults to False

Raises:

• RuntimeError: If transaction is not sealed

Returns:

signed transaction

complete

def complete() -> "Transaction"

Update transaction state to Final.

Returns:

transaction with updated state