You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/sdk/getting-started.md
+10-24Lines changed: 10 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,56 +8,42 @@ Don't want to go through setup and build from ground up?
8
8
9
9
This template is programmed with React & Vite framework. It contains basic components ready to set you off on your cross-chain dApp journey.
10
10
11
-
## Install Dependencies
11
+
## Install XCM SDK and its dependencies
12
12
13
-
Install peer dependencies according to the API package you choose.
13
+
XCM SDK supports three different Javascript client providers. It is advised to use PAPI JS provider or Dedot JS provider, but in case your project heavily relies on Polkadot JS you can also install PJS SDK version.
14
14
15
-
ParaSpell XCM SDK is the 🥇 first in the ecosystem to support **PolkadotJS**, **Polkadot API** and **Dedot**.
16
15
17
16
**Choose your package manager:**
18
17
19
18
<PackageManagerSwitch />
20
19
21
-
### Polkadot API (PAPI) Peer Dependencies
20
+
### Polkadot API (PAPI) version of SDK and Peer Dependencies
21
+
**BEWARE: SDK uses PAPI V2 since 13.2.1 onwards!**
### PolkadotJS (PJS) version of SDK and Peer Dependencies
28
29
29
30
<InstallCommand :pkg="[
31
+
'@paraspell/sdk-pjs',
30
32
'@polkadot/api',
31
33
'@polkadot/types',
32
34
'@polkadot/api-base',
33
35
'@polkadot/util',
34
36
'@polkadot/util-crypto'
35
37
]" />
36
38
37
-
### Dedot Peer Dependencies
39
+
### Dedot version of SDK and Peer Dependencies
38
40
39
41
<InstallCommand :pkg="[
42
+
'@paraspell/sdk-dedot',
40
43
'dedot',
41
44
'@polkadot/keyring',
42
45
]" />
43
46
44
-
45
-
## Install XCM SDK package
46
-
XCM SDK supports three different Javascript client providers. It is advised to use PAPI JS provider or Dedot JS provider, but in case your project heavily relies on Polkadot JS you can also install PJS SDK version. Please note, that PJS and Dedot version does not have Swap functionality yet.
47
-
48
-
### Polkadot API (PAPI) client version
49
-
**BEWARE: SDK uses PAPI V2 since 13.2.0 onwards!**
50
-
51
-
<InstallCommandpkg="@paraspell/sdk" />
52
-
53
-
### PolkadotJS (PJS) client version
54
-
55
-
<InstallCommandpkg="@paraspell/sdk-pjs" />
56
-
57
-
### Dedot client version
58
-
59
-
<InstallCommandpkg="@paraspell/sdk-dedot" />
60
-
61
47
## Install swap extension
62
48
If you plan to [do Swap XCMs](https://paraspell.github.io/docs/sdk/xcmPallet.html#swap) you can install Swap package which allows you to do cross-chain swaps on popular Polkadot, Kusama, Paseo, Westend exchanges. Now available in **ALL** versions of SDK.
0 commit comments