@nockchain/sdk 0.1.4-nightly

package/dist/transaction.js

@@ -0,0 +1,144 @@
+/**
+ * Transaction builder with fluent API for constructing Nockchain transactions
+ */
+import { base58 } from '@scure/base';
+import { InvalidAddressError, InvalidTransactionError } from './errors.js';
+/**
+ * Conversion rate: 1 NOCK = 65,536 nicks (2^16)
+ */
+export const NOCK_TO_NICKS = 65536;
+/**
+ * Default transaction fee in nicks (32,768 nicks = 0.5 NOCK)
+ */
+export const DEFAULT_FEE = 32768;
+/**
+ * Minimum amount in nicks (must be positive)
+ */
+export 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 class TransactionBuilder {
+    /**
+     * 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) {
+        if (!this.isValidAddress(address)) {
+            throw new InvalidAddressError(address);
+        }
+        const builder = new TransactionBuilder();
+        builder._to = address;
+        builder._amount = this._amount;
+        builder._fee = this._fee;
+        return builder;
+    }
+    /**
+     * 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) {
+        if (!Number.isInteger(nicks)) {
+            throw new InvalidTransactionError('Amount must be an integer');
+        }
+        if (nicks < MIN_AMOUNT) {
+            throw new InvalidTransactionError(`Amount must be at least ${MIN_AMOUNT} nick`);
+        }
+        // Note: MIN_AMOUNT = 1, so the above check already covers negative amounts
+        const builder = new TransactionBuilder();
+        builder._to = this._to;
+        builder._amount = nicks;
+        builder._fee = this._fee;
+        return builder;
+    }
+    /**
+     * 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) {
+        if (!Number.isInteger(nicks)) {
+            throw new InvalidTransactionError('Fee must be an integer');
+        }
+        if (nicks < 0) {
+            throw new InvalidTransactionError('Fee must be non-negative');
+        }
+        const builder = new TransactionBuilder();
+        builder._to = this._to;
+        builder._amount = this._amount;
+        builder._fee = nicks;
+        return builder;
+    }
+    /**
+     * Build and validate the transaction
+     * @returns The constructed Transaction object
+     * @throws {InvalidTransactionError} If required fields are missing
+     */
+    build() {
+        if (!this._to) {
+            throw new InvalidTransactionError('Missing required field: to (recipient address)');
+        }
+        if (this._amount === undefined || this._amount === null) {
+            throw new InvalidTransactionError('Missing required field: amount');
+        }
+        return {
+            to: this._to,
+            amount: this._amount,
+            fee: this._fee ?? DEFAULT_FEE,
+        };
+    }
+    /**
+     * 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
+     */
+    isValidAddress(address) {
+        try {
+            const trimmed = (address || '').trim();
+            if (trimmed.length === 0)
+                return false;
+            const bytes = base58.decode(trimmed);
+            return bytes.length === 40;
+        }
+        catch {
+            // Invalid base58 encoding
+            return false;
+        }
+    }
+    /**
+     * 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) {
+        // Use setters to ensure validation is applied
+        let builder = new TransactionBuilder().to(tx.to).amount(tx.amount);
+        if (typeof tx.fee === 'number') {
+            builder = builder.fee(tx.fee);
+        }
+        return builder;
+    }
+}
+//# sourceMappingURL=transaction.js.map

package/dist/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAE3E;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,KAAM,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC;AAE5B;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,kBAAkB;IAK7B;;;;;OAKG;IACH,EAAE,CAAC,OAAe;QAChB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC;QACtB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACzB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAa;QAClB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,KAAK,GAAG,UAAU,EAAE,CAAC;YACvB,MAAM,IAAI,uBAAuB,CAAC,2BAA2B,UAAU,OAAO,CAAC,CAAC;QAClF,CAAC;QACD,2EAA2E;QAE3E,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzC,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,OAAO,CAAC,OAAO,GAAG,KAAK,CAAC;QACxB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACzB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,KAAa;QACf,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;QAC9D,CAAC;QACD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,MAAM,IAAI,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACzC,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/B,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC;QACrB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,uBAAuB,CAAC,gDAAgD,CAAC,CAAC;QACtF,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;YACxD,MAAM,IAAI,uBAAuB,CAAC,gCAAgC,CAAC,CAAC;QACtE,CAAC;QAED,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,GAAG;YACZ,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,GAAG,EAAE,IAAI,CAAC,IAAI,IAAI,WAAW;SAC9B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACK,cAAc,CAAC,OAAe;QACpC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACvC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,KAAK,CAAC;YAEvC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACrC,OAAO,KAAK,CAAC,MAAM,KAAK,EAAE,CAAC;QAC7B,CAAC;QAAC,MAAM,CAAC;YACP,0BAA0B;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,eAAe,CAAC,EAAe;QACpC,8CAA8C;QAC9C,IAAI,OAAO,GAAG,IAAI,kBAAkB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;QAEnE,IAAI,OAAO,EAAE,CAAC,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}

package/dist/types.d.ts

@@ -0,0 +1,92 @@
+/**
+ * TypeScript type definitions for Iris SDK
+ */
+/**
+ * Transaction object representing a Nockchain transaction
+ */
+export interface Transaction {
+    /** Recipient address (base58-encoded public key hash / PKH) */
+    to: string;
+    /** Amount to send in nicks (1 NOCK = 65,536 nicks) */
+    amount: number;
+    /** Transaction fee in nicks (optional, defaults to 32,768 = 0.5 NOCK) */
+    fee?: number;
+}
+/**
+ * RPC request object for communicating with the extension
+ */
+export interface RpcRequest {
+    /** The RPC method to call */
+    method: string;
+    /** Optional parameters for the method */
+    params?: unknown[];
+    /** Optional timeout for the request */
+    timeout?: number;
+}
+/**
+ * RPC response object from the extension
+ */
+export interface RpcResponse<T = unknown> {
+    /** The result of the RPC call */
+    result?: T;
+    /** Error information if the call failed */
+    error?: {
+        code: number;
+        message: string;
+        data?: unknown;
+    };
+}
+/**
+ * Event types that the provider can emit
+ */
+export type NockchainEvent = 'accountsChanged' | 'chainChanged' | 'connect' | 'disconnect';
+/**
+ * Event listener callback function
+ */
+export type EventListener<T = unknown> = (data: T) => void;
+/**
+ * Interface for the injected window.nockchain object
+ */
+export interface InjectedNockchain {
+    /**
+     * Make an RPC request to the wallet extension
+     * @param request - The RPC request object
+     * @returns Promise resolving to the result
+     */
+    request<T = unknown>(request: RpcRequest): Promise<T>;
+    /**
+     * Provider name (e.g., 'iris')
+     */
+    provider?: string;
+    /**
+     * Provider version
+     */
+    version?: string;
+}
+/**
+ * Extended Window interface with nockchain property
+ */
+declare global {
+    interface Window {
+        nockchain?: InjectedNockchain;
+    }
+}
+/**
+ * Chain information
+ */
+export interface ChainInfo {
+    /** Chain ID (e.g., 'mainnet', 'testnet') */
+    chainId: string;
+    /** Network name */
+    name: string;
+}
+/**
+ * Account information
+ */
+export interface AccountInfo {
+    /** Account address */
+    address: string;
+    /** Account balance in nicks (optional, may not be available) */
+    balance?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,+DAA+D;IAC/D,EAAE,EAAE,MAAM,CAAC;IACX,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,yEAAyE;IACzE,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,OAAO;IACtC,iCAAiC;IACjC,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,2CAA2C;IAC3C,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,iBAAiB,GAAG,cAAc,GAAG,SAAS,GAAG,YAAY,CAAC;AAE3F;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEtD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,SAAS,CAAC,EAAE,iBAAiB,CAAC;KAC/B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * TypeScript type definitions for Iris SDK
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/wasm.d.ts

@@ -0,0 +1,13 @@
+/**
+ * `@nockchain/sdk/wasm`
+ *
+ * Convenience re-export of the Rose WASM package so consumers can import:
+ *   - `@nockchain/sdk/wasm`
+ * instead of:
+ *   - `@nockchain/rose-wasm/rose_wasm.js`
+ *
+ * This mirrors the "SDK owns WASM surface" pattern used elsewhere in the repo.
+ */
+export * from '@nockchain/rose-wasm/rose_wasm.js';
+export { default } from '@nockchain/rose-wasm/rose_wasm.js';
+//# sourceMappingURL=wasm.d.ts.map

package/dist/wasm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wasm.d.ts","sourceRoot":"","sources":["../src/wasm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,cAAc,mCAAmC,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC"}

package/dist/wasm.js

@@ -0,0 +1,13 @@
+/**
+ * `@nockchain/sdk/wasm`
+ *
+ * Convenience re-export of the Rose WASM package so consumers can import:
+ *   - `@nockchain/sdk/wasm`
+ * instead of:
+ *   - `@nockchain/rose-wasm/rose_wasm.js`
+ *
+ * This mirrors the "SDK owns WASM surface" pattern used elsewhere in the repo.
+ */
+export * from '@nockchain/rose-wasm/rose_wasm.js';
+export { default } from '@nockchain/rose-wasm/rose_wasm.js';
+//# sourceMappingURL=wasm.js.map

package/dist/wasm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wasm.js","sourceRoot":"","sources":["../src/wasm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,cAAc,mCAAmC,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@nockchain/sdk",
+  "version": "0.1.4-nightly",
+  "description": "TypeScript SDK for interacting with Nockchain wallet extensions",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./wasm": {
+      "types": "./dist/wasm.d.ts",
+      "import": "./dist/wasm.js"
+    },
+    "./hooks": {
+      "types": "./dist/hooks/index.d.ts",
+      "import": "./dist/hooks/index.js"
+    },
+    "./hooks/use-rose": {
+      "types": "./dist/hooks/use-rose.d.ts",
+      "import": "./dist/hooks/use-rose.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "nockchain",
+    "wallet",
+    "web3",
+    "blockchain",
+    "schnorr"
+  ],
+  "author": "Nockchain.net LLC",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nocktoshi/rose.git",
+    "directory": "sdk"
+  },
+  "scripts": {
+    "build": "tsc",
+    "build-example": "npm run build && tsc --project examples/tsconfig.json && vite build --config vite.config.examples.ts",
+    "dev": "tsc --watch",
+    "dev-example": "vite --config vite.config.examples.ts",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@nockchain/rose-wasm": "^0.1.4-nightly.13.1.1bd3e0f",
+    "@scure/base": "2.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "19.2.7",
+    "prettier": "3.7.4",
+    "react": "19.2.3",
+    "typescript": "5.9.3",
+    "vite": "7.3.0"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  }
+}