Skip to main content

​
Prerequisites

Ensure you have the following installed before getting started:
  • Node.js (v22 or higher)

​
Installation

npm install @arkade-os/sdk

​
Basic Setup

When creating a wallet, you can use an existing private key or generate a new one. For production applications, always use a secure key management solution rather than hardcoded keys.
import { MnemonicIdentity, Wallet } from '@arkade-os/sdk'
import { generateMnemonic } from '@scure/bip39'
import { wordlist } from '@scure/bip39/wordlists/english'

// Generate a new mnemonic or load an existing one from secure storage
const mnemonic = generateMnemonic(wordlist)
const identity = MnemonicIdentity.fromMnemonic(mnemonic)

// Create a wallet instance
const wallet = await Wallet.create({
  identity,
  arkServerUrl: 'https://arkade.computer',
})

// Receive Bitcoin offchain instantly
const address = await wallet.getAddress()
console.log('Arkade Address:', address)
Prefer MnemonicIdentity or SeedIdentity for new applications. SingleKey is still supported, but mainly for legacy integrations that already manage raw private keys.
Network defaults to mainnet (since v0.4.8). You no longer need to pass { isMainnet: true } explicitly. If you’re on testnet, pass { isMainnet: false } — the SDK will validate that your identity’s derivation path matches the server’s network and throw a clear error if there’s a mismatch.

​
Next Steps

Now that you have set up your Arkade wallet, you can: