Skip to content
Algorand Developer Portal

algokit_utils.transactions.builders.common

algokit_utils.transactions.builders.common

Section titled “algokit_utils.transactions.builders.common”

Attributes

Section titled “Attributes”
SuggestedParamsLike

Classes

Section titled “Classes”
TransactionHeader
FeeConfig
BuiltTransaction

Functions

Section titled “Functions”

| build_transaction_header(→ tuple[TransactionHeader, …) | | | ---------------------------------------------------------------------------------------------------------------------------------- | ----- | --- | | build_transaction(…) | | | apply_transaction_fees(→ BuiltTransaction) | | | encode_lease(→ bytes | None) | | | calculate_inner_fee_delta(…) | |

Module Contents

Section titled “Module Contents”

SuggestedParamsLike

Section titled “SuggestedParamsLike”

class TransactionHeader

Section titled “class TransactionHeader”

sender : str

Section titled “sender : str”

first*valid *: int_

Section titled “first*valid *: int_”

last*valid *: int_

Section titled “last*valid *: int_”

genesis*hash *: bytes_

Section titled “genesis*hash *: bytes_”

genesis*id *: str | None_

Section titled “genesis*id *: str | None_”

note : bytes | None

Section titled “note : bytes | None”

lease : bytes | None

Section titled “lease : bytes | None”

rekey*to *: str | None_

Section titled “rekey*to *: str | None_”

class FeeConfig

Section titled “class FeeConfig”

fee*per_byte *: int_

Section titled “fee*per_byte *: int_”

min*fee *: int_

Section titled “min*fee *: int_”

flat*fee *: bool_

Section titled “flat*fee *: bool_”

class BuiltTransaction

Section titled “class BuiltTransaction”

txn : Transaction

Section titled “txn : Transaction”

logical*max_fee *: AlgoAmount | None_

Section titled “logical*max_fee *: AlgoAmount | None_”

build_transaction_header(params: CommonTxnParams, suggested_params: SuggestedParamsLike, *, default_validity_window: int, default_validity_window_is_explicit: bool, is_localnet: bool) → tuple[TransactionHeader, FeeConfig]

Section titled “build_transaction_header(params: CommonTxnParams, suggested_params: SuggestedParamsLike, *, default_validity_window: int, default_validity_window_is_explicit: bool, is_localnet: bool) → tuple[TransactionHeader, FeeConfig]”

build_transaction(txn_type: TransactionType, header: TransactionHeader, *, payment: PaymentTransactionFields | None = None, asset_transfer: AssetTransferTransactionFields | None = None, asset_config: AssetConfigTransactionFields | None = None, asset_freeze: AssetFreezeTransactionFields | None = None, application_call: AppCallTransactionFields | None = None, key_registration: KeyRegistrationTransactionFields | None = None) → Transaction

Section titled “build_transaction(txn_type: TransactionType, header: TransactionHeader, *, payment: PaymentTransactionFields | None = None, asset_transfer: AssetTransferTransactionFields | None = None, asset_config: AssetConfigTransactionFields | None = None, asset_freeze: AssetFreezeTransactionFields | None = None, application_call: AppCallTransactionFields | None = None, key_registration: KeyRegistrationTransactionFields | None = None) → Transaction”

apply_transaction_fees(txn: Transaction, params: CommonTxnParams, fee_config: FeeConfig) → BuiltTransaction

Section titled “apply_transaction_fees(txn: Transaction, params: CommonTxnParams, fee_config: FeeConfig) → BuiltTransaction”

encode_lease(lease: str | bytes | None) → bytes | None

Section titled “encode_lease(lease: str | bytes | None) → bytes | None”

calculate_inner_fee_delta(inner_txns: list[PendingTransactionResponse] | None, min_fee: int, acc: FeeDelta | None = None) → FeeDelta | None

Section titled “calculate_inner_fee_delta(inner_txns: list[PendingTransactionResponse] | None, min_fee: int, acc: FeeDelta | None = None) → FeeDelta | None”