algokit_utils.models.transaction
================================

.. py:module:: algokit_utils.models.transaction


Attributes
----------

.. autoapisummary::

   algokit_utils.models.transaction.Arc2TransactionNote
   algokit_utils.models.transaction.TransactionNoteData
   algokit_utils.models.transaction.TransactionNote


Classes
-------

.. autoapisummary::

   algokit_utils.models.transaction.BaseArc2Note
   algokit_utils.models.transaction.StringFormatArc2Note
   algokit_utils.models.transaction.JsonFormatArc2Note
   algokit_utils.models.transaction.TransactionWrapper
   algokit_utils.models.transaction.SendParams


Module Contents
---------------

.. py:class:: BaseArc2Note

   Bases: :py:obj:`TypedDict`


   Base ARC-0002 transaction note structure


   .. py:attribute:: dapp_name
      :type:  str


.. py:class:: StringFormatArc2Note

   Bases: :py:obj:`BaseArc2Note`


   ARC-0002 note for string-based formats (m/b/u)


   .. py:attribute:: format
      :type:  Literal['m', 'b', 'u']


   .. py:attribute:: data
      :type:  str


.. py:class:: JsonFormatArc2Note

   Bases: :py:obj:`BaseArc2Note`


   ARC-0002 note for JSON format


   .. py:attribute:: format
      :type:  Literal['j']


   .. py:attribute:: data
      :type:  str | dict[str, Any] | list[Any] | int | None


.. py:data:: Arc2TransactionNote

.. py:data:: TransactionNoteData

.. py:data:: TransactionNote

.. py:class:: TransactionWrapper(transaction: algosdk.transaction.Transaction)

   Wrapper around algosdk.transaction.Transaction with optional property validators


   .. py:property:: raw
      :type: algosdk.transaction.Transaction



   .. py:property:: payment
      :type: algosdk.transaction.PaymentTxn



   .. py:property:: keyreg
      :type: algosdk.transaction.KeyregTxn



   .. py:property:: asset_config
      :type: algosdk.transaction.AssetConfigTxn



   .. py:property:: asset_transfer
      :type: algosdk.transaction.AssetTransferTxn



   .. py:property:: asset_freeze
      :type: algosdk.transaction.AssetFreezeTxn



   .. py:property:: application_call
      :type: algosdk.transaction.ApplicationCallTxn



   .. py:property:: state_proof
      :type: algosdk.transaction.StateProofTxn



.. py:class:: SendParams

   Bases: :py:obj:`TypedDict`


   Parameters for sending a transaction


   .. py:attribute:: max_rounds_to_wait
      :type:  int | None


   .. py:attribute:: suppress_log
      :type:  bool | None


   .. py:attribute:: populate_app_call_resources
      :type:  bool | None


   .. py:attribute:: cover_app_call_inner_transaction_fees
      :type:  bool | None