@arkade-os/sdk 0.4.27 → 0.4.28

package/dist/esm/arkfee/types.js

@@ -1,22 +0,0 @@
-/**
- * FeeAmount is a wrapper around a number that represents a fee amount in satoshis floating point.
- * @param value - The fee amount in floating point.
- * @example
- * const fee = new FeeAmount(1.23456789);
- * console.log(fee.value); // 1.23456789
- * console.log(fee.satoshis); // 2
- */
-export class FeeAmount {
-    constructor(value) {
-        this.value = value;
-    }
-    /** Returns the fee amount rounded up to whole satoshis. */
-    get satoshis() {
-        return this.value ? Math.ceil(this.value) : 0;
-    }
-    /** Add two fee amounts together. */
-    add(other) {
-        return new FeeAmount(this.value + other.value);
-    }
-}
-FeeAmount.ZERO = new FeeAmount(0);

package/dist/esm/arknote/index.js

@@ -1,124 +0,0 @@
-import { base58, hex } from "@scure/base";
-import { sha256 } from "@scure/btc-signer/utils.js";
-import { Script } from "@scure/btc-signer";
-import { VtxoScript } from "../script/base.js";
-/**
- * ArkNotes are special virtual outputs in the Arkade protocol that
- * can be created and spent without requiring any transactions.
- * The server mints them, and they are encoded as base58 strings
- * with a human-readable prefix, a preimage and a value.
- *
- * @see VtxoScript
- *
- * @example
- * ```typescript
- * // Create an ArkNote
- * const note = new ArkNote(preimage, 50000);
- *
- * // Encode to string
- * const noteString = note.toString();
- *
- * // Decode from string
- * const decodedNote = ArkNote.fromString(noteString);
- * ```
- */
-export class ArkNote {
-    /**
-     * Create an ArkNote from a preimage and value.
-     *
-     * @param preimage - 32-byte preimage revealed to spend the note
-     * @param value - Note value in satoshis
-     * @param HRP - Optional human-readable prefix for string encoding
-     */
-    constructor(preimage, value, HRP = ArkNote.DefaultHRP) {
-        this.preimage = preimage;
-        this.value = value;
-        this.HRP = HRP;
-        this.vout = 0;
-        const preimageHash = sha256(this.preimage);
-        this.vtxoScript = new VtxoScript([noteTapscript(preimageHash)]);
-        const leaf = this.vtxoScript.leaves[0];
-        this.txid = hex.encode(new Uint8Array(preimageHash).reverse());
-        this.tapTree = this.vtxoScript.encode();
-        this.forfeitTapLeafScript = leaf;
-        this.intentTapLeafScript = leaf;
-        this.value = value;
-        this.status = { confirmed: true };
-        this.extraWitness = [this.preimage];
-    }
-    /**
-     * Encode the note as raw bytes.
-     *
-     * @returns Serialized note bytes
-     * @see decode
-     */
-    encode() {
-        const result = new Uint8Array(ArkNote.Length);
-        result.set(this.preimage, 0);
-        writeUInt32BE(result, this.value, this.preimage.length);
-        return result;
-    }
-    /**
-     * Decode a note from raw bytes.
-     *
-     * @param data - Serialized note bytes
-     * @param hrp - Human-readable prefix expected for future string encoding
-     * @returns Decoded ArkNote
-     * @throws Error if the payload length is invalid
-     * @see encode
-     */
-    static decode(data, hrp = ArkNote.DefaultHRP) {
-        if (data.length !== ArkNote.Length) {
-            throw new Error(`invalid data length: expected ${ArkNote.Length} bytes, got ${data.length}`);
-        }
-        const preimage = data.subarray(0, ArkNote.PreimageLength);
-        const value = readUInt32BE(data, ArkNote.PreimageLength);
-        return new ArkNote(preimage, value, hrp);
-    }
-    /**
-     * Decode a note from its base58 string form.
-     *
-     * @param noteStr - Base58-encoded note string
-     * @param hrp - Human-readable prefix expected on the note string
-     * @returns Decoded ArkNote
-     * @throws Error if the prefix or base58 payload is invalid
-     * @see toString
-     */
-    static fromString(noteStr, hrp = ArkNote.DefaultHRP) {
-        noteStr = noteStr.trim();
-        if (!noteStr.startsWith(hrp)) {
-            throw new Error(`invalid human-readable part: expected ${hrp} prefix (note '${noteStr}')`);
-        }
-        const encoded = noteStr.slice(hrp.length);
-        const decoded = base58.decode(encoded);
-        if (decoded.length === 0) {
-            throw new Error("failed to decode base58 string");
-        }
-        return ArkNote.decode(decoded, hrp);
-    }
-    /**
-     * Encode the note to its human-readable base58 string form.
-     *
-     * @returns Base58-encoded note string
-     * @see fromString
-     */
-    toString() {
-        return this.HRP + base58.encode(this.encode());
-    }
-}
-ArkNote.DefaultHRP = "arknote";
-ArkNote.PreimageLength = 32; // 32 bytes for the preimage
-ArkNote.ValueLength = 4; // 4 bytes for the value
-ArkNote.Length = ArkNote.PreimageLength + ArkNote.ValueLength;
-ArkNote.FakeOutpointIndex = 0;
-function writeUInt32BE(array, value, offset) {
-    const view = new DataView(array.buffer, array.byteOffset + offset, 4);
-    view.setUint32(0, value, false);
-}
-function readUInt32BE(array, offset) {
-    const view = new DataView(array.buffer, array.byteOffset + offset, 4);
-    return view.getUint32(0, false);
-}
-function noteTapscript(preimageHash) {
-    return Script.encode(["SHA256", preimageHash, "EQUAL"]);
-}

package/dist/esm/bip322/index.js

@@ -1,267 +0,0 @@
-import { p2tr, p2wpkh, Address, OutScript, RawWitness, SigHash, } from "@scure/btc-signer";
-import { concatBytes, hash160, sha256x2, } from "@scure/btc-signer/utils.js";
-import { schnorr, secp256k1 } from "@noble/curves/secp256k1.js";
-import { equalBytes } from "@noble/curves/utils.js";
-import { base64 } from "@scure/base";
-import { Transaction } from "../utils/transaction.js";
-import { craftToSpendTx, OP_RETURN_EMPTY_PKSCRIPT } from "../intent/index.js";
-const TAG_BIP322 = "BIP0322-signed-message";
-/**
- * BIP-322 simple message signing and verification.
- *
- * Supports P2TR (Taproot) signing and verification, P2WPKH verification,
- * and legacy P2PKH verification (Bitcoin Core signmessage format).
- *
- * Reuses the same toSpend/toSign transaction construction as Intent proofs,
- * but with the standard BIP-322 tagged hash ("BIP0322-signed-message")
- * instead of the Arkade-specific tag.
- *
- * @see https://github.com/bitcoin/bips/blob/master/bip-0322.mediawiki
- *
- * @example
- * ```typescript
- * // Sign a message (P2TR)
- * const signature = await BIP322.sign("Hello Bitcoin!", identity);
- *
- * // Verify a signature (P2TR or P2WPKH)
- * const valid = BIP322.verify("Hello Bitcoin!", signature, "bc1p...");
- * const valid2 = BIP322.verify("Hello Bitcoin!", signature, "bc1q...");
- * ```
- */
-export var BIP322;
-(function (BIP322) {
-    /**
-     * Sign a message using the BIP-322 simple signature scheme.
-     *
-     * Constructs the standard BIP-322 toSpend and toSign transactions,
-     * signs via the Identity interface, and returns the base64-encoded
-     * witness stack.
-     *
-     * @param message - The message to sign
-     * @param identity - Identity instance (holds the private key internally)
-     * @param network - Optional Bitcoin network for P2TR address derivation
-     * @returns Base64-encoded BIP-322 simple signature (witness stack)
-     */
-    async function sign(message, identity, network) {
-        const xOnlyPubKey = await identity.xOnlyPublicKey();
-        const payment = p2tr(xOnlyPubKey, undefined, network);
-        // Build BIP-322 toSpend using shared construction with BIP-322 tag
-        const toSpend = craftToSpendTx(message, payment.script, TAG_BIP322);
-        // Build BIP-322 toSign: version 0, single input spending toSpend, OP_RETURN output
-        const toSign = craftBIP322ToSignP2TR(toSpend, payment.script, xOnlyPubKey);
-        // Sign with identity (handles P2TR key-spend internally)
-        const signed = await identity.sign(toSign, [0]);
-        // Finalize and extract witness
-        signed.finalizeIdx(0);
-        const input = signed.getInput(0);
-        if (!input.finalScriptWitness) {
-            throw new Error("BIP-322: failed to produce witness after signing");
-        }
-        return base64.encode(RawWitness.encode(input.finalScriptWitness));
-    }
-    BIP322.sign = sign;
-    /**
-     * Verify a BIP-322 signature for a P2TR, P2WPKH, or legacy P2PKH address.
-     *
-     * For segwit addresses (P2TR, P2WPKH), reconstructs the BIP-322
-     * toSpend/toSign transactions and verifies the witness signature.
-     *
-     * For P2PKH addresses, verifies using the Bitcoin Core legacy
-     * `signmessage` format (compact recoverable ECDSA signature).
-     *
-     * @param message - The original message that was signed
-     * @param signature - Base64-encoded signature (BIP-322 witness or legacy compact)
-     * @param address - P2TR, P2WPKH, or P2PKH address of the signer
-     * @param network - Optional Bitcoin network for address decoding
-     * @returns true if the signature is valid
-     */
-    function verify(message, signature, address, network) {
-        let decoded;
-        try {
-            decoded = Address(network).decode(address);
-        }
-        catch {
-            return false;
-        }
-        // Legacy P2PKH: signature is base64 of 65 raw bytes, not a witness
-        if (decoded.type === "pkh") {
-            try {
-                return verifyLegacy(message, base64.decode(signature), decoded.hash);
-            }
-            catch {
-                return false;
-            }
-        }
-        // BIP-322 simple: signature is base64 of RawWitness
-        let pkScript;
-        let witnessItems;
-        try {
-            pkScript = OutScript.encode(decoded);
-            witnessItems = RawWitness.decode(base64.decode(signature));
-        }
-        catch {
-            return false;
-        }
-        if (witnessItems.length === 0) {
-            return false;
-        }
-        if (decoded.type === "tr") {
-            return verifyP2TR(message, witnessItems, pkScript, decoded.pubkey);
-        }
-        if (decoded.type === "wpkh") {
-            return verifyP2WPKH(message, witnessItems, pkScript, decoded.hash);
-        }
-        throw new Error(`BIP-322 verify: unsupported address type '${decoded.type}'`);
-    }
-    BIP322.verify = verify;
-})(BIP322 || (BIP322 = {}));
-function verifyP2TR(message, witnessItems, pkScript, pubkey) {
-    // P2TR key-spend witness is exactly [schnorr_signature].
-    // Multiple items indicates a script-path spend, which BIP-322 simple doesn't cover.
-    if (witnessItems.length !== 1) {
-        return false;
-    }
-    const sig = witnessItems[0];
-    if (sig.length !== 64 && sig.length !== 65) {
-        return false;
-    }
-    // BIP-322 simple only allows SIGHASH_DEFAULT (64-byte sig) or SIGHASH_ALL (0x01).
-    const sighashType = sig.length === 65 ? sig[64] : SigHash.DEFAULT;
-    if (sighashType !== SigHash.DEFAULT && sighashType !== SigHash.ALL) {
-        return false;
-    }
-    const toSpend = craftToSpendTx(message, pkScript, TAG_BIP322);
-    const toSign = craftBIP322ToSignP2TR(toSpend, pkScript, pubkey);
-    const sighash = toSign.preimageWitnessV1(0, [pkScript], sighashType, [0n]);
-    const rawSig = sig.length === 65 ? sig.subarray(0, 64) : sig;
-    return schnorr.verify(rawSig, sighash, pubkey);
-}
-function verifyP2WPKH(message, witnessItems, pkScript, addressHash) {
-    // P2WPKH witness: [der_signature || sighash_byte, compressed_pubkey]
-    if (witnessItems.length !== 2) {
-        return false;
-    }
-    const sigWithHash = witnessItems[0];
-    const pubkey = witnessItems[1];
-    if (pubkey.length !== 33 || sigWithHash.length < 2) {
-        return false;
-    }
-    // Verify the pubkey matches the address hash
-    const derived = p2wpkh(pubkey);
-    if (!equalBytes(derived.hash, addressHash)) {
-        return false;
-    }
-    // Extract sighash type (last byte) and DER signature
-    const sighashType = sigWithHash[sigWithHash.length - 1];
-    const derSig = sigWithHash.subarray(0, sigWithHash.length - 1);
-    // Build toSpend and toSign
-    const toSpend = craftToSpendTx(message, pkScript, TAG_BIP322);
-    const toSign = craftBIP322ToSignSimple(toSpend, pkScript);
-    // BIP-143 scriptCode for P2WPKH: equivalent P2PKH script
-    const scriptCode = OutScript.encode({ type: "pkh", hash: addressHash });
-    const sighash = toSign.preimageWitnessV0(0, scriptCode, sighashType, 0n);
-    return secp256k1.verify(derSig, sighash, pubkey, {
-        prehash: false,
-        format: "der",
-    });
-}
-/**
- * Verify a legacy Bitcoin Core signmessage signature for a P2PKH address.
- *
- * The signature is 65 bytes: [recovery_flag, r(32), s(32)].
- * The recovery flag encodes both the recovery ID and whether the key is
- * compressed: flag = 27 + recovery_id (+ 4 if compressed).
- */
-function verifyLegacy(message, sigBytes, addressHash) {
-    if (sigBytes.length !== 65) {
-        return false;
-    }
-    const flag = sigBytes[0];
-    if (flag < 27 || flag > 34) {
-        return false;
-    }
-    const compressed = flag >= 31;
-    const recoveryId = compressed ? flag - 31 : flag - 27;
-    const compactSig = sigBytes.subarray(1, 65);
-    const msgHash = bitcoinMessageHash(message);
-    try {
-        const sig = secp256k1.Signature.fromBytes(compactSig, "compact").addRecoveryBit(recoveryId);
-        const point = sig.recoverPublicKey(msgHash);
-        const pubkeyBytes = point.toBytes(compressed);
-        return equalBytes(hash160(pubkeyBytes), addressHash);
-    }
-    catch {
-        return false;
-    }
-}
-/**
- * Compute the Bitcoin message hash: SHA256d(magic_prefix + CompactSize(len) + message).
- */
-function bitcoinMessageHash(message) {
-    const MAGIC = new TextEncoder().encode("\x18Bitcoin Signed Message:\n");
-    const msgBytes = new TextEncoder().encode(message);
-    return sha256x2(concatBytes(MAGIC, encodeCompactSize(msgBytes.length), msgBytes));
-}
-function encodeCompactSize(n) {
-    if (n < 253)
-        return new Uint8Array([n]);
-    if (n <= 0xffff) {
-        const buf = new Uint8Array(3);
-        buf[0] = 253;
-        buf[1] = n & 0xff;
-        buf[2] = (n >> 8) & 0xff;
-        return buf;
-    }
-    const buf = new Uint8Array(5);
-    buf[0] = 254;
-    buf[1] = n & 0xff;
-    buf[2] = (n >> 8) & 0xff;
-    buf[3] = (n >> 16) & 0xff;
-    buf[4] = (n >> 24) & 0xff;
-    return buf;
-}
-/**
- * Build the BIP-322 "toSign" transaction for P2TR key-spend.
- */
-function craftBIP322ToSignP2TR(toSpend, pkScript, tapInternalKey) {
-    const tx = new Transaction({ version: 0 });
-    tx.addInput({
-        txid: toSpend.id,
-        index: 0,
-        sequence: 0,
-        witnessUtxo: {
-            script: pkScript,
-            amount: 0n,
-        },
-        tapInternalKey,
-        sighashType: SigHash.DEFAULT,
-    });
-    tx.addOutput({
-        amount: 0n,
-        script: OP_RETURN_EMPTY_PKSCRIPT,
-    });
-    return tx;
-}
-/**
- * Build the BIP-322 "toSign" transaction (generic, no key metadata).
- *
- * Used for P2WPKH verification where the toSign only needs
- * the witnessUtxo, not tapInternalKey.
- */
-function craftBIP322ToSignSimple(toSpend, pkScript) {
-    const tx = new Transaction({ version: 0 });
-    tx.addInput({
-        txid: toSpend.id,
-        index: 0,
-        sequence: 0,
-        witnessUtxo: {
-            script: pkScript,
-            amount: 0n,
-        },
-    });
-    tx.addOutput({
-        amount: 0n,
-        script: OP_RETURN_EMPTY_PKSCRIPT,
-    });
-    return tx;
-}

package/dist/esm/contracts/arkcontract.js

@@ -1,140 +0,0 @@
-import { hex } from "@scure/base";
-import { contractHandlers } from "./handlers/index.js";
-import { DEFAULT_ARKADE_HRP } from "../wallet/index.js";
-/**
- * Prefix for arkcontract strings.
- */
-const ARKCONTRACT_PREFIX = "arkcontract";
-/**
- * Encode a contract to the arkcontract string format.
- *
- * Format: arkcontract={type}&{key1}={value1}&{key2}={value2}...
- *
- * This format is compatible with NArk and allows contracts to be
- * shared/imported across different Arkade SDKs.
- *
- * @example
- * ```typescript
- * const contract: Contract = {
- *   type: "vhtlc",
- *   params: { sender: "ab12...", receiver: "cd34...", ... },
- *   // ...
- * };
- *
- * const encoded = encodeArkContract(contract);
- * // "arkcontract=vhtlc&sender=ab12...&receiver=cd34...&..."
- * ```
- */
-export function encodeArkContract(contract) {
-    const params = new URLSearchParams();
-    // Add contract type first
-    params.set(ARKCONTRACT_PREFIX, contract.type);
-    // Add all params
-    for (const [key, value] of Object.entries(contract.params)) {
-        params.set(key, value);
-    }
-    return params.toString();
-}
-/**
- * Decode an arkcontract string into raw type and data.
- *
- * This is a low-level function that parses the URL-encoded format.
- * For creating typed Contract objects, use `contractFromArkContract`
- * or `contractFromArkContractWithAddress` instead.
- *
- * @param encoded - The arkcontract string
- * @returns Parsed type and key-value data
- * @throws If the string is not a valid arkcontract
- *
- * @example
- * ```typescript
- * const parsed = decodeArkContract("arkcontract=vhtlc&sender=ab12...");
- * // { type: "vhtlc", data: { sender: "ab12...", ... } }
- * ```
- */
-export function decodeArkContract(encoded) {
-    const params = new URLSearchParams(encoded);
-    // Extract type from the arkcontract key
-    const type = params.get(ARKCONTRACT_PREFIX);
-    if (!type) {
-        throw new Error(`Invalid arkcontract string: missing '${ARKCONTRACT_PREFIX}' key`);
-    }
-    // Build data object from all other params
-    const data = {};
-    for (const [key, value] of params.entries()) {
-        if (key !== ARKCONTRACT_PREFIX) {
-            data[key] = value;
-        }
-    }
-    return { type, data };
-}
-/**
- * Create a Contract from an arkcontract string.
- *
- * This requires a handler to be registered for the contract type.
- *
- * @param encoded - The arkcontract string
- * @param options - Additional options for the contract
- * @returns A Contract object
- * @throws If the string is invalid or no handler exists for the type
- *
- * @example
- * ```typescript
- * const contract = contractFromArkContract(
- *   "arkcontract=vhtlc&sender=ab12...",
- *   {
- *     label: "Lightning Receive",
- *   }
- * );
- * ```
- */
-export function contractFromArkContract(encoded, options = {}) {
-    const parsed = decodeArkContract(encoded);
-    const handler = contractHandlers.get(parsed.type);
-    if (!handler) {
-        throw new Error(`No handler registered for contract type '${parsed.type}'`);
-    }
-    // Separate params from runtime data
-    // This is type-specific - the handler knows which keys are params
-    // For now, we treat all data as params
-    const params = parsed.data;
-    return {
-        label: options.label,
-        type: parsed.type,
-        params,
-        state: options.state || "active",
-        createdAt: Date.now(),
-        metadata: options.metadata,
-    };
-}
-/**
- * Create a full Contract with derived script and address.
- *
- * @param encoded - The arkcontract string
- * @param serverPubKey - Server public key (for address derivation)
- * @param addressPrefix - Address prefix (e.g., "tark" for testnet)
- * @param options - Additional options
- * @returns A complete Contract object
- */
-export function contractFromArkContractWithAddress(encoded, serverPubKey, addressPrefix = DEFAULT_ARKADE_HRP, options = {}) {
-    const parsed = decodeArkContract(encoded);
-    const handler = contractHandlers.getOrThrow(parsed.type);
-    const params = parsed.data;
-    const vtxoScript = handler.createScript(params);
-    return {
-        label: options.label,
-        type: parsed.type,
-        params,
-        script: hex.encode(vtxoScript.pkScript),
-        address: vtxoScript.address(addressPrefix, serverPubKey).encode(),
-        state: options.state || "active",
-        createdAt: Date.now(),
-        metadata: options.metadata,
-    };
-}
-/**
- * Check if a string is an arkcontract.
- */
-export function isArkContract(str) {
-    return str.startsWith(ARKCONTRACT_PREFIX + "=");
-}