@acala-network/api-derive

Additional polkadot.js derives for Acala Network

Usage no npm install needed!

<script type="module">
  import acalaNetworkApiDerive from 'https://cdn.skypack.dev/@acala-network/api-derive';
</script>

README

license npm

@acala-network

This library provides additional typing information for user to access Acala Network by using polkadot.js.

Getting Started

More documentation and examples on wiki.

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

async function main() {
    const provider = new WsProvider('wss://karura.api.onfinality.io/public-ws');
    const api = new ApiPromise(options({ provider }));
    await api.isReady;

    // use 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
  • api-derive
    • Additional polkadot.js derives for Acala Network
  • app-util
    • Utilities to work with Acala Network
  • types
    • Polkadot.js type definations for Acala Network