npm - @paraspell/sdk - Versions diffs - 2.0.6 → 3.0.2 - Mend

@paraspell/sdk 2.0.6 → 3.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/README.md CHANGED Viewed

@@ -1,53 +1,26 @@
 # @paraspell/sdk
 ![Full name (3)](https://user-images.githubusercontent.com/55763425/197985791-fc7afa52-061d-413a-bbe9-bf1123f16a50.png)
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 [![Known Vulnerabilities](https://snyk.io/test/github/paraspell/sdk/badge.svg)](https://snyk.io/test/github/paraspell/sdk)
-SDK For XCM & XCMP handling made with ❤️ by ParaSpell✨. It is no longer necessary to construct calls manually. @paraspell/sdk handles this for you. Feel free to become magician and try your paraSPELLS 🧙✨.
+SDK For XCM & XCMP handling made with ❤️ by ParaSpell✨. It is no longer necessary to construct calls manually. @paraspell/sdk handles this for you. Feel free to become a magician and try your paraSPELLS 🧙✨.
-##### Currently supporting 44 Polkadot & Kusama nodes list [here](https://github.com/paraspell/sdk/blob/main/docs/supportedNodes.md).
+##### Currently supporting 48 Polkadot & Kusama nodes list [here](https://github.com/paraspell/sdk/blob/main/docs/supportedNodes.md).
 ### Check out our brand new Wiki documentation! [Wiki docs](https://paraspell.github.io/docs/)
 ## Usage
 **Install package:**
 #### Since version 1.0.0
-Our SDK introduced all Polkadot libraries as peer dependencies. Reason for this is, that most of the projects use these libraries in some way already and it fixes issues with unmet dependency warnings. Make sure your project have them. You can install them by following command:
+Our SDK introduced all Polkadot libraries as peer dependencies. The reason for this is, that most of the projects use these libraries in some way already and it fixes issues with unmet dependency warnings. Make sure your project has them. You can install them by following the command:
 ##### Install DEPS via npm||yarn||pnpm
@@ -70,45 +43,38 @@ yarn install @paraspell/sdk
 //pnpm
 pnpm install @paraspell/sdk
 ```
-##### Importing package to your project:
+##### Importing package to your project:
-If you wish to use XCM, HRMP, XYK Pallets only you can import Builder like this:
+If you wish to use XCM, HRMP and XYK Pallets only you can import Builder like this:
 ```js
-import { Builder } from  '@paraspell/sdk'
+import { Builder } from '@paraspell/sdk'
 ```
 Old function like import (With assets):
 ```js
 // ESM
-import  *  as  paraspell  from  '@paraspell/sdk'
+import * as paraspell from '@paraspell/sdk'
 // CommonJS
-const  paraspell  =  require('@paraspell/sdk')
+const paraspell = require('@paraspell/sdk')
 ```
 ## Currently implemented pallets
 XCM pallet (Combined xTokens, polkadotXCM, ormlXTokens, XcmPallet & relayerXCM):
 Builder pattern XCM & HRMP construction
 ```ts
 //Transfer tokens from Parachain to Parachain
+//**NOTE** If you wish to transfer from Parachain that uses long IDs for example Moonbeam you have to add character 'n' the end of currencyID. Eg: .currency(42259045809535163221576417993425387648n) will mean you transfer xcDOT.
 Builder(api).from(NODE).to(NODE).currency(CurrencyString||CurrencyID).amount(amount).address(address).build()
-//Transfer tokens from Relay chain to Parachain
+//Transfer tokens from the Relay chain to Parachain
 Builder(api).to(NODE).amount(amount).address(address).build()
 //Transfer tokens from Parachain to Relay chain
@@ -121,12 +87,11 @@ Builder(api).from(NODE).closeChannel().inbound(inbound).outbound(outbound).build
 Builder(api).from(NODE).to(NODE).openChannel().maxSize(maxSize).maxMessageSize(maxMsgSize).build()'
 ```
 Function pattern XCM & HRMP construction
 ```ts
 //Transfer tokens from Parachain to Parachain
+//**NOTE** If you wish to transfer from Parachain that uses long IDs for example Moonbeam you have to add character 'n' the end of currencyID. Eg: currency = 42259045809535163221576417993425387648n will mean you transfer xcDOT.
 paraspell.xcmPallet.send(api: ApiPromise, origin: origin  Parachain  name  string, currency: CurrencyString||CurrencyID, amount: any, to: destination  address  string, destination: destination  Parachain  ID)
 //Transfer tokens from Parachain to Relay chain
@@ -144,30 +109,28 @@ paraspell.closeChannels.closeChannel(api: ApiPromise, origin: origin  Parachain
 paraspell.openChannels.openChannel(api: ApiPromise, origin: origin  Parachain  ID, destination: destination  Parachain  ID, maxSize: number, maxMessageSize: number)
 ```
-Asset pallet contruction:
+Asset pallet construction:
 ```ts
 //Returns assets object from assets.json for particular node including information about native and foreign assets
 paraspell.assets.getAssetsObject(node: TNode)
-//Returns foreign assetId for particular node and asset symbol
+//Returns foreign assetId for a particular node and asset symbol
 paraspell.assets.getAssetId(node: TNode, symbol: string)
-//Returns symbol of the relay chain for particular node. Either "DOT" or "KSM"
+//Returns the symbol of the relay chain for a particular node. Either "DOT" or "KSM"
 paraspell.assets.getRelayChainSymbol(node: TNode)
 //Returns string array of native assets symbols for particular node
 paraspell.assets.getNativeAssets(node: TNode)
-//Returns object array of foreign assets for particular node. Each object has symbol and assetId property
+//Returns object array of foreign assets for a particular node. Each object has a symbol and assetId property
 paraspell.assets.getOtherAssets(node: TNode)
-//Returns string array of all assets symbols. (native and foreign assets are merged to a single array)
+//Returns string array of all assets symbols. (native and foreign assets are merged into a single array)
 paraspell.assets.getAllAssetsSymbols(node: TNode)
-//Checks if node supports particular asset. (Both native and foreign assets are searched). Returns boolean
+//Checks if a node supports a particular asset. (Both native and foreign assets are searched). Returns boolean
 paraspell.assets.hasSupportForAsset(node: TNode, symbol: string)
 //Get decimals for specific asset
@@ -183,30 +146,28 @@ paraspell.assets.getTNode(nodeID: number)
 paraspell.NODE_NAMES
 ```
-Basilisk XYK pallet contruction
+Basilisk XYK pallet construction
-Builder patternn XYK construction
+Builder pattern XYK construction
 ```ts
-//Add liquidity to specific pool
+//Add liquidity to a specific pool
 Builder(api).addLiquidity().assetA(assetA).assetB(assetB).amountA(amountA).amountBMaxLimit(maxLimit).build()
-//Remove liquidity from specific pool
+//Remove liquidity from a specific pool
 Builder(api).removeLiquidity().assetA(assetA).assetB(assetB).liquidityAmount(liquidity).build()
 //Create pool
 Builder(api).createPool().assetA(assetA).amountA(amountA).assetB(assetB).amountB(amountB).build()
-//Buy specific asset from pool
+//Buy specific asset from the pool
 Builder(api).buy().assetOut(out).assetIn(in).amount(amount).maxLimit(maxLimit).discount(discount).build()
-//Sell specific asset from pool
+//Sell specific asset from the pool
 Builder(api).sell().assetIn(in).assetOut(out).amount(amount).maxLimit(maxLimit).discount(discount).build()
 ```
-Function pattern XYK contruction
+Function pattern XYK construction
 ```ts
 //Add liquidity to specific pool
@@ -233,7 +194,7 @@ import { getDefaultPallet, getSupportedPallets, SUPPORTED_PALLETS } from  '@para
 //Returns default pallet for specific parachain node
 getDefaultPallet(node: TNode)
-//Returns an array of supported pallets for specific parachain node.
+//Returns an array of supported pallets for a specific parachain node.
 getSupportedPallets(node: TNode)
 //Prints all pallets that are currently supported
@@ -242,7 +203,7 @@ console.log(SUPPORTED_PALLETS)
 ##### Example of usage can be found in the UI repository [here](https://github.com/paraspell/ui) or in the Astarot repository [here](https://github.com/paraspell/astarot)
-##### List of currently compatible nodes can be found [here](https://github.com/paraspell/sdk/blob/beta-pre-release/docs/supportedNodes.md)
+##### A list of currently compatible nodes can be found [here](https://github.com/paraspell/sdk/blob/beta-pre-release/docs/supportedNodes.md)
 ## 💻 Development
@@ -262,7 +223,7 @@ console.log(SUPPORTED_PALLETS)
 - Run updatePallets script using `pnpm updatePallets`
-- Run coverage tests usign `pnpm test`
+- Run coverage tests using `pnpm test`
 - Run all tests using `pnpm runAll`
@@ -276,61 +237,19 @@ console.log(SUPPORTED_PALLETS)
 [![logo-v1](https://user-images.githubusercontent.com/55763425/204865221-90d2b3cd-f2ac-48a2-a367-08722aa8e923.svg)](https://bsx.fi/)
 ## License
 Made with 💛 by [ParaSpell✨](https://github.com/paraspell)
 Published under [MIT License](https://github.com/paraspell/sdk/blob/main/LICENSE).
 <!-- Badges -->
 [npm-version-src]: https://img.shields.io/npm/v/@paraspell/sdk?style=flat-square
 [npm-version-href]: https://npmjs.com/package/@paraspell/sdk
 [npm-downloads-src]: https://img.shields.io/npm/dm/@paraspell/sdk?style=flat-square
 [npm-downloads-href]: https://npmjs.com/package/@paraspell/sdk
 [github-actions-src]: https://img.shields.io/github/workflow/status/unjs/@paraspell/sdk/ci/main?style=flat-square
 [github-actions-href]: https://github.com/unjs/@paraspell/sdk/actions?query=workflow%3Aci
 [codecov-src]: https://img.shields.io/codecov/c/gh/unjs/@paraspell/sdk/main?style=flat-square
 [codecov-href]: https://codecov.io/gh/unjs/@paraspell/sdk