Skip to content

Commit

Permalink
Merge dfd1456 into 496a8e4
Browse files Browse the repository at this point in the history
  • Loading branch information
smk762 committed Jul 17, 2024
2 parents 496a8e4 + dfd1456 commit 5088be6
Showing 1 changed file with 29 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,27 @@ The token's contract **must** have `approve` and `transferFrom` methods. Additio
| Parameter | Type | Description |
| ----------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| chain\_id | integer | To find the EVM chain ID, see [Chainlist](https://chainlist.org/) |
| gas\_limit | object | Optional, required for tokens only. Defines more precise gas prices for swap or transaction operations, useful for tokens called ovcer proxy contracts which often require more than the default gas. See the `Gas Limit Options` table below for more information. |
| protocol.type | string | Platform / protocol - e.g `ETH` for Ethereum, `ERC20` for ERC20 tokens on the Ethereum network |
| protocol.protocol\_data | object | Required for tokens only. |
| protocol.protocol\_data.platform | string | The parent coin of the token's platform - e.g `MATIC` for PLG20 tokens |
| protocol.protocol\_data.contract\_address | string | **Must be mixed case** The indentifying hex string for the token's contract. Can be found on sites like [EthScan](https://etherscan.io/), [BscScan](https://bscscan.com/) & [PolygonScan](https://polygonscan.com/) |
| protocol.protocol\_data.contract\_address | string | **Must be mixed case** The identifying hex string for the token's contract. Can be found on sites like [EthScan](https://etherscan.io/), [BscScan](https://bscscan.com/) & [PolygonScan](https://polygonscan.com/) |


### Gas Limit Options

| Parameter | Type | Description |
| ----------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| eth_send_coins | integer | Gas limit for sending coins. |
| eth_send_erc20 | integer | Gas limit for sending ERC20 tokens. |
| eth_payment | integer | Gas limit for swap payment tx with coins. |
| erc20_payment | integer | Gas limit for swap payment tx with ERC20 tokens. |
| eth_receiver_spend | integer | Gas limit for swap receiver spend tx with coins. |
| erc20_receiver_spend | integer | Gas limit for swap receiver spend tx with ERC20 tokens. |
| eth_sender_refund | integer | Gas limit for swap refund tx with coins. |
| erc20_sender_refund | integer | Gas limit for swap refund tx with with ERC20 tokens. |
| eth_max_trade_gas | integer | Gas limit for other operations. |


### ERC20 token example

Expand All @@ -152,6 +169,17 @@ The token's contract **must** have `approve` and `transferFrom` methods. Additio
"platform": "ETH",
"contract_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
}
},
"gas_limit": {
"eth_send_coins": 21000,
"eth_send_erc20": 65000,
"eth_payment": 75000,
"erc20_payment": 120000,
"eth_receiver_spend": 55000,
"erc20_receiver_spend": 130000,
"eth_sender_refund": 110000,
"erc20_sender_refund": 110000,
"eth_max_trade_gas": 150000
}
}
```
Expand Down

0 comments on commit 5088be6

Please sign in to comment.