Skip to content

add destination fee balance to xcm sdk docs #730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eshaben merged 6 commits into from
Sep 1, 2023
Merged

add destination fee balance to xcm sdk docs #730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5317705
add destinationFeeBalance property in the response examples
mmaurello Aug 28, 2023
99a115a
Merge pull request #727 from mmaurello/mjm/add-destinationFeeBalance
eshaben Aug 29, 2023
d497042
add destinationFeeBalance to reference page
eshaben Aug 29, 2023
cf4a050
destinationFeeBalance is part of the source chain object
eshaben Aug 29, 2023
6cb2c08
Update builders/interoperability/xcm/xcm-sdk/v1/reference.md
eshaben Sep 1, 2023
d0c42fb
fix typo
eshaben Sep 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions builders/interoperability/xcm/xcm-sdk/v1/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,15 +110,16 @@ The XCM SDK is based on the premise of defining an asset to transfer and then de

- `SourceChainTransferData` - defines the source chain data for the transfer

| Name | Type | Description |
|:--------------------:|:-------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------:|
| `balance` | *AssetAmount* | The balance of the asset being transferred for the source address |
| `chain` | *AnyChain* | The source chain information |
| `existentialDeposit` | *AssetAmount* | The existential deposit for the asset being transferred on the source chain |
| `fee` | *AssetAmount* | The amount of fees for the asset being transferred on the source chain |
| `feeBalance` | *AssetAmount* | The balance of the asset being transferred on the source chain |
| `min` | *AssetAmount* | The minimum amount of the asset that should be kept on the source chain, taking into consideration the `existentialDeposit` and `fee` for the transfer |
| `max` | *AssetAmount* | The maximum amount of the asset that *can* be transferred |
| Name | Type | Description |
|:-----------------------:|:-------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------:|
| `balance` | *AssetAmount* | The balance of the asset being transferred for the source address |
| `chain` | *AnyChain* | The source chain information |
| `destinationFeeBalance` | *AssetAmount* | The balance of the asset used to pay for fees in the destination chain |
| `existentialDeposit` | *AssetAmount* | The existential deposit for the asset being transferred on the source chain |
| `fee` | *AssetAmount* | The amount of fees for the asset being transferred on the source chain |
| `feeBalance` | *AssetAmount* | The balance of the asset being transferred on the source chain |
| `min` | *AssetAmount* | The minimum amount of the asset that should be kept on the source chain, taking into consideration the `existentialDeposit` and `fee` for the transfer |
| `max` | *AssetAmount* | The maximum amount of the asset that *can* be transferred |

## Core Methods {: #core-sdk-methods }

Expand Down Expand Up @@ -219,7 +220,7 @@ When building transfer data with the `Sdk().assets()` function, you'll use multi
|:----------:|:--------:|:---------------------------------------------------------------------------------------------:|
| `accounts` | function | Sets the source address, the destination address, and the signer(s) required for the transfer |

- `accounts()` - sets the source address, the destination address, and the signer(s) required for the transfer. **Must call `destionation()` first**
- `accounts()` - sets the source address, the destination address, and the signer(s) required for the transfer. **Must call `destination()` first**

??? code "Parameters"
| Name | Type | Description |
Expand Down
14 changes: 14 additions & 0 deletions builders/interoperability/xcm/xcm-sdk/v1/xcm-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,13 @@ As previously mentioned, regardless of which method you use to build the transfe
weight: 1000000000,
ws: 'wss://rpc.polkadot.io'
},
destinationFeeBalance: e {
key: 'dot',
originSymbol: 'DOT',
amount: 0n,
decimals: 10,
symbol: 'DOT'
},
existentialDeposit: e {
key: 'dot',
originSymbol: 'DOT',
Expand Down Expand Up @@ -513,6 +520,13 @@ The `swap` function returns the transfer data with the original source chain and
id: 1284,
rpc: 'https://rpc.api.moonbeam.network'
},
destinationFeeBalance: e {
key: 'dot',
originSymbol: 'DOT',
amount: 0n,
decimals: 10,
symbol: 'DOT'
},
existentialDeposit: e {
key: 'glmr',
originSymbol: 'GLMR',
Expand Down