@kaiachain/kss-bridges-celer/docs/ParamsExplanation.md

TypeScript client and use-cases for cBridge

# PARAMETER Variables
This file contains the detailed explanation of `use-cases` required **`parameter variables`**

## CBRIDGE_GATEWAY_URL
This variable as its name shows, contains the Celer Bridge's Gateway URL (through which our SDK communicates with & performs all core features of cBridge).
```js
// cBridge testnet Gateway URL
 const CBRIDGE_GATEWAY_URL = 'https://cbridge-v2-test.celer.network'
```
From [here](https://cbridge-docs.celer.network/developer/cbridge-sdk#cbridge-testnet-endpoint) you can get Testnet & Mainnet cBridge's Gateway URLs.
## SRC_CHAIN_RPC
At this variable you should set the RPC endpoint of your source-chain (the chain from where you want to send your tokens to other chain)
```js
// testnet RPC URL for src-chain
 const SRC_CHAIN_RPC = 'https://ethereum-goerli-rpc.allthatnode.com'
```
## SRC_CHAIN_ID
At this variable you should set the chain ID of source-chain. From [here](https://chainlist.org) you can get the chain ID of your source-chain
```js
// src-chain id
 const SRC_CHAIN_ID = 5
```
## DST_CHAIN_RPC
At this variable you should set the RPC endpoint of your destination-chain (the chain to where you want to receive your tokens)
```js
// testnet RPC URL for dst-chain
 const DST_CHAIN_RPC = 'https://godwoken-testnet-v1.ckbapp.dev'
```
## DST_CHAIN_ID
At this variable you should set the chain ID of destination-chain. From [here](https://chainlist.org) you can get the chain ID of your destination-chain
```js
// dst-chain id
 const DST_CHAIN_ID = 71401
```
## TOKEN_SYMBOL
At this variable you should set the SYMBOL of your token, which you want to move from source chain to destination.
You can get SYMBOLS of supported tokens with the pair of chains you've mentioned above at [cBridge](https://test-cbridge-v2.celer.network/5/71401/USDC) web interface
```js
// token symbol
 const TOKEN_SYMBOL = 'USDC'
```
## AMOUNT
This variable is to set the `amount` of token, you want to move from source to destination chain
```js
// src-chain id
 const AMOUNT = 22
```
#### Note:
Amount for burn should always be between min and max burn values of pegged burn contract
- you can get min & max burn amount of given pegged token cBridge contract
  - for example at Godwoken testnet for the token of `USDC: 0x4Ea08DCA142F103ac2D5FF95F1d376712C5EF5a9`
  - you can get maxBurn & minBurn amount from [this](https://gw-explorer.nervosdao.community/address/0x70D4814e111Ad66B90B90D54a44797BC696BcdAF/read-contract#address-tabs) cBridge contract
  - you need to provide `USDC` address as a parameter in above-mentioned functions (same for other chains & pegged tokens)
## SLIPPAGE_TOLERANCE
At this variable you can set the slippage amount you can tolerate while transferring your tokens from source to destination chain using `poolBasedTransfer` method.
```js
// slippage example value
 const SLIPPAGE_TOLERANCE = 3000
```
## CONFIRMATIONS
At this variable you can set the number of Blocks confirmations you want a transaction should achieve before considering it mined.
```js
// confirmation example value
 const CONFIRMATIONS = 6
```
## WALLET_ADDRESS
This should have public key of your wallet / account
```js
// confirmation example value
 const WALLET_ADDRESS = '0xPUBLIC_KEY_HERE'
```
## PRIVATE_KEY
This should have private key of your wallet / account
```js
// confirmation example value
 const PRIVATE_KEY = '0xPRIVATE_KEY_HERE'
```