State logger

[cffls]

Logs the state of an instance, e.g. txbuilder, when an exception is raised. Optionally, the state could be logged every time when the function is called if log level of the parent logger is set to DEBUG.

State logger is added to TransactionBuilder.build(), TransactionBuilder.build_and_sign(), ChainContext.submit_tx().

Sample log output:

2024-05-26 13:29:49,568 - PyCardano - WARNING - Class: <class 'pycardano.txbuilder.TransactionBuilder'>, method: <function TransactionBuilder.build at 0x104ef0e00>, state:
 {
  '_datums': {},
  '_excluded_inputs': [],
  '_input_addresses': [
    'addr_test1vrm9x2zsux7va6w892g38tvchnzahvcd9tykqf3ygnmwtaqyfg52x',
  ],
  '_inputs': [],
  '_inputs_to_redeemers': {},
  '_inputs_to_scripts': {},
  '_minting_script_to_redeemers': [],
  '_outputs': [
    {
      'address': addr_test1vrm9x2zsux7va6w892g38tvchnzahvcd9tykqf3ygnmwtaqyfg52x,
      'amount': {'coin': 1000000000, 'multi_asset': {}},
      'datum': None,
      'datum_hash': None,
      'post_alonzo': False,
      'script': None,
    },
    {
      'address': addr_test1vrm9x2zsux7va6w892g38tvchnzahvcd9tykqf3ygnmwtaqyfg52x,
      'amount': {
        'coin': 2000000,
        'multi_asset': {ScriptHash(hex='31313131313131313131313131313131313131313131313131313131'): {AssetName(b'NewToken'): 1}},
      },
      'datum': None,
      'datum_hash': None,
      'post_alonzo': False,
      'script': None,
    },
  ],
  '_potential_inputs': [],
  '_reference_scripts': [],
  '_withdrawal_script_to_redeemers': [],
  'auxiliary_data': None,
  'certificates': None,
  'collaterals': [],
  'context': <test.pycardano.util.FixedChainContext object at 0x10501d790>,
  'execution_memory_buffer': 0.2,
  'execution_step_buffer': 0.2,
  'fee_buffer': None,
  'initial_stake_pool_registration': False,
  'mint': None,
  'native_scripts': None,
  'reference_inputs': set(),
  'required_signers': None,
  'ttl': None,
  'utxo_selectors': [
    <pycardano.coinselection.RandomImproveMultiAsset object at 0x10501ccd0>,
    <pycardano.coinselection.LargestFirstSelector object at 0x10501cb50>,
  ],
  'validity_start': None,
  'withdrawals': None,
  'witness_override': None,
}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.66%. Comparing base (20e8ed7) to head (b8b1576).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #352      +/-   ##
==========================================
+ Coverage   83.61%   83.66%   +0.05%     
==========================================
  Files          29       29              
  Lines        3722     3735      +13     
  Branches      939      942       +3     
==========================================
+ Hits         3112     3125      +13     
  Misses        445      445              
  Partials      165      165              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.