Skip to content

Commit

Permalink
feat(requirements): add warning for psdkcompat recommendation
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosala committed Sep 9, 2024
1 parent 5c52b3b commit 6a49ad3
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/pages/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ import { getWsProvider } from "polkadot-api/ws-provider/web"
const client = createClient(getWsProvider("wss://your-rpc.your-url.xyz"))
```

:::warning
A new error in Polkadot-SDK has been discovered, reported and solved in Polkadot-SDK `1.16.0` (or `stable-2409`). Therefore, we recommend anyone connecting through a WebSocket to use the same following recommendations as in Polkadot-SDK `1.1.0 <= x < 1.11.0`.
:::

#### Polkadot-SDK `1.1.0 <= x < 1.11.0`

If your node uses versions between `1.1` and `1.11`, you are still good to go with Polkadot-API. The node implements the JSON-RPC spec wrongly, but we provide some enhancers to workaround these flaws. You need to start the connection as follows:
Expand Down

0 comments on commit 6a49ad3

Please sign in to comment.