SDK Getting Started - LeoKit Documentation

Availability

The LeoKit SDK is not published on npm. Don’t install a package named leokit-sdk from npm or any other registry: we don’t own that name, so anything published there isn’t ours.

To swap from your code today, use one of these:

The REST API with your LeoKit API key.
LeoDex’s public Swap API: one free key, no account, three HTTP calls.
The openswap CLI. Packages published by the npm user leodex are ours.

The SDK has five entry points:

Import path	Use
`leokit-sdk`	`LeoKitClient`, factory, top-level types
`leokit-sdk/wallets`	`WalletManager` and adapter classes (lazy-loaded)
`leokit-sdk/protocols`	Protocol handlers (`EvmProtocol`, `NearProtocol`, etc.)
`leokit-sdk/utils`	Amount/chain/asset/error helpers, `EventEmitter`
`leokit-sdk/cdn`	Icon-URL builders

Create a Client

import { createLeoKit } from "leokit-sdk";

const sdk = createLeoKit({
  apiKey: "your-leokit-api-key",
  network: "mainnet",
});

`LeoKitConfig`

Field	Type	Required	Description
`apiKey`	string	Yes	API key from dash.leokit.dev
`network`	`"mainnet"` \| `"testnet"`	No	Default: `"mainnet"`
`apiUrl`	string	No	Default: `https://api.leokit.dev`
`cdnUrl`	string	No	CDN base for icons. Default: LeoKit CDN

sdk.getConfig() returns the resolved ResolvedConfig (defaults filled in). sdk.getNetwork() returns the active Network.

End-to-End Swap

import { createLeoKit } from "leokit-sdk";

const sdk = createLeoKit({ apiKey: process.env.LEOKIT_API_KEY!, network: "mainnet" });

// 1. Connect a wallet (e.g. MetaMask in a browser)
await sdk.connectWallet("metamask");

// 2. Get a quote
const quote = await sdk.getQuote({
  fromAsset: "ETH.ETH",
  toAsset: "BTC.BTC",
  amount: "1000000000000000000",      // 1 ETH in wei
  destination: "bc1q...",             // recipient address
});

// 3. Execute
const result = await sdk.executeSwap(quote);
console.log("Tx hash:", result.txHash);

// 4. Track to completion
const stop = sdk.watchTransaction(quote.quoteId, (status) => {
  console.log(status.state); // "pending" | "success" | "failed" | "refunded"
  if (status.state !== "pending") stop();
});

Where to Go Next

Wallets

19 adapters: MetaMask, Phantom, Ledger, Keplr, Trust, WalletConnect…

Quotes & Swaps

getQuote, streamQuote, executeSwap, transfer, transaction tracking

Limit Orders

THORChain / MAYAChain native limit orders

Shielded ZCash

WebZjs-backed shielded balance scan and transfer

Utilities

Amount math, chain helpers, asset parsing, error handling, events, icons

​Availability

​Create a Client

​LeoKitConfig

​End-to-End Swap

​Where to Go Next

Wallets

Quotes & Swaps

Limit Orders

Shielded ZCash

Utilities

Availability

Create a Client

`LeoKitConfig`

End-to-End Swap

Where to Go Next