Thanks to visit codestin.com
Credit goes to github.com

Skip to content

AcalaNetwork/acala.js

Repository files navigation

🌊 Acala.js

License npm TypeScript Node.js

πŸ“¦ Packages

Package Description Version
@acala-network/sdk Main SDK with wallet, DeFi protocols npm
@acala-network/sdk-core Core utilities, tokens, math operations npm
@acala-network/sdk-swap DEX trading and liquidity operations npm
@acala-network/sdk-loan CDP (Collateralized Debt Position) management npm
@acala-network/sdk-homa Liquid staking (LDOT/LKSM) operations npm
@acala-network/sdk-payment Transaction fee management npm
@acala-network/wormhole-portal Cross-chain bridge operations npm

πŸš€ Quick Start

Installation

# Install the main SDK
npm install @acala-network/sdk @acala-network/types @polkadot/api

# Or with yarn
yarn add @acala-network/sdk @acala-network/types @polkadot/api

Basic Usage

import { ApiPromise, WsProvider } from '@polkadot/api';
import { options } from '@acala-network/api';
import { Wallet } from '@acala-network/sdk';

// Connect to Acala network
const provider = new WsProvider('wss://acala-rpc.aca-api.network');
const api = await ApiPromise.create(options({ provider }));

// Create wallet instance
const wallet = new Wallet(api);

// Get account balance
const address = '5F98oWfz2r5rcRVnP9VCndg33DAAsky3iuoBSpaPUbgN9AJn';
const accountInfo = await wallet.queryBalance(address);
console.log('ACA Balance:', accountInfo.native.available.toString());

// Subscribe to balance changes
wallet.subscribeBalance(address, (balance) => {
  console.log('Balance updated:', balance.native.available.toString());
});

πŸ“š Documentation

πŸ› οΈ Development

Prerequisites

  • Node.js β‰₯ 22
  • Yarn 4.x

Setup

# Clone the repository
git clone https://github.com/AcalaNetwork/acala.js.git
cd acala.js

# Install dependencies
yarn install

# Build all packages
yarn build

# Run tests
yarn test

# Lint code
yarn lint

Project Structure

acala.js/
β”œβ”€β”€ packages/
β”‚   β”œβ”€β”€ sdk/           # Main SDK package
β”‚   β”œβ”€β”€ sdk-core/      # Core utilities
β”‚   β”œβ”€β”€ sdk-swap/      # DEX operations
β”‚   β”œβ”€β”€ sdk-loan/      # CDP management
β”‚   β”œβ”€β”€ sdk-homa/      # Liquid staking
β”‚   β”œβ”€β”€ sdk-payment/   # Fee management
β”‚   └── wormhole-portal/ # Cross-chain bridge
β”œβ”€β”€ docs/              # Documentation
└── examples/          # Example applications