https://github.com/acalanetwork/acala-types.js

https://github.com/acalanetwork/acala-types.js

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/acalanetwork/acala-types.js
• Owner: AcalaNetwork
• License: apache-2.0
• Created: 2023-04-27T10:59:33.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-09T10:42:32.000Z (6 months ago)
• Last Synced: 2025-04-10T21:09:29.255Z (about 1 month ago)
• Language: TypeScript
• Size: 3.47 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![license](https://img.shields.io/badge/License-Apache%202.0-blue?logo=apache&style=flat-square)

[![npm](https://img.shields.io/npm/v/@acala-network/api?logo=npm&style=flat-square)](https://www.npmjs.com/package/@acala-network/api)

# @acala-network

This library provides additional typing information for user to access Acala Network by using [polkadot.js](https://github.com/polkadot-js/api).

# Getting Started

- install

```bash

yarn add @polkadot/api @acala-network/api

```

- import TS interfaces augmentation

```ts

// index.ts

import '@acala-network/types';

```

- create and use api with Acala type definitions

```ts

import { ApiPromise, WsProvider } from '@polkadot/api';

import { options } from '@acala-network/api';

const provider = new WsProvider('wss://karura-rpc.aca-api.network');

const api = new ApiPromise(options({ provider }));

await api.isReady;

// use api

const data = await api.query.system.account('5F98oWfz2r5rcRVnP9VCndg33DAAsky3iuoBSpaPUbgN9AJn');

console.log(data.toHuman())

```

# Packages

- [api](./packages/api)

  - Contains necessary options to create a polkadot.js API instance

- [types](./packages/types)

  - Polkadot.js type definations for Acala Network