-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add comment about websocket in rpc-provider
- Loading branch information
Showing
1 changed file
with
3 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,5 @@ | ||
| # @polkadot/rpc-provider | ||
| The RPC provider is a subset of https://github.com/polkadot-js/api/tree/master/packages/rpc-provider. | ||
|
|
||
| Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface. | ||
| However, it contains a small but crucial change for us: | ||
|
|
||
| ## Provider Selection | ||
|
|
||
| There are three flavours of the providers provided, one allowing for using HTTP as a transport mechanism, the other using WebSockets, and the third one uses substrate light-client through @substrate/connect. It is generally recommended to use the [[WsProvider]] since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client. | ||
|
|
||
| All providers are usable (as is the API), in both browser-based and Node.js environments. Polyfills for unsupported functionality are automatically applied based on feature-detection. | ||
|
|
||
| ## Usage | ||
|
|
||
| Installation - | ||
|
|
||
| ``` | ||
| yarn add @polkadot/rpc-provider | ||
| ``` | ||
|
|
||
| WebSocket Initialization - | ||
|
|
||
| ```javascript | ||
| import { WsProvider } from '@polkadot/rpc-provider'; | ||
|
|
||
| // this is the actual default endpoint | ||
| const provider = new WsProvider('ws://127.0.0.1:9944'); | ||
| const version = await provider.send('client_version', []); | ||
|
|
||
| console.log('client version', version); | ||
| ``` | ||
|
|
||
| HTTP Initialization - | ||
|
|
||
| ```javascript | ||
| import { HttpProvider } from '@polkadot/rpc-provider'; | ||
|
|
||
| // this is the actual default endpoint | ||
| const provider = new HttpProvider('http://127.0.0.1:9933'); | ||
| const version = await provider.send('chain_getBlockHash', []); | ||
|
|
||
| console.log('latest block Hash', hash); | ||
| ``` | ||
|
|
||
| @substrate/connect Initialization - | ||
|
|
||
| Instantiating a Provider for the Polkadot Relay Chain: | ||
| ```javascript | ||
| import { ScProvider } from '@polkadot/rpc-provider'; | ||
| import * as Sc from '@substrate/connect'; | ||
|
|
||
| const provider = new ScProvider(Sc, Sc.WellKnownChain.polkadot); | ||
|
|
||
| await provider.connect(); | ||
|
|
||
| const version = await provider.send('chain_getBlockHash', []); | ||
| ``` | ||
|
|
||
| Instantiating a Provider for a Polkadot parachain: | ||
| ```javascript | ||
| import { ScProvider } from '@polkadot/rpc-provider'; | ||
| import * as Sc from '@substrate/connect'; | ||
|
|
||
| const polkadotProvider = new ScProvider(Sc, Sc.WellKnownChain.polkadot); | ||
| const parachainProvider = new ScProvider(Sc, parachainSpec, polkadotProvider); | ||
|
|
||
| await parachainProvider.connect(); | ||
|
|
||
| const version = await parachainProvider.send('chain_getBlockHash', []); | ||
| ``` | ||
| The reason it lives here, is only because we want to be able to inject a websocket for integration testing against local setups for the integritee worker, which means the websocket needs accept self-signed certificates. |