docs: add BTS API and commands for NEAR #502
Conversation
…-the-workflow-of-cross-chain-transfer-from-near
doc/near/bts.md
Outdated
| ``` | ||
|
|
||
|
|
||
| ## Usage |
There was a problem hiding this comment.
These usages are not clear enough how to use because there are input parameters with no examples of what those should be. Please add the real-world usage for these commands instead of linking to the CLI commands.
doc/near/bts.md
Outdated
|
|
||
| ### Transfer NEAR to Cross-Chain | ||
| 1. Deposit NEAR to BTS [here](#deposit-near-to-bts) | ||
| 2. Query Transfer Fee [here] (#get-fee) |
There was a problem hiding this comment.
this is not correctly linking because there is a space between [here] and (#get-fee)
doc/near/bts.md
Outdated
|
|
||
| **CLI Command** | ||
| ```console | ||
| NEAR_ENV=testnet near call <NEP141 Contract> ft_transfer_call '{"receiver_id": "<BTS>", "amount": "<AMOUNT>", "msg": ""}' --accountId <ACCOUNT ID> --amount <1 yoctoNEAR in highest Denomination ie 0.000000000000000000000001> |
There was a problem hiding this comment.
Please add a description for what the input parameters are.
doc/near/bts.md
Outdated
|
|
||
| **CLI Command** | ||
| ```console | ||
| NEAR_ENV=testnet near call <BTS> transfer '{"coin_name": "<Coin Name>", "destination": "btp://<Network>/<Address>", "amount": "<Amount in lowest Denomination, For NEAR in yoctoNEAR ie 1 NEAR = 1^24 yoctoNEAR>"}' --gas 300000000000000 --accountId <ACCOUNT ID> |
There was a problem hiding this comment.
Please add a description for what the input parameters are. For example, the user may not know what BTS is or what btp:///
is. I also don't see what the valid possible inputs are for btp:/// because there is no NEAR info in https://github.com/icon-project/icon-bridge/blob/main/docs/testnet_deployment.json…-cross-chain-transfer-from-near
MuhammedIrfan
requested review from
pragyanshrestha-ibriz and
andrii-kl
as code owners
Codecov Report
@@ Coverage Diff @@
## main #502 +/- ##
============================================
+ Coverage 42.01% 42.08% +0.06%
Complexity 801 801
============================================
Files 115 115
Lines 11321 11321
Branches 941 941
============================================
+ Hits 4757 4764 +7
+ Misses 6155 6147 -8
- Partials 409 410 +1
|
|
@CyrusVorwald-ICON I have updated with the requested changes. Please review. |
| "near": { | ||
| "bmc":"7270a79be789d770f2de015047684e2806597eeee96ee3ca87b179c6399deaaf", | ||
| "bts":"bts.iconbridge-6.testnet", | ||
| "ICX":"btp-icx.bts.iconbridge-6.testnet" |
There was a problem hiding this comment.
please move tokens above smart contract addresses to be consistent with icon and bsc, and add an equivalent contract for each of the tokens listed on icon and bsc that are not currently listed on near
There was a problem hiding this comment.
Also, where are the NEAR token addresses for the other networks?
Checklist:
Related Issues:
Closes #429