@galacticcouncil/sdk-next v0.2.0

Galactic SDK Next

Next gen hydration sdk build on top of Polkadot API (Papi).

⚠️ Disclaimer: Next is not prod ready yet. Official 1.x release coming soon.

Missing functionality & progress tracked here

Table of contents:

• Installation
• Usage
• Components
  • api
  • client
  • ctx
  • tx
• API Reference
  • AaveUtils
  • TradeRouter
  • TradeScheduler
  • BalanceClient
  • AssetClient
• Examples

Installation

Install with npm:

npm install @galacticcouncil/sdk-next

Usage

Use createSdkContext to quickly set up all components of the SDK — pool context, trading logic, client access, and transaction building — in a single call.

import { api, createSdkContext } from '@galacticcouncil/sdk-next';

const client = await api.getWs('wss://hydradx-rpc.dwellir.com');
const sdk = await createSdkContext(client);

// Don't forget to cleanup resources when DONE
sdk.destroy();
client.destroy();

It handles all necessary setup under the hood. Just plug in your PolkadotClient, and you're ready to interact with registry, accounts, pools, router, and more.

⚠️ Note: Make sure to keep only single instance of context per session.

Components

api

• aave: AaveUtils — Aave-related utilities.
• router: TradeRouter — Off-chain optimization of trades across pools for best price execution.
• scheduler: TradeScheduler — Trade orders scheduling.

client

• asset: AssetClient — Registry metadata and lookup.
• balance: BalanceClient — Account balance tracking.
• evm: EvmClient — Interacts with EVM.

ctx

• pool: PoolContextProvider — Internal stateful pool context. Initialized with support for:
  • Aave
  • Omnipool
  • Stableswap
  • XYK pools
  • LBP pools

tx

• TxBuilderFactory — Factory for generating submittable transaction using fluent APIs.

destroy()

Gracefully cleans up SDK resources. Always call before exiting to avoid memory leaks or stale subscriptions.

API Reference

AaveUtils

➡️ For type definitions visit types.ts

TradeRouter

➡️ For type definitions visit types.ts

TradeScheduler

➡️ For type definitions visit types.ts

BalanceClient

➡️ For type definitions visit types.ts

AssetClient

➡️ For type definitions visit types.ts

Examples

All examples assume sdk have been initialized see

TradeRouter

Calculate sell of 1 DOT for HDX & build tx with 5% slippage (default to 1% if not specified)

const { api, tx } = sdk;

const trade = await api.router.getBestSell(5, 10, 10_000_000_000n);
const tradeTx = await tx.trade(trade)
  .withBeneficiary(BENEFICIARY)
  .withSlippage(5)
  .build();
const tradeCall = await tradeTx.get().getEncodedData();
console.log(trade.toHuman());
console.log('Transaction hash:', tradeCall.asHex());

Note: For convenience, the router amount can be specified either as a native bigint or as a human-readable string.

For example, "1" DOT (string) is equivalent to 10_000_000_000n (bigint), as DOT has 10 decimals.

BalanceClient

Subscribe hydration treasury account.

const { client } = sdk;

const account = "7L53bUTBbfuj14UpdCNPwmgzzHSsrsTWBHX5pys32mVWM3C1"
const subscription = client.balance
  .subscribeBalance(account)
  .subscribe((balances) => {
    console.log(balances);
  });

AssetClient

Get default on-chain data.

const { client } = sdk;

const assets = await client.asset.getOnChainAssets();
console.log(assets);

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

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