@arkade-os/sdk 0.4.14 → 0.4.16

package/dist/cjs/extension/asset/metadata.js

@@ -15,11 +15,13 @@ class Metadata {
         this.key = key;
         this.value = value;
     }
+    /** Create a metadata entry from raw key and value bytes. */
     static create(key, value) {
         const md = new Metadata(key, value);
         md.validate();
         return md;
     }
+    /** Decode metadata from its hex string form. */
     static fromString(s) {
         let buf;
         try {
@@ -30,6 +32,7 @@ class Metadata {
         }
         return Metadata.fromBytes(buf);
     }
+    /** Decode metadata from its serialized bytes. */
     static fromBytes(buf) {
         if (!buf || buf.length === 0) {
             throw new Error("missing metadata");
@@ -37,11 +40,13 @@ class Metadata {
         const reader = new utils_1.BufferReader(buf);
         return Metadata.fromReader(reader);
     }
+    /** Serialize metadata to raw bytes. */
     serialize() {
         const writer = new utils_1.BufferWriter();
         this.serializeTo(writer);
         return writer.toBytes();
     }
+    /** Encode metadata to a hex string. */
     toString() {
         return base_1.hex.encode(this.serialize());
     }
@@ -51,6 +56,7 @@ class Metadata {
     get valueString() {
         return new TextDecoder().decode(this.value);
     }
+    /** Validate the metadata key and value. */
     validate() {
         if (this.key.length === 0) {
             throw new Error("missing metadata key");
@@ -59,6 +65,7 @@ class Metadata {
             throw new Error("missing metadata value");
         }
     }
+    /** Decode metadata from a buffer reader. */
     static fromReader(reader) {
         let key;
         let value;
@@ -78,6 +85,7 @@ class Metadata {
         md.validate();
         return md;
     }
+    /** Serialize metadata into an existing buffer writer. */
     serializeTo(writer) {
         writer.writeVarSlice(this.key);
         writer.writeVarSlice(this.value);
@@ -88,6 +96,7 @@ class MetadataList {
     constructor(items) {
         this.items = items;
     }
+    /** Create a metadata list from its hex string form. */
     static fromString(s) {
         let buf;
         try {
@@ -98,6 +107,7 @@ class MetadataList {
         }
         return MetadataList.fromBytes(buf);
     }
+    /** Decode a metadata list from its serialized bytes. */
     static fromBytes(buf) {
         if (!buf || buf.length === 0) {
             throw new Error("missing metadata list");
@@ -105,28 +115,33 @@ class MetadataList {
         const reader = new utils_1.BufferReader(buf);
         return MetadataList.fromReader(reader);
     }
+    /** Decode a metadata list from a buffer reader. */
     static fromReader(reader) {
         const count = Number(reader.readVarUint());
         const items = Array.from({ length: count }, () => Metadata.fromReader(reader));
         return new MetadataList(items);
     }
+    /** Serialize the metadata list into an existing buffer writer. */
     serializeTo(writer) {
         writer.writeVarUint(this.items.length);
         for (const item of this) {
             item.serializeTo(writer);
         }
     }
+    /** Serialize the metadata list to raw bytes. */
     serialize() {
         const writer = new utils_1.BufferWriter();
         this.serializeTo(writer);
         return writer.toBytes();
     }
+    /** Iterate through metadata entries in insertion order. */
     [Symbol.iterator]() {
         return this.items[Symbol.iterator]();
     }
     get length() {
         return this.items.length;
     }
+    /** Compute the tagged Merkle root for the metadata list. */
     hash() {
         if (this.items.length === 0)
             throw new Error("missing metadata list");

package/dist/cjs/extension/asset/packet.js

@@ -13,6 +13,7 @@ class Packet {
     constructor(groups) {
         this.groups = groups;
     }
+    /** Create a validated asset packet from a list of asset groups. */
     static create(groups) {
         const p = new Packet(groups);
         p.validate();
@@ -46,13 +47,14 @@ class Packet {
     type() {
         return Packet.PACKET_TYPE;
     }
+    /** Convert the packet into the batch-leaf form for a specific intent transaction id. */
     leafTxPacket(intentTxid) {
         const leafGroups = this.groups.map((group) => group.toBatchLeafAssetGroup(intentTxid));
         return new Packet(leafGroups);
     }
     /**
      * serialize encodes the packet as raw bytes (varint group count + group data).
-     * Does NOT include OP_RETURN, ARK magic, or TLV type/length — those are
+     * Does NOT include OP_RETURN, Arkade magic bytes (`ARK`), or TLV type/length; those are
      * added by the Extension module.
      */
     serialize() {
@@ -72,6 +74,7 @@ class Packet {
     toString() {
         return base_1.hex.encode(this.serialize());
     }
+    /** Validate packet structure and cross-group references. */
     validate() {
         if (this.groups.length === 0) {
             throw new Error("missing assets");

package/dist/cjs/extension/index.js

@@ -11,7 +11,7 @@ var packet_3 = require("./packet");
 Object.defineProperty(exports, "UnknownPacket", { enumerable: true, get: function () { return packet_3.UnknownPacket; } });
 /**
  * ArkadeMagic is the 3-byte magic prefix ("ARK") that identifies an OP_RETURN
- * output as an ark extension blob.
+ * output as an Arkade extension blob.
  */
 exports.ARKADE_MAGIC = new Uint8Array([0x41, 0x52, 0x4b]); // "ARK"
 /**

package/dist/cjs/forfeit.js

@@ -4,6 +4,13 @@ exports.buildForfeitTx = buildForfeitTx;
 exports.buildForfeitTxWithOutput = buildForfeitTxWithOutput;
 const transaction_1 = require("./utils/transaction");
 const anchor_1 = require("./utils/anchor");
+/**
+ * Build a forfeit transaction that spends the provided inputs to a single forfeit output.
+ *
+ * @param inputs - Inputs to include in the forfeit transaction
+ * @param forfeitPkScript - ScriptPubKey for the forfeit output
+ * @param txLocktime - Optional locktime to apply to the transaction
+ */
 function buildForfeitTx(inputs, forfeitPkScript, txLocktime) {
     let amount = 0n;
     for (const input of inputs) {
@@ -17,6 +24,13 @@ function buildForfeitTx(inputs, forfeitPkScript, txLocktime) {
         amount,
     }, txLocktime);
 }
+/**
+ * Build a forfeit transaction using an explicit output descriptor (used for delegated renewals)
+ *
+ * @param inputs - Inputs to include in the forfeit transaction
+ * @param output - Primary transaction output
+ * @param txLocktime - Optional locktime to apply to the transaction
+ */
 function buildForfeitTxWithOutput(inputs, output, txLocktime) {
     const tx = new transaction_1.Transaction({
         version: 3,

package/dist/cjs/identity/index.js

@@ -14,5 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBatchSignable = isBatchSignable;
+/** Type guard for identities that support batch signing. */
+function isBatchSignable(identity) {
+    return ("signMultiple" in identity &&
+        typeof identity.signMultiple === "function");
+}
 __exportStar(require("./singleKey"), exports);
 __exportStar(require("./seedIdentity"), exports);

package/dist/cjs/identity/seedIdentity.js

@@ -17,7 +17,7 @@ const ALL_SIGHASH = Object.values(btc_signer_1.SigHash).filter((x) => typeof x =
 function detectNetwork(descriptor) {
     return descriptor.includes("tpub") ? descriptors_scure_1.networks.testnet : descriptors_scure_1.networks.bitcoin;
 }
-function hasDescriptor(opts) {
+function hasDescriptor(opts = {}) {
     return "descriptor" in opts && typeof opts.descriptor === "string";
 }
 /**
@@ -44,7 +44,7 @@ function buildDescriptor(seed, isMainnet) {
  * format is HD-ready, allowing future support for multiple addresses
  * and change derivation.
  *
- * Prefer this (or {@link MnemonicIdentity}) over `SingleKey` for new
+ * Prefer this (or @see MnemonicIdentity) over `SingleKey` for new
  * integrations — `SingleKey` exists for backward compatibility with
  * raw nsec-style keys.
  *
@@ -101,7 +101,7 @@ class SeedIdentity {
      * @param seed - 64-byte seed (typically from mnemonicToSeedSync)
      * @param opts - Network selection or custom descriptor.
      */
-    static fromSeed(seed, opts) {
+    static fromSeed(seed, opts = {}) {
         const descriptor = hasDescriptor(opts)
             ? opts.descriptor
             : buildDescriptor(seed, opts.isMainnet ?? true);
@@ -161,7 +161,7 @@ exports.SeedIdentity = SeedIdentity;
  *
  * This is the most user-friendly identity type — recommended for wallet
  * applications where users manage their own backup phrase. Extends
- * {@link SeedIdentity} with mnemonic validation and optional passphrase
+ * @see SeedIdentity with mnemonic validation and optional passphrase
  * support.
  *
  * @example
@@ -185,7 +185,7 @@ class MnemonicIdentity extends SeedIdentity {
      * @param phrase - BIP39 mnemonic phrase (12 or 24 words)
      * @param opts - Network selection or custom descriptor, plus optional passphrase
      */
-    static fromMnemonic(phrase, opts) {
+    static fromMnemonic(phrase, opts = {}) {
         if (!(0, bip39_1.validateMnemonic)(phrase, english_js_1.wordlist)) {
             throw new Error("Invalid mnemonic");
         }

package/dist/cjs/identity/singleKey.js

@@ -29,12 +29,15 @@ class SingleKey {
     constructor(key) {
         this.key = key || (0, utils_js_1.randomPrivateKeyBytes)();
     }
+    /** Create a signing identity from raw private key bytes. */
     static fromPrivateKey(privateKey) {
         return new SingleKey(privateKey);
     }
+    /** Create a signing identity from a hex-encoded private key. */
     static fromHex(privateKeyHex) {
         return new SingleKey(base_1.hex.decode(privateKeyHex));
     }
+    /** Create a signing identity with a freshly generated random private key. */
     static fromRandomBytes() {
         return new SingleKey((0, utils_js_1.randomPrivateKeyBytes)());
     }
@@ -92,6 +95,7 @@ class SingleKey {
 }
 exports.SingleKey = SingleKey;
 class ReadonlySingleKey {
+    /** Create a readonly identity from a compressed public key. */
     constructor(publicKey) {
         this.publicKey = publicKey;
         if (publicKey.length !== 33) {

package/dist/cjs/index.js

@@ -36,9 +36,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CosignerPublicKey = exports.getArkPsbtFields = exports.setArkPsbtField = exports.ArkPsbtFieldKeyType = exports.ArkPsbtFieldKey = exports.TapTreeCoder = exports.CLTVMultisigTapscript = exports.ConditionMultisigTapscript = exports.ConditionCSVMultisigTapscript = exports.CSVMultisigTapscript = exports.MultisigTapscript = exports.decodeTapscript = exports.DEFAULT_MESSAGE_TIMEOUTS = exports.ServiceWorkerReadonlyWallet = exports.ServiceWorkerWallet = exports.ServiceWorkerTimeoutError = exports.MessageBusNotInitializedError = exports.MESSAGE_BUS_NOT_INITIALIZED = exports.DelegatorNotConfiguredError = exports.ReadonlyWalletError = exports.WalletNotInitializedError = exports.WalletMessageHandler = exports.MessageBus = exports.setupServiceWorker = exports.SettlementEventType = exports.ChainTxType = exports.IndexerTxType = exports.TxType = exports.VHTLC = exports.VtxoScript = exports.DelegateVtxo = exports.DefaultVtxo = exports.ArkAddress = exports.RestIndexerProvider = exports.RestArkProvider = exports.EsploraProvider = exports.ESPLORA_URL = exports.RestDelegatorProvider = exports.DelegatorManagerImpl = exports.VtxoManager = exports.Ramps = exports.OnchainWallet = exports.ReadonlyDescriptorIdentity = exports.MnemonicIdentity = exports.SeedIdentity = exports.ReadonlySingleKey = exports.SingleKey = exports.ReadonlyWallet = exports.Wallet = exports.asset = void 0;
-exports.decodeArkContract = exports.encodeArkContract = exports.VHTLCContractHandler = exports.DelegateContractHandler = exports.DefaultContractHandler = exports.contractHandlers = exports.ContractWatcher = exports.ContractManager = exports.getSequence = exports.isExpired = exports.isSubdust = exports.isSpendable = exports.isRecoverable = exports.buildForfeitTx = exports.validateConnectorsTxGraph = exports.validateVtxoTxGraph = exports.Batch = exports.maybeArkError = exports.ArkError = exports.Transaction = exports.Unroll = exports.P2A = exports.TxTree = exports.BIP322 = exports.Intent = exports.ContractRepositoryImpl = exports.WalletRepositoryImpl = exports.rollbackMigration = exports.getMigrationStatus = exports.requiresMigration = exports.migrateWalletRepository = exports.MIGRATION_KEY = exports.InMemoryContractRepository = exports.InMemoryWalletRepository = exports.IndexedDBContractRepository = exports.IndexedDBWalletRepository = exports.openDatabase = exports.closeDatabase = exports.networks = exports.ArkNote = exports.isValidArkAddress = exports.isVtxoExpiringSoon = exports.combineTapscriptSigs = exports.hasBoardingTxExpired = exports.waitForIncomingFunds = exports.verifyTapscriptSignatures = exports.buildOffchainTx = exports.ConditionWitness = exports.VtxoTaprootTree = exports.VtxoTreeExpiry = void 0;
-exports.isArkContract = exports.contractFromArkContractWithAddress = exports.contractFromArkContract = void 0;
+exports.getArkPsbtFields = exports.setArkPsbtField = exports.ArkPsbtFieldKeyType = exports.ArkPsbtFieldKey = exports.TapTreeCoder = exports.CLTVMultisigTapscript = exports.ConditionMultisigTapscript = exports.ConditionCSVMultisigTapscript = exports.CSVMultisigTapscript = exports.MultisigTapscript = exports.decodeTapscript = exports.DEFAULT_MESSAGE_TIMEOUTS = exports.ServiceWorkerReadonlyWallet = exports.ServiceWorkerWallet = exports.ServiceWorkerTimeoutError = exports.MessageBusNotInitializedError = exports.MESSAGE_BUS_NOT_INITIALIZED = exports.DelegatorNotConfiguredError = exports.ReadonlyWalletError = exports.WalletNotInitializedError = exports.WalletMessageHandler = exports.MessageBus = exports.setupServiceWorker = exports.SettlementEventType = exports.ChainTxType = exports.IndexerTxType = exports.TxType = exports.VHTLC = exports.VtxoScript = exports.DelegateVtxo = exports.DefaultVtxo = exports.ArkAddress = exports.RestIndexerProvider = exports.RestArkProvider = exports.EsploraProvider = exports.ESPLORA_URL = exports.RestDelegatorProvider = exports.DelegatorManagerImpl = exports.VtxoManager = exports.Ramps = exports.OnchainWallet = exports.isBatchSignable = exports.ReadonlyDescriptorIdentity = exports.MnemonicIdentity = exports.SeedIdentity = exports.ReadonlySingleKey = exports.SingleKey = exports.ReadonlyWallet = exports.Wallet = exports.asset = void 0;
+exports.encodeArkContract = exports.VHTLCContractHandler = exports.DelegateContractHandler = exports.DefaultContractHandler = exports.contractHandlers = exports.ContractWatcher = exports.ContractManager = exports.getSequence = exports.isExpired = exports.isSubdust = exports.isSpendable = exports.isRecoverable = exports.buildForfeitTx = exports.validateConnectorsTxGraph = exports.validateVtxoTxGraph = exports.Batch = exports.maybeArkError = exports.ArkError = exports.Transaction = exports.Unroll = exports.P2A = exports.TxTree = exports.BIP322 = exports.Intent = exports.ContractRepositoryImpl = exports.WalletRepositoryImpl = exports.rollbackMigration = exports.getMigrationStatus = exports.requiresMigration = exports.migrateWalletRepository = exports.MIGRATION_KEY = exports.InMemoryContractRepository = exports.InMemoryWalletRepository = exports.IndexedDBContractRepository = exports.IndexedDBWalletRepository = exports.openDatabase = exports.closeDatabase = exports.networks = exports.ArkNote = exports.isValidArkAddress = exports.isVtxoExpiringSoon = exports.combineTapscriptSigs = exports.hasBoardingTxExpired = exports.waitForIncomingFunds = exports.verifyTapscriptSignatures = exports.buildOffchainTx = exports.ConditionWitness = exports.VtxoTaprootTree = exports.VtxoTreeExpiry = exports.CosignerPublicKey = void 0;
+exports.isArkContract = exports.contractFromArkContractWithAddress = exports.contractFromArkContract = exports.decodeArkContract = void 0;
 const transaction_1 = require("./utils/transaction");
 Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return transaction_1.Transaction; } });
 const singleKey_1 = require("./identity/singleKey");
@@ -48,6 +48,8 @@ const seedIdentity_1 = require("./identity/seedIdentity");
 Object.defineProperty(exports, "SeedIdentity", { enumerable: true, get: function () { return seedIdentity_1.SeedIdentity; } });
 Object.defineProperty(exports, "MnemonicIdentity", { enumerable: true, get: function () { return seedIdentity_1.MnemonicIdentity; } });
 Object.defineProperty(exports, "ReadonlyDescriptorIdentity", { enumerable: true, get: function () { return seedIdentity_1.ReadonlyDescriptorIdentity; } });
+const identity_1 = require("./identity");
+Object.defineProperty(exports, "isBatchSignable", { enumerable: true, get: function () { return identity_1.isBatchSignable; } });
 const address_1 = require("./script/address");
 Object.defineProperty(exports, "ArkAddress", { enumerable: true, get: function () { return address_1.ArkAddress; } });
 const vhtlc_1 = require("./script/vhtlc");

package/dist/cjs/intent/index.js

@@ -12,10 +12,11 @@ const base_2 = require("../script/base");
  * Intent proof implementation for Bitcoin message signing.
  *
  * Intent proof defines a standard for signing Bitcoin messages as well as proving
- * ownership of coins. This namespace provides utilities for creating and
- * validating Intent proof.
+ * ownership of outputs.
  *
- * it is greatly inspired by BIP322.
+ * This namespace provides utilities for creating and validating Intent proof.
+ *
+ * It is greatly inspired by BIP322.
  * @see https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki
  *
  * @example
@@ -37,11 +38,11 @@ var Intent;
      * Creates a new Intent proof unsigned transaction.
      *
      * This function constructs a special transaction that can be signed to prove
-     * ownership of VTXOs and UTXOs. The proof includes the message to be
+     * ownership of onchain and virtual outputs. The proof includes the message to be
      * signed and the inputs/outputs that demonstrate ownership.
      *
      * @param message - The Intent message to be signed, either raw string of Message object
-     * @param inputs - Array of transaction inputs to prove ownership of
+     * @param ins - Array of transaction inputs to prove ownership of
      * @param outputs - Optional array of transaction outputs
      * @returns An unsigned Intent proof transaction
      */
@@ -56,12 +57,18 @@ var Intent;
             throw new Error("invalid inputs");
         if (!validateOutputs(outputs))
             throw new Error("invalid outputs");
-        // create the initial transaction to spend
+        // Create the initial transaction to spend.
         const toSpend = craftToSpendTx(message, inputs[0].witnessUtxo.script);
-        // create the transaction to sign
+        // Create the transaction to sign.
         return craftToSignTx(toSpend, inputs, outputs);
     }
     Intent.create = create;
+    /**
+     * Compute the fee paid by an intent proof transaction.
+     *
+     * @param proof - Intent proof transaction
+     * @returns The fee in satoshis
+     */
     function fee(proof) {
         let sumOfInputs = 0n;
         for (let i = 0; i < proof.inputsLength; i++) {
@@ -83,6 +90,12 @@ var Intent;
         return Number(sumOfInputs - sumOfOutputs);
     }
     Intent.fee = fee;
+    /**
+     * Serialize an intent message to the canonical JSON string used for signing.
+     *
+     * @param message - Intent message payload
+     * @returns Canonical string form of the message
+     */
     function encodeMessage(message) {
         switch (message.type) {
             case "register":
@@ -143,7 +156,7 @@ function validateOutputs(outputs) {
  *
  * @param message - The message to embed
  * @param pkScript - The scriptPubKey of the signer's address
- * @param tag - Tagged-hash tag (defaults to the Ark intent proof tag)
+ * @param tag - Tagged-hash tag (defaults to the Arkade intent proof tag)
  */
 function craftToSpendTx(message, pkScript, tag = exports.TAG_INTENT_PROOF) {
     const messageHash = hashMessage(message, tag);
@@ -169,12 +182,15 @@ function craftToSpendTx(message, pkScript, tag = exports.TAG_INTENT_PROOF) {
 // craftToSignTx creates the transaction that will be signed for the proof
 function craftToSignTx(toSpend, inputs, outputs) {
     const firstInput = inputs[0];
-    const lockTime = inputs
-        .map((input) => input.sequence || 0)
-        .reduce((a, b) => Math.max(a, b), 0);
+    // Proof tx is never broadcast onchain — toSpend references a zero-hash
+    // outpoint (see BIP-322). The tx exists only as a sighash commitment
+    // the server verifies signatures against; nLockTime and nSequence carry
+    // no consensus meaning here, they only need to match between signer and
+    // verifier. Use lockTime = 0 (BIP-322 convention) and leave each input's
+    // nSequence untouched.
     const tx = new transaction_1.Transaction({
         version: 2,
-        lockTime,
+        lockTime: 0,
     });
     // add the first "toSpend" input
     tx.addInput({

package/dist/cjs/providers/ark.js

@@ -19,11 +19,12 @@ var SettlementEventType;
     SettlementEventType["StreamStarted"] = "stream_started";
 })(SettlementEventType || (exports.SettlementEventType = SettlementEventType = {}));
 /**
- * REST-based Ark provider implementation.
+ * REST-based Arkade provider implementation.
+ *
  * @see https://buf.build/arkade-os/arkd/docs/main:ark.v1#ark.v1.ArkService
  * @example
  * ```typescript
- * const provider = new RestArkProvider('https://ark.example.com');
+ * const provider = new RestArkProvider('https://arkade.computer');
  * const info = await provider.getInfo();
  * ```
  */

package/dist/cjs/providers/delegator.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RestDelegatorProvider = void 0;
 const intent_1 = require("../intent");
 /**
- * REST-based Delegator provider implementation.
+ * REST-based delegation provider implementation.
  * @example
  * ```typescript
  * const provider = new RestDelegatorProvider('https://delegator.example.com');
@@ -12,9 +12,22 @@ const intent_1 = require("../intent");
  * ```
  */
 class RestDelegatorProvider {
+    /**
+     * Create a REST delegation provider targeting the given base URL.
+     *
+     * @param url - Base URL of the delegation service
+     */
     constructor(url) {
         this.url = url;
     }
+    /**
+     * Submit a delegation request to the remote delegation service.
+     *
+     * @param intent - Signed register intent to delegate
+     * @param forfeitTxs - Forfeit transactions associated with the delegation request
+     * @param options - Optional delegate behavior flags
+     * @throws Error if the remote service rejects the request
+     */
     async delegate(intent, forfeitTxs, options) {
         const url = `${this.url}/v1/delegate`;
         const response = await fetch(url, {
@@ -36,6 +49,12 @@ class RestDelegatorProvider {
             throw new Error(`Failed to delegate: ${errorText}`);
         }
     }
+    /**
+     * Fetch delegate metadata exposed by the remote delegation service.
+     *
+     * @returns Delegate identity and fee information
+     * @throws Error if the remote service returns invalid data
+     */
     async getDelegateInfo() {
         const url = `${this.url}/v1/delegator/info`;
         const response = await fetch(url);

package/dist/cjs/providers/expoArk.js

@@ -4,7 +4,7 @@ exports.ExpoArkProvider = void 0;
 const ark_1 = require("./ark");
 const expoUtils_1 = require("./expoUtils");
 /**
- * Expo-compatible Ark provider implementation using expo/fetch for SSE support.
+ * Expo-compatible Arkade provider implementation using expo/fetch for SSE support.
  * This provider works specifically in React Native/Expo environments where
  * standard EventSource is not available but expo/fetch provides SSE capabilities.
  *
@@ -12,7 +12,7 @@ const expoUtils_1 = require("./expoUtils");
  * ```typescript
  * import { ExpoArkProvider } from '@arkade-os/sdk/providers/expo';
  *
- * const provider = new ExpoArkProvider('https://ark.example.com');
+ * const provider = new ExpoArkProvider('https://arkade.computer');
  * const info = await provider.getInfo();
  * ```
  */

package/dist/cjs/providers/indexer.js

@@ -20,11 +20,11 @@ var ChainTxType;
     ChainTxType["CHECKPOINT"] = "INDEXER_CHAINED_TX_TYPE_CHECKPOINT";
 })(ChainTxType || (exports.ChainTxType = ChainTxType = {}));
 /**
- * REST-based Indexer provider implementation.
+ * REST-based indexer provider implementation.
  * @see https://buf.build/arkade-os/arkd/docs/main:ark.v1#ark.v1.IndexerService
  * @example
  * ```typescript
- * const provider = new RestIndexerProvider('https://ark.indexer.example.com');
+ * const provider = new RestIndexerProvider('https://arkade.computer');
  * const commitmentTx = await provider.getCommitmentTx("6686af8f3be3517880821f62e6c3d749b9d6713736a1d8e229a55daa659446b2");
  * ```
  */

package/dist/cjs/providers/onchain.js

@@ -13,11 +13,12 @@ exports.ESPLORA_URL = {
 };
 /**
  * Implementation of the onchain provider interface for esplora REST API.
+ *
  * @see https://mempool.space/docs/api/rest
  * @example
  * ```typescript
  * const provider = new EsploraProvider("https://mempool.space/api");
- * const utxos = await provider.getCoins("bcrt1q679zsd45msawvr7782r0twvmukns3drlstjt77");
+ * const outputs = await provider.getCoins("bcrt1q679zsd45msawvr7782r0twvmukns3drlstjt77");
  * ```
  */
 class EsploraProvider {

package/dist/cjs/repositories/realm/schemas.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * Realm object schemas for the Ark wallet.
+ * Realm object schemas for the Arkade wallet.
  *
  * All schema names are prefixed with "Ark" to avoid collisions with
  * other Realm schemas in the consuming application.
@@ -96,7 +96,7 @@ exports.ArkContractSchema = {
     },
 };
 /**
- * All Realm schemas needed by the Ark wallet repositories.
+ * All Realm schemas needed by the Arkade wallet repositories.
  * Pass this array to your Realm configuration's `schema` property.
  */
 exports.ArkRealmSchemas = [

package/dist/cjs/repositories/realm/types.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * Minimal interface for the subset of the Realm API used by the
- * Ark repositories.  Consumers pass their real Realm instance and
+ * Arkade repositories. Consumers pass their real Realm instance and
  * the compiler validates it satisfies this shape.
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/script/address.js

@@ -4,13 +4,20 @@ exports.ArkAddress = void 0;
 const base_1 = require("@scure/base");
 const script_js_1 = require("@scure/btc-signer/script.js");
 /**
- * ArkAddress allows to create and decode bech32m encoded ark address.
- * An ark address is composed of:
+ * ArkAddress allows creating and decoding bech32m-encoded Arkade addresses.
+ *
+ * An Arkade address is composed of:
  * - a human readable prefix (hrp)
  * - a version byte (1 byte)
  * - a server public key (32 bytes)
  * - a vtxo taproot public key (32 bytes)
  *
+ * @remarks
+ * This is an Arkade-specific address format.
+ * It is distinct from the Taproot onchain address returned by `VtxoScript.onchainAddress`.
+ *
+ * @see VtxoScript
+ *
  * @example
  * ```typescript
  * const address = new ArkAddress(
@@ -26,6 +33,16 @@ const script_js_1 = require("@scure/btc-signer/script.js");
  * ```
  */
 class ArkAddress {
+    /**
+     * Create an Arkade address from its server key, vtxo taproot public key, and prefix.
+     *
+     * @param serverPubKey - 32-byte Arkade server public key
+     * @param vtxoTaprootKey - 32-byte tweaked vtxo taproot public key
+     * @param hrp - Bech32 human-readable prefix
+     * @param version - Address version byte
+     * @defaultValue `version = 0`
+     * @throws Error if either public key is not 32 bytes long
+     */
     constructor(serverPubKey, vtxoTaprootKey, hrp, version = 0) {
         this.serverPubKey = serverPubKey;
         this.vtxoTaprootKey = vtxoTaprootKey;
@@ -40,13 +57,21 @@ class ArkAddress {
                 vtxoTaprootKey.length);
         }
     }
+    /**
+     * Decode an Arkade address from its bech32m string form.
+     *
+     * @param address - Bech32m-encoded Arkade address
+     * @returns Decoded Arkade address
+     * @throws Error if the address is malformed or has an invalid payload length
+     * @see encode
+     */
     static decode(address) {
         const decoded = base_1.bech32m.decodeUnsafe(address, 1023);
         if (!decoded) {
             throw new Error("Invalid address");
         }
         const data = new Uint8Array(base_1.bech32m.fromWords(decoded.words));
-        // First the version byte, then 32 bytes server pubkey, then 32 bytes vtxo taproot pubkey
+        // First the version byte, then 32 bytes server pubkey, then 32 bytes vtxo taproot public key.
         if (data.length !== 1 + 32 + 32) {
             throw new Error("Invalid data length, expected 65 bytes, got " + data.length);
         }
@@ -55,8 +80,14 @@ class ArkAddress {
         const vtxoTaprootPubKey = data.slice(33, 65);
         return new ArkAddress(serverPubKey, vtxoTaprootPubKey, decoded.prefix, version);
     }
+    /**
+     * Encode the address to its bech32m string form.
+     *
+     * @returns Bech32m-encoded Arkade address
+     * @see decode
+     */
     encode() {
-        // Combine version byte, server pubkey, and vtxo taproot pubkey
+        // Combine version byte, server pubkey, and vtxo taproot public key.
         const data = new Uint8Array(1 + 32 + 32);
         data[0] = this.version;
         data.set(this.serverPubKey, 1);
@@ -64,11 +95,11 @@ class ArkAddress {
         const words = base_1.bech32m.toWords(data);
         return base_1.bech32m.encode(this.hrp, words, 1023);
     }
-    // pkScript is the script that should be used to send non-dust funds to the address
+    /** ScriptPubKey used to send non-dust funds to the address. */
     get pkScript() {
         return script_js_1.Script.encode(["OP_1", this.vtxoTaprootKey]);
     }
-    // subdustPkScript is the script that should be used to send sub-dust funds to the address
+    /** ScriptPubKey used to send sub-dust funds to the address. */
     get subdustPkScript() {
         return script_js_1.Script.encode(["RETURN", this.vtxoTaprootKey]);
     }