Arkade TypeScript SDKs - Build on Arkade

This reference documents the public API surface of the official Arkade SDKs for TypeScript. You can use the Arkade TypeScript SDKs to:

Create and restore Bitcoin wallets
Send Arkade payments
Issue, transfer, reissue, and burn Arkade assets
Integrate settlement, boarding, withdrawal, delegation, and path-specific recovery flows
Construct advanced Tapscript-based expressive contracts
Integrate asset exchange through Arkade Intents

Available SDKs

Base SDK

Create a wallet, make transfers, manage assets, and settle through Bitcoin

Intent Swap SDK

Discover markets and create, track, cancel, or restore funded asset offers

Exclude the legacy @arkade-os/boltz-swap client from new integrations because its provider service is unavailable. Use Integrate Lightning for outbound Lightning payments.

Installing

Install @arkade-os/sdk using your preferred package manager.

npm install @arkade-os/sdk

yarn add @arkade-os/sdk

pnpm add @arkade-os/sdk

Create a Wallet

Create a wallet instance to start using Arkade.

import { Wallet, MnemonicIdentity, RestArkProvider } from "@arkade-os/sdk";

async function main() {
  const wallet = await Wallet.create({
    identity: MnemonicIdentity.fromMnemonic('abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'),
    arkProvider: new RestArkProvider(),
  })
  const address = await wallet.getAddress();
  console.log({ address });
}

main();

​Available SDKs

Base SDK

Intent Swap SDK

​Installing

​Create a Wallet

Available SDKs

Installing

Create a Wallet