Skip to main content
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 instant offchain payments
  • Issue, transfer, reissue, and burn Arkade assets
  • Keep funds self-custodial with settlement, boarding, recovery, delegation, and collaborative exit flows
  • Construct advanced Tapscript-based expressive contracts
  • Integrate Boltz for Lightning and chain swap flows

​
Available SDKs

Base SDK

Create a wallet, make transfers, manage assets, and settle to Bitcoin L1

Boltz Swap SDK

Trustlessly move funds between Bitcoin mainnet, Lightning, and Arkade

​
Installing

Install @arkade-os/sdk using your preferred package manager. 
npm install @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();