@paraspell/sdk 0.0.20 → 0.0.22

package/README.md

@@ -1,5 +1,6 @@
 
 # @paraspell/sdk
+![Full name (3)](https://user-images.githubusercontent.com/55763425/197985791-fc7afa52-061d-413a-bbe9-bf1123f16a50.png)
 
   
 
@@ -14,7 +15,7 @@ SDK For XCM & XCMP handling made with ❤️ by ParaSpell✨. It is no longer ne
 
 #####  Currently supporting 42 Polkadot & Kusama nodes list [here](https://github.com/paraspell/sdk/blob/beta-pre-release/docs/supportedNodes.md). 
 
-  
+### Check out our brand new Wiki documentation! [Wiki docs](https://paraspell.github.io/docs/)
 
 ## Usage
 
@@ -41,32 +42,27 @@ pnpm install @paraspell/sdk
 
  ##### Importing package to your project:
 
- 
+If you wish to use XCM, HRMP, XYK Pallets only you can import Builder like this:
 ```js
-/////////NEW BUILDER STYLE IMPORT///////////
-
 import { Builder } from '@paraspell/sdk'
+```
 
-/////////OLD STYLE IMPORT & IMPORT FOR ASSET PALLET//////////
-
+Old function like import (With assets):
+```js
 // ESM
 import  *  as  paraspell  from  '@paraspell/sdk'
 
 // CommonJS
 const paraspell = require('@paraspell/sdk')
-
 ```
 
   
 
 ## Currently implemented pallets
+XCM pallet (Combined xTokens, polkadotXCM, ormlXTokens, XcmPallet & relayerXCM):
 
+Builder pattern XCM & HRMP construction
 ```ts
-
-//XCM pallet (Combined xTokens, polkadotXCM, ormlXTokens, XcmPallet & relayerXCM):
-
-//////////NEW BUILDER PATTERN XCM & HRMP CONSTRUCTION//////////
-
 //Transfer tokens from Parachain to Parachain
 Builder(api).from(NODE).to(NODE).currency(CurrencyString).currencyId(currencyId).amount(amount).address(address).build()
 
@@ -80,10 +76,11 @@ Builder(api).from(NODE).currency(CurrencyString).currencyId(currencyId).amount(a
 Builder(api).from(NODE).closeChannel().inbound(inbound).outbound(outbound).build()
 
 //Open HRMP channels
-Builder(api).from(NODE).to(NODE).openChannel().maxSize(maxSize).maxMessageSize(maxMsgSize).build()
-
-///////////OLD STYLE XCM & HRMP CONSTRUCTION////////////// 
+Builder(api).from(NODE).to(NODE).openChannel().maxSize(maxSize).maxMessageSize(maxMsgSize).build()'
+```
 
+Function pattern XCM & HRMP construction
+```ts
 //Transfer tokens from Parachain to Parachain
 paraspell.xcmPallet.send(api: ApiPromise, origin: origin  Parachain  name  string, currency: currency  symbol  string, currencyID: number (If applicable), amount: any, to: destination  address  string, destination: destination  Parachain  ID)
 
@@ -100,11 +97,10 @@ paraspell.closeChannels.closeChannel(api: ApiPromise, origin: origin  Parachain
 //parasSudoWrapper pallet:
 //Open HRMP channels
 paraspell.openChannels.openChannel(api: ApiPromise, origin: origin  Parachain  ID, destination: destination  Parachain  ID, maxSize: number, maxMessageSize: number)
+```
+Asset pallet contruction:
 
-////////ASSET PALLET CONSTRUCTION UNCHANGED////////
-
-//Asset pallet
-
+```ts
 //Returns assets object from assets.json for particular node including information about native and foreign assets
 paraspell.assets.getAssetsObject(node: TNode)
 
@@ -134,7 +130,56 @@ paraspell.assets.getParaId(node: TNode)
 
 //Import all compatible nodes as constant:
 paraspell.NODE_NAMES
+```
+Basilisk XYK pallet contruction
+
+Builder patternn XYK construction
+```ts
+//Add liquidity to specific pool
+Builder(api).addLiquidity().assetA(assetA).assetB(assetB).amountA(amountA).amountBMaxLimit(maxLimit).build()
+
+//Remove liquidity from 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
+Builder(api).buy().assetOut(out).assetIn(in).amount(amount).maxLimit(maxLimit).discount(discount).build()
+
+//Sell specific asset from pool
+Builder(api).sell().assetIn(in).assetOut(out).amount(amount).maxLimit(maxLimit).discount(discount).build()
+```
+Function pattern XYK contruction
+```ts
+//Add liquidity to specific pool
+paraspell.xyk.addLiquidity(api: ApiPromise, assetA: number, assetB: number, amountA: any, amountBMaxLimit: any)
+
+//Remove liquidity from specific pool
+paraspell.xyk.removeLiquidity(api: ApiPromise, assetA: number, assetB: number, liquidityAmount: any)
+
+//Create pool
+paraspell.xyk.createPool(api: ApiPromise, assetA: number, amountA: any, assetB: number, amountB: any)
+
+//Buy specific asset from pool
+paraspell.xyk.buy(api: ApiPromise, assetOut: number, assetIn: number, amount: any, maxLimit: any, discount: Bool)
+
+//Sell specific asset from pool
+paraspell.xyk.sell(api: ApiPromise, assetIn: number, assetOut: number, amount: any, maxLimit: any, discount: Bool)
+```
+
+Node pallet operations
+```js
+import { getDefaultPallet, getSupportedPallets, SUPPORTED_PALLETS } from '@paraspell/sdk'
+
+//Returns default pallet for specific parachain node
+getDefaultPallet(node: TNode)
+
+//Returns an array of supported pallets for specific parachain node.
+getSupportedPallets(node: TNode)
 
+//Prints all pallets that are currently supported
+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)
@@ -156,6 +201,7 @@ paraspell.NODE_NAMES
 - Run compilation test using `pnpm compile`
 - Run linting test using `pnpm lint`
 - Run updateAssets script using `pnpm updateAssets`
+- Run updatePallets script using `pnpm updatePallets`
 - Run coverage tests usign `pnpm test`
 - Run all tests using `pnpm runAll`