> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arkadeos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Arkade TypeScript SDKs

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

<CardGroup cols={3}>
  <Card title="Base SDK" icon="wallet" href="https://www.npmjs.com/package/@arkade-os/sdk">
    Create a wallet, make transfers, manage assets, and settle to Bitcoin L1
  </Card>

  <Card title="Boltz Swap SDK" icon="bolt" href="https://www.npmjs.com/package/@arkade-os/boltz-swap">
    Trustlessly move funds between Bitcoin mainnet, Lightning, and Arkade
  </Card>
</CardGroup>

## Installing

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

<CodeGroup>
  ```bash npm theme={null}
  npm install @arkade-os/sdk
  ```

  ```bash yarn theme={null}
  yarn add @arkade-os/sdk
  ```

  ```bash pnpm theme={null}
  pnpm add @arkade-os/sdk
  ```
</CodeGroup>

## Create a Wallet

Create a wallet instance to start using Arkade.

```typescript theme={null}
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();
```