Skip to content

Latest commit

 

History

History
121 lines (96 loc) · 4.87 KB

polycli_ulxly_deposit-new.md

File metadata and controls

121 lines (96 loc) · 4.87 KB
Raw

polycli ulxly deposit-new

Auto-generated documentation.

Table of Contents

Description

Make a uLxLy deposit transaction

polycli ulxly deposit-new [flags]

Usage

This command will attempt to send a deposit transaction to the bridge contract.

    /**
     * @notice Deposit add a new leaf to the merkle tree
     * note If this function is called with a reentrant token, it would be possible to `claimTokens` in the same call
     * Reducing the supply of tokens on this contract, and actually locking tokens in the contract.
     * Therefore we recommend to third parties bridges that if they do implement reentrant call of `beforeTransfer` of some reentrant tokens
     * do not call any external address in that case
     * note User/UI must be aware of the existing/available networks when choosing the destination network
     * @param destinationNetwork Network destination
     * @param destinationAddress Address destination
     * @param amount Amount of tokens
     * @param token Token address, 0 address is reserved for ether
     * @param forceUpdateGlobalExitRoot Indicates if the new global exit root is updated or not
     * @param permitData Raw data of the call `permit` of the token
     */
    function bridgeAsset(
        uint32 destinationNetwork,
        address destinationAddress,
        uint256 amount,
        address token,
        bool forceUpdateGlobalExitRoot,
        bytes calldata permitData
    );

Each transaction will require manual input of parameters. Example usage:

polycli ulxly deposit-new \
        --private-key 12d7de8621a77640c9241b2595ba78ce443d05e94090365ab3bb5e19df82c625 \
        --gas-limit 300000 \
        --amount 1000000000000000000 \
        --rpc-url http://127.0.0.1:8545 \
        --bridge-address 0xD71f8F956AD979Cc2988381B8A743a2fE280537D \
        --destination-network 1 \
        --destination-address 0xE34aaF64b29273B7D567FCFc40544c014EEe9970

This command would use the supplied private key and attempt to send a deposit transaction to the bridge contract address with the input flags. Successful deposit transaction will output logs like below:

Deposit Transaction Successful: 0x8c9b82e8abdfb4aad5fccd91879397acfa73e4261282c8dc634734d05ad889d3

Upon successful deposit, the transaction can be queried using polycli ulxly deposit-get command

Failed deposit transactions will output logs like below:

Deposit Transaction Failed: 0x60385209b0e9db359c24c88c2fb8a5c9e4628fffe8d5fb2b5e64dfac3a2b7639
Try increasing the gas limit:
Current gas limit: 100000
Cumulative gas used for transaction: 98641

The reason for failing may likely be due to the out of gas error. Increasing the --gas-limit flag value will likely resolve this.

Flags

      --amount int                           The amount to send.
      --bridge-address string                The address of the bridge contract.
      --bridge-message                       Bridge a message instead of an asset.
      --bridge-weth                          Bridge a weth instead of an asset.
      --call-data permit                     For bridging assets - raw data of the call permit of the token. For bridging messages - the metadata. (default "0x")
      --chain-id string                      The chainID.
      --destination-address string           The address of receiver in destination network.
      --destination-network uint32           The destination network number. (default 1)
      --force-update-root                    Force the update of the Global Exit Root. (default true)
      --gas-limit uint                       The gas limit for the transaction. Setting this value to 0 will estimate the gas limit.
  -h, --help                                 help for deposit-new
      --private-key string                   The private key of the sender account.
      --rpc-url string                       The RPC endpoint of the network (default "http://127.0.0.1:8545")
      --token-address string                 The address of the token to send. (default "0x0000000000000000000000000000000000000000")
      --transaction-receipt-timeout uint32   The timeout limit to check for the transaction receipt of the deposit. (default 60)

The command also inherits flags from parent commands.

      --config string   config file (default is $HOME/.polygon-cli.yaml)
      --pretty-logs     Should logs be in pretty format or JSON (default true)
  -v, --verbosity int   0 - Silent
                        100 Panic
                        200 Fatal
                        300 Error
                        400 Warning
                        500 Info
                        600 Debug
                        700 Trace (default 500)

See also