@kynesyslabs/demosdk 2.7.1 → 2.7.3

package/build/index.d.ts

@@ -15,3 +15,4 @@ export * as instantMessaging from "./instant_messaging";
 export * as storage from "./storage";
 export * as escrow from "./escrow";
 export * as ipfs from "./ipfs";
+export * as tlsnotary from "./tlsnotary";

package/build/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ipfs = exports.escrow = exports.storage = exports.instantMessaging = exports.bridge = exports.web2 = exports.abstraction = exports.websdk = exports.l2ps = exports.demoswork = exports.wallet = exports.xmcore = exports.xmwebsdk = exports.xmlocalsdk = exports.utils = exports.encryption = exports.types = void 0;
+exports.tlsnotary = exports.ipfs = exports.escrow = exports.storage = exports.instantMessaging = exports.bridge = exports.web2 = exports.abstraction = exports.websdk = exports.l2ps = exports.demoswork = exports.wallet = exports.xmcore = exports.xmwebsdk = exports.xmlocalsdk = exports.utils = exports.encryption = exports.types = void 0;
 // Common types and constants
 exports.types = __importStar(require("./types"));
 // Basic cryptographic and data manipulation functions
@@ -55,4 +55,5 @@ exports.instantMessaging = __importStar(require("./instant_messaging"));
 exports.storage = __importStar(require("./storage"));
 exports.escrow = __importStar(require("./escrow"));
 exports.ipfs = __importStar(require("./ipfs"));
+exports.tlsnotary = __importStar(require("./tlsnotary"));
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAA6B;AAC7B,iDAAgC;AAChC,sDAAsD;AACtD,2DAA0C;AAC1C,iDAAgC;AAEhC,gCAAgC;AAChC,oEAAmD;AACnD,gEAA+C;AAC/C,4DAA2C,CAAC,gCAAgC;AAE5E,mDAAkC;AAClC,yDAAwC;AAExC,+CAA8B;AAE9B,mDAAkC;AAClC,6DAA4C;AAC5C,2DAA0C;AAE1C,qCAAqC;AACrC,mDAAkC;AAElC,wEAAuD;AAEvD,qDAAoC;AAEpC,mDAAkC;AAElC,+CAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6BAA6B;AAC7B,iDAAgC;AAChC,sDAAsD;AACtD,2DAA0C;AAC1C,iDAAgC;AAEhC,gCAAgC;AAChC,oEAAmD;AACnD,gEAA+C;AAC/C,4DAA2C,CAAC,gCAAgC;AAE5E,mDAAkC;AAClC,yDAAwC;AAExC,+CAA8B;AAE9B,mDAAkC;AAClC,6DAA4C;AAC5C,2DAA0C;AAE1C,qCAAqC;AACrC,mDAAkC;AAElC,wEAAuD;AAEvD,qDAAoC;AAEpC,mDAAkC;AAElC,+CAA8B;AAE9B,yDAAwC"}

package/build/tlsnotary/TLSNotary.d.ts

@@ -0,0 +1,186 @@
+/**
+ * TLSNotary - Browser-based HTTPS Attestation
+ *
+ * This module provides TLSNotary attestation capabilities for the Demos SDK.
+ * It runs the TLSNotary Prover in a Web Worker using WASM, communicates with
+ * a Notary server, and produces cryptographic proofs of HTTPS requests.
+ *
+ * NOTE: This module is browser-only. It requires Web Workers and WASM support.
+ *
+ * @example
+ * ```typescript
+ * import { TLSNotary } from '@kynesyslabs/demosdk/tlsnotary';
+ *
+ * // Option 1: Explicit configuration
+ * const tlsn = new TLSNotary({
+ *   notaryUrl: 'wss://node.demos.sh:7047',
+ *   websocketProxyUrl: 'wss://node.demos.sh:55688',
+ * });
+ *
+ * // Option 2: Discovery via Demos instance (preferred)
+ * const demos = new Demos({ rpc: 'https://node.demos.sh' });
+ * const tlsn = await demos.tlsnotary();
+ *
+ * await tlsn.initialize();
+ *
+ * const result = await tlsn.attest({
+ *   url: 'https://api.github.com/users/octocat',
+ *   headers: { 'User-Agent': 'DemosSDK' },
+ * });
+ *
+ * console.log('Verified server:', result.verification.serverName);
+ * console.log('Response:', result.verification.recv);
+ * ```
+ */
+import type { PresentationJSON } from "tlsn-js/build/types";
+import type { TLSNotaryConfig, AttestRequest, AttestResult, CommitRanges, VerificationResult, AttestOptions, StatusCallback, TranscriptInfo } from "./types";
+/**
+ * TLSNotary class for browser-based HTTPS attestation
+ *
+ * This class handles:
+ * - Running the Prover (MPC-TLS client) in the browser via WASM
+ * - Communicating with the Demos Node's Notary server
+ * - Attesting HTTPS requests with cryptographic proofs
+ * - Verifying attestations offline
+ */
+export declare class TLSNotary {
+    private config;
+    private worker;
+    private wasm;
+    private initialized;
+    private initializingPromise;
+    /**
+     * Create a new TLSNotary instance
+     *
+     * @param config - Configuration with notary and proxy URLs
+     */
+    constructor(config: TLSNotaryConfig);
+    /**
+     * Initialize the WASM module
+     *
+     * Must be called before any attestation operations.
+     * Only needs to be called once per page load.
+     *
+     * @throws Error if WASM initialization fails
+     */
+    initialize(): Promise<void>;
+    /**
+     * Request a dynamic WebSocket proxy for a target URL
+     *
+     * This method calls the node's `requestTLSNproxy` endpoint to get a
+     * dynamically allocated proxy for the specific target domain.
+     * Proxies auto-expire after 30 seconds of inactivity.
+     *
+     * @param targetUrl - The HTTPS URL to create a proxy for
+     * @returns Proxy response with websocketProxyUrl
+     * @throws Error if RPC URL is not configured or proxy request fails
+     *
+     * @internal This is called automatically by attest/attestQuick methods
+     */
+    private requestProxy;
+    /**
+     * Get the WebSocket proxy URL for a target URL
+     *
+     * Automatically requests a dynamic proxy from the node if rpcUrl is configured,
+     * otherwise falls back to the static websocketProxyUrl.
+     *
+     * @param targetUrl - The target HTTPS URL
+     * @param onStatus - Optional status callback
+     * @returns The websocket proxy URL to use
+     */
+    private getProxyUrl;
+    /**
+     * Attest an HTTPS request using the step-by-step method
+     *
+     * This provides full control over the attestation process including
+     * custom commit ranges for selective disclosure.
+     *
+     * @param request - Request configuration (URL, method, headers, body)
+     * @param commit - Optional commit ranges for selective disclosure
+     * @param onStatus - Optional status callback for progress updates
+     * @returns Attestation result with proof and verification
+     *
+     * @example
+     * ```typescript
+     * const result = await tlsn.attest({
+     *   url: 'https://api.example.com/user',
+     *   method: 'GET',
+     *   headers: { 'Authorization': 'Bearer token' },
+     * }, {
+     *   // Hide authorization header in the proof
+     *   sent: [{ start: 0, end: 50 }, { start: 100, end: 200 }],
+     *   recv: [{ start: 0, end: 500 }],
+     * });
+     * ```
+     */
+    attest(request: AttestRequest, commit?: CommitRanges, onStatus?: StatusCallback): Promise<AttestResult>;
+    /**
+     * Quick attestation using the helper method
+     *
+     * Simpler API with less control over the process.
+     * Good for straightforward use cases.
+     *
+     * @param options - Attestation options including request and commit config
+     * @returns Attestation result with proof and verification
+     *
+     * @example
+     * ```typescript
+     * const result = await tlsn.attestQuick({
+     *   url: 'https://api.coingecko.com/api/v3/simple/price?ids=bitcoin&vs_currencies=usd',
+     * });
+     * ```
+     */
+    attestQuick(options: AttestOptions): Promise<AttestResult>;
+    /**
+     * Verify a presentation/proof
+     *
+     * Can be used to verify proofs from other sources.
+     * This operation can be done offline.
+     *
+     * @param presentationJSON - The presentation to verify
+     * @returns Verification result with extracted data
+     *
+     * @example
+     * ```typescript
+     * // Load a saved proof
+     * const savedProof = JSON.parse(localStorage.getItem('proof'));
+     * const result = await tlsn.verify(savedProof);
+     *
+     * console.log('Server:', result.serverName);
+     * console.log('Time:', new Date(result.time * 1000));
+     * console.log('Response:', result.recv);
+     * ```
+     */
+    verify(presentationJSON: PresentationJSON): Promise<VerificationResult>;
+    /**
+     * Get the transcript from an attestation for inspection
+     *
+     * Useful for determining commit ranges for selective disclosure.
+     *
+     * @param request - Request to send (without creating attestation)
+     * @returns Transcript with sent and received bytes
+     */
+    getTranscript(request: AttestRequest): Promise<TranscriptInfo>;
+    /**
+     * Cleanup resources
+     *
+     * Call when done with TLSNotary to release the Web Worker.
+     */
+    destroy(): void;
+    /**
+     * Check if WASM is initialized
+     */
+    isInitialized(): boolean;
+    /**
+     * Get current configuration
+     */
+    getConfig(): TLSNotaryConfig;
+    /**
+     * Update configuration
+     *
+     * Note: Changes take effect on next attestation.
+     * If changing notary URL, you may want to re-initialize.
+     */
+    updateConfig(config: Partial<TLSNotaryConfig>): void;
+}
+export default TLSNotary;