@provablehq/sdk 0.10.2 → 0.10.4

package/dist/testnet/record-scanner.d.ts

@@ -1,10 +1,11 @@
-import { EncryptedRecord } from "./models/record-provider/encryptedRecord";
+import { TransportFunction } from "./utils.js";
+import { EncryptedRecord } from "./models/record-provider/encryptedRecord.js";
 import { CryptoBoxPubKey } from "./models/cryptoBoxPubkey.js";
-import { OwnedFilter } from "./models/record-scanner/ownedFilter";
-import { OwnedRecord } from "./models/record-provider/ownedRecord";
-import { RecordProvider } from "./record-provider";
-import { Field, ViewKey } from "./wasm";
-import { RecordsFilter } from "./models/record-scanner/recordsFilter";
+import { OwnedFilter } from "./models/record-scanner/ownedFilter.js";
+import { OwnedRecord } from "./models/record-provider/ownedRecord.js";
+import { RecordProvider } from "./record-provider.js";
+import { Field, ViewKey } from "./wasm.js";
+import { RecordsFilter } from "./models/record-scanner/recordsFilter.js";
 import { RegisterResult } from "./models/record-scanner/registrationResult.js";
 import { RevokeResult } from "./models/record-scanner/revokeResult.js";
 import { TagsResult } from "./models/record-scanner/tagsResult.js";
@@ -49,6 +50,7 @@ export interface RecordScannerOptions {
     cacheViewKeysOnRegister?: boolean;
     autoReRegister?: boolean;
     decryptEnabled?: boolean;
+    transport?: TransportFunction;
 }
 /**
  * RecordScanner is a RecordProvider implementation that uses Provable's confidential record scanning service to find
@@ -104,6 +106,7 @@ declare class RecordScanner implements RecordProvider {
     private viewKeys?;
     private autoReRegister?;
     private decryptEnabled?;
+    transport: TransportFunction;
     account?: Account | undefined;
     /**
      * @param {RecordScannerOptions} options Configuration for the record scanner.

package/dist/testnet/security.d.cts

@@ -0,0 +1,62 @@
+import { ViewKey, Authorization, ProvingRequest } from "./wasm.js";
+/**
+ * Encrypt an authorization with a cryptobox X25519 public key (libsodium-compatible wire format).
+ *
+ * @param {string} publicKey The cryptobox X25519 public key to encrypt with (encoded in RFC 4648 standard Base64).
+ * @param {Authorization} authorization the authorization to encrypt.
+ *
+ * @returns {string} the encrypted authorization in RFC 4648 standard Base64.
+ */
+export declare function encryptAuthorization(publicKey: string, authorization: Authorization): string;
+/**
+ * Encrypt a ProvingRequest with a cryptobox X25519 public key (libsodium-compatible wire format).
+ *
+ * @param {string} publicKey The cryptobox X25519 public key to encrypt with (encoded in RFC 4648 standard Base64).
+ * @param {ProvingRequest} provingRequest the ProvingRequest to encrypt.
+ *
+ * @returns {string} the encrypted ProvingRequest in RFC 4648 standard Base64.
+ */
+export declare function encryptProvingRequest(publicKey: string, provingRequest: ProvingRequest): string;
+/**
+ * Encrypt a view key with a cryptobox X25519 public key (libsodium-compatible wire format).
+ *
+ * @param {string} publicKey The cryptobox X25519 public key to encrypt with (encoded in RFC 4648 standard Base64).
+ * @param {ViewKey} viewKey the view key to encrypt.
+ *
+ * @returns {string} the encrypted view key in RFC 4648 standard Base64.
+ */
+export declare function encryptViewKey(publicKey: string, viewKey: ViewKey): string;
+/**
+ * Encrypt a record scanner registration request.
+ *
+ * @param {string} publicKey The cryptobox X25519 public key to encrypt with (encoded in RFC 4648 standard Base64).
+ * @param {ViewKey} viewKey the view key to encrypt.
+ * @param {number} start the start height of the registration request.
+ *
+ * @returns {string} the encrypted view key in RFC 4648 standard Base64.
+ */
+export declare function encryptRegistrationRequest(publicKey: string, viewKey: ViewKey, start: number): string;
+/**
+ * Best-effort zeroization of a byte array by overwriting all bytes with zeros.
+ * Use this to clear sensitive data (e.g., key bytes) from memory when working
+ * with Uint8Array representations of keys or other secrets.
+ *
+ * This is best-effort in JavaScript — the JIT compiler could theoretically
+ * elide the fill if the array is never read again (though current engines
+ * do not). For deterministic zeroization of key material, use
+ * `Account.destroy()` or call `.free()` on key objects (PrivateKey, ViewKey,
+ * ComputeKey, GraphKey) whose Rust Drop implementations zeroize memory
+ * before deallocation.
+ *
+ * Note: This cannot zeroize JavaScript strings, which are immutable and managed
+ * by the garbage collector. Prefer using byte array representations of sensitive
+ * data over strings whenever possible.
+ *
+ * @param {Uint8Array} bytes The byte array to zeroize
+ *
+ * @example
+ * const keyBytes = privateKey.toBytesLe();
+ * // ... use keyBytes ...
+ * zeroizeBytes(keyBytes); // Overwrite with zeros when done
+ */
+export declare function zeroizeBytes(bytes: Uint8Array): void;

package/dist/testnet/security.d.ts

@@ -1,6 +1,6 @@
-import { ViewKey, Authorization, ProvingRequest } from "@provablehq/wasm";
+import { ViewKey, Authorization, ProvingRequest } from "./wasm.js";
 /**
- * Encrypt an authorization with a libsodium cryptobox public key.
+ * Encrypt an authorization with a cryptobox X25519 public key (libsodium-compatible wire format).
  *
  * @param {string} publicKey The cryptobox X25519 public key to encrypt with (encoded in RFC 4648 standard Base64).
  * @param {Authorization} authorization the authorization to encrypt.
@@ -9,16 +9,16 @@ import { ViewKey, Authorization, ProvingRequest } from "@provablehq/wasm";
  */
 export declare function encryptAuthorization(publicKey: string, authorization: Authorization): string;
 /**
- * Encrypt a ProvingRequest with a libsodium cryptobox public key.
+ * Encrypt a ProvingRequest with a cryptobox X25519 public key (libsodium-compatible wire format).
  *
  * @param {string} publicKey The cryptobox X25519 public key to encrypt with (encoded in RFC 4648 standard Base64).
- * @param {Authorization} provingRequest the ProvingRequest to encrypt.
+ * @param {ProvingRequest} provingRequest the ProvingRequest to encrypt.
  *
  * @returns {string} the encrypted ProvingRequest in RFC 4648 standard Base64.
  */
 export declare function encryptProvingRequest(publicKey: string, provingRequest: ProvingRequest): string;
 /**
- * Encrypt a view key with a libsodium cryptobox public key.
+ * Encrypt a view key with a cryptobox X25519 public key (libsodium-compatible wire format).
  *
  * @param {string} publicKey The cryptobox X25519 public key to encrypt with (encoded in RFC 4648 standard Base64).
  * @param {ViewKey} viewKey the view key to encrypt.

package/dist/testnet/utils.d.cts

@@ -0,0 +1,23 @@
+export declare function isNode(): boolean;
+export declare function environment(): "chrome" | "firefox" | "safari" | "edge" | "opera" | "browser" | "node" | "unknown";
+export declare function logAndThrow(message: string): never;
+/**
+ * A function matching the global `fetch` signature. Consumers can provide
+ * their own implementation to inject custom HTTP agents, mTLS certificates,
+ * timeouts, or logging.
+ */
+export type TransportFunction = typeof fetch;
+/** Default transport — wraps global fetch to avoid illegal-invocation errors in browsers. */
+export declare const defaultTransport: TransportFunction;
+export declare function parseJSON(json: string): any;
+export declare function get(url: URL | string, options?: RequestInit, transport?: TransportFunction): Promise<Response>;
+export declare function post(url: URL | string, options: RequestInit, transport?: TransportFunction): Promise<Response>;
+type RetryOptions = {
+    maxAttempts?: number;
+    baseDelay?: number;
+    jitter?: number;
+    retryOnStatus?: number[];
+    shouldRetry?: (err: any) => boolean;
+};
+export declare function retryWithBackoff<T>(fn: () => Promise<T>, { maxAttempts, baseDelay, jitter, retryOnStatus, shouldRetry, }?: RetryOptions): Promise<T>;
+export {};

package/dist/testnet/utils.d.ts

@@ -1,9 +1,17 @@
 export declare function isNode(): boolean;
 export declare function environment(): "chrome" | "firefox" | "safari" | "edge" | "opera" | "browser" | "node" | "unknown";
 export declare function logAndThrow(message: string): never;
+/**
+ * A function matching the global `fetch` signature. Consumers can provide
+ * their own implementation to inject custom HTTP agents, mTLS certificates,
+ * timeouts, or logging.
+ */
+export type TransportFunction = typeof fetch;
+/** Default transport — wraps global fetch to avoid illegal-invocation errors in browsers. */
+export declare const defaultTransport: TransportFunction;
 export declare function parseJSON(json: string): any;
-export declare function get(url: URL | string, options?: RequestInit): Promise<Response>;
-export declare function post(url: URL | string, options: RequestInit): Promise<Response>;
+export declare function get(url: URL | string, options?: RequestInit, transport?: TransportFunction): Promise<Response>;
+export declare function post(url: URL | string, options: RequestInit, transport?: TransportFunction): Promise<Response>;
 type RetryOptions = {
     maxAttempts?: number;
     baseDelay?: number;

package/dist/testnet/wasm.d.cts

@@ -0,0 +1 @@
+export { Address, Authorization, Boolean, BHP256, BHP512, BHP768, BHP1024, Ciphertext, ComputeKey, DynamicRecord, EncryptionToolkit, ExecutionRequest, Execution, ExecutionResponse, Field, GraphKey, Group, I8, I16, I32, I64, I128, OfflineQuery, Metadata, Pedersen64, Pedersen128, Plaintext, Poseidon2, Poseidon4, Poseidon8, PrivateKey, PrivateKeyCiphertext, Program, ProgramManager, Proof, ProvingKey, ProvingRequest, RecordCiphertext, RecordPlaintext, Scalar, Signature, stringToField, Transaction, Transition, U8, U16, U32, U64, U128, Value, VerifyingKey, ViewKey, initThreadPool, getOrInitConsensusVersionTestHeights, snarkVerify, snarkVerifyBatch, verifyFunctionExecution, } from "@provablehq/wasm/testnet.js";

package/package.json

@@ -1,29 +1,66 @@
 {
   "name": "@provablehq/sdk",
-  "version": "0.10.2",
+  "version": "0.10.4",
   "description": "A Software Development Kit (SDK) for Zero-Knowledge Transactions",
   "collaborators": [
     "The Provable Team"
   ],
   "license": "GPL-3.0",
   "type": "module",
-  "main": "./dist/testnet/node.js",
+  "main": "./dist/testnet/node.cjs",
+  "module": "./dist/testnet/node.js",
   "browser": "./dist/testnet/browser.js",
   "exports": {
     ".": {
-      "node": "./dist/testnet/node.js",
+      "node": {
+        "types": {
+          "import": "./dist/testnet/node.d.ts",
+          "require": "./dist/testnet/node.d.cts"
+        },
+        "import": "./dist/testnet/node.js",
+        "require": "./dist/testnet/node.cjs",
+        "default": "./dist/testnet/node.js"
+      },
+      "types": "./dist/testnet/browser.d.ts",
       "default": "./dist/testnet/browser.js"
     },
     "./testnet.js": {
-      "node": "./dist/testnet/node.js",
+      "node": {
+        "types": {
+          "import": "./dist/testnet/node.d.ts",
+          "require": "./dist/testnet/node.d.cts"
+        },
+        "import": "./dist/testnet/node.js",
+        "require": "./dist/testnet/node.cjs",
+        "default": "./dist/testnet/node.js"
+      },
+      "types": "./dist/testnet/browser.d.ts",
       "default": "./dist/testnet/browser.js"
     },
     "./mainnet.js": {
-      "node": "./dist/mainnet/node.js",
+      "node": {
+        "types": {
+          "import": "./dist/mainnet/node.d.ts",
+          "require": "./dist/mainnet/node.d.cts"
+        },
+        "import": "./dist/mainnet/node.js",
+        "require": "./dist/mainnet/node.cjs",
+        "default": "./dist/mainnet/node.js"
+      },
+      "types": "./dist/mainnet/browser.d.ts",
       "default": "./dist/mainnet/browser.js"
     },
     "./dynamic.js": {
-      "node": "./dist/dynamic/node.js",
+      "node": {
+        "types": {
+          "import": "./dist/dynamic/node.d.ts",
+          "require": "./dist/dynamic/node.d.cts"
+        },
+        "import": "./dist/dynamic/node.js",
+        "require": "./dist/dynamic/node.cjs",
+        "default": "./dist/dynamic/node.js"
+      },
+      "types": "./dist/dynamic/browser.d.ts",
       "default": "./dist/dynamic/browser.js"
     }
   },
@@ -34,7 +71,10 @@
   ],
   "scripts": {
     "build": "rimraf dist && rollup -c rollup.config.js",
-    "test": "rimraf tmp && rollup -c rollup.test.js && mocha tmp/**/*.test.js --timeout 60000 && RUN_SKIPPED=true mocha tmp/**/wasm.test.js --timeout 60000 --grep Consensus"
+    "test": "rimraf tmp && rollup -c rollup.test.js && mocha tmp/**/*.test.js --timeout 60000 && RUN_SKIPPED=true mocha tmp/**/wasm.test.js --timeout 60000 --grep Consensus",
+    "test:attw": "yarn pack --filename /tmp/provablehq-sdk-attw.tgz && attw /tmp/provablehq-sdk-attw.tgz --profile=node16",
+    "test:cjs": "node tests/cjs-smoke/smoke.cjs",
+    "test:cjs:pack": "node tests/cjs-smoke/pack-install.cjs"
   },
   "repository": {
     "type": "git",
@@ -51,15 +91,16 @@
   },
   "homepage": "https://github.com/ProvableHQ/sdk#readme",
   "dependencies": {
-    "@provablehq/wasm": "^0.10.2",
+    "@provablehq/wasm": "^0.10.4",
     "@scure/base": "^2.0.0",
+    "@serenity-kit/noble-sodium": "0.2.3",
     "comlink": "^4.4.2",
     "core-js": "^3.40.0",
-    "libsodium-wrappers": "^0.8.2",
     "mime": "^4.0.6",
     "xmlhttprequest-ssl": "^4.0.0"
   },
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
     "@rollup/plugin-replace": "^6.0.2",
     "@types/chai": "^5.0.1",
     "@types/mocha": "^10.0.10",
@@ -76,6 +117,7 @@
     "glob": "^11.0.1",
     "jsdoc": "^4.0.4",
     "kis-jsdoc-plugin": "^2.2.1",
+    "libsodium-wrappers": "^0.8.2",
     "mocha": "^11.1.0",
     "prettier": "3.4.2",
     "rimraf": "^6.0.1",