From 9fddb2146fce320ee550a61b4ca7bc52bfbe8b48 Mon Sep 17 00:00:00 2001 From: Elmar Kenigs Date: Mon, 15 Jul 2024 16:26:42 +0200 Subject: [PATCH] Reverted docs files from main --- mkdocs/docs/contribute.md | 6 +++--- mkdocs/docs/example-usage.md | 20 ++++++++++---------- mkdocs/docs/reference/interfaces.md | 2 +- mkdocs/docs/reference/methods.md | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/mkdocs/docs/contribute.md b/mkdocs/docs/contribute.md index ae7c23d3..d52c00ea 100644 --- a/mkdocs/docs/contribute.md +++ b/mkdocs/docs/contribute.md @@ -48,7 +48,7 @@ Follow these steps: 3. Add your asset to the `assetsList` array at the end of the file !!! note -Assets are listed in alphabetical order. Please make sure you follow this order when adding new assets. + Assets are listed in alphabetical order. Please make sure you follow this order when adding new assets. ## Add a Chain @@ -120,7 +120,7 @@ To add a chain, take the following steps: 4. Add the newly created chain to the `chainsList` array at the end of the file !!! note -Chains are listed in alphabetical order. Please make sure you follow this order when adding new chains. + Chains are listed in alphabetical order. Please make sure you follow this order when adding new chains. Now that you've added the chain, you can continue to the next section to add the assets that this chain supports. @@ -242,7 +242,7 @@ Assuming that all of the required pallets and methods are already supported, you 4. Add the newly created chain configurations to the `chainsConfigList` in the `xcm-sdk/blob/main/packages/config/src/configs/index.ts` file !!! note -Chain configurations are listed in alphabetical order. Please follow this order when adding new chain configurations. + Chain configurations are listed in alphabetical order. Please follow this order when adding new chain configurations. For example, to add support to transfer USDT from the Polkadot Asset Hub to Moonbeam, the Polkadot Asset Hub configuration file is as follows: diff --git a/mkdocs/docs/example-usage.md b/mkdocs/docs/example-usage.md index 361531fe..0aa16c5d 100644 --- a/mkdocs/docs/example-usage.md +++ b/mkdocs/docs/example-usage.md @@ -53,7 +53,7 @@ You can pass, for example, a [browser extension wallet as a signer into Ethers]( To create an EVM signer and a Polkadot signer, you can refer to the following sections. !!! warning -**Never store your private key or mnemonic in a JavaScript or TypeScript file.** + **Never store your private key or mnemonic in a JavaScript or TypeScript file.** ### Create an EVM Signer {: #create-a-evm-signer } @@ -212,7 +212,7 @@ If you want to pass in a browser extension wallet to viem, you can use the follo ``` !!! note ---8<-- 'text/endpoint-setup.md' + --8<-- 'text/endpoint-setup.md' ### Create a Polkadot Signer {: #create-a-polkadot-signer } @@ -237,7 +237,7 @@ createPolkadotSigner(); ``` !!! note -In the above `INSERT_PRIVATE_KEY` field, you can specify a seed phrase instead of a private key. + In the above `INSERT_PRIVATE_KEY` field, you can specify a seed phrase instead of a private key. ## Get Asset and Chain Data {: #asset-chain-data } @@ -398,7 +398,7 @@ fromPolkadot(); ``` !!! note -For more information on each of the `Sdk().assets()` builder functions, including the parameters and returned data, please refer to the [XCM SDK Reference](./reference/methods.md#build-the-transfer-data-starting-with-assets){target=\_blank}. + For more information on each of the `Sdk().assets()` builder functions, including the parameters and returned data, please refer to the [XCM SDK Reference](./reference/methods.md#build-the-transfer-data-starting-with-assets){target=\_blank}. If you don't need any of the asset or chain information, you can use the `getTransferData` function: @@ -423,7 +423,7 @@ fromPolkadot(); ``` !!! note -For more information on the `Sdk().getTransferData()` function, including the parameters and returned data, please refer to the [XCM SDK Reference](./reference/methods.md#the-get-transfer-data-method){target=\_blank}. + For more information on the `Sdk().getTransferData()` function, including the parameters and returned data, please refer to the [XCM SDK Reference](./reference/methods.md#the-get-transfer-data-method){target=\_blank}. As previously mentioned, the same output will be generated regardless of which method you use to build the transfer data. @@ -589,7 +589,7 @@ console.log(`${data.source.chain.name} tx hash: ${hash}`); As the above snippet shows, the `transfer` function returns a transaction hash on the source chain. !!! note -For more information on the parameters and returned data for `transfer`, please refer to the [XCM SDK Reference](./reference/methods.md#the-transfer-method){target=\_blank}. + For more information on the parameters and returned data for `transfer`, please refer to the [XCM SDK Reference](./reference/methods.md#the-transfer-method){target=\_blank}. ## Swap an Asset {: #swap-an-asset} @@ -745,7 +745,7 @@ The `swap` function returns the transfer data with the original source chain and ``` !!! note -For more information on the parameters and returned data for `swap`, please refer to the [XCM SDK Reference](./reference/methods.md#the-swap-method){target=\_blank}. + For more information on the parameters and returned data for `swap`, please refer to the [XCM SDK Reference](./reference/methods.md#the-swap-method){target=\_blank}. ## Get an Estimate of the Asset to Be Received on the Destination Chain {: #get-estimate } @@ -786,7 +786,7 @@ The `getEstimate` function returns the estimated amount along with information o ``` !!! note -For more information on the parameters and returned data for `getEstimate`, please refer to the [XCM SDK Reference](./reference/methods.md#the-get-estimate-method){target=\_blank}. + For more information on the parameters and returned data for `getEstimate`, please refer to the [XCM SDK Reference](./reference/methods.md#the-get-estimate-method){target=\_blank}. ## Get Transfer Minimum and Maximum Amounts {: #transfer-min-max-amounts } @@ -838,7 +838,7 @@ The `min` and `max` properties return the minimum and maximum amount of the asse ``` !!! note -For more information on assets and asset amounts, please refer to the [XCM SDK Reference](./reference/interfaces.md#assets){target=\_blank}. + For more information on assets and asset amounts, please refer to the [XCM SDK Reference](./reference/interfaces.md#assets){target=\_blank}. ## Get Transfer Fees {: #get-transfer-fees } @@ -887,6 +887,6 @@ The `fee` property returns the fees to be paid along with information on the ass ``` !!! note -For more information on assets and asset amounts, including fees, please refer to the [XCM SDK Reference](./reference/interfaces.md#assets){target=\_blank}. + For more information on assets and asset amounts, including fees, please refer to the [XCM SDK Reference](./reference/interfaces.md#assets){target=\_blank}. --8<-- 'text/third-party-content.md' diff --git a/mkdocs/docs/reference/interfaces.md b/mkdocs/docs/reference/interfaces.md index b3977693..19fd5509 100644 --- a/mkdocs/docs/reference/interfaces.md +++ b/mkdocs/docs/reference/interfaces.md @@ -44,7 +44,7 @@ Defines an asset's key and symbol used on the asset's origin chain. Defines properties related to an asset, including `Asset` properties, the decimals and symbol of the asset, and the amount an associated source or destination address has of the asset. !!! note -A few utility methods are available for working with the `AssetAmount` class that converts the amount to various formats. Please refer to the [Methods for Asset Conversions](./methods.md#asset-utilities) section. + A few utility methods are available for working with the `AssetAmount` class that converts the amount to various formats. Please refer to the [Methods for Asset Conversions](./methods.md#asset-utilities) section. **Attributes** diff --git a/mkdocs/docs/reference/methods.md b/mkdocs/docs/reference/methods.md index 6c2de27c..c7c22936 100644 --- a/mkdocs/docs/reference/methods.md +++ b/mkdocs/docs/reference/methods.md @@ -990,7 +990,7 @@ The `AssetAmount` class contains the following utility functions. `fromAsset()` - Creates an [`AssetAmount`](./interfaces.md#the-asset-amount-object) instance from an [`Asset`](./interfaces.md#the-asset-object) and some additional parameters. !!! note -To use the `fromAsset` method, you'll need to import it from the [xcm-types package](https://github.com/moonbeam-foundation/xcm-sdk/tree/main/packages/types){target=\_blank}. To install the xcm-types package, run the following: + To use the `fromAsset` method, you'll need to import it from the [xcm-types package](https://github.com/moonbeam-foundation/xcm-sdk/tree/main/packages/types){target=\_blank}. To install the xcm-types package, run the following: ```bash npm i @moonbeam-network/xcm-types