@dignetwork/dig-sdk 0.0.1-alpha.4 → 0.0.1-alpha.42

package/dist/DataIntegrityTree/DataIntegrityTree.d.ts

@@ -0,0 +1,160 @@
+import { MerkleTree } from "merkletreejs";
+import { Readable } from "stream";
+export interface DataIntegrityTreeOptions {
+    storeDir?: string;
+    storageMode?: "local" | "unified";
+    rootHash?: string;
+    disableInitialize?: boolean;
+}
+/**
+ * DataStoreManager class to manage Merkle tree operations.
+ */
+declare class DataIntegrityTree {
+    private storeId;
+    private storeBaseDir;
+    private storeDir;
+    private dataDir;
+    files: Map<string, {
+        hash: string;
+        sha256: string;
+    }>;
+    private tree;
+    constructor(storeId: string, options?: DataIntegrityTreeOptions);
+    static from(storeId: string, options: DataIntegrityTreeOptions): DataIntegrityTree;
+    /**
+     * Load the manifest file.
+     * @private
+     */
+    private _loadManifest;
+    /**
+     * Load the latest tree from the manifest file.
+     * @private
+     */
+    private _loadLatestTree;
+    /**
+     * Save a binary stream to the store's data directory.
+     * @param sha256 - The SHA-256 hash of the buffer.
+     * @returns The write stream for the file.
+     */
+    private _createWriteStream;
+    /**
+     * Stream file from one path to another.
+     * @param src - The source file path.
+     * @param dest - The destination file path.
+     */
+    private _streamFile;
+    /**
+     * Upsert a key with a binary stream to the Merkle tree.
+     * Compresses the file, calculates the SHA-256 of the uncompressed file, and stores it.
+     * @param readStream - The binary data stream.
+     * @param key - The hexadecimal key for the binary data.
+     */
+    upsertKey(readStream: Readable, key: string): Promise<void>;
+    /**
+     * Delete a key from the Merkle tree.
+     * @param key - The hexadecimal key to delete.
+     */
+    deleteKey(key: string): void;
+    /**
+     * List all keys in the Merkle tree.
+     * @param rootHash - The root hash of the tree. Defaults to the latest root hash.
+     * @returns The list of keys.
+     */
+    listKeys(rootHash?: string | null): string[];
+    /**
+     * Rebuild the Merkle tree from the current files.
+     * @private
+     */
+    private _rebuildTree;
+    /**
+     * Get the root of the Merkle tree.
+     * @param rootHash - The root hash of the tree. Defaults to the latest root hash.
+     * @returns The Merkle root.
+     */
+    getRoot(): string;
+    /**
+     * Serialize the Merkle tree to a JSON object.
+     * @param rootHash - The root hash of the tree. Defaults to the latest root hash.
+     * @returns The serialized Merkle tree.
+     */
+    serialize(rootHash?: string | null): object;
+    /**
+     * Deserialize a JSON object to a Merkle tree.
+     * @param rootHash - The root hash of the tree.
+     * @returns The deserialized Merkle tree.
+     */
+    deserializeTree(rootHash: string): MerkleTree;
+    private appendRootHashToManifest;
+    /**
+     * Commit the current state of the Merkle tree.
+     */
+    commit(): string | undefined;
+    /**
+     * Clear pending changes and revert to the latest committed state.
+     */
+    clearPendingRoot(): void;
+    /**
+     * Check if a file exists for a given key.
+     * @param hexKey - The hexadecimal key of the file.
+     * @param rootHash - The root hash of the tree. Defaults to the latest root hash.
+     * @returns A boolean indicating if the file exists.
+     */
+    hasKey(hexKey: string, rootHash?: string | null): boolean;
+    /**
+     * Get a readable stream for a file based on its key, with decompression.
+     * @param hexKey - The hexadecimal key of the file.
+     * @param rootHash - The root hash of the tree. Defaults to the latest root hash.
+     * @returns The readable stream for the file.
+     */
+    getValueStream(hexKey: string, rootHash?: string | null, byteOffset?: number | null, length?: number | null): Readable;
+    /**
+     * Delete all leaves from the Merkle tree.
+     */
+    deleteAllLeaves(): void;
+    getSHA256(hexKey: string, rootHash?: string): string | undefined;
+    /**
+     * Get a proof for a file based on its key and SHA-256 hash.
+     * @param hexKey - The hexadecimal key of the file.
+     * @param sha256 - The SHA-256 hash of the file.
+     * @param rootHash - The root hash of the tree. Defaults to the latest root hash.
+     * @returns The proof for the file as a hex string.
+     */
+    getProof(hexKey: string, sha256: string, rootHash?: string | null): string;
+    /**
+     * Verify a proof for a file against the Merkle tree.
+     * @param proofObjectHex - The proof object as a hex string.
+     * @param sha256 - The SHA-256 hash of the file.
+     * @returns True if the proof is valid, false otherwise.
+     */
+    verifyProof(proofObjectHex: string, sha256: string): boolean;
+    /**
+     * Get the difference between two Merkle tree roots.
+     * @param rootHash1 - The first root hash.
+     * @param rootHash2 - The second root hash.
+     * @returns An object containing the added and deleted keys and their SHA-256 hashes.
+     */
+    getRootDiff(rootHash1: string, rootHash2: string): {
+        added: Map<string, string>;
+        deleted: Map<string, string>;
+    };
+    /**
+     * Verify the integrity of a file based on its SHA-256 hash and check if it is in the specified Merkle root.
+     * @param sha256 - The SHA-256 hash of the file.
+     * @param root - The root hash to check against.
+     * @returns True if the file integrity is verified and it is in the Merkle root, false otherwise.
+     */
+    verifyKeyIntegrity(sha256: string, rootHash: string): Promise<boolean>;
+    /**
+     * Static method to validate key integrity using a foreign Merkle tree.
+     * Verifies if a given SHA-256 hash for a key exists within the foreign tree and checks if the root hash matches.
+     *
+     * @param key - The hexadecimal key of the file.
+     * @param sha256 - The SHA-256 hash of the file.
+     * @param serializedTree - The foreign serialized Merkle tree.
+     * @param expectedRootHash - The expected root hash of the Merkle tree.
+     * @returns A boolean indicating if the SHA-256 is present in the foreign tree and the root hash matches.
+     */
+    static validateKeyIntegrityWithForeignTree(key: string, sha256: string, serializedTree: object, expectedRootHash: string): boolean;
+}
+export { DataIntegrityTree };
+//# sourceMappingURL=DataIntegrityTree.d.ts.map

package/dist/DataIntegrityTree/DataIntegrityTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataIntegrityTree.d.ts","sourceRoot":"","sources":["../../src/DataIntegrityTree/DataIntegrityTree.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAuClC,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;GAEG;AACH,cAAM,iBAAiB;IACrB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAS;IACjB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5D,OAAO,CAAC,IAAI,CAAa;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,wBAA6B;WAiDrD,IAAI,CAChB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,wBAAwB,GAChC,iBAAiB;IAOpB;;;OAGG;IACH,OAAO,CAAC,aAAa;IAQrB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAUvB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAa1B;;;;OAIG;YACW,WAAW;IAazB;;;;;OAKG;IACG,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqFjE;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAW5B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,GAAE,MAAM,GAAG,IAAW,GAAG,MAAM,EAAE;IAalD;;;OAGG;IACH,OAAO,CAAC,YAAY;IAOpB;;;;OAIG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,SAAS,CAAC,QAAQ,GAAE,MAAM,GAAG,IAAW,GAAG,MAAM;IAqBjD;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;IAwB7C,OAAO,CAAC,wBAAwB;IAuBhC;;OAEG;IACH,MAAM,IAAI,MAAM,GAAG,SAAS;IAoC5B;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAIxB;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO;IA+B/D;;;;;OAKG;IACH,cAAc,CACZ,MAAM,EAAE,MAAM,EACd,QAAQ,GAAE,MAAM,GAAG,IAAW,EAC9B,UAAU,GAAE,MAAM,GAAG,IAAW,EAChC,MAAM,GAAE,MAAM,GAAG,IAAW,GAC3B,QAAQ;IA4DX;;OAEG;IACH,eAAe,IAAI,IAAI;IAKvB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAUhE;;;;;;OAMG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,QAAQ,GAAE,MAAM,GAAG,IAAW,GAC7B,MAAM;IAsCT;;;;;OAKG;IACH,WAAW,CAAC,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IA4B5D;;;;;OAKG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB;QAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE;IA+B/D;;;;;OAKG;IACG,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA0D5E;;;;;;;;;OASG;IACH,MAAM,CAAC,mCAAmC,CACxC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,MAAM,EACtB,gBAAgB,EAAE,MAAM,GACvB,OAAO;CAgDX;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}