neozip-blockchain 0.5.1

package/dist/ots/ZipkitOTS.d.ts

@@ -0,0 +1,152 @@
+/**
+ * ======================================
+ * ZipkitOTS.ts - OpenTimestamps Integration
+ * ======================================
+ *
+ * This module provides comprehensive OpenTimestamps (OTS) functionality,
+ * including timestamp creation, verification, certificate generation, and proof upgrades.
+ *
+ * Key Features:
+ * - Bitcoin blockchain timestamping via OpenTimestamps
+ * - Merkle root calculation and verification
+ * - OTS proof upgrade capabilities
+ * - Certificate generation for verified timestamps
+ *
+ * @fileoverview OpenTimestamps utilities for blockchain timestamping
+ * @author NeoWare Inc.
+ */
+import type { ZipkitLike, ZipEntryLike } from '../types';
+export declare const TIMESTAMP_SUBMITTED = "META-INF/TS-SUBMIT.OTS";
+export declare const TIMESTAMP_METADATA = "META-INF/TIMESTAMP.OTS";
+export declare const CMP_METHOD: {
+    STORED: number;
+    DEFLATED: number;
+};
+declare global {
+    var _bitcore: any;
+}
+export interface TimestampResult {
+    merkleRoot: string | null;
+    ots: ArrayBuffer | null;
+    verified: boolean;
+    results: any | null;
+    error: string | null;
+    attestations: any | null;
+    upgradedOts: ArrayBuffer | null;
+}
+export interface TimestampInfo {
+    message: string;
+    results: string[];
+    attestDate: Date | null;
+    attestHeight: number | null;
+    submittedUri: string | null;
+    otsUpgraded: boolean;
+}
+export interface DeserializeOtsResult {
+    attestStr: string | null;
+    needsUpdateMsg: string | null;
+    attestationValues: any[];
+}
+export interface OtsVerifyResult {
+    status: 'none' | 'valid' | 'pending' | 'error';
+    message?: string;
+    blockHeight?: number;
+    attestedAt?: Date;
+    upgraded?: boolean;
+    upgradedOts?: Buffer;
+}
+/**
+ * Verifies an OpenTimestamps proof against a hash digest.
+ * @param hashDigest - SHA256 hash as hex string to verify
+ * @param ots - OpenTimestamps proof data
+ * @param options - Configuration options
+ * @param options.debug - Enable debug logging
+ * @returns Promise resolving to verification result, error object, or null if inputs invalid
+ */
+export declare function verifyOts(hashDigest: string | null, ots: ArrayBuffer | null, options?: {
+    debug?: boolean;
+}): Promise<TimestampResult | {
+    error: string;
+} | null>;
+/**
+ * Converts a Node.js Buffer to an ArrayBuffer.
+ * @param buf - Buffer to convert
+ * @returns ArrayBuffer with same data
+ */
+export declare function bufferToArrayBuffer(buf: Buffer): ArrayBuffer;
+/**
+ * Finds the OpenTimestamps entry in a ZIP file.
+ * Searches for TIMESTAMP_METADATA first, then TIMESTAMP_SUBMITTED.
+ * @param zip - Zipkit-like instance to search
+ * @returns ZIP entry containing OTS proof, or null if not found
+ */
+export declare function getOtsEntry(zip: ZipkitLike): ZipEntryLike | null;
+/**
+ * Extracts OTS proof data from a ZIP entry.
+ * Prefers extractToBuffer when available (required for file-based ZIPs loaded with loadZipFile).
+ * @param zip - Zipkit-like instance
+ * @param otsEntry - ZIP entry containing OTS data
+ * @returns Promise resolving to OTS proof buffer, or null if extraction fails
+ */
+export declare function getOtsBuffer(zip: ZipkitLike, otsEntry: ZipEntryLike): Promise<Buffer | null>;
+/**
+ * Safely extracts merkle root from a ZIP file.
+ * @param zip - Zipkit-like instance
+ * @returns Merkle root hash string, or null if not available
+ */
+export declare function getMerkleRootSafe(zip: ZipkitLike): string | null;
+/**
+ * Verifies OpenTimestamps proof within a ZIP file.
+ * Extracts merkle root and OTS proof, then verifies against Bitcoin blockchain.
+ * @param zip - Zipkit-like instance containing files and OTS proof
+ * @returns Promise resolving to verification result with status: 'none', 'error', 'pending', or 'valid'
+ */
+export declare function verifyOtsZip(zip: ZipkitLike): Promise<OtsVerifyResult>;
+/**
+ * Creates an OpenTimestamps proof for a hash digest.
+ * Submits hash to OpenTimestamps servers for Bitcoin blockchain anchoring.
+ * @param hashDigest - SHA256 hash as hex string to timestamp
+ * @param options - Configuration options
+ * @param options.debug - Enable debug logging
+ * @returns Promise resolving to OTS proof buffer, or null if creation failed
+ */
+export declare function createTimestamp(hashDigest: string | null, options?: {
+    debug?: boolean;
+}): Promise<Buffer | null>;
+/**
+ * Deserializes OpenTimestamps verification result into JSON format.
+ * Extracts blockchain attestation data and transaction details.
+ * @param tsResult - Timestamp verification result to deserialize
+ * @param options - Configuration options
+ * @param options.debug - Enable debug logging
+ * @returns Promise resolving to JSON string with attestation data, or null if failed
+ */
+export declare function deserializeOts(tsResult: TimestampResult, options?: {
+    debug?: boolean;
+}): Promise<string | null>;
+/**
+ * Parses timestamp verification result into readable information.
+ * Formats blockchain attestation data with human-readable messages and dates.
+ * @param verifyResult - Timestamp verification result to parse
+ * @returns Promise resolving to formatted timestamp information
+ */
+export declare function parseVerifyResult(verifyResult: TimestampResult): Promise<TimestampInfo>;
+/**
+ * Upgrades OpenTimestamps proof in an existing ZIP file.
+ * Note: This function requires neozipkit for ZIP operations.
+ * @param zipFilePath - Path to ZIP file to upgrade
+ * @param upgradedOts - Buffer containing upgraded OTS proof
+ * @param zipkitInstance - Optional Zipkit instance for ZIP operations
+ * @returns Promise that resolves when upgrade is complete
+ * @throws Error if upgrade fails
+ */
+export declare function upgradeOTS(zipFilePath: string, upgradedOts: Buffer, zipkitInstance?: any): Promise<void>;
+/**
+ * Creates a ZIP metadata entry containing OpenTimestamps proof.
+ * Note: This function requires a Zipkit instance for ZIP operations.
+ * @param zipKit - Zipkit-like instance to add metadata entry to
+ * @param ots - Buffer containing OpenTimestamps proof data
+ * @returns ZIP entry containing OTS metadata, or null if creation failed
+ */
+export declare function createOtsMetadataEntry(zipKit: any, ots: Buffer | null): any | null;
+//# sourceMappingURL=ZipkitOTS.d.ts.map

package/dist/ots/ZipkitOTS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZipkitOTS.d.ts","sourceRoot":"","sources":["../../src/ots/ZipkitOTS.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAIH,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAIzD,eAAO,MAAM,mBAAmB,2BAAgB,CAAC;AACjD,eAAO,MAAM,kBAAkB,2BAAgB,CAAC;AAEhD,eAAO,MAAM,UAAU;;;CAA6B,CAAC;AAgBrD,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,QAAQ,EAAE,GAAG,CAAC;CACnB;AA4DD,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,GAAG,EAAE,WAAW,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,YAAY,EAAE,GAAG,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,iBAAiB,EAAE,GAAG,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAC7B,UAAU,EAAE,MAAM,GAAG,IAAI,EACzB,GAAG,EAAE,WAAW,GAAG,IAAI,EACvB,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAC5B,OAAO,CAAC,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,CAuDrD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAK5D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAgBhE;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAWlG;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAOhE;AAcD;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,CA+B5E;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAiBtH;AAED;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAClC,QAAQ,EAAE,eAAe,EACzB,OAAO,CAAC,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAC5B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAiDxB;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,YAAY,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CA2B7F;AAED;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAC9B,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,GAAG,GACnB,OAAO,CAAC,IAAI,CAAC,CAmJf;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,CAYlF"}