Merge pull request #17 from polkadot-api/cs-providrs

fix: rename providers
polkadot-api · Aug 5, 2024 · b308edb · b308edb
2 parents f5c07a8 + 66e990a
commit b308edb
Show file tree

Hide file tree

Showing 5 changed files with 291 additions and 328 deletions.
diff --git a/docs/pages/getting-started.mdx b/docs/pages/getting-started.mdx
@@ -73,11 +73,11 @@ Now you can create a PolkadotClient with a provider of your choice and start int
   <Tabs.Content value="web">
     ```ts
     // [!include ~/snippets/gettingStarted.ts:import]
-    import { WebSocketProvider } from "polkadot-api/ws-provider/web";
+    import { getWsProvider } from "polkadot-api/ws-provider/web";
 
     // Connect to the polkadot relay chain.
     const client = createClient(
-      WebSocketProvider("wss://dot-rpc.stakeworld.io")
+      getWsProvider("wss://dot-rpc.stakeworld.io")
     );
 
     // [!include ~/snippets/gettingStarted.ts:usage]
@@ -87,11 +87,11 @@ Now you can create a PolkadotClient with a provider of your choice and start int
   <Tabs.Content value="node">
     ```ts
     // [!include ~/snippets/gettingStarted.ts:import]
-    import { WebSocketProvider } from "polkadot-api/ws-provider/node";
+    import { getWsProvider } from "polkadot-api/ws-provider/node";
 
     // Connect to the polkadot relay chain.
     const client = createClient(
-      WebSocketProvider("wss://dot-rpc.stakeworld.io")
+      getWsProvider("wss://dot-rpc.stakeworld.io")
     );
 
     // [!include ~/snippets/gettingStarted.ts:usage]

diff --git a/docs/pages/providers.md b/docs/pages/providers.md
@@ -17,7 +17,7 @@ Calling it will initiate a connection. Messages coming from the service will com
 
 Polkadot-API offers a couple of providers for some of the most used ways of connecting to a chain:
 
-- `WebSocketProvider(uri: string)` from `polkadot-api/ws-provider/web` or `polkadot-api/ws-provider/node` to connect through WebSocket.
+- `getWsProvider(uri: string)` from `polkadot-api/ws-provider/web` or `polkadot-api/ws-provider/node` to connect through WebSocket.
 - `getSmProvider(chain: smoldot.Chain)` from `polkadot-api/sm-provider` to connect through Smoldot.
 
 The `JsonRpcProvider` interface is designed so that it can be easily enhanced: You can wrap any JsonRpcProvider with another one that adds in more features, such as logging, statistics, or error recovery.
@@ -30,9 +30,9 @@ Polkadot-API has a subpackage `polkadot-api/logs-provider` that can be used to c
 // 1. recording logs
 import { createClient } from "polkadot-api"
 import { withLogsRecorder } from "polkadot-api/logs-provider"
-import { WebSocketProvider } from "polkadot-api/ws-provider/node"
+import { getWsProvider } from "polkadot-api/ws-provider/node"
 
-const wsProvider = WebSocketProvider("wss://example.url")
+const wsProvider = getWsProvider("wss://example.url")
 // Using console.log to output each line, but you could e.g. write it directly to a
 // file or push into an array
 const provider = withLogsRecorder((line) => console.log(line), wsProvider)

diff --git a/docs/pages/requirements.md b/docs/pages/requirements.md
@@ -30,9 +30,9 @@ Polkadot-API will work without any issues. The WebSocket provider could be used
 
 ```ts
 import { createClient } from "polkadot-api"
-import { WebSocketProvider } from "polkadot-api/ws-provider/web"
+import { getWsProvider } from "polkadot-api/ws-provider/web"
 
-const client = createClient(WebSocketProvider("wss://your-rpc.your-url.xyz"))
+const client = createClient(getWsProvider("wss://your-rpc.your-url.xyz"))
 ```
 
 #### Polkadot-SDK `1.1.0 <= x < 1.11.0`
@@ -41,11 +41,11 @@ If your node uses versions between `1.1` and `1.11`, you are still good to go wi
 
 ```ts
 import { createClient } from "polkadot-api"
-import { WebSocketProvider } from "polkadot-api/ws-provider/web"
-import compatEnhancer from "polkadot-api/polkadot-sdk-compat"
+import { getWsProvider } from "polkadot-api/ws-provider/web"
+import { withPolkadotSdkCompat } from "polkadot-api/polkadot-sdk-compat"
 
 const client = createClient(
-  compatEnhancer(WebSocketProvider("wss://your-rpc.your-url.xyz")),
+  withPolkadotSdkCompat(getWsProvider("wss://your-rpc.your-url.xyz")),
 )
 ```
 

diff --git a/package.json b/package.json
@@ -28,5 +28,5 @@
       "@homer0/prettier-plugin-jsdoc"
     ]
   },
-  "packageManager": "pnpm@9.3.0+sha512.ee7b93e0c2bd11409c6424f92b866f31d3ea1bef5fbe47d3c7500cdc3c9668833d2e55681ad66df5b640c61fa9dc25d546efa54d76d7f8bf54b13614ac293631"
+  "packageManager": "pnpm@9.6.0+sha512.38dc6fba8dba35b39340b9700112c2fe1e12f10b17134715a4aa98ccf7bb035e76fd981cf0bb384dfa98f8d6af5481c2bef2f4266a24bfa20c34eb7147ce0b5e"
 }