@paraspell/sdk 0.0.7 → 0.0.8

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 (2) hide show
  1. package/README.md +15 -2
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -26,12 +26,26 @@ Import:
26
26
 
27
27
  ```js
28
28
  // ESM
29
- import { } from '@paraspell/sdk'
29
+ import * as paraspell from '@paraspell/sdk'
30
30
 
31
31
  // CommonJS
32
32
  const { } = require('@paraspell/sdk')
33
33
  ```
34
34
 
35
+ ## Currently implemented pallets
36
+ ```ts
37
+ //xToken pallet:
38
+ paraspell.xTokens.transferParaToPara(api: ApiPromise, origin: origin Parachain name string, destination: destination Parachain ID, currency: currency symbol string, amount: any, to: destination address string)
39
+ paraspell.xTokens.transferParaToRelay(api: ApiPromise, origin: origin Parachain name string, currency: currency symbol string, amount: any, to: destination address string)
40
+ paraspell.xTokens.transferRelayToPara(api: ApiPromise, destination: destination Parachain ID, amount: any, to: destination address string)
41
+ //hrmp pallet:
42
+ paraspell.closeChannels.closeChannel(api: ApiPromise, origin: origin Parachain ID, inbound: number, outbound: number)
43
+ //parasSudoWrapper pallet:
44
+ paraspell.openChannels.openChannel(api: ApiPromise, origin: origin Parachain ID, destination: destination Parachain ID, maxSize: number, maxMessageSize: number)
45
+
46
+ ```
47
+ Example of usage can be found in the UI repository [here](https://github.com/paraspell/ui)
48
+
35
49
  ## 💻 Development
36
50
 
37
51
  - Clone this repository
@@ -40,7 +54,6 @@ const { } = require('@paraspell/sdk')
40
54
  - Run interactive tests using `pnpm dev`
41
55
 
42
56
  ## License
43
-
44
57
  Made with 💛
45
58
 
46
59
  Published under [MIT License](./LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@paraspell/sdk",
3
- "version": "0.0.7",
3
+ "version": "0.0.8",
4
4
  "description": "SDK for ParaSpell XCM/XCMP tool for developers",
5
5
  "repository": "@paraspell/sdk",
6
6
  "license": "MIT",
@@ -36,7 +36,7 @@
36
36
  "build": "unbuild",
37
37
  "dev": "vitest dev",
38
38
  "lint": "eslint --ext .ts,.js,.mjs,.cjs .",
39
- "release": "pnpm test && standard-version && git push --follow-tags && pnpm publish --no-git-checks --access=public",
39
+ "release": "pnpm test && standard-version && git push --follow-tags && pnpm publish --access=public",
40
40
  "test": "pnpm lint && vitest run --coverage"
41
41
  }
42
42
  }