@nockchain/sdk 0.1.4-nightly

package/dist/provider.d.ts

@@ -0,0 +1,193 @@
+/**
+ * NockchainProvider - Main SDK class for interacting with Iris wallet
+ */
+import type { Transaction, NockchainEvent, EventListener } from './types.js';
+import { TransactionBuilder } from './transaction.js';
+/**
+ * NockchainProvider class - Main interface for dApps to interact with Iris wallet
+ *
+ * @example
+ * ```typescript
+ * const nockchain = new NockchainProvider();
+ *
+ * // Connect wallet
+ * const accounts = await nockchain.requestAccounts();
+ *
+ * // Build and send transaction
+ * const tx = nockchain.transaction()
+ *   .to('recipient_address')
+ *   .amount(1_000_000)
+ *   .build();
+ *
+ * const txId = await nockchain.sendTransaction(tx);
+ * ```
+ */
+export declare class NockchainProvider {
+    private injected;
+    private eventListeners;
+    private _accounts;
+    private _chainId;
+    private _messageHandler?;
+    /**
+     * Create a new NockchainProvider instance
+     * @throws {WalletNotInstalledError} If the Iris extension is not installed
+     */
+    constructor();
+    /**
+     * Connect to the wallet and request access
+     * This will prompt the user to approve the connection
+     * @returns Promise resolving to wallet info with PKH and gRPC endpoint
+     * @throws {UserRejectedError} If the user rejects the request
+     * @throws {RpcError} If the RPC call fails
+     */
+    connect(): Promise<{
+        pkh: string;
+        grpcEndpoint: string;
+    }>;
+    /**
+     * Get the currently connected accounts (if any)
+     * @returns Array of connected account addresses (PKH)
+     */
+    get accounts(): string[];
+    /**
+     * Get the current chain ID
+     * @returns The current chain ID or null if not connected
+     */
+    get chainId(): string | null;
+    /**
+     * Check if the wallet is connected
+     * @returns true if wallet is connected
+     */
+    get isConnected(): boolean;
+    /**
+     * Send a transaction
+     * @param transaction - The transaction object to send
+     * @returns Promise resolving to the transaction ID
+     * @throws {NoAccountError} If no account is connected
+     * @throws {UserRejectedError} If the user rejects the transaction
+     * @throws {RpcError} If the RPC call fails
+     */
+    sendTransaction(transaction: Transaction): Promise<string>;
+    /**
+     * Sign an arbitrary message with the current account
+     * @param message - The message to sign
+     * @returns Promise resolving to the signature and public key hex (for verification)
+     * @throws {NoAccountError} If no account is connected
+     * @throws {UserRejectedError} If the user rejects the signing request
+     * @throws {RpcError} If the RPC call fails
+     */
+    signMessage(message: string): Promise<{
+        signature: string;
+        publicKeyHex: string;
+    }>;
+    /**
+     * Sign a raw transaction
+     * Accepts either wasm objects (with toProtobuf() method) or protobuf JS objects
+     * @param params - The transaction parameters (rawTx, notes, spendConditions)
+     * @returns Promise resolving to the signed raw transaction as protobuf Uint8Array
+     * @throws {NoAccountError} If no account is connected
+     * @throws {UserRejectedError} If the user rejects the signing request
+     * @throws {RpcError} If the RPC call fails
+     *
+     * @example
+     * ```typescript
+     * // Option 1: Pass wasm objects directly (auto-converts to protobuf)
+     * const rawTx = builder.build();
+     * const txNotes = builder.allNotes();
+     *
+     * const signedTx = await provider.signRawTx({
+     *   rawTx: rawTx,  // wasm RawTx object
+     *   notes: txNotes.notes,  // array of wasm Note objects
+     *   spendConditions: txNotes.spendConditions  // array of wasm SpendCondition objects
+     * });
+     *
+     * // Option 2: Pass protobuf JS objects directly
+     * const signedTx = await provider.signRawTx({
+     *   rawTx: rawTxProtobufObject,  // protobuf JS object
+     *   notes: noteProtobufObjects,  // array of protobuf JS objects
+     *   spendConditions: spendCondProtobufObjects  // array of protobuf JS objects
+     * });
+     * ```
+     */
+    signRawTx(params: {
+        rawTx: any;
+        notes: any[];
+        spendConditions: any[];
+    }): Promise<Uint8Array>;
+    /**
+     * Create a new transaction builder
+     * @returns A new TransactionBuilder instance
+     *
+     * @example
+     * ```typescript
+     * const tx = provider.transaction()
+     *   .to('recipient_address')
+     *   .amount(1_000_000)
+     *   .fee(50_000)
+     *   .build();
+     * ```
+     */
+    transaction(): TransactionBuilder;
+    /**
+     * Add an event listener for wallet events
+     * @param event - The event to listen for
+     * @param listener - The callback function to invoke when the event occurs
+     *
+     * @example
+     * ```typescript
+     * provider.on('accountsChanged', (accounts) => {
+     *   console.log('Accounts changed:', accounts);
+     * });
+     * ```
+     */
+    on<T = unknown>(event: NockchainEvent, listener: EventListener<T>): void;
+    /**
+     * Remove an event listener
+     * @param event - The event to stop listening for
+     * @param listener - The callback function to remove
+     */
+    off<T = unknown>(event: NockchainEvent, listener: EventListener<T>): void;
+    /**
+     * Remove all event listeners for a specific event or all events
+     * @param event - Optional event to remove listeners for (removes all if not specified)
+     */
+    removeAllListeners(event?: NockchainEvent): void;
+    /**
+     * Make a raw RPC request to the wallet extension (EIP-1193 compatible)
+     * @param args - The RPC request arguments
+     * @returns Promise resolving to the result
+     * @throws {UserRejectedError} If the user rejects the request
+     * @throws {RpcError} If the RPC call fails
+     */
+    request<T = unknown>(args: {
+        method: string;
+        params?: unknown[];
+    }): Promise<T>;
+    /**
+     * Check if an error represents user rejection
+     * Uses EIP-1193 standard error code 4001
+     */
+    private isUserRejected;
+    /**
+     * Set up event listeners for wallet events
+     * This listens for events from the extension and forwards them to registered listeners
+     */
+    private setupEventListeners;
+    /**
+     * Clean up event listeners and resources
+     * Call this when the provider is no longer needed (e.g., on component unmount)
+     */
+    dispose(): void;
+    /**
+     * Emit an event to all registered listeners
+     * @param event - The event to emit
+     * @param data - The data to pass to listeners
+     */
+    private emit;
+    /**
+     * Check if the Iris extension is installed and authentic
+     * @returns true if the extension is installed
+     */
+    static isInstalled(): boolean;
+}
+//# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,aAAa,EAAqB,MAAM,YAAY,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAItD;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,cAAc,CAA0C;IAChE,OAAO,CAAC,SAAS,CAAgB;IACjC,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,eAAe,CAAC,CAAgC;IAExD;;;OAGG;;IAyBH;;;;;;OAMG;IACG,OAAO,IAAI,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAU/D;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,EAAE,CAEvB;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,GAAG,IAAI,CAE3B;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;;;;;OAOG;IACG,eAAe,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAWhE;;;;;;;OAOG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IAWxF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,SAAS,CAAC,MAAM,EAAE;QACtB,KAAK,EAAE,GAAG,CAAC;QACX,KAAK,EAAE,GAAG,EAAE,CAAC;QACb,eAAe,EAAE,GAAG,EAAE,CAAC;KACxB,GAAG,OAAO,CAAC,UAAU,CAAC;IA4BvB;;;;;;;;;;;;OAYG;IACH,WAAW,IAAI,kBAAkB;IAIjC;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI;IAOxE;;;;OAIG;IACH,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI;IAOzE;;;OAGG;IACH,kBAAkB,CAAC,KAAK,CAAC,EAAE,cAAc,GAAG,IAAI;IAQhD;;;;;;OAMG;IACU,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAsB3F;;;OAGG;IACH,OAAO,CAAC,cAAc;IAgBtB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAqC3B;;;OAGG;IACI,OAAO,IAAI,IAAI;IAQtB;;;;OAIG;IACH,OAAO,CAAC,IAAI;IAaZ;;;OAGG;IACH,MAAM,CAAC,WAAW,IAAI,OAAO;CAI9B"}

package/dist/provider.js

@@ -0,0 +1,350 @@
+/**
+ * NockchainProvider - Main SDK class for interacting with Iris wallet
+ */
+import { TransactionBuilder } from './transaction.js';
+import { WalletNotInstalledError, UserRejectedError, RpcError, NoAccountError } from './errors.js';
+import { PROVIDER_METHODS } from './constants.js';
+/**
+ * NockchainProvider class - Main interface for dApps to interact with Iris wallet
+ *
+ * @example
+ * ```typescript
+ * const nockchain = new NockchainProvider();
+ *
+ * // Connect wallet
+ * const accounts = await nockchain.requestAccounts();
+ *
+ * // Build and send transaction
+ * const tx = nockchain.transaction()
+ *   .to('recipient_address')
+ *   .amount(1_000_000)
+ *   .build();
+ *
+ * const txId = await nockchain.sendTransaction(tx);
+ * ```
+ */
+export class NockchainProvider {
+    /**
+     * Create a new NockchainProvider instance
+     * @throws {WalletNotInstalledError} If the Iris extension is not installed
+     */
+    constructor() {
+        this._accounts = [];
+        this._chainId = null;
+        if (typeof window === 'undefined') {
+            throw new Error('NockchainProvider can only be used in a browser environment');
+        }
+        // Verify Iris extension is installed and authentic
+        if (!NockchainProvider.isInstalled()) {
+            throw new WalletNotInstalledError();
+        }
+        const injected = window.nockchain;
+        // TODO: remove this duplicate check
+        if (!injected) {
+            throw new WalletNotInstalledError();
+        }
+        this.injected = injected;
+        this.eventListeners = new Map();
+        // Initialize event listeners for wallet events
+        this.setupEventListeners();
+    }
+    /**
+     * Connect to the wallet and request access
+     * This will prompt the user to approve the connection
+     * @returns Promise resolving to wallet info with PKH and gRPC endpoint
+     * @throws {UserRejectedError} If the user rejects the request
+     * @throws {RpcError} If the RPC call fails
+     */
+    async connect() {
+        const info = await this.request({
+            method: PROVIDER_METHODS.CONNECT,
+        });
+        // Store the PKH as the connected account
+        this._accounts = [info.pkh];
+        return info;
+    }
+    /**
+     * Get the currently connected accounts (if any)
+     * @returns Array of connected account addresses (PKH)
+     */
+    get accounts() {
+        return [...this._accounts];
+    }
+    /**
+     * Get the current chain ID
+     * @returns The current chain ID or null if not connected
+     */
+    get chainId() {
+        return this._chainId;
+    }
+    /**
+     * Check if the wallet is connected
+     * @returns true if wallet is connected
+     */
+    get isConnected() {
+        return this._accounts.length > 0;
+    }
+    /**
+     * Send a transaction
+     * @param transaction - The transaction object to send
+     * @returns Promise resolving to the transaction ID
+     * @throws {NoAccountError} If no account is connected
+     * @throws {UserRejectedError} If the user rejects the transaction
+     * @throws {RpcError} If the RPC call fails
+     */
+    async sendTransaction(transaction) {
+        if (!this.isConnected) {
+            throw new NoAccountError();
+        }
+        return this.request({
+            method: PROVIDER_METHODS.SEND_TRANSACTION,
+            params: [transaction],
+        });
+    }
+    /**
+     * Sign an arbitrary message with the current account
+     * @param message - The message to sign
+     * @returns Promise resolving to the signature and public key hex (for verification)
+     * @throws {NoAccountError} If no account is connected
+     * @throws {UserRejectedError} If the user rejects the signing request
+     * @throws {RpcError} If the RPC call fails
+     */
+    async signMessage(message) {
+        if (!this.isConnected) {
+            throw new NoAccountError();
+        }
+        return this.request({
+            method: PROVIDER_METHODS.SIGN_MESSAGE,
+            params: [message],
+        });
+    }
+    /**
+     * Sign a raw transaction
+     * Accepts either wasm objects (with toProtobuf() method) or protobuf JS objects
+     * @param params - The transaction parameters (rawTx, notes, spendConditions)
+     * @returns Promise resolving to the signed raw transaction as protobuf Uint8Array
+     * @throws {NoAccountError} If no account is connected
+     * @throws {UserRejectedError} If the user rejects the signing request
+     * @throws {RpcError} If the RPC call fails
+     *
+     * @example
+     * ```typescript
+     * // Option 1: Pass wasm objects directly (auto-converts to protobuf)
+     * const rawTx = builder.build();
+     * const txNotes = builder.allNotes();
+     *
+     * const signedTx = await provider.signRawTx({
+     *   rawTx: rawTx,  // wasm RawTx object
+     *   notes: txNotes.notes,  // array of wasm Note objects
+     *   spendConditions: txNotes.spendConditions  // array of wasm SpendCondition objects
+     * });
+     *
+     * // Option 2: Pass protobuf JS objects directly
+     * const signedTx = await provider.signRawTx({
+     *   rawTx: rawTxProtobufObject,  // protobuf JS object
+     *   notes: noteProtobufObjects,  // array of protobuf JS objects
+     *   spendConditions: spendCondProtobufObjects  // array of protobuf JS objects
+     * });
+     * ```
+     */
+    async signRawTx(params) {
+        if (!this.isConnected) {
+            throw new NoAccountError();
+        }
+        // Helper to convert to protobuf if it's a wasm object
+        const toProtobuf = (obj) => {
+            // If object has toProtobuf method, it's a wasm object - convert it
+            if (obj && typeof obj.toProtobuf === 'function') {
+                return obj.toProtobuf();
+            }
+            // Otherwise assume it's already a protobuf JS object
+            return obj;
+        };
+        // Convert wasm objects to protobuf (if needed)
+        const protobufParams = {
+            rawTx: toProtobuf(params.rawTx),
+            notes: params.notes.map(toProtobuf),
+            spendConditions: params.spendConditions.map(toProtobuf),
+        };
+        return this.request({
+            method: PROVIDER_METHODS.SIGN_RAW_TX,
+            params: [protobufParams],
+        });
+    }
+    /**
+     * Create a new transaction builder
+     * @returns A new TransactionBuilder instance
+     *
+     * @example
+     * ```typescript
+     * const tx = provider.transaction()
+     *   .to('recipient_address')
+     *   .amount(1_000_000)
+     *   .fee(50_000)
+     *   .build();
+     * ```
+     */
+    transaction() {
+        return new TransactionBuilder();
+    }
+    /**
+     * Add an event listener for wallet events
+     * @param event - The event to listen for
+     * @param listener - The callback function to invoke when the event occurs
+     *
+     * @example
+     * ```typescript
+     * provider.on('accountsChanged', (accounts) => {
+     *   console.log('Accounts changed:', accounts);
+     * });
+     * ```
+     */
+    on(event, listener) {
+        if (!this.eventListeners.has(event)) {
+            this.eventListeners.set(event, new Set());
+        }
+        this.eventListeners.get(event).add(listener);
+    }
+    /**
+     * Remove an event listener
+     * @param event - The event to stop listening for
+     * @param listener - The callback function to remove
+     */
+    off(event, listener) {
+        const listeners = this.eventListeners.get(event);
+        if (listeners) {
+            listeners.delete(listener);
+        }
+    }
+    /**
+     * Remove all event listeners for a specific event or all events
+     * @param event - Optional event to remove listeners for (removes all if not specified)
+     */
+    removeAllListeners(event) {
+        if (event) {
+            this.eventListeners.delete(event);
+        }
+        else {
+            this.eventListeners.clear();
+        }
+    }
+    /**
+     * Make a raw RPC request to the wallet extension (EIP-1193 compatible)
+     * @param args - The RPC request arguments
+     * @returns Promise resolving to the result
+     * @throws {UserRejectedError} If the user rejects the request
+     * @throws {RpcError} If the RPC call fails
+     */
+    async request(args) {
+        try {
+            const result = await this.injected.request(args);
+            return result;
+        }
+        catch (error) {
+            // Handle RPC errors and map known error codes
+            if (error && typeof error === 'object' && 'code' in error && 'message' in error) {
+                const { code, message, data } = error;
+                const rpcError = new RpcError(code, message, data);
+                // Map EIP-1193 error codes to typed errors
+                if (this.isUserRejected(rpcError)) {
+                    throw new UserRejectedError(message);
+                }
+                throw rpcError;
+            }
+            // Re-throw other errors as-is
+            throw error;
+        }
+    }
+    /**
+     * Check if an error represents user rejection
+     * Uses EIP-1193 standard error code 4001
+     */
+    isUserRejected(error) {
+        // EIP-1193 standard: 4001 = User Rejected Request
+        const USER_REJECTED_CODES = new Set([4001]);
+        if (error instanceof RpcError) {
+            return USER_REJECTED_CODES.has(error.code);
+        }
+        // Fallback: check message for common rejection phrases
+        if (error instanceof Error) {
+            return /reject|denied|cancel/i.test(error.message);
+        }
+        return false;
+    }
+    /**
+     * Set up event listeners for wallet events
+     * This listens for events from the extension and forwards them to registered listeners
+     */
+    setupEventListeners() {
+        if (typeof window === 'undefined')
+            return;
+        this._messageHandler = (event) => {
+            // Only accept messages from the same window
+            if (event.source !== window)
+                return;
+            const payload = event.data;
+            // SECURITY: Verify the message is from Iris extension
+            // This prevents malicious scripts from forging wallet events
+            if (!payload || payload.__iris !== true)
+                return;
+            // Check if this is a valid wallet event
+            if (typeof payload.type !== 'string' || !payload.type.startsWith('nockchain_'))
+                return;
+            const eventType = payload.type.replace('nockchain_', '');
+            const eventData = payload.data;
+            // Update internal state based on event type
+            if (eventType === 'accountsChanged' && Array.isArray(eventData)) {
+                this._accounts = eventData;
+            }
+            else if (eventType === 'chainChanged' && typeof eventData === 'string') {
+                this._chainId = eventData;
+            }
+            else if (eventType === 'disconnect') {
+                // Clear state on disconnect
+                this._accounts = [];
+                this._chainId = null;
+            }
+            // Emit to registered listeners
+            this.emit(eventType, eventData);
+        };
+        window.addEventListener('message', this._messageHandler);
+    }
+    /**
+     * Clean up event listeners and resources
+     * Call this when the provider is no longer needed (e.g., on component unmount)
+     */
+    dispose() {
+        if (this._messageHandler && typeof window !== 'undefined') {
+            window.removeEventListener('message', this._messageHandler);
+            this._messageHandler = undefined;
+        }
+        this.removeAllListeners();
+    }
+    /**
+     * Emit an event to all registered listeners
+     * @param event - The event to emit
+     * @param data - The data to pass to listeners
+     */
+    emit(event, data) {
+        const listeners = this.eventListeners.get(event);
+        if (listeners) {
+            listeners.forEach(listener => {
+                try {
+                    listener(data);
+                }
+                catch (error) {
+                    console.error(`Error in ${event} listener:`, error);
+                }
+            });
+        }
+    }
+    /**
+     * Check if the Iris extension is installed and authentic
+     * @returns true if the extension is installed
+     */
+    static isInstalled() {
+        // TODO: Support other providers
+        return typeof window !== 'undefined' && window.nockchain?.provider === 'iris';
+    }
+}
+//# sourceMappingURL=provider.js.map

package/dist/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACnG,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,iBAAiB;IAO5B;;;OAGG;IACH;QARQ,cAAS,GAAa,EAAE,CAAC;QACzB,aAAQ,GAAkB,IAAI,CAAC;QAQrC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;QACjF,CAAC;QAED,mDAAmD;QACnD,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,EAAE,CAAC;YACrC,MAAM,IAAI,uBAAuB,EAAE,CAAC;QACtC,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC;QAElC,oCAAoC;QACpC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,uBAAuB,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAE,CAAC;QAEhC,+CAA+C;QAC/C,IAAI,CAAC,mBAAmB,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwC;YACrE,MAAM,EAAE,gBAAgB,CAAC,OAAO;SACjC,CAAC,CAAC;QAEH,yCAAyC;QACzC,IAAI,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CAAC,WAAwB;QAC5C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,cAAc,EAAE,CAAC;QAC7B,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAS;YAC1B,MAAM,EAAE,gBAAgB,CAAC,gBAAgB;YACzC,MAAM,EAAE,CAAC,WAAW,CAAC;SACtB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe;QAC/B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,cAAc,EAAE,CAAC;QAC7B,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAA8C;YAC/D,MAAM,EAAE,gBAAgB,CAAC,YAAY;YACrC,MAAM,EAAE,CAAC,OAAO,CAAC;SAClB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,SAAS,CAAC,MAIf;QACC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,cAAc,EAAE,CAAC;QAC7B,CAAC;QAED,sDAAsD;QACtD,MAAM,UAAU,GAAG,CAAC,GAAQ,EAAO,EAAE;YACnC,mEAAmE;YACnE,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;gBAChD,OAAO,GAAG,CAAC,UAAU,EAAE,CAAC;YAC1B,CAAC;YACD,qDAAqD;YACrD,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QAEF,+CAA+C;QAC/C,MAAM,cAAc,GAAG;YACrB,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC;YAC/B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC;YACnC,eAAe,EAAE,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC;SACxD,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CAAa;YAC9B,MAAM,EAAE,gBAAgB,CAAC,WAAW;YACpC,MAAM,EAAE,CAAC,cAAc,CAAC;SACzB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW;QACT,OAAO,IAAI,kBAAkB,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,EAAE,CAAc,KAAqB,EAAE,QAA0B;QAC/D,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YACpC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC,GAAG,CAAC,QAAyB,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAc,KAAqB,EAAE,QAA0B;QAChE,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,CAAC,MAAM,CAAC,QAAyB,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,KAAsB;QACvC,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CAAc,IAA4C;QAC5E,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAI,IAAI,CAAC,CAAC;YACpD,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,8CAA8C;YAC9C,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;gBAChF,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAA0D,CAAC;gBAC3F,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;gBAEnD,2CAA2C;gBAC3C,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAClC,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;gBACvC,CAAC;gBAED,MAAM,QAAQ,CAAC;YACjB,CAAC;YACD,8BAA8B;YAC9B,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,cAAc,CAAC,KAAyB;QAC9C,kDAAkD;QAClD,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAE5C,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;YAC9B,OAAO,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;QAED,uDAAuD;QACvD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACK,mBAAmB;QACzB,IAAI,OAAO,MAAM,KAAK,WAAW;YAAE,OAAO;QAE1C,IAAI,CAAC,eAAe,GAAG,CAAC,KAAmB,EAAE,EAAE;YAC7C,4CAA4C;YAC5C,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM;gBAAE,OAAO;YAEpC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC;YAE3B,sDAAsD;YACtD,6DAA6D;YAC7D,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI;gBAAE,OAAO;YAEhD,wCAAwC;YACxC,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;gBAAE,OAAO;YAEvF,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAmB,CAAC;YAC3E,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;YAE/B,4CAA4C;YAC5C,IAAI,SAAS,KAAK,iBAAiB,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAC7B,CAAC;iBAAM,IAAI,SAAS,KAAK,cAAc,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;gBACzE,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;YAC5B,CAAC;iBAAM,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;gBACtC,4BAA4B;gBAC5B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;gBACpB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACvB,CAAC;YAED,+BAA+B;YAC/B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAClC,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,IAAI,IAAI,CAAC,eAAe,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAC1D,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;YAC5D,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACK,IAAI,CAAc,KAAqB,EAAE,IAAO;QACtD,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBAC3B,IAAI,CAAC;oBACH,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACjB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,CAAC,KAAK,CAAC,YAAY,KAAK,YAAY,EAAE,KAAK,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW;QAChB,gCAAgC;QAChC,OAAO,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,SAAS,EAAE,QAAQ,KAAK,MAAM,CAAC;IAChF,CAAC;CACF"}

package/dist/transaction.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Transaction builder with fluent API for constructing Nockchain transactions
+ */
+import type { Transaction } from './types.js';
+/**
+ * Conversion rate: 1 NOCK = 65,536 nicks (2^16)
+ */
+export declare const NOCK_TO_NICKS = 65536;
+/**
+ * Default transaction fee in nicks (32,768 nicks = 0.5 NOCK)
+ */
+export declare const DEFAULT_FEE = 32768;
+/**
+ * Minimum amount in nicks (must be positive)
+ */
+export declare const MIN_AMOUNT = 1;
+/**
+ * TransactionBuilder class implementing the builder pattern for type-safe transaction construction
+ *
+ * @example
+ * ```typescript
+ * const tx = new TransactionBuilder()
+ *   .to('nock1recipient_address')
+ *   .amount(1_000_000)
+ *   .fee(50_000)
+ *   .build();
+ * ```
+ */
+export declare class TransactionBuilder {
+    private _to?;
+    private _amount?;
+    private _fee?;
+    /**
+     * Set the recipient address for the transaction
+     * @param address - Base58-encoded Nockchain V1 PKH address (40 bytes, ~54-55 chars)
+     * @returns A new TransactionBuilder instance with the address set
+     * @throws {InvalidAddressError} If the address format is invalid
+     */
+    to(address: string): TransactionBuilder;
+    /**
+     * Set the amount to send in nicks (1 NOCK = 65,536 nicks)
+     * @param nicks - Amount in nicks (must be a positive integer)
+     * @returns A new TransactionBuilder instance with the amount set
+     * @throws {InvalidTransactionError} If the amount is invalid
+     */
+    amount(nicks: number): TransactionBuilder;
+    /**
+     * Set the transaction fee in nicks (optional, defaults to 32,768 nicks)
+     * @param nicks - Fee amount in nicks (must be a positive integer)
+     * @returns A new TransactionBuilder instance with the fee set
+     * @throws {InvalidTransactionError} If the fee is invalid
+     */
+    fee(nicks: number): TransactionBuilder;
+    /**
+     * Build and validate the transaction
+     * @returns The constructed Transaction object
+     * @throws {InvalidTransactionError} If required fields are missing
+     */
+    build(): Transaction;
+    /**
+     * Validate a Nockchain V1 PKH address format
+     * V1 PKH addresses are TIP5 hash (40 bytes) of public key, base58-encoded
+     *
+     * Validates by decoding the base58 string and checking for exactly 40 bytes
+     * rather than relying on character count which can vary
+     *
+     * @param address - The address to validate
+     * @returns true if valid, false otherwise
+     */
+    private isValidAddress;
+    /**
+     * Create a transaction builder from an existing transaction object
+     * Useful for modifying existing transactions
+     * @param tx - The transaction to create a builder from
+     * @returns A new TransactionBuilder instance with values from the transaction
+     * @throws {InvalidAddressError} If the transaction address is invalid
+     * @throws {InvalidTransactionError} If the transaction amount or fee is invalid
+     */
+    static fromTransaction(tx: Transaction): TransactionBuilder;
+}
+//# sourceMappingURL=transaction.d.ts.map

package/dist/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAG9C;;GAEG;AACH,eAAO,MAAM,aAAa,QAAS,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,WAAW,QAAS,CAAC;AAElC;;GAEG;AACH,eAAO,MAAM,UAAU,IAAI,CAAC;AAE5B;;;;;;;;;;;GAWG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,GAAG,CAAC,CAAS;IACrB,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,IAAI,CAAC,CAAS;IAEtB;;;;;OAKG;IACH,EAAE,CAAC,OAAO,EAAE,MAAM,GAAG,kBAAkB;IAYvC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB;IAgBzC;;;;;OAKG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB;IAetC;;;;OAIG;IACH,KAAK,IAAI,WAAW;IAepB;;;;;;;;;OASG;IACH,OAAO,CAAC,cAAc;IAatB;;;;;;;OAOG;IACH,MAAM,CAAC,eAAe,CAAC,EAAE,EAAE,WAAW,GAAG,kBAAkB;CAU5D"}