feat: add dedot (#602)

* add getting started with dedot

* updates

* fix grammars

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update dedot.md

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update dedot.md

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: 0xLucca <[email protected]>

* Update develop/toolkit/api-libraries/dedot.md

Co-authored-by: Nicolás Hussein <[email protected]>

* Apply suggestions from code review

Co-authored-by: 0xLucca <[email protected]>

* move code to snippets

* adding desc for each example

* wording tweaks

---------

Co-authored-by: 0xLucca <[email protected]>
Co-authored-by: Nicolás Hussein <[email protected]>

Author: 3 people

.snippets/code/develop/toolkit/api-libraries/dedot/call-runtime-apis.ts

@@ -0,0 +1,2 @@
+const metadata = await client.call.metadata.metadataAtVersion(15);
+console.log('Metadata V15', metadata)

.snippets/code/develop/toolkit/api-libraries/dedot/client-initialization-via-smoldot.ts

@@ -0,0 +1,14 @@
+import { DedotClient, SmoldotProvider } from 'dedot';
+import type { PolkadotApi } from '@dedot/chaintypes';
+import * as smoldot from 'smoldot';
+
+// import `polkadot` chain spec to connect to Polkadot
+import { polkadot } from '@substrate/connect-known-chains'
+
+// Start smoldot instance & initialize a chain
+const client = smoldot.start();
+const chain = await client.addChain({ chainSpec: polkadot });
+
+// Initialize providers & clients
+const provider = new SmoldotProvider(chain);
+const client = await DedotClient.new<PolkadotApi>(provider);

.snippets/code/develop/toolkit/api-libraries/dedot/client-initialization-via-ws.ts

@@ -0,0 +1,6 @@
+import { DedotClient, WsProvider } from 'dedot';
+import type { PolkadotApi } from '@dedot/chaintypes';
+
+// Initialize providers & clients
+const provider = new WsProvider('wss://rpc.polkadot.io');
+const client = await DedotClient.new<PolkadotApi>(provider);

.snippets/code/develop/toolkit/api-libraries/dedot/legacy-client-initialization.ts

@@ -0,0 +1,5 @@
+import { LegacyClient, WsProvider } from 'dedot';
+import type { PolkadotApi } from '@dedot/chaintypes';
+
+const provider = new WsProvider('wss://rpc.polkadot.io');
+const client = await LegacyClient.new<PolkadotApi>(provider);

.snippets/code/develop/toolkit/api-libraries/dedot/pick-chainapi-interface.ts

@@ -0,0 +1,6 @@
+import { DedotClient, WsProvider } from 'dedot';
+import type { PolkadotApi, KusamaApi } from '@dedot/chaintypes';
+
+const polkadotClient = await DedotClient.new<PolkadotApi>(new WsProvider('wss://rpc.polkadot.io'));
+const kusamaClient = await DedotClient.new<KusamaApi>(new WsProvider('wss://kusama-rpc.polkadot.io'));
+const genericClient = await DedotClient.new(new WsProvider('ws://localhost:9944'));

.snippets/code/develop/toolkit/api-libraries/dedot/runtime-constants.ts

@@ -0,0 +1,2 @@
+const ss58Prefix = client.consts.system.ss58Prefix;
+console.log('Polkadot ss58Prefix:', ss58Prefix);

.snippets/code/develop/toolkit/api-libraries/dedot/sign-and-send-tx-with-extension-signer.ts

@@ -0,0 +1,15 @@
+const injected = await window.injectedWeb3['polkadot-js'].enable('My dApp');
+const account = (await injected.accounts.get())[0];
+const signer = injected.signer;
+const unsub = await client.tx.balances
+    .transferKeepAlive(<destAddress>, 2_000_000_000_000n)
+    .signAndSend(account.address, { signer }, async ({ status }) => {
+      console.log('Transaction status', status.type);
+      if (status.type === 'BestChainBlockIncluded') {
+        console.log(`Transaction is included in best block`);
+      }
+      if (status.type === 'Finalized') {
+        console.log(`Transaction completed at block hash ${status.value.blockHash}`);
+        await unsub();
+      }
+    });

.snippets/code/develop/toolkit/api-libraries/dedot/sign-and-send-tx-with-keyring.ts

@@ -0,0 +1,19 @@
+import { cryptoWaitReady } from '@polkadot/util-crypto';
+import { Keyring } from '@polkadot/keyring';
+// Setup keyring
+await cryptoWaitReady();
+const keyring = new Keyring({ type: 'sr25519' });
+const alice = keyring.addFromUri('//Alice');
+// Send transaction
+const unsub = await client.tx.balances
+    .transferKeepAlive(<destAddress>, 2_000_000_000_000n)
+    .signAndSend(alice, async ({ status }) => {
+      console.log('Transaction status', status.type);
+      if (status.type === 'BestChainBlockIncluded') {
+        console.log(`Transaction is included in best block`);
+      }
+      if (status.type === 'Finalized') {
+        console.log(`Transaction completed at block hash ${status.value.blockHash}`);
+        await unsub();
+      }
+    });

.snippets/code/develop/toolkit/api-libraries/dedot/storage-queries.ts

@@ -0,0 +1,2 @@
+const balance = await client.query.system.account(<address>);
+console.log('Balance:', balance.data.free);

.snippets/code/develop/toolkit/api-libraries/dedot/subscribe-storage-changes.ts

@@ -0,0 +1,3 @@
+const unsub = await client.query.system.number((blockNumber) => {
+  console.log(`Current block number: ${blockNumber}`);
+});