Skip to content

Commit

Permalink
chore: remove PolkadotJS from readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kratico committed Jan 3, 2024
1 parent a33e831 commit c4bf4de
Showing 1 changed file with 0 additions and 76 deletions.
76 changes: 0 additions & 76 deletions packages/connect/README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,5 @@
# @substrate/connect

## Using `@substrate/connect` through the PolkadotJS RPC Provider

The recommended way to use `@substrate/connect` is to use PolkadotJS,
which provides a higher-level API built on top of it.
Unless you are writting your own library, you probably want to use the
PolkadotJS RPC provider.

Provide a well-known chain name ('polkadot', 'ksmcc3', 'westend2', 'rococo_v2_2'):

Note these names are the "real" names of the chains rather than the friendly
names (e.g. "kusama" or "rococo"). 'ksmcc3' is the name for kusama. This
matters for chains which have been hard forked. I.e. rococo - "rococo_v2" and
"rococo_v2_2" are two completely unrelated chains.

```js
import { ApiPromise } from "@polkadot/api";
import {
ScProvider
} from "@polkadot/rpc-provider";
import * as Sc from "@substrate/connect";

const provider = new ScProvider(Sc, Sc.WellKnownChain.polkadot);
await provider.connect();
const polkadotApi = await ApiPromise.create({ provider });
await polkadotApi.rpc.chain.subscribeNewHeads((lastHeader) => {
console.log(lastHeader.number.toString());
});
```

...or provide your custom Substrate chain's specification:

```js
import { ApiPromise } from "@polkadot/api";
import { ScProvider } from "@polkadot/rpc-provider/substrate-connect";
import * as Sc from "@substrate/connect";

import myJsonSubstrateChainSpec from './mySubstrateChainSpec.json';

const mySubstrateChainSpec = JSON.stringify(myJsonSubstrateChainSpec);
const provider = new ScProvider(Sc, mySubstrateChainSpec);

await provider.connect();

const polkadotApi = await ApiPromise.create({ provider });
await polkadotApi.rpc.chain.subscribeNewHeads((lastHeader) => {
console.log(lastHeader.number.toString());
});
```

In order to connect to a parachain, you must first instantiate the `ScProvider`
corresponding to the relay chain, then pass this `ScProvider` as the second
argument of the constructor of the parachain `ScProvider`. The following example
connects to a parachain of the Westend test network:

```js
import { ApiPromise } from "@polkadot/api";
import {
ScProvider
} from "@polkadot/rpc-provider";
import * as Sc from "@substrate/connect";

import jsonParachainSpec from './myParaChainSpec.json';

const parachainSpec = JSON.stringify(jsonParachainSpec);

const relayProvider = new ScProvider(Sc, Sc.WellKnownChain.westend2);
const provider = new ScProvider(Sc, parachainSpec, relayProvider);

await provider.connect();

const polkadotApi = await ApiPromise.create({ provider });
await polkadotApi.rpc.chain.subscribeNewHeads((lastHeader) => {
console.log(lastHeader.number.toString());
});
```

## Using `@substrate/connect` for library authors

Provide a well-known chain name ('polkadot', 'ksmcc3', 'westend2', 'rococo_v2_2'):
Expand Down

0 comments on commit c4bf4de

Please sign in to comment.