🤖 Merge PR DefinitelyTyped#71500 Add types for opentimestamps by @despotes

Author: despotes

types/opentimestamps/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/opentimestamps/index.d.ts

@@ -0,0 +1,7 @@
+export * as Context from "./src/context";
+export { default as DetachedTimestampFile } from "./src/detached-timestamp-file";
+export * as Notary from "./src/notary";
+export * from "./src/open-timestamps";
+export * as Ops from "./src/ops";
+export { default as Timestamp } from "./src/timestamp";
+export * as Utils from "./src/utils";

types/opentimestamps/opentimestamps-tests.ts

@@ -0,0 +1,7 @@
+import "./test/stamp";
+import "./test/stamp-hash";
+import "./test/stamp-multiple-files";
+import "./test/async-usage";
+import "./test/info";
+import "./test/verify";
+import "./test/upgrade";

types/opentimestamps/package.json

@@ -0,0 +1,20 @@
+{
+    "private": true,
+    "name": "@types/opentimestamps",
+    "version": "0.4.9999",
+    "projects": [
+        "https://github.com/opentimestamps/javascript-opentimestamps#readme"
+    ],
+    "dependencies": {
+        "@types/node": "*"
+    },
+    "devDependencies": {
+        "@types/opentimestamps": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Pedro Medeiros",
+            "githubUsername": "despotes"
+        }
+    ]
+}

types/opentimestamps/src/bitcoin.d.ts

@@ -0,0 +1,22 @@
+export class BlockHeader {
+    constructor(merkleroot: string, hash: string, time: number);
+    getMerkleroot(): string;
+    getHash(): string;
+    getTime(): number;
+}
+
+export interface BitcoinConf {
+    rpcuser: string;
+    rpcpassword: string;
+    rpcconnect?: string;
+    rpcport?: string;
+    testnet?: boolean;
+}
+
+export class BitcoinNode {
+    constructor(bitcoinConf: BitcoinConf);
+    static readBitcoinConf(): Promise<BitcoinConf>;
+    getInfo(): Promise<any>;
+    getBlockHeader(height: number): Promise<BlockHeader>;
+    callRPC(params: any): Promise<any>;
+}

types/opentimestamps/src/calendar.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="node" />
+
+import Timestamp = require("./timestamp");
+
+export class RemoteCalendar {
+    constructor(url: string);
+    url: string;
+    headers: { [key: string]: string };
+    timeout: number;
+    submit(digest: Buffer): Promise<Timestamp>;
+    getTimestamp(commitment: Buffer): Promise<Timestamp>;
+}
+
+export class UrlWhitelist {
+    constructor(urls: string[]);
+    add(url: string): void;
+    contains(url: string): boolean;
+    toString(): string;
+}
+
+export const DEFAULT_CALENDAR_WHITELIST: UrlWhitelist;
+export const DEFAULT_AGGREGATORS: [
+    "https://a.pool.opentimestamps.org",
+    "https://b.pool.opentimestamps.org",
+    "https://a.pool.eternitywall.com",
+    "https://ots.btc.catallaxy.com",
+];
+
+export class CommitmentNotFoundError extends Error {
+    name: "CommitmentNotFoundError";
+    constructor(message?: string);
+}
+
+export class URLError extends Error {
+    name: "URLError";
+    constructor(message?: string);
+}
+
+export class ExceededSizeError extends Error {
+    name: "ExceededSizeError";
+    constructor(message?: string);
+}

types/opentimestamps/src/context.d.ts

@@ -0,0 +1,69 @@
+export class StreamDeserializationContext {
+    constructor(stream: Buffer | ArrayBuffer | Uint8Array | string | Array<number>);
+    buffer: Uint8Array;
+    counter: number;
+    getOutput(): Uint8Array;
+    getCounter(): number;
+    readBuffer(l: number): Uint8Array | undefined;
+    read(l: number): number[];
+    readBool(): boolean;
+    readVaruint(): number;
+    readBytes(expectedLength?: number): number[];
+    readVarbytes(maxLen: number, minLen?: number): number[];
+    assertMagic(expectedMagic: number[]): void;
+    assertEof(): void;
+    toString(): string;
+}
+
+export class StreamSerializationContext {
+    buffer: Uint8Array;
+    length: number;
+    getOutput(): Uint8Array;
+    getLenght(): number;
+    writeBool(value: boolean): void;
+    writeVaruint(value: number): void;
+    writeByte(value: number): void;
+    writeBytes(value: number[]): void;
+    writeVarbytes(value: number[]): void;
+    toString(): string;
+}
+
+export class DeserializationError extends Error {
+    constructor(message?: string);
+}
+
+export class BadMagicError extends DeserializationError {
+    constructor(expectedMagic?: number[], actualMagic?: number[]);
+}
+
+export class UnsupportedMajorVersion extends Error {
+    constructor(message?: string);
+}
+
+export class TruncationError extends DeserializationError {
+    constructor(message?: string);
+}
+
+export class TrailingGarbageError extends DeserializationError {
+    constructor(message?: string);
+}
+
+export class RecursionLimitError extends DeserializationError {
+    constructor(message?: string);
+}
+
+export class SerializerTypeError extends TypeError {
+    constructor(message?: string);
+}
+
+export class SerializerValueError extends ValueError {
+    constructor(message?: string);
+}
+
+export class ValueError extends Error {
+    constructor(message?: string);
+}
+
+export class TypeError extends Error {
+    constructor(message?: string);
+}

types/opentimestamps/src/detached-timestamp-file.d.ts

@@ -0,0 +1,33 @@
+import { Op } from "./ops";
+import Timestamp = require("./timestamp");
+import { StreamDeserializationContext, StreamSerializationContext } from "./context";
+
+declare class DetachedTimestampFile {
+    constructor(fileHashOp: Op, timestamp: Timestamp);
+    fileHashOp: Op;
+    timestamp: Timestamp;
+    fileDigest(): number[];
+    serialize(ctx: StreamSerializationContext): void;
+    serializeToBytes(): Uint8Array;
+    static deserialize(
+        buffer:
+            | StreamDeserializationContext
+            | number[]
+            | Uint8Array
+            | ArrayBuffer,
+    ): DetachedTimestampFile;
+    static fromBytes(
+        fileHashOp: Op,
+        buffer:
+            | StreamDeserializationContext
+            | number[]
+            | Uint8Array
+            | ArrayBuffer,
+    ): DetachedTimestampFile;
+    static fromHash(fileHashOp: Op, fdHash: number[] | ArrayBuffer | Uint8Array): DetachedTimestampFile;
+    toString(): string;
+    toJson(): any;
+    equals(another: DetachedTimestampFile): boolean;
+}
+
+export = DetachedTimestampFile;

types/opentimestamps/src/esplora.d.ts

@@ -0,0 +1,19 @@
+export const PUBLIC_ESPLORA_URL: string;
+
+export interface EsploraOptions {
+    url?: string;
+    timeout?: number;
+}
+
+export class Esplora {
+    constructor(options?: EsploraOptions);
+    url: string;
+    timeout: number;
+    blockhash(height: string): Promise<string>;
+    block(hash: string): Promise<{ merkleroot: string; time: number }>;
+}
+
+export class URLError extends Error {
+    name: "URLError";
+    constructor(message?: string);
+}

types/opentimestamps/src/notary.d.ts

@@ -0,0 +1,68 @@
+import { BlockHeader } from "./bitcoin";
+import { StreamDeserializationContext, StreamSerializationContext } from "./context";
+
+export class VerificationError extends Error {
+    name: "VerificationError";
+    constructor(message?: string);
+}
+
+export abstract class TimeAttestation {
+    static deserialize(ctx: StreamDeserializationContext): TimeAttestation;
+    serialize(ctx: StreamSerializationContext): void;
+    abstract serializePayload(ctx: StreamSerializationContext): void;
+    abstract _TAG(): number[];
+    compareTo(other: TimeAttestation): number;
+}
+
+// @ts-ignore Opentimestamps library extends and change signature of deserialize method
+export class UnknownAttestation extends TimeAttestation {
+    constructor(tag: number[], payload: number[]);
+    _tag: number[];
+    payload: number[];
+    serializePayload(ctx: StreamSerializationContext): void;
+    static deserialize(
+        ctxPayload: StreamDeserializationContext,
+        tag: number[],
+    ): UnknownAttestation;
+    _TAG(): number[];
+    toString(): string;
+    equals(another: UnknownAttestation): boolean;
+    compareTo(other: TimeAttestation): number;
+}
+
+export class PendingAttestation extends TimeAttestation {
+    constructor(uri_: string);
+    uri: string;
+    static checkUri(uri: number[]): boolean;
+    static deserialize(ctxPayload: StreamDeserializationContext): PendingAttestation;
+    serializePayload(ctx: StreamSerializationContext): void;
+    _TAG(): number[];
+    _MAX_URI_LENGTH(): number;
+    _ALLOWED_URI_CHARS(): string;
+    toString(): string;
+    equals(another: PendingAttestation): boolean;
+    compareTo(other: TimeAttestation): number;
+}
+
+export class BitcoinBlockHeaderAttestation extends TimeAttestation {
+    constructor(height_: number);
+    height: number;
+    static deserialize(ctxPayload: StreamDeserializationContext): BitcoinBlockHeaderAttestation;
+    serializePayload(ctx: StreamSerializationContext): void;
+    _TAG(): number[];
+    toString(): string;
+    equals(another: BitcoinBlockHeaderAttestation): boolean;
+    compareTo(other: TimeAttestation): number;
+    verifyAgainstBlockheader(digest: number[], block: BlockHeader): number;
+}
+export class LitecoinBlockHeaderAttestation extends TimeAttestation {
+    constructor(height_: number);
+    height: number;
+    static deserialize(ctxPayload: StreamDeserializationContext): LitecoinBlockHeaderAttestation;
+    serializePayload(ctx: StreamSerializationContext): void;
+    _TAG(): number[];
+    toString(): string;
+    equals(another: LitecoinBlockHeaderAttestation): boolean;
+    compareTo(other: TimeAttestation): number;
+    verifyAgainstBlockheader(digest: number[], block: BlockHeader): number;
+}