@astar-network/astar-api
TypeScript icon, indicating that this package has built-in type declarations

0.2.8 • Public • Published

license

@astar-network api

This library provides additional typing information for user to access Astar's modules by using polkadot.js

Getting Started

More documentation and examples on wiki

  • Install dependencies
yarn add @polkadot/api @astar-network/astar-api@beta
  • Create API instance
import { ApiPromise } from '@polkadot/api';
import { WsProvider } from '@polkadot/rpc-provider';
import { options } from '@astar-network/astar-api';

async function main() {
    const provider = new WsProvider('wss://localhost:9944');
    const api = new ApiPromise(options({ provider }));
    await api.isReady;

    // use the api
    //..
}

main()
  • Use api to interact with node
// query and display account data
const data = await api.query.system.account('5F98oWfz2r5rcRVnP9VCndg33DAAsky3iuoBSpaPUbgN9AJn');
console.log(data.toHuman())

Packages

  • api
    • Contains necessary options to create a polkadot.js API instance
  • type-definitions
    • Polkadot.js type definitions for Astar Network.
  • types
    • Polkadot.js auto-generated types for Astar Network.

Readme

Keywords

none

Package Sidebar

Install

npm i @astar-network/astar-api

Weekly Downloads

47

Version

0.2.8

License

Apache-2.0

Unpacked Size

16.2 kB

Total Files

5

Last publish

Collaborators

  • astar-sys
  • gluneau
  • codespool