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 your mnemonic seed phrase
const identity = MnemonicIdentity.fromMnemonic("abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about")

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

// You can receive bitcoin offchain instantly! No inbound liquidity!
const address = await wallet.getAddress()
console.log('Ark Address:', address)
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: