@otskit/client 0.1.2 → 0.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 alexalves87
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 alexalves87
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -7,10 +7,12 @@
 > TypeScript/JavaScript client for OpenTimestamps with enterprise-grade resilience patterns
 
 [![CI](https://github.com/OTSkit/OTSkit-client/actions/workflows/ci.yml/badge.svg)](https://github.com/OTSkit/OTSkit-client/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/OTSkit/OTSkit-client/actions/workflows/codeql.yml/badge.svg)](https://github.com/OTSkit/OTSkit-client/actions/workflows/codeql.yml)
 [![npm version](https://img.shields.io/npm/v/@otskit/client.svg)](https://www.npmjs.com/package/@otskit/client)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![TypeScript](https://img.shields.io/badge/TypeScript-5.6-blue.svg)](https://www.typescriptlang.org/)
-[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org/)
+[![npm downloads](https://img.shields.io/npm/dt/@otskit/client.svg)](https://www.npmjs.com/package/@otskit/client)
+[![TypeScript](https://img.shields.io/badge/TypeScript-6-blue.svg)](https://www.typescriptlang.org/)
+[![Node ≥20](https://img.shields.io/badge/node-%3E%3D20-brightgreen)](https://nodejs.org)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 
 `@otskit/client` is the official client SDK for submitting, upgrading, and verifying [OpenTimestamps](https://opentimestamps.org) proofs. It sits on top of [@otskit/core](https://github.com/OTSkit/OTSkit-core) — the low-level protocol engine — and wraps it in a high-level API with production-ready resilience patterns built in.
 

package/dist/index.cjs

@@ -44,6 +44,8 @@ __export(index_exports, {
   UpgradeError: () => UpgradeError,
   UrlWhitelist: () => UrlWhitelist,
   ValidationError: () => ValidationError,
+  hashBuffer: () => hashBuffer,
+  hashFile: () => hashFile,
   verifyAgainstBlockheader: () => verifyAgainstBlockheader,
   verifyTimestampAttestation: () => verifyTimestampAttestation
 });
@@ -443,7 +445,7 @@ var ResilientNetworkLayer = class {
   }
 };
 
-// node_modules/.pnpm/@otskit+core@0.1.0/node_modules/@otskit/core/dist/index.js
+// ../otskit-core/dist/index.js
 var DeserializationError = class extends Error {
   constructor(message) {
     super(message);
@@ -2418,6 +2420,19 @@ var OpenTimestampsClient = class {
     this.networkLayer.resetAllCircuits();
   }
 };
+
+// src/utils/hash.ts
+var import_crypto = require("crypto");
+var import_fs = require("fs");
+function hashBuffer(data) {
+  return (0, import_crypto.createHash)("sha256").update(data).digest();
+}
+function hashFile(path) {
+  return new Promise((resolve, reject) => {
+    const hash = (0, import_crypto.createHash)("sha256");
+    (0, import_fs.createReadStream)(path).on("data", (chunk) => hash.update(chunk)).on("end", () => resolve(hash.digest())).on("error", reject);
+  });
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CalendarClient,
@@ -2444,6 +2459,8 @@ var OpenTimestampsClient = class {
   UpgradeError,
   UrlWhitelist,
   ValidationError,
+  hashBuffer,
+  hashFile,
   verifyAgainstBlockheader,
   verifyTimestampAttestation
 });

package/dist/index.d.cts

@@ -358,4 +358,7 @@ declare class EsploraClient {
  */
 declare function verifyTimestampAttestation(digest: Uint8Array, attestation: Attestation, explorer: EsploraClient, signal?: AbortSignal): Promise<number>;
 
-export { type BackoffStrategy, CalendarClient, CalendarResponseTooLargeError, CircuitBreakerError, type CircuitBreakerOptions, CircuitState, type ClientOptions, CommitmentNotFoundError, DEFAULT_AGGREGATORS, DEFAULT_CALENDARS, DEFAULT_CALENDAR_WHITELIST, DEFAULT_RESILIENCE, EsploraClient, type EsploraClientOptions, EsploraResponseError, type JitterType, type Logger, MAX_CALENDAR_RESPONSE_SIZE, MAX_ESPLORA_RESPONSE_SIZE, NetworkError, OpenTimestampsClient, OpenTimestampsClientError, type OperationOptions, PUBLIC_ESPLORA_URL, type ResilienceOptions, ResilientNetworkLayer, type RetryOptions, StampError, UpgradeError, UrlWhitelist, ValidationError, type VerificationResult, verifyTimestampAttestation };
+declare function hashBuffer(data: Buffer | Uint8Array): Buffer;
+declare function hashFile(path: string): Promise<Buffer>;
+
+export { type BackoffStrategy, CalendarClient, CalendarResponseTooLargeError, CircuitBreakerError, type CircuitBreakerOptions, CircuitState, type ClientOptions, CommitmentNotFoundError, DEFAULT_AGGREGATORS, DEFAULT_CALENDARS, DEFAULT_CALENDAR_WHITELIST, DEFAULT_RESILIENCE, EsploraClient, type EsploraClientOptions, EsploraResponseError, type JitterType, type Logger, MAX_CALENDAR_RESPONSE_SIZE, MAX_ESPLORA_RESPONSE_SIZE, NetworkError, OpenTimestampsClient, OpenTimestampsClientError, type OperationOptions, PUBLIC_ESPLORA_URL, type ResilienceOptions, ResilientNetworkLayer, type RetryOptions, StampError, UpgradeError, UrlWhitelist, ValidationError, type VerificationResult, hashBuffer, hashFile, verifyTimestampAttestation };

package/dist/index.d.ts

@@ -358,4 +358,7 @@ declare class EsploraClient {
  */
 declare function verifyTimestampAttestation(digest: Uint8Array, attestation: Attestation, explorer: EsploraClient, signal?: AbortSignal): Promise<number>;
 
-export { type BackoffStrategy, CalendarClient, CalendarResponseTooLargeError, CircuitBreakerError, type CircuitBreakerOptions, CircuitState, type ClientOptions, CommitmentNotFoundError, DEFAULT_AGGREGATORS, DEFAULT_CALENDARS, DEFAULT_CALENDAR_WHITELIST, DEFAULT_RESILIENCE, EsploraClient, type EsploraClientOptions, EsploraResponseError, type JitterType, type Logger, MAX_CALENDAR_RESPONSE_SIZE, MAX_ESPLORA_RESPONSE_SIZE, NetworkError, OpenTimestampsClient, OpenTimestampsClientError, type OperationOptions, PUBLIC_ESPLORA_URL, type ResilienceOptions, ResilientNetworkLayer, type RetryOptions, StampError, UpgradeError, UrlWhitelist, ValidationError, type VerificationResult, verifyTimestampAttestation };
+declare function hashBuffer(data: Buffer | Uint8Array): Buffer;
+declare function hashFile(path: string): Promise<Buffer>;
+
+export { type BackoffStrategy, CalendarClient, CalendarResponseTooLargeError, CircuitBreakerError, type CircuitBreakerOptions, CircuitState, type ClientOptions, CommitmentNotFoundError, DEFAULT_AGGREGATORS, DEFAULT_CALENDARS, DEFAULT_CALENDAR_WHITELIST, DEFAULT_RESILIENCE, EsploraClient, type EsploraClientOptions, EsploraResponseError, type JitterType, type Logger, MAX_CALENDAR_RESPONSE_SIZE, MAX_ESPLORA_RESPONSE_SIZE, NetworkError, OpenTimestampsClient, OpenTimestampsClientError, type OperationOptions, PUBLIC_ESPLORA_URL, type ResilienceOptions, ResilientNetworkLayer, type RetryOptions, StampError, UpgradeError, UrlWhitelist, ValidationError, type VerificationResult, hashBuffer, hashFile, verifyTimestampAttestation };

package/dist/index.js

@@ -392,7 +392,7 @@ var ResilientNetworkLayer = class {
   }
 };
 
-// node_modules/.pnpm/@otskit+core@0.1.0/node_modules/@otskit/core/dist/index.js
+// ../otskit-core/dist/index.js
 var DeserializationError = class extends Error {
   constructor(message) {
     super(message);
@@ -2367,6 +2367,19 @@ var OpenTimestampsClient = class {
     this.networkLayer.resetAllCircuits();
   }
 };
+
+// src/utils/hash.ts
+import { createHash } from "crypto";
+import { createReadStream } from "fs";
+function hashBuffer(data) {
+  return createHash("sha256").update(data).digest();
+}
+function hashFile(path) {
+  return new Promise((resolve, reject) => {
+    const hash = createHash("sha256");
+    createReadStream(path).on("data", (chunk) => hash.update(chunk)).on("end", () => resolve(hash.digest())).on("error", reject);
+  });
+}
 export {
   CalendarClient,
   CalendarResponseTooLargeError,
@@ -2392,6 +2405,8 @@ export {
   UpgradeError,
   UrlWhitelist,
   ValidationError,
+  hashBuffer,
+  hashFile,
   verifyAgainstBlockheader,
   verifyTimestampAttestation
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@otskit/client",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Official client SDK for OpenTimestamps calendars with resilience patterns",
   "author": "alexalves87",
   "license": "MIT",