dedot

A delightful JavaScript/TypeScript client for Polkadot & Substrate

Source

npm

Version: 1.0.1

Version published: 9 months ago

Weekly downloads: 595

Maintainers: 1

Weekly downloads

Created: 2 years ago

Source

Dedot Banner

Dedot

Delightful JavaScript/TypeScript client for Polkadot & Polkadot SDK-based blockchains.

Version Unit test E2E test License weekly downloads

👉 Join our Telegram group to receive the latest updates and support!! 👈

Dedot is the next-generation JavaScript client for Polkadot and Polkadot SDK-based blockchains. Designed to elevate the dapp development experience, Dedot is built & optimized to be lightweight and tree-shakable, offering precise Types & APIs suggestions for individual Polkadot SDK-based blockchain network and ink! Smart Contracts. Dedot also helps dapps efficiently connect to multiple chains simultaneously as we head toward a seamless multi-chain future.

Features

✅ Fully support light clients (e.g: smoldot)
✅ Small bundle size, tree-shakable (no more bn.js or wasm-blob tight dependencies)
✅ Types & APIs suggestions for each individual Polkadot SDK-based blockchain network (@dedot/chaintypes)
✅ Familiar api style with @polkadot/api, easy & fast migration!
✅ Native TypeScript type system for scale-codec
✅ Compatible with @polkadot/extension-based wallets
✅ Support Metadata V14, V15, V16 (latest)
✅ Built-in metadata optimization (caching)
✅ Build on top of both the new & legacy ( deprecated soon) JSON-RPC APIs
✅ Unified Typesafe Contract APIs for ink! v5 (WASM, pallet-contracts), ink! v6 and solidity contracts (PVM, pallet-revive)
✅ Fully-typed low-level JSON-RPC client

[!TIP] Are you building dapps on Polkadot?

Check out Typink (https://typink.dev), a comprehensive toolkit for dapps development, powered by Dedot!

Documentation

Check out Dedot documentation on the website: https://dedot.dev

Example

Install packages

npm i dedot # or yarn, pnpm

npm i -D @dedot/chaintypes

Connect to the network

import { DedotClient, WsProvider } from 'dedot';
import type { PolkadotApi } from '@dedot/chaintypes';

const provider = new WsProvider('wss://rpc.polkadot.io');
const client = await DedotClient.new<PolkadotApi>(provider);

// Get current best block
const bestBlock = await client.block.best();
console.log('Best block:', bestBlock.number, bestBlock.hash);

// Subscribe to finalized blocks
const unsub = client.block.finalized((block) => {
  console.log('Finalized block:', block.number);
});

// Query on-chain storage
const balance = await client.query.system.account(<address>);
console.log('Balance:', balance);

// Get pallet constants
const ss58Prefix = client.consts.system.ss58Prefix;
console.log('Polkadot ss58Prefix:', ss58Prefix);

// Call runtime api
const pendingRewards = await client.call.nominationPoolsApi.pendingRewards(<address>);
console.log('Pending rewards:', pendingRewards);

// Sign and send transaction
const result = await client.tx.balances.transferKeepAlive(<dest>, 1_000_000_000_000n)
                           .signAndSend(signer).untilFinalized();

// Disconnect
await client.disconnect();