@paraspell/sdk 4.1.0 → 5.0.0

package/README.md

@@ -27,14 +27,14 @@
 
 #### Install dependencies
 
-```
-pnpm||yarn||npm install @polkadot/api @polkadot/types @polkadot/api-base @polkadot/apps-config @polkadot/util
+```bash
+pnpm | npm install || yarn add @polkadot/api @polkadot/types @polkadot/api-base @polkadot/apps-config @polkadot/util
 ```
 
 #### Install SDK 
 
-```
-pnpm||yarn||npm install @paraspell/sdk
+```bash
+pnpm | npm install || yarn add @paraspell/sdk
 ```
 
 #### Importing package to your project:
@@ -148,23 +148,66 @@ Builder(api)
 
 ### Function pattern:
 ```ts
+//NOW FEATURING OBJECT PARAMETERS
+
 // Transfer assets from Parachain to Parachain
-await paraspell.xcmPallet.send(api?: ApiPromise, origin: origin  Parachain  name  string, currency: CurrencyString||CurrencyID, amount: any, to: destination  address  string, destination: destination  Parachain  ID, paraIdTo?: number,)
+await paraspell.xcmPallet.send(
+    {
+      api?: ApiPromise,
+      origin: origin  Parachain  name  string,
+      currency: CurrencyString||CurrencyID,
+      amount: any,
+      to: destination  address  string,
+      destination: destination  Parachain  ID,
+      paraIdTo?: number,
+      destApiForKeepAlive?: ApiPromise
+    }
+)
 
 // Transfer assets from Parachain to Relay chain
-await paraspell.xcmPallet.send(api?: ApiPromise, origin: origin  Parachain  name  string, amount: any, to: destination  address  string, paraIdTo?: number,)
+await paraspell.xcmPallet.send(
+  {
+    api?: ApiPromise,
+    origin: origin  Parachain  name  string,
+    amount: any,
+    to: destination  address  string,
+    paraIdTo?: number,
+    destApiForKeepAlive?: ApiPromise
+  }
+)
 
 // Transfer assets from Relay chain to Parachain
-await paraspell.xcmPallet.transferRelayToPara(api?: ApiPromise, destination: destination  Parachain  ID, amount: any, to: destination  address  string,paraIdTo?: number,)
-
-// Use keepAlive option
-await paraspell.xcmPallet.send(api?: ApiPromise, destination: TNode, amount: string | number | bigint, to: string, paraIdTo?: number, destApiForKeepAlive?: ApiPromise)
+await paraspell.xcmPallet.transferRelayToPara(
+  {
+    api?: ApiPromise,
+    destination: destination  Parachain  ID,
+    amount: any,
+    to: destination  address  string,
+    paraIdTo?: number,
+    destApiForKeepAlive?: ApiPromise
+  }
+)
 
 // Close HRMP channels
-paraspell.closeChannels.closeChannel(api: ApiPromise, origin: origin  Parachain  ID, inbound: number, outbound: number)
+paraspell.closeChannels.closeChannel(
+  {
+    api: ApiPromise,
+    origin: origin  Parachain  ID, 
+    inbound: number,
+    outbound: number
+  }
+)
 
 // Open HRMP channels
-paraspell.openChannels.openChannel(api: ApiPromise, origin: origin  Parachain  ID, destination: destination  Parachain  ID, maxSize: number, maxMessageSize: number)
+paraspell.openChannels.openChannel(
+  {
+    api: ApiPromise,
+    origin: origin  Parachain  ID,
+    destination: destination  Parachain  ID,
+    maxSize: number,
+    maxMessageSize: number
+  }
+)
 ```
 
 ### Asset queries:
@@ -242,6 +285,8 @@ const ed = getExistentialDeposit('Acala')
 
 - Run all core tests and checks using `pnpm runAll`
 
+XCM SDK can be tested in [Playground](https://github.com/paraspell/xcm-tools/tree/main/apps/playground).
+
 ## License
 
 Made with 💛 by [ParaSpell✨](https://github.com/paraspell)