!license

@pendulum-chain api

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

Getting Started

More documentation and examples on wiki

- Install dependencies

``bash
yarn add @polkadot/api @pendulum-chain/api@beta
`

- Create API instance

`ts
import { ApiPromise } from '@polkadot/api';
import { WsProvider } from '@polkadot/rpc-provider';
import { options } from '@pendulum-chain/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

`ts
// 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 Pendulum Network.
- types
- Polkadot.js auto-generated types for Pendulum Network.