@otskit/client 0.5.0 → 0.6.0

package/README.md

@@ -12,6 +12,8 @@
 [![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)
+[![Coverage](https://codecov.io/gh/OTSkit/OTSkit-client/branch/main/graph/badge.svg)](https://codecov.io/gh/OTSkit/OTSkit-client)
+[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=OTSkit_OTSkit-client&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=OTSkit_OTSkit-client)
 [![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.
@@ -33,14 +35,14 @@
 ### Developer Experience
 - **TypeScript-first** — Strict types throughout; full IntelliSense for every option and error
 - **Node.js 20+** — Requires Node.js; uses native `crypto`, `dns`, and `net` APIs not available in browsers or edge runtimes
-- **Tree-shakeable** — Dual ESM/CJS build, zero runtime dependencies
+- **Tree-shakeable** — Dual ESM/CJS build; `@otskit/core` is the only runtime dependency, no third-party packages
 - **`AbortController` support** — Cancel any in-flight operation at any level
 - **Observable** — Drop-in `Logger` interface compatible with `console`, `pino`, `winston`, etc.
 - **Built-in SHA-256 helpers** — `hashFile()` and `hashBuffer()` so you don't need to wire up `crypto` yourself
 
 ---
 
-> **Note on confirmation times:** After `stamp()`, the proof is `pending` — registered with calendar servers but not yet anchored to Bitcoin. Confirmations typically arrive within **10–60 minutes**, but can take **several hours** during periods of high network congestion. Call `upgrade()` periodically to check; an `UpgradeError` simply means the blockchain hasn't confirmed yet, not that anything went wrong.
+> **Note on confirmation times:** After `stamp()`, the proof is `pending` — registered with calendar servers but not yet anchored to Bitcoin. Confirmations typically arrive within **~60 minutes**, but can take **several hours** during network congestion. Call `upgrade()` periodically to check; a pending proof is not a failed proof — an `UpgradeError` simply means the blockchain hasn't confirmed yet.
 
 ---
 
@@ -50,7 +52,7 @@
 npm install @otskit/client
 ```
 
-`@otskit/core` is a peer dependency bundled as a `file:` reference in monorepo setups; no separate install is needed.
+`@otskit/core` is a regular dependency and installs automatically; no separate install is needed.
 
 ---
 
@@ -68,7 +70,7 @@ const hash = await hashFile('contract.pdf')
 // 2. Submit to calendars → get a pending .ots proof
 const pendingProof = await client.stamp(hash)
 writeFileSync('contract.pdf.ots', pendingProof)
-console.log('Proof saved — Bitcoin confirmation usually arrives in 10–60 minutes.')
+console.log('Proof saved — Bitcoin confirmation usually arrives in ~60 minutes.')
 
 // 3. Later: query calendars for a Bitcoin confirmation
 const upgradedProof = await client.upgrade(pendingProof)
@@ -558,7 +560,7 @@ This repository uses [Conventional Commits](https://www.conventionalcommits.org)
 - TypeScript strict mode
 - ESLint + Prettier (run `npm run format` before pushing)
 - Fail-closed: all external input is validated at the boundary
-- No runtime dependencies
+- No third-party runtime dependencies (`@otskit/core` is the only dependency)
 
 ---
 
@@ -571,4 +573,4 @@ This repository uses [Conventional Commits](https://www.conventionalcommits.org)
 
 ## License
 
-MIT
+MIT © OTSkit contributors — see [LICENSE](LICENSE).

package/dist/browser.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Type definitions for the OpenTimestamps Client SDK
+ */
+/** Logger interface for observability. */
+interface Logger {
+    debug(message: string, ...args: unknown[]): void;
+    info(message: string, ...args: unknown[]): void;
+    warn(message: string, ...args: unknown[]): void;
+    error(message: string, ...args: unknown[]): void;
+}
+
+/** SHA-256 via the platform Web Crypto — identical in Node 20+ and browsers. */
+declare function hashBytes(data: Uint8Array): Promise<Uint8Array>;
+/** Hash a user-selected File/Blob without a Node stream. */
+declare function hashBlob(blob: Blob): Promise<Uint8Array>;
+
+declare function bytesToHex(bytes: Uint8Array): string;
+
+/** Calendars confirmed to accept browser-origin CORS requests (verified 2026-07-28). */
+declare const BROWSER_CALENDARS: readonly ["https://a.pool.opentimestamps.org", "https://b.pool.opentimestamps.org", "https://a.pool.eternitywall.com"];
+interface BrowserClientOptions {
+    minimumSuccessfulSubmissions?: number;
+    logger?: Logger;
+}
+/** Browser-only OpenTimestamps client: stamp a hash, get back a pending .ots (Uint8Array). */
+declare class OpenTimestampsBrowserClient {
+    private readonly calendars;
+    private readonly minSubs;
+    private readonly layer;
+    private readonly logger?;
+    constructor(options?: BrowserClientOptions);
+    /** hash: 32-byte Uint8Array or 64-char hex. Returns the pending .ots as Uint8Array. */
+    stamp(hash: Uint8Array | string): Promise<Uint8Array>;
+}
+
+export { BROWSER_CALENDARS, type BrowserClientOptions, OpenTimestampsBrowserClient, bytesToHex, hashBlob, hashBytes };