@arkade-os/sdk 0.4.26 → 0.4.28

package/dist/types/extension/asset/assetGroup.d.ts

@@ -1,119 +0,0 @@
-import { AssetId } from "./assetId.js";
-import { AssetRef } from "./assetRef.js";
-import { AssetInput } from "./assetInput.js";
-import { AssetOutput } from "./assetOutput.js";
-import { Metadata } from "./metadata.js";
-import { BufferReader, BufferWriter } from "./utils.js";
-/**
- * An asset group contains inputs, outputs, and all data related to a given asset id.
- *
- * @see Packet
- * @see AssetId
- * @see AssetRef
- *
- * @example
- * ```typescript
- * const group = AssetGroup.create(
- *   null,                              // asset ID: null for new issuance
- *   null,                              // control asset ID: null when reissuance not needed
- *   [],                                // asset inputs: empty for new issuance
- *   [AssetOutput.create(0, 1000)],     // asset outputs: 1000 units at vout index 0
- *   []                                 // metadata: can be empty
- * )
- * ```
- */
-export declare class AssetGroup {
-    readonly assetId: AssetId | null;
-    readonly controlAsset: AssetRef | null;
-    readonly inputs: AssetInput[];
-    readonly outputs: AssetOutput[];
-    private readonly metadataList;
-    /** @see create */
-    constructor(assetId: AssetId | null, controlAsset: AssetRef | null, inputs: AssetInput[], outputs: AssetOutput[], metadata: Metadata[]);
-    /**
-     * Create and validate an asset group.
-     *
-     * @param assetId - Asset id for this group, or `null` for fresh issuance
-     * @param controlAsset - Optional control asset reference for (re) issuance
-     * @param inputs - Asset inputs in the group
-     * @param outputs - Asset outputs in the group
-     * @param metadata - Metadata entries associated with the group
-     * @returns A validated asset group
-     * @throws Error if the group fails validation
-     * @see validate
-     */
-    static create(assetId: AssetId | null, controlAsset: AssetRef | null, inputs: AssetInput[], outputs: AssetOutput[], metadata: Metadata[]): AssetGroup;
-    /**
-     * Decode an asset group from its hex string form.
-     *
-     * @param s - Hex-encoded asset group
-     * @returns Decoded asset group
-     * @throws Error if the string is not valid hex or does not encode a valid asset group
-     * @see toString
-     */
-    static fromString(s: string): AssetGroup;
-    /**
-     * Decode an asset group from its serialized bytes.
-     *
-     * @param buf - Serialized asset group bytes
-     * @returns Decoded asset group
-     * @throws Error if the buffer is empty or malformed
-     */
-    static fromBytes(buf: Uint8Array): AssetGroup;
-    /**
-     * Return true when the group represents an issuance.
-     *
-     * @returns `true` when the group has no asset id
-     */
-    isIssuance(): boolean;
-    /**
-     * Return true when the group represents a reissuance.
-     *
-     * @returns `true` when the group has an asset id and outputs exceed local inputs
-     * @remarks
-     * Only local inputs contribute to the comparison; intent-backed inputs contribute `0` here.
-     */
-    isReissuance(): boolean;
-    /**
-     * Serialize the asset group to raw bytes.
-     *
-     * @returns Serialized asset group bytes
-     * @see fromBytes
-     */
-    serialize(): Uint8Array;
-    /**
-     * Validate the asset group and its child structures.
-     *
-     * @throws Error if the group is empty or violates issuance invariants
-     */
-    validate(): void;
-    /**
-     * Convert the group into its batch-leaf representation for the given intent txid.
-     *
-     * @param intentTxid - Intent transaction id used to build the leaf input reference
-     * @returns Batch-leaf asset group
-     * @see AssetInput.createIntent
-     */
-    toBatchLeafAssetGroup(intentTxid: Uint8Array): AssetGroup;
-    /**
-     * Encode the asset group to a hex string.
-     *
-     * @returns Hex-encoded asset group
-     * @see fromString
-     */
-    toString(): string;
-    /**
-     * Decode an asset group from a binary reader.
-     *
-     * @param reader - Reader positioned at an asset group
-     * @returns Decoded asset group
-     * @throws Error if the encoded group is malformed
-     */
-    static fromReader(reader: BufferReader): AssetGroup;
-    /**
-     * Serialize the asset group into an existing binary writer.
-     *
-     * @param writer - Writer to append the asset group to
-     */
-    serializeTo(writer: BufferWriter): void;
-}

package/dist/types/extension/asset/assetId.d.ts

@@ -1,83 +0,0 @@
-import { BufferReader, BufferWriter } from "./utils.js";
-/**
- * AssetId identifies a specific asset.
- *
- * @remarks
- * Asset ids are derived from the genesis transaction id plus the asset group index.
- *
- * @see AssetRef
- *
- * @example
- * ```typescript
- * const assetId = AssetId.create('00'.repeat(32), 0)
- * const encoded = assetId.toString()
- * const decoded = AssetId.fromString(encoded)
- * ```
- */
-export declare class AssetId {
-    readonly txid: Uint8Array;
-    readonly groupIndex: number;
-    private constructor();
-    /**
-     * Create an asset id from a genesis transaction id and group index.
-     *
-     * @param txid - Hex-encoded genesis transaction id
-     * @param groupIndex - Asset group index within the genesis transaction
-     * @returns A validated asset id
-     * @throws Error if the txid is missing, malformed, or not 32 bytes long
-     * @see fromString
-     */
-    static create(txid: string, groupIndex: number): AssetId;
-    /**
-     * Decode an asset id from its hex string representation.
-     *
-     * @param s - Hex-encoded asset id
-     * @returns Decoded asset id
-     * @throws Error if the string is not valid hex or does not encode a valid asset id
-     * @see toString
-     */
-    static fromString(s: string): AssetId;
-    /**
-     * Decode an asset id from its serialized bytes.
-     *
-     * @param buf - Serialized asset id bytes
-     * @returns Decoded asset id
-     * @throws Error if the buffer length is invalid
-     */
-    static fromBytes(buf: Uint8Array): AssetId;
-    /**
-     * Serialize the asset id to raw bytes.
-     *
-     * @returns Serialized asset id bytes
-     * @see fromBytes
-     */
-    serialize(): Uint8Array;
-    /**
-     * Encode the asset id to a hex string.
-     *
-     * @returns Hex-encoded asset id
-     * @see fromString
-     */
-    toString(): string;
-    /**
-     * Validate the asset id fields.
-     *
-     * @throws Error if the txid is empty or the group index is out of range
-     */
-    validate(): void;
-    /**
-     * Decode an asset id from a binary reader.
-     *
-     * @param reader - Reader positioned at an asset id
-     * @returns Decoded asset id
-     * @throws Error if the reader does not contain enough bytes
-     */
-    static fromReader(reader: BufferReader): AssetId;
-    /**
-     * Serialize the asset id into an existing binary writer.
-     *
-     * @param writer - Writer to append the asset id to
-     * @see serialize
-     */
-    serializeTo(writer: BufferWriter): void;
-}

package/dist/types/extension/asset/assetInput.d.ts

@@ -1,64 +0,0 @@
-import { AssetInputType } from "./types.js";
-import { BufferReader, BufferWriter } from "./utils.js";
-type AssetInputLocal = {
-    type: AssetInputType.Local;
-    vin: number;
-    amount: bigint;
-};
-type AssetInputIntent = Pick<AssetInputLocal, "vin" | "amount"> & {
-    type: AssetInputType.Intent;
-    txid: Uint8Array;
-};
-/**
- * AssetInput represents an input of an asset group.
- * a local input references a real transaction input and specify the amount in satoshis.
- * an intent input references an external intent transaction. It is created by the server to handle batch leaf transaction.
- */
-export declare class AssetInput {
-    readonly input: AssetInputLocal | AssetInputIntent;
-    private constructor();
-    /** Gets the transaction input index for an asset input, e.g. 0 */
-    get vin(): number;
-    /** Gets the amount for an input (in most cases, 330 sats) */
-    get amount(): bigint;
-    /** Create a local asset input that points at a transaction input index. */
-    static create(vin: number, amount: bigint | number): AssetInput;
-    /** Create an intent-backed asset input referencing an external intent transaction. */
-    static createIntent(txid: string, vin: number, amount: bigint | number): AssetInput;
-    /** Decode an asset input from its hex string form. */
-    static fromString(s: string): AssetInput;
-    /** Decode an asset input from its serialized bytes. */
-    static fromBytes(buf: Uint8Array): AssetInput;
-    /** Serialize the asset input to raw bytes. */
-    serialize(): Uint8Array;
-    /** Encode the asset input to a hex string. */
-    toString(): string;
-    /** Validate the asset input fields. */
-    validate(): void;
-    /** Decode an asset input from a buffer reader. */
-    static fromReader(reader: BufferReader): AssetInput;
-    /** Serialize the asset input into an existing buffer writer. */
-    serializeTo(writer: BufferWriter): void;
-}
-/**
- * AssetInputs represents a list of asset inputs.
- */
-export declare class AssetInputs {
-    readonly inputs: AssetInput[];
-    private constructor();
-    /** Create a validated list of asset inputs. */
-    static create(inputs: AssetInput[]): AssetInputs;
-    /** Decode an asset input list from its hex string form. */
-    static fromString(s: string): AssetInputs;
-    /** Serialize the asset input list to raw bytes. */
-    serialize(): Uint8Array;
-    /** Encode the asset input list to a hex string. */
-    toString(): string;
-    /** Validate the asset input list. */
-    validate(): void;
-    /** Decode an asset input list from a buffer reader. */
-    static fromReader(reader: BufferReader): AssetInputs;
-    /** Serialize the asset input list into an existing buffer writer. */
-    serializeTo(writer: BufferWriter): void;
-}
-export {};

package/dist/types/extension/asset/assetOutput.d.ts

@@ -1,54 +0,0 @@
-import { BufferReader, BufferWriter } from "./utils.js";
-/**
- * AssetOutput references a real transaction output and specify the amount in satoshis.
- * it must be present in an AssetGroup.
- *
- * @param vout - the output index in the transaction
- * @param amount - asset amount in satoshis
- */
-export declare class AssetOutput {
-    readonly vout: number;
-    readonly amount: bigint;
-    static readonly TYPE_LOCAL = 1;
-    private constructor();
-    /** Create a local asset output referencing a transaction output index. */
-    static create(vout: number, amount: bigint | number): AssetOutput;
-    /** Decode an asset output from its hex string form. */
-    static fromString(s: string): AssetOutput;
-    /** Decode an asset output from its serialized bytes. */
-    static fromBytes(buf: Uint8Array): AssetOutput;
-    /** Serialize the asset output to raw bytes. */
-    serialize(): Uint8Array;
-    /** Encode the asset output to a hex string. */
-    toString(): string;
-    /** Validate the asset output fields. */
-    validate(): void;
-    /** Decode an asset output from a buffer reader. */
-    static fromReader(reader: BufferReader): AssetOutput;
-    /** Serialize the asset output into an existing buffer writer. */
-    serializeTo(writer: BufferWriter): void;
-}
-/**
- * AssetOutputs is a list of AssetOutput references.
- * it must be present in an AssetGroup.
- *
- * @param outputs - the list of asset outputs
- */
-export declare class AssetOutputs {
-    readonly outputs: AssetOutput[];
-    private constructor();
-    /** Create a validated list of asset outputs. */
-    static create(outputs: AssetOutput[]): AssetOutputs;
-    /** Decode an asset output list from its hex string form. */
-    static fromString(s: string): AssetOutputs;
-    /** Serialize the asset output list to raw bytes. */
-    serialize(): Uint8Array;
-    /** Encode the asset output list to a hex string. */
-    toString(): string;
-    /** Validate the asset output list. */
-    validate(): void;
-    /** Decode an asset output list from a buffer reader. */
-    static fromReader(reader: BufferReader): AssetOutputs;
-    /** Serialize the asset output list into an existing buffer writer. */
-    serializeTo(writer: BufferWriter): void;
-}

package/dist/types/extension/asset/assetRef.d.ts

@@ -1,91 +0,0 @@
-import { AssetRefType } from "./types.js";
-import { AssetId } from "./assetId.js";
-import { BufferReader, BufferWriter } from "./utils.js";
-type AssetRefByID = {
-    type: AssetRefType.ByID;
-    assetId: AssetId;
-};
-type AssetRefByGroup = {
-    type: AssetRefType.ByGroup;
-    groupIndex: number;
-};
-/**
- * Reference to either an explicit asset id or another asset group in the same packet.
- *
- * @see AssetId
- *
- * @example
- * ```typescript
- * const refById = AssetRef.fromId(assetId)
- * const refByGroup = AssetRef.fromGroupIndex(0)
- * ```
- */
-export declare class AssetRef {
-    readonly ref: AssetRefByID | AssetRefByGroup;
-    private constructor();
-    /** Reference type discriminator. */
-    get type(): AssetRefType;
-    /**
-     * Create an asset reference that points to a specific asset id.
-     *
-     * @param assetId - Asset id referenced by this pointer
-     * @returns Asset reference by id
-     * @see fromGroupIndex
-     */
-    static fromId(assetId: AssetId): AssetRef;
-    /**
-     * Create an asset reference that points to another asset group by index.
-     *
-     * @param groupIndex - Zero-based asset group index in the packet
-     * @returns Asset reference by group index
-     * @see fromId
-     */
-    static fromGroupIndex(groupIndex: number): AssetRef;
-    /**
-     * Decode an asset reference from its hex string form.
-     *
-     * @param s - Hex-encoded asset reference
-     * @returns Decoded asset reference
-     * @throws Error if the string is not valid hex or does not encode a valid asset reference
-     * @see toString
-     */
-    static fromString(s: string): AssetRef;
-    /**
-     * Decode an asset reference from its serialized bytes.
-     *
-     * @param buf - Serialized asset reference bytes
-     * @returns Decoded asset reference
-     * @throws Error if the buffer is empty or malformed
-     */
-    static fromBytes(buf: Uint8Array): AssetRef;
-    /**
-     * Serialize the asset reference to raw bytes.
-     *
-     * @returns Serialized asset reference bytes
-     * @see fromBytes
-     */
-    serialize(): Uint8Array;
-    /**
-     * Encode the asset reference to a hex string.
-     *
-     * @returns Hex-encoded asset reference
-     * @see fromString
-     */
-    toString(): string;
-    /**
-     * Decode an asset reference from a binary reader.
-     *
-     * @param reader - Reader positioned at an asset reference
-     * @returns Decoded asset reference
-     * @throws Error if the type is unknown or the reader does not contain enough bytes
-     */
-    static fromReader(reader: BufferReader): AssetRef;
-    /**
-     * Serialize the asset reference into an existing binary writer.
-     *
-     * @param writer - Writer to append the asset reference to
-     * @see serialize
-     */
-    serializeTo(writer: BufferWriter): void;
-}
-export {};

package/dist/types/extension/asset/index.d.ts

@@ -1,8 +0,0 @@
-export { AssetInputType, AssetRefType } from "./types.js";
-export { AssetId } from "./assetId.js";
-export { AssetRef } from "./assetRef.js";
-export { AssetInput, AssetInputs } from "./assetInput.js";
-export { AssetOutput, AssetOutputs } from "./assetOutput.js";
-export { Metadata, MetadataList } from "./metadata.js";
-export { AssetGroup } from "./assetGroup.js";
-export { Packet } from "./packet.js";

package/dist/types/extension/asset/metadata.d.ts

@@ -1,52 +0,0 @@
-import { Bytes } from "@scure/btc-signer/utils.js";
-import { BufferReader, BufferWriter } from "./utils.js";
-/**
- * Metadata represents a key-value pair.
- * @param key - the key
- * @param value - the value
- */
-export declare class Metadata {
-    readonly key: Uint8Array;
-    readonly value: Uint8Array;
-    private constructor();
-    /** Create a metadata entry from raw key and value bytes. */
-    static create(key: Bytes, value: Bytes): Metadata;
-    /** Decode metadata from its hex string form. */
-    static fromString(s: string): Metadata;
-    /** Decode metadata from its serialized bytes. */
-    static fromBytes(buf: Uint8Array): Metadata;
-    /** Serialize metadata to raw bytes. */
-    serialize(): Uint8Array;
-    /** Encode metadata to a hex string. */
-    toString(): string;
-    get keyString(): string;
-    get valueString(): string;
-    /** Validate the metadata key and value. */
-    validate(): void;
-    /** Decode metadata from a buffer reader. */
-    static fromReader(reader: BufferReader): Metadata;
-    /** Serialize metadata into an existing buffer writer. */
-    serializeTo(writer: BufferWriter): void;
-}
-export declare class MetadataList {
-    readonly items: Metadata[];
-    static readonly ARK_LEAF_TAG = "ArkadeAssetLeaf";
-    static readonly ARK_BRANCH_TAG = "ArkadeAssetBranch";
-    static readonly ARK_LEAF_VERSION = 0;
-    constructor(items: Metadata[]);
-    /** Create a metadata list from its hex string form. */
-    static fromString(s: string): MetadataList;
-    /** Decode a metadata list from its serialized bytes. */
-    static fromBytes(buf: Uint8Array): MetadataList;
-    /** Decode a metadata list from a buffer reader. */
-    static fromReader(reader: BufferReader): MetadataList;
-    /** Serialize the metadata list into an existing buffer writer. */
-    serializeTo(writer: BufferWriter): void;
-    /** Serialize the metadata list to raw bytes. */
-    serialize(): Uint8Array;
-    /** Iterate through metadata entries in insertion order. */
-    [Symbol.iterator](): Iterator<Metadata>;
-    get length(): number;
-    /** Compute the tagged Merkle root for the metadata list. */
-    hash(): Uint8Array;
-}

package/dist/types/extension/asset/packet.d.ts

@@ -1,41 +0,0 @@
-import type { ExtensionPacket } from "../packet.js";
-import { AssetGroup } from "./assetGroup.js";
-/**
- * Packet represents a collection of asset groups.
- * It encodes/decodes as raw bytes only — OP_RETURN framing is handled by the Extension module.
- */
-export declare class Packet implements ExtensionPacket {
-    readonly groups: AssetGroup[];
-    /** PACKET_TYPE is the 1-byte TLV type tag used in the Extension envelope. */
-    static readonly PACKET_TYPE = 0;
-    private constructor();
-    /** Create a validated asset packet from a list of asset groups. */
-    static create(groups: AssetGroup[]): Packet;
-    /**
-     * fromBytes parses a Packet from raw bytes.
-     */
-    static fromBytes(buf: Uint8Array): Packet;
-    /**
-     * fromString parses a Packet from a raw hex string (not an OP_RETURN script).
-     */
-    static fromString(s: string): Packet;
-    /**
-     * type returns the TLV packet type tag. Implements ExtensionPacket interface.
-     */
-    type(): number;
-    /** Convert the packet into the batch-leaf form for a specific intent transaction id. */
-    leafTxPacket(intentTxid: Uint8Array): Packet;
-    /**
-     * serialize encodes the packet as raw bytes (varint group count + group data).
-     * Does NOT include OP_RETURN, Arkade magic bytes (`ARK`), or TLV type/length; those are
-     * added by the Extension module.
-     */
-    serialize(): Uint8Array;
-    /**
-     * toString returns the hex-encoded raw packet bytes.
-     */
-    toString(): string;
-    /** Validate packet structure and cross-group references. */
-    validate(): void;
-    private static fromReader;
-}

package/dist/types/extension/asset/types.d.ts

@@ -1,16 +0,0 @@
-export declare const TX_HASH_SIZE = 32;
-export declare const ASSET_ID_SIZE = 34;
-export declare const ASSET_VERSION = 1;
-export declare enum AssetInputType {
-    Unspecified = 0,
-    Local = 1,
-    Intent = 2
-}
-export declare enum AssetRefType {
-    Unspecified = 0,
-    ByID = 1,
-    ByGroup = 2
-}
-export declare const MASK_ASSET_ID = 1;
-export declare const MASK_CONTROL_ASSET = 2;
-export declare const MASK_METADATA = 4;

package/dist/types/extension/asset/utils.d.ts

@@ -1,21 +0,0 @@
-export declare class BufferWriter {
-    private buffer;
-    write(data: Uint8Array): void;
-    writeByte(byte: number): void;
-    writeUint16LE(value: number): void;
-    writeVarUint(value: bigint | number): void;
-    writeVarSlice(data: Uint8Array): void;
-    toBytes(): Uint8Array;
-}
-export declare class BufferReader {
-    private view;
-    private offset;
-    constructor(data: Uint8Array);
-    remaining(): number;
-    readByte(): number;
-    readSlice(size: number): Uint8Array;
-    readUint16LE(): number;
-    readVarUint(): bigint;
-    readVarSlice(): Uint8Array;
-}
-export declare function isZeroBytes(bytes: Uint8Array): boolean;

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

@@ -1,56 +0,0 @@
-import { Packet } from "./asset/packet.js";
-import { ExtensionPacket } from "./packet.js";
-import type { TransactionOutput } from "@scure/btc-signer/psbt.js";
-import type { Transaction } from "../utils/transaction.js";
-export type { ExtensionPacket } from "./packet.js";
-export { UnknownPacket } from "./packet.js";
-/**
- * ArkadeMagic is the 3-byte magic prefix ("ARK") that identifies an OP_RETURN
- * output as an Arkade extension blob.
- */
-export declare const ARKADE_MAGIC: Uint8Array<ArrayBuffer>;
-/**
- * ErrExtensionNotFound is thrown when no extension output is found in a transaction.
- */
-export declare class ExtensionNotFoundError extends Error {
-    constructor();
-}
-/**
- * Extension is a set of typed packets encoded in an OP_RETURN output.
- *
- * Wire format:
- *   OP_RETURN | <push> | ARK(3B) | [type(1B) | varint_len | data]...
- */
-export declare class Extension {
-    private readonly packets;
-    private constructor();
-    static create(packets: ExtensionPacket[]): Extension;
-    /**
-     * isExtension returns true if the script is an OP_RETURN whose push data
-     * begins with the ARK magic bytes.
-     */
-    static isExtension(script: Uint8Array): boolean;
-    /**
-     * fromBytes parses an Extension from a raw OP_RETURN script.
-     */
-    static fromBytes(script: Uint8Array): Extension;
-    /**
-     * fromTx searches the transaction outputs for an extension blob and parses it.
-     * Throws ExtensionNotFoundError if none is found.
-     */
-    static fromTx(tx: Transaction): Extension;
-    /**
-     * serialize encodes the extension as an OP_RETURN script.
-     *
-     * Layout: OP_RETURN | <push> | ARK | [type | varint_len | data]...
-     */
-    serialize(): Uint8Array;
-    /**
-     * txOut returns the extension as a zero-value OP_RETURN transaction output.
-     */
-    txOut(): Required<Pick<TransactionOutput, "script" | "amount">>;
-    /**
-     * getAssetPacket returns the embedded Packet, or null if not present.
-     */
-    getAssetPacket(): Packet | null;
-}

package/dist/types/extension/packet.d.ts

@@ -1,21 +0,0 @@
-/**
- * ExtensionPacket is the interface that all extension packets must implement.
- * It mirrors the Go extension.Packet interface.
- */
-export interface ExtensionPacket {
-    /** type returns the 1-byte packet type tag */
-    type(): number;
-    /** serialize returns the raw bytes of the packet (without type or length prefix) */
-    serialize(): Uint8Array;
-}
-/**
- * UnknownPacket holds a packet whose type is not recognized by this implementation.
- * It round-trips opaquely: the raw bytes are preserved as-is.
- */
-export declare class UnknownPacket implements ExtensionPacket {
-    private readonly packetType;
-    private readonly data;
-    constructor(packetType: number, data: Uint8Array);
-    type(): number;
-    serialize(): Uint8Array;
-}

package/dist/types/forfeit.d.ts

@@ -1,18 +0,0 @@
-import { Transaction } from "./utils/transaction.js";
-import { TransactionInputUpdate, TransactionOutput } from "@scure/btc-signer/psbt.js";
-/**
- * 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
- */
-export declare function buildForfeitTx(inputs: TransactionInputUpdate[], forfeitPkScript: Uint8Array, txLocktime?: number): Transaction;
-/**
- * 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
- */
-export declare function buildForfeitTxWithOutput(inputs: TransactionInputUpdate[], output: TransactionOutput, txLocktime?: number): Transaction;