A JavaScript library providing Promise and RxJS APIs for interacting with Polkadot and Substrate blockchains via RPC.
@polkadot/api is a JavaScript library that provides Promise and RxJS APIs for interacting with Polkadot and Substrate-based blockchain networks via RPC calls. It dynamically generates type-safe interfaces based on the runtime metadata exposed by nodes, simplifying blockchain development. The library wraps all methods and types available from network clients, enabling seamless queries, transactions, and subscriptions.
Blockchain developers building applications on Polkadot or Substrate networks who need a reliable, type-safe way to interact with nodes via RPC.
Developers choose @polkadot/api for its dynamic type generation, which ensures compatibility with any Substrate-based chain without manual updates, and its dual API support offering flexibility between Promise and RxJS patterns.
Promise and RxJS APIs around Polkadot and Substrate based chains via RPC calls. It is dynamically generated based on what the Substrate runtime provides in terms of metadata.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Automatically generates TypeScript definitions from node runtime metadata, eliminating manual updates and ensuring compatibility with any Substrate-based chain, as highlighted in the key features.
Provides both Promise-based and RxJS-based interfaces, offering flexibility for different asynchronous programming patterns, mentioned in the description for versatile development.
Wraps all methods exposed by Polkadot/Substrate clients, enabling seamless queries, transactions, and subscriptions, as stated in the key features for full blockchain interaction.
Ensures compile-time and runtime type safety for all blockchain calls, reducing errors and improving developer experience, emphasized in the description for reliability.
Tied exclusively to Polkadot and Substrate networks, making it unsuitable for multi-chain projects and creating vendor dependency for developers.
Relies on external documentation portals and scattered examples, as noted in the README pointing to the docs site, which can hinder quick onboarding and troubleshooting.
Dynamic type generation based on runtime metadata introduces performance overhead, increasing initial load times and potential latency for applications.
Errors from metadata mismatches or asynchronous patterns can be opaque, requiring deep familiarity with Polkadot-specific concepts and library internals to debug effectively.