Galactic SDK

• Installation
• Components
  • Router
  • TradeRouter
• Examples
• Roadmap

Installation

Install with npm:

npm install @galacticcouncil/sdk

Troubleshooting

As of v2.x .wasm files are no longer embedded in bundle but rather deferred to improve load performance & decrease module size (esm only).

If you upgrading from v1.x to v2.x make sure you use appropriate wasm plugin in your build config to directly import .wasm files as if they were a javascript module.

For more details visit TROUBLESHOOTING.md

Components

Router

Off-chain routing, build to find the most suitable routes across the pools. Building block for TradeRouter.

API

getPools(): PoolBase[]
getAllAssets(): Asset[]
getAssetPairs(token: string): Asset[]
getAllPaths(tokenIn: string, tokenOut: string): Hop[][]

TradeRouter

Off-chain optimization of orders across pools for best price execution. TradeRouter does not perform any on-chain transations.

API

getBestSpotPrice(tokenIn: string, tokenOut: string): Amount
getBestSell(tokenIn: string, tokenOut: string, amountIn: BigNumber | number | string): Trade
getBestBuy(tokenIn: string, tokenOut: string, amountOut: BigNumber | number | string): Trade

For type signature visit types.ts

Usage

// Import
import { ApiPromise, WsProvider } from '@polkadot/api';
import { TradeRouter, PoolService, PoolType } from '@galacticcouncil/sdk';

// Initialize Polkadot API
const wsProvider = new WsProvider('wss://rpc.hydradx.cloud');
const api = await ApiPromise.create({ provider: wsProvider });

// Initialize Trade Router
const poolService = new PoolService(api);
await poolService.syncRegistry(); // Wait until pools initialized (optional), fallback to lazy init
const tradeRouter = new TradeRouter(poolService);

// Do something
const result = await tradeRouter.getAllAssets();
console.log(result);

Examples

SDK Examples and testing helpers.

Run

Run: $ npx tsx ./test/script/examples/<examplePackage>/<exampleName>.ts with valid example package & name.

To demonstrate full working examples on real chain see script section.

Roadmap

Component list and current status ⬇️

• 🧪 Done
• 🛠 Work in progress
• ⏳ Planning to build

| Name | Type | | | ----------- | :--: | --: | | Router | API | 🧪 | | TradeRouter | API | 🧪 | | XYK | Math | 🧪 | | XYK | Pool | 🧪 | | Omni | Math | 🧪 | | Omni | Pool | 🧪 | | LBP | Math | 🧪 | | LBP | Pool | 🧪 | | Stable | Math | 🧪 | | Stable | Pool | 🧪 |