prepare_approve_for_burn

Documentation for eth_defi.cctp.transfer.prepare_approve_for_burn function.

prepare_approve_for_burn(web3, amount, burn_token=None)

Build a USDC approve() call to TokenMessengerV2.

Must be called before prepare_deposit_for_burn().

Parameters

  • web3 (web3.main.Web3) – Web3 connection to the source chain

  • amount (int) – Amount of USDC to approve in raw token units (6 decimals)

  • burn_token (Optional[Union[eth_typing.evm.HexAddress, str]]) – USDC address on the source chain. If None, auto-detected.

Returns

Bound contract function for USDC.approve(TokenMessengerV2, amount)

Return type

web3.contract.contract.ContractFunction