Transaction Module

Transaction module handles blockchain transaction operations and queries.

To learn more about how to use the AI Agent SDK to interact with the transaction module, please visit AI Agent SDK Transaction Queries.

3.1 Get Transaction By Hash

Fetches a transaction by hash.

Python

Function Name

get_transaction_by_hash

Query

• Arguments

  hash (str): The hash of the transaction.

• Example Code

  from crypto_com_developer_platform_client import Transaction
  
  tx = Transaction.get_transaction_by_hash('example-hash')
  print(tx)

Response

• Returns

  The transaction details.

• Errors

  ValueError: If the Transaction class is not initialized with a Client instance.

• Example Return

  {'status': 'Success', 'data': {'transaction': {'_type': 'TransactionResponse', 'accessList': example-list, 'blockNumber': example-block-number, 'blockHash': 'example-hash', 'blobVersionedHashes': example-hashes, 'chainId': 'example-chain0id', 'data': 'example-data', 'from': 'example-from', 'gasLimit': 'example-gas-limit', 'gasPrice': 'example-gas-price', 'hash': 'example-hash', 'maxFeePerGas': 'example-fee', 'maxPriorityFeePerGas': 'example-fee', 'maxFeePerBlobGas': example-fee, 'nonce': example-nonce, 'signature': {'_type': 'signature', 'networkV': 'example-V', 'r': 'example-r', 's': 'example-s', 'v': example-v}, 'to': 'example-to', 'index': example-index, 'type': example-type, 'value': 'example-value'}}}

TypeScript

Function Name

getTransactionByHash

Query

• Arguments

  {string} txHash: Transaction hash.

• Example Code

  import { Transaction } from '@crypto.com/developer-platform-client';
  
  const tx = await Transaction.getTransactionByHash('example-hash');
  console.log(tx);

Response

• Returns

  {Promise<ApiResponse<TransactionByHash>>}: A promise that resolves to the transaction result

• Example Return

  {
    status: 'Success',
    data: {
      transaction: {
        _type: 'TransactionResponse',
        accessList: example-list,
        blockNumber: example-block-number,
        blockHash: 'example-hash',
        blobVersionedHashes: example-hashes,
        chainId: 'example-chain-id',
        data: 'example-data',
        from: 'example-from',
        gasLimit: 'example-gas-limit',
        gasPrice: 'example-gas-price',
        hash: 'example-hash',
        maxFeePerGas: 'example-fee',
        maxPriorityFeePerGas: 'example-fee',
        maxFeePerBlobGas: example-fee,
        nonce: example-nonce,
        signature: [example-singature],
        to: 'example-to',
        index: example-index,
        type: example-type,
        value: 'example-value'
      }
    }
  }

3.2 Get Transaction Status

Fetches transaction status by hash.

Python

Function Name

get_transaction_status

Query

• Arguments

  hash (str): The hash of the transaction.

• Example Code

  from crypto_com_developer_platform_client import Transaction
  
  status = Transaction.get_transaction_status('example-hash')
  print(status)

Response

• Returns

  The transaction status.

• Errors

  ValueError: If the Transaction class is not initialized with a Client instance.

• Example Return

  {'status': 'Success', 'data': {'status': 1}}

TypeScript

Function Name

getTransactionStatus

Query

• Arguments

  {string} txHash: Transaction hash.

• Example Code

  import { Transaction } from '@crypto.com/developer-platform-client';
  
  const status = await Transaction.getTransactionStatus('example-hash');
  console.log(status);

Response

• Returns

  Promise<ApiResponse<TransactionStatus>>}: A promise that resolves to the transaction status.

• Example Return

  { status: 'Success', data: { status: 1 } }

3.3 Get Transaction Count

Fetches transaction count for a wallet.

Python

Function Name

get_transaction_count

Query

• Arguments

  wallet_address (str): The address to get the transaction count for.

• Example Code

  from crypto_com_developer_platform_client import Transaction
  
  count = Transaction.get_transaction_count('example-wallet')
  print(count)

Response

• Returns

  The transaction count for the wallet address.

• Errors

  ValueError: If the Transaction class is not initialized with a Client instance.

• Example Return

  {'status': 'Success', 'data': {'count': example-count}}

TypeScript

Function Name

getTransactionCount

Query

• Arguments

  {string} walletAddress: Wallet address.

• Example Code

  import { Transaction } from '@crypto.com/developer-platform-client';
  
  const count = await Transaction.getTransactionCount('example-address');
  console.log(count);

Response

• Returns

  {Promise<ApiResponse<TransactionCount>>}: A promise that resolves to the transaction count.

• Example Return

  { status: 'Success', data: { count: example-number } }

3.4 Get Gas Price

Fetches current gas price.

Python

Function Name

get_gas_price

Query

• Example Code

  from crypto_com_developer_platform_client import Transaction
  
  price = Transaction.get_gas_price()
  print(price)

Response

• Returns

  The current gas price.

• Errors

  ValueError: If the Transaction class is not initialized with a Client instance.

• Example Return

  {'status': 'Success', 'data': {'gasPrice': 'example-gas-price'}}

TypeScript

Function Name

getGasPrice

Query

• Example Code

  import { Transaction } from '@crypto.com/developer-platform-client';
  
  const gasPrice = await Transaction.getGasPrice();
  console.log(gasPrice);

Response

• Returns

  {Promise<ApiResponse<GasPrice>>}: A promise that resolves to the gas price.

• Example Return

  { status: 'Success', data: { gasPrice: 'example-gas-price' } }

3.5 Get Fee Data

Fetches current fee data.

Python

Function Name

get_fee_data

Query

• Example Code

  from crypto_com_developer_platform_client import Transaction
  
  data = Transaction.get_fee_data()
  print(data)

Response

• Returns

  The current fee data.

• Errors

  ValueError: If the Transaction class is not initialized with a Client instance.

• Example Return

  {'status': 'Success', 'data': {'feeData': {'_type': 'FeeData', 'gasPrice': 'example-gas-price', 'maxFeePerGas': 'example-fee', 'maxPriorityFeePerGas': 'example-fee'}}}

TypeScript

Function Name

getFeeData

Query

• Example Code

  import { Transaction } from '@crypto.com/developer-platform-client';
  
  const feeData = await Transaction.getFeeData();
  console.log(feeData);

Response

• Returns

  {Promise<ApiResponse<FeeData>>}: A promise that resolves to the fee data.

• Example Return

  {
    status: 'Success',
    data: {
      feeData: {
        _type: 'FeeData',
        gasPrice: 'example-gas-price',
        maxFeePerGas: 'example-fee',
        maxPriorityFeePerGas: 'example-fee'
      }
    }
  }

3.6 Estimate Gas

Estimates gas for a transaction.

Python

Function Name

estimate_gas

Query

• Arguments

  payload (dict): The payload for gas estimation, including fields like `from`, `to`, `value`, `gasLimit`, `gasPrice`, `data`.

• Example Code

  from crypto_com_developer_platform_client import Transaction
  
  gas = Transaction.estimate_gas({'from': 'example-from', 'to': 'example-to', 'value': 'example-value', 'gasLimit': 'example-gas-limit', 'gasPrice': 'example-gas-price', 'data': 'example-data'})
  print(gas)

Response

• Returns

  The estimated gas information.

• Errors

  ValueError: If the Transaction class is not initialized with a Client instance.

• Example Return

  {'status': 'Success', 'data': {'gasLimit': 'example-gas-limit'}}

TypeScript

Function Name

estimateGas

Query

• Arguments

  {object} payload: Transaction payload (from, to, value, gasLimit, gasPrice, data).

• Example Code

  import { Transaction } from '@crypto.com/developer-platform-client';
  
  const estimation = await Transaction.estimateGas({from: 'example-from', to: 'example-to', value: 'example-value', gasLimit: 'example-gas-limit', gasPrice: 'example-gas-price', data: 'example-data'});
  console.log(estimation);

Response

• Returns

  {Promise<ApiResponse<EstimateGasData>>}: A promise that resolves to the estimate gas data.

• Example Return

  { status: 'Success', data: { gasLimit: 'example-gas-limit' } }