https://github.com/dedotdev/dedot
Delightful JavaScript client for Polkadot & Polkadot SDK-based blockchain networks
https://github.com/dedotdev/dedot
light-client polkadot polkadot-api substrate substrate-rpc-client
Last synced: about 1 month ago
JSON representation
Delightful JavaScript client for Polkadot & Polkadot SDK-based blockchain networks
- Host: GitHub
- URL: https://github.com/dedotdev/dedot
- Owner: dedotdev
- License: apache-2.0
- Created: 2023-10-09T11:01:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-26T17:27:43.000Z (about 1 month ago)
- Last Synced: 2026-04-26T18:21:49.563Z (about 1 month ago)
- Topics: light-client, polkadot, polkadot-api, substrate, substrate-rpc-client
- Language: TypeScript
- Homepage: https://dedot.dev
- Size: 12.5 MB
- Stars: 70
- Watchers: 4
- Forks: 8
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-dot - Dedot Client Library - Dedot is a JavaScript client for Polkadot and Substrate-based blockchains, optimized for lightweight and tree-shakable dapp development offering precise types and API suggestions with latest metadata integration for solochains and ink! Smart Contracts. (Made by OpenGuild Community) (Libraries / Multisig Wallets)
README
# Dedot
Delightful JavaScript/TypeScript client for [Polkadot](https://polkadot.com/) & [Polkadot SDK-based](https://github.com/paritytech/polkadot-sdk) blockchains.
![Version][ico-version]
![Unit test][ico-unit-test]
![E2E test][ico-e2e-test]
![License][ico-license]
![weekly downloads][ico-downloads]
[![Chat on Telegram][ico-telegram]][link-telegram]
[ico-telegram]: https://img.shields.io/badge/Dedot-2CA5E0.svg?style=flat-square&logo=telegram&label=Telegram
[ico-unit-test]: https://img.shields.io/github/actions/workflow/status/dedotdev/dedot/run-tests.yml?label=unit%20tests&style=flat-square
[ico-e2e-test]: https://img.shields.io/github/actions/workflow/status/dedotdev/dedot/zombienet-tests-batch-01.yml?label=e2e%20tests&style=flat-square
[ico-version]: https://img.shields.io/github/package-json/v/dedotdev/dedot?filename=packages%2Fapi%2Fpackage.json&style=flat-square
[ico-license]: https://img.shields.io/github/license/dedotdev/dedot?style=flat-square
[ico-downloads]: https://img.shields.io/npm/dw/dedot?style=flat-square
[link-telegram]: https://t.me/JoinDedot
👉 Join our [Telegram group](https://t.me/JoinDedot) to receive the latest updates and support!! 👈
---
[Dedot](https://dedot.dev) 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](https://docs.dedot.dev/getting-started/connect-to-network#smoldot) (e.g: [smoldot](https://www.npmjs.com/package/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](https://github.com/dedotdev/chaintypes))
- ✅ Familiar api style with `@polkadot/api`, [easy & fast migration!](https://docs.dedot.dev/getting-started/pjs-to-dedot)
- ✅ Native [TypeScript type system](https://docs.dedot.dev/getting-started/pjs-to-dedot#type-system) for scale-codec
- ✅ Compatible with `@polkadot/extension`-based wallets
- ✅ Support Metadata V14, V15, V16 (latest)
- ✅ Built-in metadata optimization ([caching](https://docs.dedot.dev/getting-started/connect-to-network#caching-metadata))
- ✅ Build on top of both the [new](https://paritytech.github.io/json-rpc-interface-spec/introduction.html) & [legacy](https://github.com/w3f/PSPs/blob/master/PSPs/drafts/psp-6.md) (
deprecated soon) JSON-RPC APIs
- ✅ [Unified Typesafe Contract APIs](https://docs.dedot.dev/smart-contracts/intro) for ink! v5 (WASM, pallet-contracts), ink! v6 and solidity contracts (PVM, pallet-revive)
- ✅ Fully-typed low-level [JSON-RPC client](https://docs.dedot.dev/clients-and-providers/clients#jsonrpcclient)
> [!TIP]
> Are you building dapps on Polkadot?
>
> Check out [Typink](https://github.com/dedotdev/typink) (https://typink.dev), a comprehensive toolkit for dapps development, powered by Dedot!
### Documentation
Check out Dedot documentation on the website: https://dedot.dev
- [Getting started](https://docs.dedot.dev/getting-started/installation)
- [Interact with ink! smart contracts](https://docs.dedot.dev/ink-smart-contracts/intro)
- [CLI](https://docs.dedot.dev/cli)
- [Build with Dedot](https://docs.dedot.dev/help-and-faq/built-with-dedot)
### Example
1. Install packages
```shell
npm i dedot # or yarn, pnpm
npm i -D @dedot/chaintypes
```
2. Connect to the network
```typescript
import { DedotClient, WsProvider } from 'dedot';
import type { PolkadotApi } from '@dedot/chaintypes';
const provider = new WsProvider('wss://rpc.polkadot.io');
const client = await DedotClient.new(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(
);
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(
);
console.log('Pending rewards:', pendingRewards);
// Sign and send transaction
const result = await client.tx.balances.transferKeepAlive(, 1_000_000_000_000n)
.signAndSend(signer).untilFinalized();
// Disconnect
await client.disconnect();
```
### Resources & announcements
- [Introducing Dedot](https://forum.polkadot.network/t/introducing-dedot-a-delightful-javascript-client-for-polkadot-substrate-based-blockchains/8956)
- [Type-safe APIs to interact with ink! Smart Contracts](https://forum.polkadot.network/t/type-safe-apis-to-interact-with-ink-smart-contracts-dedot/9485)
### Real-World Projects Powered by Dedot
- [Polkadot Live App](https://polkadot-live.github.io/) ([Github](https://github.com/polkadot-live/polkadot-live-app))
- [Polkadot Staking Dashboard](https://staking.polkadot.cloud/) ([Github](https://github.com/polkadot-cloud/polkadot-staking-dashboard))
- [Typink](https://typink.dev/) ([Github](https://github.com/dedotdev/typink))
- [Allfeat SDK](https://www.allfeat.com/) ([Github](https://github.com/Allfeat/allfeat-js))
- [Polkadot UI](https://dot-ui.com/) ([Github](https://github.com/Polkadot-UI-Initiative/dot-ui))
- [Create Dot App](https://github.com/preschian/create-dot-app)
- [LunoKit - Wallet Developer Tools](https://www.lunolab.xyz/) ([Github](https://github.com/Luno-lab/LunoKit))
- ... add yours? PRs are more than welcome!
### Acknowledgment
[Dedot](https://dedot.dev) take a lot of inspirations from project [@polkadot/api](https://github.com/polkadot-js/api). A big thank to all the maintainers/contributors of this awesome library.
Proudly supported by Web3 Foundation Grants Program.
### License
[Apache-2.0](https://github.com/dedotdev/dedot/blob/main/LICENSE)