​
Prerequisites

Ensure you have the following installed before getting started:

  • Node.js (v16 or higher)

​
Installation

npm install @arkade-os/sdk

​
Arkade Operator Instances

Connect to the following live Arkade Operator instances. This allows you to test your integration against a live environment without the need for a local setup.

NetworkURLStatus
Regtesthttp://localhost:7070Self-deployed
Mutinynethttps://mutinynet.arkade.sh✅ Active
Signethttps://signet.arkade.sh✅ Active

​
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 { InMemoryKey, Wallet } from '@arkade-os/sdk'

// use your private key in hex format  
const identity = InMemoryKey.fromHex('secret')

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

// You can receive bitcoin offchain instantly! No inbound liquidity!
const addresses = await wallet.getAddress()
console.log('Ark Address:', addresses.offchain)

​
Next Steps

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