@oxyhq/contracts 0.16.0 → 0.18.0

package/dist/types/transparency.d.ts

@@ -0,0 +1,392 @@
+import { z } from 'zod';
+/**
+ * One signer's endorsement of a checkpoint's signed fields.
+ *
+ * The operator and every independent witness produce this same shape over the
+ * SAME bytes, so the array on a checkpoint can grow without coordination.
+ */
+export declare const transparencyCheckpointSignatureSchema: z.ZodObject<{
+    /** Uncompressed hex public key of the signer. */
+    publicKey: z.ZodString;
+    alg: z.ZodLiteral<"ES256K-DER-SHA256">;
+    /** DER-encoded hex secp256k1 signature over the checkpoint signing input. */
+    signature: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    publicKey: string;
+    alg: "ES256K-DER-SHA256";
+    signature: string;
+}, {
+    publicKey: string;
+    alg: "ES256K-DER-SHA256";
+    signature: string;
+}>;
+/** Where a checkpoint root was published on a public chain. */
+export declare const transparencyAnchorSchema: z.ZodObject<{
+    /** Chain/network identifier, e.g. `faircoin-main`. */
+    network: z.ZodString;
+    txid: z.ZodString;
+    confirmations: z.ZodNumber;
+    /** When the anchoring transaction was broadcast (ms epoch). */
+    anchoredAt: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    network: string;
+    txid: string;
+    confirmations: number;
+    anchoredAt: number;
+}, {
+    network: string;
+    txid: string;
+    confirmations: number;
+    anchoredAt: number;
+}>;
+/**
+ * A published checkpoint.
+ *
+ * `signatures` is non-empty by contract: an unsigned root commits nobody and
+ * must never be served as a checkpoint. `anchors` may be empty — a checkpoint is
+ * published immediately and anchored asynchronously, so "not yet anchored" is a
+ * normal, temporary state rather than an error.
+ */
+export declare const transparencyCheckpointSchema: z.ZodObject<{
+    index: z.ZodNumber;
+    /** End of the committed period (ms epoch). */
+    periodEnd: z.ZodNumber;
+    /** Number of subjects (leaves) committed. */
+    treeSize: z.ZodNumber;
+    root: z.ZodString;
+    /** Hash of the previous checkpoint; `null` only at genesis. */
+    prevCheckpointHash: z.ZodNullable<z.ZodString>;
+    signatures: z.ZodArray<z.ZodObject<{
+        /** Uncompressed hex public key of the signer. */
+        publicKey: z.ZodString;
+        alg: z.ZodLiteral<"ES256K-DER-SHA256">;
+        /** DER-encoded hex secp256k1 signature over the checkpoint signing input. */
+        signature: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        publicKey: string;
+        alg: "ES256K-DER-SHA256";
+        signature: string;
+    }, {
+        publicKey: string;
+        alg: "ES256K-DER-SHA256";
+        signature: string;
+    }>, "many">;
+    anchors: z.ZodArray<z.ZodObject<{
+        /** Chain/network identifier, e.g. `faircoin-main`. */
+        network: z.ZodString;
+        txid: z.ZodString;
+        confirmations: z.ZodNumber;
+        /** When the anchoring transaction was broadcast (ms epoch). */
+        anchoredAt: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        network: string;
+        txid: string;
+        confirmations: number;
+        anchoredAt: number;
+    }, {
+        network: string;
+        txid: string;
+        confirmations: number;
+        anchoredAt: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    index: number;
+    periodEnd: number;
+    treeSize: number;
+    root: string;
+    prevCheckpointHash: string | null;
+    signatures: {
+        publicKey: string;
+        alg: "ES256K-DER-SHA256";
+        signature: string;
+    }[];
+    anchors: {
+        network: string;
+        txid: string;
+        confirmations: number;
+        anchoredAt: number;
+    }[];
+}, {
+    index: number;
+    periodEnd: number;
+    treeSize: number;
+    root: string;
+    prevCheckpointHash: string | null;
+    signatures: {
+        publicKey: string;
+        alg: "ES256K-DER-SHA256";
+        signature: string;
+    }[];
+    anchors: {
+        network: string;
+        txid: string;
+        confirmations: number;
+        anchoredAt: number;
+    }[];
+}>;
+/**
+ * An inclusion proof for one subject against one checkpoint.
+ *
+ * Carries the leaf PREIMAGE (`subjectDid`, `seq`, `headRecordId`) as well as the
+ * `leaf` digest so the verifier re-derives the leaf itself rather than trusting
+ * the server's hash, then walks `proof` up to the checkpoint's `root`.
+ */
+export declare const transparencyInclusionProofSchema: z.ZodObject<{
+    checkpoint: z.ZodObject<{
+        index: z.ZodNumber;
+        /** End of the committed period (ms epoch). */
+        periodEnd: z.ZodNumber;
+        /** Number of subjects (leaves) committed. */
+        treeSize: z.ZodNumber;
+        root: z.ZodString;
+        /** Hash of the previous checkpoint; `null` only at genesis. */
+        prevCheckpointHash: z.ZodNullable<z.ZodString>;
+        signatures: z.ZodArray<z.ZodObject<{
+            /** Uncompressed hex public key of the signer. */
+            publicKey: z.ZodString;
+            alg: z.ZodLiteral<"ES256K-DER-SHA256">;
+            /** DER-encoded hex secp256k1 signature over the checkpoint signing input. */
+            signature: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }, {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }>, "many">;
+        anchors: z.ZodArray<z.ZodObject<{
+            /** Chain/network identifier, e.g. `faircoin-main`. */
+            network: z.ZodString;
+            txid: z.ZodString;
+            confirmations: z.ZodNumber;
+            /** When the anchoring transaction was broadcast (ms epoch). */
+            anchoredAt: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }, {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        index: number;
+        periodEnd: number;
+        treeSize: number;
+        root: string;
+        prevCheckpointHash: string | null;
+        signatures: {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }[];
+        anchors: {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }[];
+    }, {
+        index: number;
+        periodEnd: number;
+        treeSize: number;
+        root: string;
+        prevCheckpointHash: string | null;
+        signatures: {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }[];
+        anchors: {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }[];
+    }>;
+    subjectDid: z.ZodString;
+    seq: z.ZodNumber;
+    headRecordId: z.ZodString;
+    leaf: z.ZodString;
+    leafIndex: z.ZodNumber;
+    /** Audit path, leaf-adjacent sibling first; empty for a single-leaf tree. */
+    proof: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    seq: number;
+    proof: string[];
+    headRecordId: string;
+    checkpoint: {
+        index: number;
+        periodEnd: number;
+        treeSize: number;
+        root: string;
+        prevCheckpointHash: string | null;
+        signatures: {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }[];
+        anchors: {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }[];
+    };
+    subjectDid: string;
+    leaf: string;
+    leafIndex: number;
+}, {
+    seq: number;
+    proof: string[];
+    headRecordId: string;
+    checkpoint: {
+        index: number;
+        periodEnd: number;
+        treeSize: number;
+        root: string;
+        prevCheckpointHash: string | null;
+        signatures: {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }[];
+        anchors: {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }[];
+    };
+    subjectDid: string;
+    leaf: string;
+    leafIndex: number;
+}>;
+/** A page of the checkpoint chain, oldest first, for walking `prevCheckpointHash`. */
+export declare const transparencyCheckpointListSchema: z.ZodObject<{
+    checkpoints: z.ZodArray<z.ZodObject<{
+        index: z.ZodNumber;
+        /** End of the committed period (ms epoch). */
+        periodEnd: z.ZodNumber;
+        /** Number of subjects (leaves) committed. */
+        treeSize: z.ZodNumber;
+        root: z.ZodString;
+        /** Hash of the previous checkpoint; `null` only at genesis. */
+        prevCheckpointHash: z.ZodNullable<z.ZodString>;
+        signatures: z.ZodArray<z.ZodObject<{
+            /** Uncompressed hex public key of the signer. */
+            publicKey: z.ZodString;
+            alg: z.ZodLiteral<"ES256K-DER-SHA256">;
+            /** DER-encoded hex secp256k1 signature over the checkpoint signing input. */
+            signature: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }, {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }>, "many">;
+        anchors: z.ZodArray<z.ZodObject<{
+            /** Chain/network identifier, e.g. `faircoin-main`. */
+            network: z.ZodString;
+            txid: z.ZodString;
+            confirmations: z.ZodNumber;
+            /** When the anchoring transaction was broadcast (ms epoch). */
+            anchoredAt: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }, {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        index: number;
+        periodEnd: number;
+        treeSize: number;
+        root: string;
+        prevCheckpointHash: string | null;
+        signatures: {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }[];
+        anchors: {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }[];
+    }, {
+        index: number;
+        periodEnd: number;
+        treeSize: number;
+        root: string;
+        prevCheckpointHash: string | null;
+        signatures: {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }[];
+        anchors: {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }[];
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    checkpoints: {
+        index: number;
+        periodEnd: number;
+        treeSize: number;
+        root: string;
+        prevCheckpointHash: string | null;
+        signatures: {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }[];
+        anchors: {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }[];
+    }[];
+}, {
+    checkpoints: {
+        index: number;
+        periodEnd: number;
+        treeSize: number;
+        root: string;
+        prevCheckpointHash: string | null;
+        signatures: {
+            publicKey: string;
+            alg: "ES256K-DER-SHA256";
+            signature: string;
+        }[];
+        anchors: {
+            network: string;
+            txid: string;
+            confirmations: number;
+            anchoredAt: number;
+        }[];
+    }[];
+}>;
+export type TransparencyCheckpointSignature = z.infer<typeof transparencyCheckpointSignatureSchema>;
+export type TransparencyAnchor = z.infer<typeof transparencyAnchorSchema>;
+export type TransparencyCheckpoint = z.infer<typeof transparencyCheckpointSchema>;
+export type TransparencyInclusionProof = z.infer<typeof transparencyInclusionProofSchema>;
+export type TransparencyCheckpointList = z.infer<typeof transparencyCheckpointListSchema>;