@1sat/wallet-toolbox 0.0.8 → 0.0.9

package/dist/api/OneSatApi.d.ts

@@ -0,0 +1,100 @@
+/**
+ * OneSatApi - 1Sat ecosystem application logic built on BRC-100/CWI
+ *
+ * This class provides convenient, app-specific methods for the 1Sat ecosystem
+ * that internally use the standard CWI (WalletInterface) primitives.
+ *
+ * The class is a thin facade over the modular functions in the subfolders.
+ * You can use the class for convenience, or import functions directly:
+ *
+ * ```typescript
+ * // Class-based usage
+ * const api = new OneSatApi(cwi);
+ * const ordinals = await api.listOrdinals();
+ *
+ * // Function-based usage
+ * import { listOrdinals } from '@1sat/wallet-toolbox/api/ordinals';
+ * const ordinals = await listOrdinals(cwi);
+ * ```
+ */
+import type { WalletInterface, WalletOutput, ListOutputsArgs } from "@bsv/sdk";
+import type { OneSatServices } from "../services/OneSatServices";
+import * as balance from "./balance";
+import * as payments from "./payments";
+import * as ordinals from "./ordinals";
+import * as tokens from "./tokens";
+import * as inscriptions from "./inscriptions";
+import * as locks from "./locks";
+import * as signing from "./signing";
+import * as broadcast from "./broadcast";
+export type { Balance, PaymentUtxo } from "./balance";
+export type { SendBsvRequest, SendBsvResponse } from "./payments";
+export type { TransferOrdinalRequest, ListOrdinalRequest, PurchaseOrdinalRequest, OrdinalOperationResponse, } from "./ordinals";
+export type { Bsv21Balance, SendBsv21Request, PurchaseBsv21Request, TokenOperationResponse } from "./tokens";
+export type { InscribeRequest, InscribeResponse } from "./inscriptions";
+export type { LockBsvRequest, LockData, LockOperationResponse } from "./locks";
+export type { SignMessageRequest, SignedMessage, } from "./signing";
+export type { BroadcastRequest, BroadcastResponse } from "./broadcast";
+export declare class OneSatApi {
+    private cwi;
+    private services?;
+    private chain;
+    private wocApiKey?;
+    constructor(cwi: WalletInterface, services?: OneSatServices | undefined, chain?: "main" | "test", wocApiKey?: string | undefined);
+    getBalance(): Promise<balance.Balance>;
+    getPaymentUtxos(): Promise<balance.PaymentUtxo[]>;
+    getExchangeRate(): Promise<number>;
+    sendBsv(requests: payments.SendBsvRequest[]): Promise<payments.SendBsvResponse>;
+    sendAllBsv(destination: string): Promise<payments.SendBsvResponse>;
+    /**
+     * List ordinals from the 1sat basket.
+     * Returns WalletOutput[] directly - use tags for metadata.
+     */
+    listOrdinals(options?: Partial<ListOutputsArgs>): Promise<WalletOutput[]>;
+    buildTransferOrdinal(request: ordinals.TransferOrdinalRequest): Promise<import("@bsv/sdk").CreateActionArgs | {
+        error: string;
+    }>;
+    buildListOrdinal(request: ordinals.ListOrdinalRequest): Promise<import("@bsv/sdk").CreateActionArgs | {
+        error: string;
+    }>;
+    transferOrdinal(request: ordinals.TransferOrdinalRequest): Promise<ordinals.OrdinalOperationResponse>;
+    listOrdinal(request: ordinals.ListOrdinalRequest): Promise<ordinals.OrdinalOperationResponse>;
+    cancelListing(outpoint: string): Promise<ordinals.OrdinalOperationResponse>;
+    purchaseOrdinal(request: ordinals.PurchaseOrdinalRequest): Promise<ordinals.OrdinalOperationResponse>;
+    /**
+     * Derive a cancel address for an ordinal listing.
+     * Uses the outpoint as keyID with security level 1 (self-only).
+     */
+    deriveCancelAddress(outpoint: string): Promise<string>;
+    /**
+     * List BSV21 token outputs.
+     * Returns WalletOutput[] directly - use tags for metadata.
+     */
+    listTokens(limit?: number): Promise<WalletOutput[]>;
+    getBsv21Balances(): Promise<tokens.Bsv21Balance[]>;
+    sendBsv21(request: tokens.SendBsv21Request): Promise<tokens.TokenOperationResponse>;
+    purchaseBsv21(request: tokens.PurchaseBsv21Request): Promise<tokens.TokenOperationResponse>;
+    inscribe(request: inscriptions.InscribeRequest): Promise<inscriptions.InscribeResponse>;
+    /**
+     * List locked outputs.
+     * Returns WalletOutput[] directly - use tags for metadata.
+     */
+    listLocks(limit?: number): Promise<WalletOutput[]>;
+    getLockData(): Promise<locks.LockData>;
+    lockBsv(requests: locks.LockBsvRequest[]): Promise<locks.LockOperationResponse>;
+    unlockBsv(): Promise<locks.LockOperationResponse>;
+    signMessage(request: signing.SignMessageRequest): Promise<signing.SignedMessage | {
+        error: string;
+    }>;
+    broadcast(request: broadcast.BroadcastRequest): Promise<broadcast.BroadcastResponse>;
+    /**
+     * Get the content URL for an inscription/ordinal.
+     * Useful for displaying in img/video tags.
+     * @param outpoint - Outpoint in format "txid_vout" (e.g., "abc123_0")
+     */
+    getContentUrl(outpoint: string): string;
+    /**
+     * Get the current block height from the CWI wallet.
+     */
+    getBlockHeight(): Promise<number>;
+}

package/dist/api/OneSatApi.js

@@ -0,0 +1,156 @@
+/**
+ * OneSatApi - 1Sat ecosystem application logic built on BRC-100/CWI
+ *
+ * This class provides convenient, app-specific methods for the 1Sat ecosystem
+ * that internally use the standard CWI (WalletInterface) primitives.
+ *
+ * The class is a thin facade over the modular functions in the subfolders.
+ * You can use the class for convenience, or import functions directly:
+ *
+ * ```typescript
+ * // Class-based usage
+ * const api = new OneSatApi(cwi);
+ * const ordinals = await api.listOrdinals();
+ *
+ * // Function-based usage
+ * import { listOrdinals } from '@1sat/wallet-toolbox/api/ordinals';
+ * const ordinals = await listOrdinals(cwi);
+ * ```
+ */
+// Import from modules
+import * as balance from "./balance";
+import * as payments from "./payments";
+import * as ordinals from "./ordinals";
+import * as tokens from "./tokens";
+import * as inscriptions from "./inscriptions";
+import * as locks from "./locks";
+import * as signing from "./signing";
+import * as broadcast from "./broadcast";
+import { ONESAT_MAINNET_CONTENT_URL, ONESAT_TESTNET_CONTENT_URL, } from "./constants";
+export class OneSatApi {
+    cwi;
+    services;
+    chain;
+    wocApiKey;
+    constructor(cwi, services, chain = "main", wocApiKey) {
+        this.cwi = cwi;
+        this.services = services;
+        this.chain = chain;
+        this.wocApiKey = wocApiKey;
+    }
+    // ============ Balance ============
+    getBalance() {
+        return balance.getBalance(this.cwi, this.chain, this.wocApiKey);
+    }
+    getPaymentUtxos() {
+        return balance.getPaymentUtxos(this.cwi);
+    }
+    getExchangeRate() {
+        return balance.getExchangeRate(this.chain, this.wocApiKey);
+    }
+    // ============ Payments ============
+    sendBsv(requests) {
+        return payments.sendBsv(this.cwi, requests);
+    }
+    sendAllBsv(destination) {
+        return payments.sendAllBsv(this.cwi, destination);
+    }
+    // ============ Ordinals ============
+    /**
+     * List ordinals from the 1sat basket.
+     * Returns WalletOutput[] directly - use tags for metadata.
+     */
+    listOrdinals(options) {
+        return ordinals.listOrdinals(this.cwi, options);
+    }
+    buildTransferOrdinal(request) {
+        return ordinals.buildTransferOrdinal(this.cwi, request);
+    }
+    buildListOrdinal(request) {
+        return ordinals.buildListOrdinal(this.cwi, request);
+    }
+    transferOrdinal(request) {
+        return ordinals.transferOrdinal(this.cwi, request);
+    }
+    listOrdinal(request) {
+        return ordinals.listOrdinal(this.cwi, request);
+    }
+    cancelListing(outpoint) {
+        return ordinals.cancelListing(this.cwi, outpoint);
+    }
+    purchaseOrdinal(request) {
+        return ordinals.purchaseOrdinal(this.cwi, request, this.services);
+    }
+    /**
+     * Derive a cancel address for an ordinal listing.
+     * Uses the outpoint as keyID with security level 1 (self-only).
+     */
+    deriveCancelAddress(outpoint) {
+        return ordinals.deriveCancelAddress(this.cwi, outpoint);
+    }
+    // ============ Tokens ============
+    /**
+     * List BSV21 token outputs.
+     * Returns WalletOutput[] directly - use tags for metadata.
+     */
+    listTokens(limit) {
+        return tokens.listTokens(this.cwi, limit);
+    }
+    getBsv21Balances() {
+        return tokens.getBsv21Balances(this.cwi);
+    }
+    sendBsv21(request) {
+        return tokens.sendBsv21(this.cwi, request, this.services);
+    }
+    purchaseBsv21(request) {
+        return tokens.purchaseBsv21(this.cwi, request, this.services);
+    }
+    // ============ Inscriptions ============
+    inscribe(request) {
+        return inscriptions.inscribe(this.cwi, request);
+    }
+    // ============ Locks ============
+    /**
+     * List locked outputs.
+     * Returns WalletOutput[] directly - use tags for metadata.
+     */
+    listLocks(limit) {
+        return locks.listLocks(this.cwi, limit);
+    }
+    getLockData() {
+        return locks.getLockData(this.cwi, this.chain, this.wocApiKey);
+    }
+    lockBsv(requests) {
+        return locks.lockBsv(this.cwi, requests);
+    }
+    unlockBsv() {
+        return locks.unlockBsv(this.cwi, this.chain, this.wocApiKey);
+    }
+    // ============ Signing ============
+    signMessage(request) {
+        return signing.signMessage(this.cwi, request);
+    }
+    // ============ Broadcast ============
+    broadcast(request) {
+        return broadcast.broadcast(this.cwi, request);
+    }
+    // ============ Utilities ============
+    /**
+     * Get the content URL for an inscription/ordinal.
+     * Useful for displaying in img/video tags.
+     * @param outpoint - Outpoint in format "txid_vout" (e.g., "abc123_0")
+     */
+    getContentUrl(outpoint) {
+        const contentBaseUrl = this.chain === "main"
+            ? ONESAT_MAINNET_CONTENT_URL
+            : ONESAT_TESTNET_CONTENT_URL;
+        return `${contentBaseUrl}/${outpoint}`;
+    }
+    /**
+     * Get the current block height from the CWI wallet.
+     */
+    async getBlockHeight() {
+        const result = await this.cwi.getHeight({});
+        return result.height;
+    }
+}

package/dist/api/balance/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Balance Module
+ *
+ * Functions for querying wallet balance and payment UTXOs.
+ */
+import type { WalletInterface } from "@bsv/sdk";
+export interface Balance {
+    /** Balance in satoshis */
+    satoshis: number;
+    /** Balance in BSV */
+    bsv: number;
+    /** Balance in USD cents */
+    usdInCents: number;
+}
+export interface PaymentUtxo {
+    txid: string;
+    vout: number;
+    satoshis: number;
+    script: string;
+}
+/**
+ * Get wallet balance with USD conversion.
+ */
+export declare function getBalance(cwi: WalletInterface, chain?: "main" | "test", wocApiKey?: string): Promise<Balance>;
+/**
+ * Get payment UTXOs for external use.
+ */
+export declare function getPaymentUtxos(cwi: WalletInterface): Promise<PaymentUtxo[]>;
+/**
+ * Get current BSV/USD exchange rate.
+ */
+export declare function getExchangeRate(chain?: "main" | "test", wocApiKey?: string): Promise<number>;
+/**
+ * Get chain info from WhatsOnChain.
+ */
+export declare function getChainInfo(chain?: "main" | "test", wocApiKey?: string): Promise<{
+    blocks: number;
+} | null>;

package/dist/api/balance/index.js

@@ -0,0 +1,82 @@
+/**
+ * Balance Module
+ *
+ * Functions for querying wallet balance and payment UTXOs.
+ */
+import { FUNDING_BASKET, WOC_MAINNET_URL, WOC_TESTNET_URL, EXCHANGE_RATE_CACHE_TTL } from "../constants";
+// Module-level cache for exchange rate
+let exchangeRateCache = null;
+/**
+ * Get wallet balance with USD conversion.
+ */
+export async function getBalance(cwi, chain = "main", wocApiKey) {
+    const exchangeRate = await getExchangeRate(chain, wocApiKey);
+    const result = await cwi.listOutputs({ basket: FUNDING_BASKET, limit: 10000 });
+    console.log(`[getBalance] Found ${result.outputs.length} outputs in "${FUNDING_BASKET}" basket, total: ${result.totalOutputs}`);
+    const satoshis = result.outputs.reduce((sum, o) => sum + o.satoshis, 0);
+    console.log(`[getBalance] Total satoshis: ${satoshis}`);
+    const bsv = satoshis / 100_000_000;
+    const usdInCents = Math.round(bsv * exchangeRate * 100);
+    return { satoshis, bsv, usdInCents };
+}
+/**
+ * Get payment UTXOs for external use.
+ */
+export async function getPaymentUtxos(cwi) {
+    const result = await cwi.listOutputs({
+        basket: FUNDING_BASKET,
+        include: "locking scripts",
+        limit: 10000,
+    });
+    return result.outputs.map((o) => {
+        const [txid, voutStr] = o.outpoint.split(".");
+        return {
+            txid,
+            vout: parseInt(voutStr, 10),
+            satoshis: o.satoshis,
+            script: o.lockingScript || "",
+        };
+    });
+}
+/**
+ * Get current BSV/USD exchange rate.
+ */
+export async function getExchangeRate(chain = "main", wocApiKey) {
+    if (exchangeRateCache && Date.now() - exchangeRateCache.timestamp < EXCHANGE_RATE_CACHE_TTL) {
+        return exchangeRateCache.rate;
+    }
+    const baseUrl = chain === "main" ? WOC_MAINNET_URL : WOC_TESTNET_URL;
+    const headers = {};
+    if (wocApiKey)
+        headers["woc-api-key"] = wocApiKey;
+    try {
+        const response = await fetch(`${baseUrl}/exchangerate`, { headers });
+        if (!response.ok)
+            throw new Error(`Failed to fetch: ${response.statusText}`);
+        const data = await response.json();
+        const rate = Number(data.rate.toFixed(2));
+        exchangeRateCache = { rate, timestamp: Date.now() };
+        return rate;
+    }
+    catch {
+        return exchangeRateCache?.rate ?? 0;
+    }
+}
+/**
+ * Get chain info from WhatsOnChain.
+ */
+export async function getChainInfo(chain = "main", wocApiKey) {
+    const baseUrl = chain === "main" ? WOC_MAINNET_URL : WOC_TESTNET_URL;
+    const headers = {};
+    if (wocApiKey)
+        headers["woc-api-key"] = wocApiKey;
+    try {
+        const response = await fetch(`${baseUrl}/chain/info`, { headers });
+        if (!response.ok)
+            return null;
+        return await response.json();
+    }
+    catch {
+        return null;
+    }
+}

package/dist/api/broadcast/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Broadcast Module
+ *
+ * Functions for broadcasting transactions.
+ */
+import { type WalletInterface } from "@bsv/sdk";
+export interface BroadcastRequest {
+    /** Raw transaction hex */
+    rawtx: string;
+    /** Transaction format */
+    format?: "tx" | "beef" | "ef";
+    /** Description for wallet records */
+    description?: string;
+}
+export interface BroadcastResponse {
+    txid?: string;
+    error?: string;
+}
+/**
+ * Broadcast a transaction and internalize it into the wallet.
+ */
+export declare function broadcast(cwi: WalletInterface, request: BroadcastRequest): Promise<BroadcastResponse>;

package/dist/api/broadcast/index.js

@@ -0,0 +1,45 @@
+/**
+ * Broadcast Module
+ *
+ * Functions for broadcasting transactions.
+ */
+import { Beef, Transaction, } from "@bsv/sdk";
+/**
+ * Broadcast a transaction and internalize it into the wallet.
+ */
+export async function broadcast(cwi, request) {
+    try {
+        let tx;
+        switch (request.format) {
+            case "beef":
+                tx = Transaction.fromHexBEEF(request.rawtx);
+                break;
+            case "ef":
+                tx = Transaction.fromHexEF(request.rawtx);
+                break;
+            default:
+                tx = Transaction.fromHex(request.rawtx);
+        }
+        const txid = tx.id("hex");
+        const beef = new Beef();
+        beef.mergeTransaction(tx);
+        const outputs = tx.outputs.map((_, index) => ({
+            outputIndex: index,
+            protocol: "wallet payment",
+            paymentRemittance: {
+                derivationPrefix: "default",
+                derivationSuffix: `${txid}.${index}`,
+                senderIdentityKey: "",
+            },
+        }));
+        await cwi.internalizeAction({
+            tx: Array.from(beef.toBinary()),
+            outputs,
+            description: request.description || "Broadcast transaction",
+        });
+        return { txid };
+    }
+    catch (error) {
+        return { error: error instanceof Error ? error.message : "Unknown error" };
+    }
+}

package/dist/api/constants.d.ts

@@ -0,0 +1,21 @@
+/**
+ * API Constants
+ */
+export declare const FUNDING_BASKET = "default";
+export declare const ORDINALS_BASKET = "1sat";
+export declare const BSV21_BASKET = "bsv21";
+export declare const LOCK_BASKET = "lock";
+export declare const WOC_MAINNET_URL = "https://api.whatsonchain.com/v1/bsv/main";
+export declare const WOC_TESTNET_URL = "https://api.whatsonchain.com/v1/bsv/test";
+export declare const ONESAT_MAINNET_URL = "https://1sat.shruggr.cloud";
+export declare const ONESAT_TESTNET_URL = "https://testnet.api.1sat.app";
+export declare const ONESAT_MAINNET_CONTENT_URL = "https://1sat.shruggr.cloud/content";
+export declare const ONESAT_TESTNET_CONTENT_URL = "https://testnet.api.1sat.app/content";
+export declare const ORDLOCK_PREFIX = "2097dfd76851bf465e8f715593b217714858bbe9570ff3bd5e33840a34e20ff0262102ba79df5f8ae7604a9830f03c7933028186aede0675a16f025dc4f8be8eec0382201008ce7480da41702918d1ec8e6849ba32b4d65b1e40dc669c31a1e6306b266c0000";
+export declare const ORDLOCK_SUFFIX = "615179547a75537a537a537a0079537a75527a527a7575615579008763567901c161517957795779210ac407f0e4bd44bfc207355a778b046225a7068fc59ee7eda43ad905aadbffc800206c266b30e6a1319c66dc401e5bd6b432ba49688eecd118297041da8074ce081059795679615679aa0079610079517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e01007e81517a75615779567956795679567961537956795479577995939521414136d08c5ed2bf3ba048afe6dcaebafeffffffffffffffffffffffffffffff00517951796151795179970079009f63007952799367007968517a75517a75517a7561527a75517a517951795296a0630079527994527a75517a6853798277527982775379012080517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e01205279947f7754537993527993013051797e527e54797e58797e527e53797e52797e57797e0079517a75517a75517a75517a75517a75517a75517a75517a75517a75517a75517a75517a75517a756100795779ac517a75517a75517a75517a75517a75517a75517a75517a75517a7561517a75517a756169587951797e58797eaa577961007982775179517958947f7551790128947f77517a75517a75618777777777777777777767557951876351795779a9876957795779ac777777777777777767006868";
+export declare const LOCK_PREFIX = "20d37f4de0d1c735b4d51a5572df0f3d9104d1d9e99db8694fdd1b1a92e1f0dce1757601687f76a9";
+export declare const LOCK_SUFFIX = "88ac7e7601207f75a9011488";
+export declare const MESSAGE_SIGNING_PROTOCOL: [0 | 1 | 2, string];
+export declare const MAX_INSCRIPTION_BYTES = 100000;
+export declare const MIN_UNLOCK_SATS = 1500;
+export declare const EXCHANGE_RATE_CACHE_TTL: number;

package/dist/api/constants.js

@@ -0,0 +1,29 @@
+/**
+ * API Constants
+ */
+// Basket names
+export const FUNDING_BASKET = "default";
+export const ORDINALS_BASKET = "1sat";
+export const BSV21_BASKET = "bsv21";
+export const LOCK_BASKET = "lock";
+// WhatsOnChain API URLs
+export const WOC_MAINNET_URL = "https://api.whatsonchain.com/v1/bsv/main";
+export const WOC_TESTNET_URL = "https://api.whatsonchain.com/v1/bsv/test";
+// 1Sat API base URLs
+export const ONESAT_MAINNET_URL = "https://1sat.shruggr.cloud";
+export const ONESAT_TESTNET_URL = "https://testnet.api.1sat.app";
+// 1Sat API content URLs (at root, not under /1sat/)
+export const ONESAT_MAINNET_CONTENT_URL = "https://1sat.shruggr.cloud/content";
+export const ONESAT_TESTNET_CONTENT_URL = "https://testnet.api.1sat.app/content";
+// OrdLock contract constants
+export const ORDLOCK_PREFIX = "2097dfd76851bf465e8f715593b217714858bbe9570ff3bd5e33840a34e20ff0262102ba79df5f8ae7604a9830f03c7933028186aede0675a16f025dc4f8be8eec0382201008ce7480da41702918d1ec8e6849ba32b4d65b1e40dc669c31a1e6306b266c0000";
+export const ORDLOCK_SUFFIX = "615179547a75537a537a537a0079537a75527a527a7575615579008763567901c161517957795779210ac407f0e4bd44bfc207355a778b046225a7068fc59ee7eda43ad905aadbffc800206c266b30e6a1319c66dc401e5bd6b432ba49688eecd118297041da8074ce081059795679615679aa0079610079517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e01007e81517a75615779567956795679567961537956795479577995939521414136d08c5ed2bf3ba048afe6dcaebafeffffffffffffffffffffffffffffff00517951796151795179970079009f63007952799367007968517a75517a75517a7561527a75517a517951795296a0630079527994527a75517a6853798277527982775379012080517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f517f7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e7c7e01205279947f7754537993527993013051797e527e54797e58797e527e53797e52797e57797e0079517a75517a75517a75517a75517a75517a75517a75517a75517a75517a75517a75517a75517a756100795779ac517a75517a75517a75517a75517a75517a75517a75517a75517a7561517a75517a756169587951797e58797eaa577961007982775179517958947f7551790128947f77517a75517a75618777777777777777777767557951876351795779a9876957795779ac777777777777777767006868";
+// Lock template constants
+export const LOCK_PREFIX = "20d37f4de0d1c735b4d51a5572df0f3d9104d1d9e99db8694fdd1b1a92e1f0dce1757601687f76a9";
+export const LOCK_SUFFIX = "88ac7e7601207f75a9011488";
+// Message signing protocol
+export const MESSAGE_SIGNING_PROTOCOL = [1, "message signing"];
+// Constants
+export const MAX_INSCRIPTION_BYTES = 100_000;
+export const MIN_UNLOCK_SATS = 1500;
+export const EXCHANGE_RATE_CACHE_TTL = 5 * 60 * 1000; // 5 minutes

package/dist/api/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 1Sat Wallet Toolbox API Layer
+ *
+ * This module provides the OneSatApi class for interacting with the 1Sat ecosystem.
+ * All methods work with any BRC-100 compatible wallet interface (CWI).
+ *
+ * Usage:
+ * ```typescript
+ * import { OneSatApi } from '@1sat/wallet-toolbox';
+ *
+ * // Create API instance with a CWI-compatible wallet
+ * const api = new OneSatApi(cwi);
+ *
+ * // Use the API
+ * const balance = await api.getBalance();
+ * const ordinals = await api.listOrdinals();
+ * const result = await api.sendBsv([{ address: '...', satoshis: 1000 }]);
+ * ```
+ *
+ * You can also import functions directly from modules:
+ * ```typescript
+ * import { listOrdinals } from '@1sat/wallet-toolbox/api/ordinals';
+ * import { sendBsv } from '@1sat/wallet-toolbox/api/payments';
+ * ```
+ */
+export { OneSatApi } from "./OneSatApi";
+export * from "./constants";
+export * from "./balance";
+export * from "./payments";
+export * from "./ordinals";
+export * from "./tokens";
+export * from "./inscriptions";
+export * from "./locks";
+export * from "./signing";
+export * from "./broadcast";
+export type { WalletInterface, WalletOutput, CreateActionArgs, CreateActionResult, CreateActionOutput, CreateActionInput, ListOutputsResult, ListOutputsArgs, } from "@bsv/sdk";

package/dist/api/index.js

@@ -0,0 +1,38 @@
+/**
+ * 1Sat Wallet Toolbox API Layer
+ *
+ * This module provides the OneSatApi class for interacting with the 1Sat ecosystem.
+ * All methods work with any BRC-100 compatible wallet interface (CWI).
+ *
+ * Usage:
+ * ```typescript
+ * import { OneSatApi } from '@1sat/wallet-toolbox';
+ *
+ * // Create API instance with a CWI-compatible wallet
+ * const api = new OneSatApi(cwi);
+ *
+ * // Use the API
+ * const balance = await api.getBalance();
+ * const ordinals = await api.listOrdinals();
+ * const result = await api.sendBsv([{ address: '...', satoshis: 1000 }]);
+ * ```
+ *
+ * You can also import functions directly from modules:
+ * ```typescript
+ * import { listOrdinals } from '@1sat/wallet-toolbox/api/ordinals';
+ * import { sendBsv } from '@1sat/wallet-toolbox/api/payments';
+ * ```
+ */
+// Export the main API class
+export { OneSatApi } from "./OneSatApi";
+// Export constants
+export * from "./constants";
+// Export module functions and types
+export * from "./balance";
+export * from "./payments";
+export * from "./ordinals";
+export * from "./tokens";
+export * from "./inscriptions";
+export * from "./locks";
+export * from "./signing";
+export * from "./broadcast";

package/dist/api/inscriptions/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Inscriptions Module
+ *
+ * Functions for creating inscriptions.
+ */
+import { type WalletInterface } from "@bsv/sdk";
+export interface InscribeRequest {
+    /** Base64 encoded data */
+    base64Data: string;
+    /** MIME type of the content */
+    mimeType: string;
+    /** Optional MAP metadata */
+    map?: Record<string, string>;
+    /** Destination address for the inscription (required - use a derived address) */
+    destination: string;
+}
+export interface InscribeResponse {
+    txid?: string;
+    rawtx?: string;
+    error?: string;
+}
+/**
+ * Create an inscription.
+ */
+export declare function inscribe(cwi: WalletInterface, request: InscribeRequest): Promise<InscribeResponse>;

package/dist/api/inscriptions/index.js

@@ -0,0 +1,50 @@
+/**
+ * Inscriptions Module
+ *
+ * Functions for creating inscriptions.
+ */
+import { P2PKH, Script, Utils, } from "@bsv/sdk";
+import { Inscription } from "@bopen-io/templates";
+import { MAX_INSCRIPTION_BYTES } from "../constants";
+/**
+ * Build an inscription locking script.
+ */
+function buildInscriptionScript(address, base64Data, mimeType) {
+    const content = Utils.toArray(base64Data, "base64");
+    const inscription = Inscription.create(new Uint8Array(content), mimeType);
+    const inscriptionScript = inscription.lock();
+    const p2pkhScript = new P2PKH().lock(address);
+    const combined = new Script();
+    for (const chunk of inscriptionScript.chunks)
+        combined.chunks.push(chunk);
+    for (const chunk of p2pkhScript.chunks)
+        combined.chunks.push(chunk);
+    return combined;
+}
+/**
+ * Create an inscription.
+ */
+export async function inscribe(cwi, request) {
+    try {
+        const decoded = Buffer.from(request.base64Data, "base64");
+        if (decoded.length > MAX_INSCRIPTION_BYTES) {
+            return { error: `Inscription data too large: ${decoded.length} bytes (max ${MAX_INSCRIPTION_BYTES})` };
+        }
+        const lockingScript = buildInscriptionScript(request.destination, request.base64Data, request.mimeType);
+        const result = await cwi.createAction({
+            description: "Create inscription",
+            outputs: [{
+                    lockingScript: lockingScript.toHex(),
+                    satoshis: 1,
+                    outputDescription: "Inscription",
+                }],
+        });
+        if (!result.txid) {
+            return { error: "no-txid-returned" };
+        }
+        return { txid: result.txid, rawtx: result.tx ? Utils.toHex(result.tx) : undefined };
+    }
+    catch (error) {
+        return { error: error instanceof Error ? error.message : "unknown-error" };
+    }
+}