@arkade-os/sdk 0.0.16

package/dist/types/utils/txSizeEstimator.d.ts

@@ -0,0 +1,27 @@
+export type VSize = {
+    value: bigint;
+    fee(feeRate: bigint): bigint;
+};
+export declare class TxWeightEstimator {
+    static readonly P2PKH_SCRIPT_SIG_SIZE: number;
+    static readonly INPUT_SIZE: number;
+    static readonly BASE_CONTROL_BLOCK_SIZE: number;
+    static readonly OUTPUT_SIZE: number;
+    static readonly P2WKH_OUTPUT_SIZE: number;
+    static readonly BASE_TX_SIZE: number;
+    static readonly WITNESS_HEADER_SIZE = 2;
+    static readonly WITNESS_SCALE_FACTOR = 4;
+    hasWitness: boolean;
+    inputCount: number;
+    outputCount: number;
+    inputSize: number;
+    inputWitnessSize: number;
+    outputSize: number;
+    private constructor();
+    static create(): TxWeightEstimator;
+    addKeySpendInput(isDefault?: boolean): TxWeightEstimator;
+    addP2PKHInput(): TxWeightEstimator;
+    addTapscriptInput(leafWitnessSize: number, leafScriptSize: number, leafControlBlockSize: number): TxWeightEstimator;
+    addP2WKHOutput(): TxWeightEstimator;
+    vsize(): VSize;
+}

package/dist/types/wallet/index.d.ts

@@ -0,0 +1,122 @@
+import { Output, SettlementEvent } from "../providers/ark";
+import { Identity } from "../identity";
+import { NetworkName } from "../networks";
+import { RelativeTimelock } from "../script/tapscript";
+import { EncodedVtxoScript, TapLeafScript } from "../script/base";
+export interface WalletConfig {
+    network: NetworkName;
+    identity: Identity;
+    esploraUrl?: string;
+    arkServerUrl?: string;
+    arkServerPublicKey?: string;
+    boardingTimelock?: RelativeTimelock;
+    exitTimelock?: RelativeTimelock;
+}
+export interface WalletBalance {
+    onchain: {
+        confirmed: number;
+        unconfirmed: number;
+        total: number;
+    };
+    offchain: {
+        swept: number;
+        settled: number;
+        pending: number;
+        total: number;
+    };
+    total: number;
+}
+export interface SendBitcoinParams {
+    address: string;
+    amount: number;
+    feeRate?: number;
+    memo?: string;
+}
+export interface Recipient {
+    address: string;
+    amount: number;
+}
+export interface SettleParams {
+    inputs: (string | ({
+        tapLeafScript: TapLeafScript;
+    } & Outpoint & EncodedVtxoScript))[];
+    outputs: Output[];
+}
+export interface VtxoTaprootAddress {
+    address: string;
+    scripts: {
+        exit: string[];
+        forfeit: string[];
+    };
+}
+export interface AddressInfo {
+    offchain: VtxoTaprootAddress;
+    boarding: VtxoTaprootAddress;
+}
+export interface Addresses {
+    onchain: string;
+    offchain?: string;
+    boarding?: string;
+    bip21: string;
+}
+export interface TapscriptInfo {
+    offchain?: string[];
+    boarding?: string[];
+}
+export interface Status {
+    confirmed: boolean;
+    block_height?: number;
+    block_hash?: string;
+    block_time?: number;
+}
+export interface VirtualStatus {
+    state: "pending" | "settled" | "swept" | "spent";
+    batchTxID?: string;
+    batchExpiry?: number;
+}
+export interface Outpoint {
+    txid: string;
+    vout: number;
+}
+export interface Coin extends Outpoint {
+    value: number;
+    status: Status;
+}
+export interface VirtualCoin extends Coin {
+    virtualStatus: VirtualStatus;
+    spentBy?: string;
+    createdAt: Date;
+}
+export declare enum TxType {
+    TxSent = "SENT",
+    TxReceived = "RECEIVED"
+}
+export interface TxKey {
+    boardingTxid: string;
+    roundTxid: string;
+    redeemTxid: string;
+}
+export interface ArkTransaction {
+    key: TxKey;
+    type: TxType;
+    amount: number;
+    settled: boolean;
+    createdAt: number;
+}
+export type ExtendedCoin = {
+    tapLeafScript: TapLeafScript;
+} & EncodedVtxoScript & Coin;
+export type ExtendedVirtualCoin = {
+    tapLeafScript: TapLeafScript;
+} & EncodedVtxoScript & VirtualCoin;
+export interface IWallet {
+    getAddress(): Promise<Addresses>;
+    getAddressInfo(): Promise<AddressInfo>;
+    getBalance(): Promise<WalletBalance>;
+    getCoins(): Promise<Coin[]>;
+    getVtxos(): Promise<ExtendedVirtualCoin[]>;
+    getBoardingUtxos(): Promise<ExtendedCoin[]>;
+    getTransactionHistory(): Promise<ArkTransaction[]>;
+    sendBitcoin(params: SendBitcoinParams, zeroFee?: boolean): Promise<string>;
+    settle(params?: SettleParams, eventCallback?: (event: SettlementEvent) => void): Promise<string>;
+}

package/dist/types/wallet/serviceWorker/db/vtxo/idb.d.ts

@@ -0,0 +1,18 @@
+import { VtxoRepository } from ".";
+import { ExtendedVirtualCoin } from "../../..";
+export declare class IndexedDBVtxoRepository implements VtxoRepository {
+    static readonly DB_NAME = "wallet-db";
+    static readonly STORE_NAME = "vtxos";
+    static readonly DB_VERSION = 1;
+    static delete(): Promise<void>;
+    private db;
+    close(): Promise<void>;
+    open(): Promise<void>;
+    addOrUpdate(vtxos: ExtendedVirtualCoin[]): Promise<void>;
+    deleteAll(): Promise<void>;
+    getSpendableVtxos(): Promise<ExtendedVirtualCoin[]>;
+    getAllVtxos(): Promise<{
+        spendable: ExtendedVirtualCoin[];
+        spent: ExtendedVirtualCoin[];
+    }>;
+}

package/dist/types/wallet/serviceWorker/db/vtxo/index.d.ts

@@ -0,0 +1,12 @@
+import { ExtendedVirtualCoin } from "../../../..";
+export interface VtxoRepository {
+    addOrUpdate(vtxos: ExtendedVirtualCoin[]): Promise<void>;
+    deleteAll(): Promise<void>;
+    getSpendableVtxos(): Promise<ExtendedVirtualCoin[]>;
+    getAllVtxos(): Promise<{
+        spendable: ExtendedVirtualCoin[];
+        spent: ExtendedVirtualCoin[];
+    }>;
+    close(): Promise<void>;
+    open(): Promise<void>;
+}

package/dist/types/wallet/serviceWorker/request.d.ts

@@ -0,0 +1,68 @@
+import { NetworkName } from "../../networks";
+import { SettleParams, SendBitcoinParams } from "..";
+export declare namespace Request {
+    type Type = "INIT_WALLET" | "SETTLE" | "GET_ADDRESS" | "GET_ADDRESS_INFO" | "GET_BALANCE" | "GET_COINS" | "GET_VTXOS" | "GET_VIRTUAL_COINS" | "GET_BOARDING_UTXOS" | "SEND_BITCOIN" | "GET_TRANSACTION_HISTORY" | "GET_STATUS" | "CLEAR";
+    interface Base {
+        type: Type;
+        id: string;
+    }
+    function isBase(message: unknown): message is Base;
+    interface InitWallet extends Base {
+        type: "INIT_WALLET";
+        privateKey: string;
+        arkServerUrl: string;
+        network: NetworkName;
+        arkServerPublicKey?: string;
+    }
+    function isInitWallet(message: Base): message is InitWallet;
+    interface Settle extends Base {
+        type: "SETTLE";
+        params?: SettleParams;
+    }
+    function isSettle(message: Base): message is Settle;
+    interface GetAddress extends Base {
+        type: "GET_ADDRESS";
+    }
+    function isGetAddress(message: Base): message is GetAddress;
+    interface GetAddressInfo extends Base {
+        type: "GET_ADDRESS_INFO";
+    }
+    function isGetAddressInfo(message: Base): message is GetAddressInfo;
+    interface GetBalance extends Base {
+        type: "GET_BALANCE";
+    }
+    function isGetBalance(message: Base): message is GetBalance;
+    interface GetCoins extends Base {
+        type: "GET_COINS";
+    }
+    function isGetCoins(message: Base): message is GetCoins;
+    interface GetVtxos extends Base {
+        type: "GET_VTXOS";
+    }
+    function isGetVtxos(message: Base): message is GetVtxos;
+    interface GetVirtualCoins extends Base {
+        type: "GET_VIRTUAL_COINS";
+    }
+    function isGetVirtualCoins(message: Base): message is GetVirtualCoins;
+    interface GetBoardingUtxos extends Base {
+        type: "GET_BOARDING_UTXOS";
+    }
+    function isGetBoardingUtxos(message: Base): message is GetBoardingUtxos;
+    interface SendBitcoin extends Base {
+        type: "SEND_BITCOIN";
+        params: SendBitcoinParams;
+        zeroFee?: boolean;
+    }
+    function isSendBitcoin(message: Base): message is SendBitcoin;
+    interface GetTransactionHistory extends Base {
+        type: "GET_TRANSACTION_HISTORY";
+    }
+    function isGetTransactionHistory(message: Base): message is GetTransactionHistory;
+    interface GetStatus extends Base {
+        type: "GET_STATUS";
+    }
+    function isGetStatus(message: Base): message is GetStatus;
+    interface Clear extends Base {
+        type: "CLEAR";
+    }
+}

package/dist/types/wallet/serviceWorker/response.d.ts

@@ -0,0 +1,107 @@
+import { WalletBalance, Coin, VirtualCoin, ArkTransaction, AddressInfo as WalletAddressInfo, IWallet, Addresses } from "..";
+import { SettlementEvent } from "../../providers/ark";
+export declare namespace Response {
+    type Type = "WALLET_INITIALIZED" | "SETTLE_EVENT" | "SETTLE_SUCCESS" | "ADDRESS" | "ADDRESS_INFO" | "BALANCE" | "COINS" | "VTXOS" | "VIRTUAL_COINS" | "BOARDING_UTXOS" | "SEND_BITCOIN_SUCCESS" | "TRANSACTION_HISTORY" | "WALLET_STATUS" | "ERROR" | "CLEAR_RESPONSE";
+    interface Base {
+        type: Type;
+        success: boolean;
+        id: string;
+    }
+    const walletInitialized: (id: string) => Base;
+    interface Error extends Base {
+        type: "ERROR";
+        success: false;
+        message: string;
+    }
+    function error(id: string, message: string): Error;
+    interface SettleEvent extends Base {
+        type: "SETTLE_EVENT";
+        success: true;
+        event: SettlementEvent;
+    }
+    function settleEvent(id: string, event: SettlementEvent): SettleEvent;
+    interface SettleSuccess extends Base {
+        type: "SETTLE_SUCCESS";
+        success: true;
+        txid: string;
+    }
+    function settleSuccess(id: string, txid: string): SettleSuccess;
+    function isSettleSuccess(response: Base): response is SettleSuccess;
+    interface Address extends Base {
+        type: "ADDRESS";
+        success: true;
+        addresses: Addresses;
+    }
+    function isAddress(response: Base): response is Address;
+    function addresses(id: string, addresses: Addresses): Address;
+    interface AddressInfo extends Base {
+        type: "ADDRESS_INFO";
+        success: true;
+        addressInfo: WalletAddressInfo;
+    }
+    function isAddressInfo(response: Base): response is AddressInfo;
+    function addressInfo(id: string, addressInfo: WalletAddressInfo): AddressInfo;
+    interface Balance extends Base {
+        type: "BALANCE";
+        success: true;
+        balance: WalletBalance;
+    }
+    function isBalance(response: Base): response is Balance;
+    function balance(id: string, balance: WalletBalance): Balance;
+    interface Coins extends Base {
+        type: "COINS";
+        success: true;
+        coins: Coin[];
+    }
+    function isCoins(response: Base): response is Coins;
+    function coins(id: string, coins: Coin[]): Coins;
+    interface Vtxos extends Base {
+        type: "VTXOS";
+        success: true;
+        vtxos: Awaited<ReturnType<IWallet["getVtxos"]>>;
+    }
+    function isVtxos(response: Base): response is Vtxos;
+    function vtxos(id: string, vtxos: Awaited<ReturnType<IWallet["getVtxos"]>>): Vtxos;
+    interface VirtualCoins extends Base {
+        type: "VIRTUAL_COINS";
+        success: true;
+        virtualCoins: VirtualCoin[];
+    }
+    function isVirtualCoins(response: Base): response is VirtualCoins;
+    function virtualCoins(id: string, virtualCoins: VirtualCoin[]): VirtualCoins;
+    interface BoardingUtxos extends Base {
+        type: "BOARDING_UTXOS";
+        success: true;
+        boardingUtxos: Awaited<ReturnType<IWallet["getBoardingUtxos"]>>;
+    }
+    function isBoardingUtxos(response: Base): response is BoardingUtxos;
+    function boardingUtxos(id: string, boardingUtxos: Awaited<ReturnType<IWallet["getBoardingUtxos"]>>): BoardingUtxos;
+    interface SendBitcoinSuccess extends Base {
+        type: "SEND_BITCOIN_SUCCESS";
+        success: true;
+        txid: string;
+    }
+    function isSendBitcoinSuccess(response: Base): response is SendBitcoinSuccess;
+    function sendBitcoinSuccess(id: string, txid: string): SendBitcoinSuccess;
+    interface TransactionHistory extends Base {
+        type: "TRANSACTION_HISTORY";
+        success: true;
+        transactions: ArkTransaction[];
+    }
+    function isTransactionHistory(response: Base): response is TransactionHistory;
+    function transactionHistory(id: string, transactions: ArkTransaction[]): TransactionHistory;
+    interface WalletStatus extends Base {
+        type: "WALLET_STATUS";
+        success: true;
+        status: {
+            walletInitialized: boolean;
+        };
+    }
+    function isWalletStatus(response: Base): response is WalletStatus;
+    function walletStatus(id: string, walletInitialized: boolean): WalletStatus;
+    interface ClearResponse extends Base {
+        type: "CLEAR_RESPONSE";
+    }
+    function isClearResponse(response: Base): response is ClearResponse;
+    function clearResponse(id: string, success: boolean): ClearResponse;
+}

package/dist/types/wallet/serviceWorker/wallet.d.ts

@@ -0,0 +1,23 @@
+import { IWallet, WalletBalance, SendBitcoinParams, SettleParams, AddressInfo, Coin, ArkTransaction, WalletConfig, ExtendedCoin, ExtendedVirtualCoin, Addresses } from "..";
+import { Response } from "./response";
+import { SettlementEvent } from "../../providers/ark";
+export declare class ServiceWorkerWallet implements IWallet {
+    private serviceWorker?;
+    static create(svcWorkerPath: string): Promise<ServiceWorkerWallet>;
+    getStatus(): Promise<Response.WalletStatus["status"]>;
+    init(config: Omit<WalletConfig, "identity"> & {
+        privateKey: string;
+    }, failIfInitialized?: boolean): Promise<void>;
+    clear(): Promise<void>;
+    private setupServiceWorker;
+    private sendMessage;
+    getAddress(): Promise<Addresses>;
+    getAddressInfo(): Promise<AddressInfo>;
+    getBalance(): Promise<WalletBalance>;
+    getCoins(): Promise<Coin[]>;
+    getVtxos(): Promise<ExtendedVirtualCoin[]>;
+    getBoardingUtxos(): Promise<ExtendedCoin[]>;
+    sendBitcoin(params: SendBitcoinParams, zeroFee?: boolean): Promise<string>;
+    settle(params?: SettleParams, callback?: (event: SettlementEvent) => void): Promise<string>;
+    getTransactionHistory(): Promise<ArkTransaction[]>;
+}

package/dist/types/wallet/serviceWorker/worker.d.ts

@@ -0,0 +1,26 @@
+import { VtxoRepository } from "./db/vtxo";
+export declare class Worker {
+    private readonly vtxoRepository;
+    private readonly messageCallback;
+    private wallet;
+    private arkProvider;
+    private vtxoSubscription;
+    constructor(vtxoRepository?: VtxoRepository, messageCallback?: (message: ExtendableMessageEvent) => void);
+    start(): Promise<void>;
+    clear(): Promise<void>;
+    private onWalletInitialized;
+    private processVtxoSubscription;
+    private handleClear;
+    private handleInitWallet;
+    private handleSettle;
+    private handleSendBitcoin;
+    private handleGetAddress;
+    private handleGetAddressInfo;
+    private handleGetBalance;
+    private handleGetCoins;
+    private handleGetVtxos;
+    private handleGetBoardingUtxos;
+    private handleGetTransactionHistory;
+    private handleGetStatus;
+    private handleMessage;
+}

package/dist/types/wallet/wallet.d.ts

@@ -0,0 +1,42 @@
+import { ArkAddress } from "../script/address";
+import { DefaultVtxo } from "../script/default";
+import { SettlementEvent } from "../providers/ark";
+import { Addresses, AddressInfo, ArkTransaction, Coin, ExtendedCoin, ExtendedVirtualCoin, IWallet, SendBitcoinParams, SettleParams, WalletBalance, WalletConfig } from ".";
+export declare class Wallet implements IWallet {
+    private identity;
+    private network;
+    private onchainProvider;
+    private onchainP2TR;
+    private arkProvider?;
+    private arkServerPublicKey?;
+    readonly offchainTapscript?: DefaultVtxo.Script | undefined;
+    readonly boardingTapscript?: DefaultVtxo.Script | undefined;
+    static DUST_AMOUNT: bigint;
+    static FEE_RATE: number;
+    private constructor();
+    static create(config: WalletConfig): Promise<Wallet>;
+    get onchainAddress(): string;
+    get boardingAddress(): ArkAddress;
+    get boardingOnchainAddress(): string;
+    get offchainAddress(): ArkAddress;
+    getAddress(): Promise<Addresses>;
+    getAddressInfo(): Promise<AddressInfo>;
+    getBalance(): Promise<WalletBalance>;
+    getCoins(): Promise<Coin[]>;
+    getVtxos(): Promise<ExtendedVirtualCoin[]>;
+    private getVirtualCoins;
+    getTransactionHistory(): Promise<ArkTransaction[]>;
+    getBoardingTxs(): Promise<{
+        boardingTxs: ArkTransaction[];
+        roundsToIgnore: Set<string>;
+    }>;
+    getBoardingUtxos(): Promise<ExtendedCoin[]>;
+    sendBitcoin(params: SendBitcoinParams, zeroFee?: boolean): Promise<string>;
+    private isOffchainSuitable;
+    private sendOnchain;
+    private sendOffchain;
+    settle(params?: SettleParams, eventCallback?: (event: SettlementEvent) => void): Promise<string>;
+    private handleSettlementSigningEvent;
+    private handleSettlementSigningNoncesGeneratedEvent;
+    private handleSettlementFinalizationEvent;
+}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@arkade-os/sdk",
+  "version": "0.0.16",
+  "description": "Bitcoin wallet SDK with Taproot and Ark integration",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/esm/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@noble/curves": "1.7.0",
+    "@noble/hashes": "1.6.1",
+    "@noble/secp256k1": "2.2.3",
+    "@scure/base": "1.2.1",
+    "@scure/btc-signer": "1.7.0",
+    "bip68": "1.0.4"
+  },
+  "devDependencies": {
+    "rimraf": "^5.0.0",
+    "@eslint/js": "^9.17.0",
+    "@types/node": "22.10.2",
+    "@typescript-eslint/eslint-plugin": "8.18.2",
+    "@typescript-eslint/parser": "8.18.2",
+    "@vitest/coverage-v8": "2.1.8",
+    "esbuild": "^0.20.1",
+    "eslint": "^9.17.0",
+    "glob": "11.0.1",
+    "husky": "9.1.7",
+    "lint-staged": "15.3.0",
+    "prettier": "3.4.2",
+    "typescript": "5.7.2",
+    "vitest": "2.1.8"
+  },
+  "keywords": [
+    "bitcoin",
+    "wallet",
+    "taproot",
+    "ark",
+    "sdk"
+  ],
+  "author": "Ark Labs",
+  "license": "MIT",
+  "engines": {
+    "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && pnpm run build:esm && node scripts/add-extensions.js && pnpm run build:cjs && pnpm run build:types && node scripts/generate-package-files.js",
+    "build:esm": "tsc -p tsconfig.esm.json --outDir dist/esm",
+    "build:cjs": "tsc -p tsconfig.cjs.json --outDir dist/cjs",
+    "build:types": "tsc -p tsconfig.json --outDir dist/types --emitDeclarationOnly",
+    "build:browser": "node scripts/build-browser.js",
+    "test": "vitest run",
+    "test:master": "ARK_ENV=master vitest run",
+    "test:unit": "vitest run --exclude test/integration.test.ts",
+    "test:setup": "node test/setup.js",
+    "test:setup-master": "node test/setup.js master",
+    "test:up-master": "docker compose -f docker-compose.yml up -d --build",
+    "test:down-master": "docker compose -f docker-compose.yml down",
+    "test:integration": "vitest run test/integration.test.ts",
+    "test:integration-master": "ARK_ENV=master vitest run test/integration.test.ts",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:sw": "pnpm run build:browser && node test/serviceWorker/serve.js",
+    "format": "prettier --write src test examples",
+    "lint": "prettier --check src test examples",
+    "audit": "pnpm audit",
+    "preinstall": "npx only-allow pnpm",
+    "release": "bash scripts/release.sh",
+    "release:dry-run": "bash scripts/release.sh --dry-run",
+    "release:cleanup": "bash scripts/release.sh --cleanup",
+    "precommit": "lint-staged"
+  }
+}