@invisi-labs/protocol 1.1.6 → 1.2.0

package/dist/provenance.d.cts

@@ -0,0 +1,188 @@
+export { provenanceIntentHash } from '@invisi-labs/primitives';
+
+interface RotationRecord {
+    version: "1";
+    providerId: string;
+    oldKeyId: string;
+    newKeyId: string;
+    newPublicKey: string;
+    activatedAt: string;
+    previousRotationHash: string;
+    signature: string;
+}
+interface KeyValidity {
+    activatedAt: string;
+    retiredAt?: string;
+}
+interface TrustedKeyring {
+    providerId: string;
+    keys: Record<string, Uint8Array>;
+    validity: Record<string, KeyValidity>;
+    rotationHash: string;
+    lastActivatedAt: string;
+}
+declare function rotationPayload(r: RotationRecord): Uint8Array;
+declare const rotationMessage: (r: RotationRecord) => Uint8Array;
+declare const rotationHash: (r: RotationRecord) => string;
+declare function verifyRotationChain(initial: {
+    providerId: string;
+    keys: Readonly<Record<string, Uint8Array>>;
+    previousRotationHash: string;
+    lastActivatedAt: string;
+    now: string;
+    validity?: Readonly<Record<string, KeyValidity>>;
+}, records: readonly RotationRecord[]): TrustedKeyring;
+declare function withRotationHistory(trust: TrustContext, keyring: TrustedKeyring): TrustContext;
+
+type TrackingStatus = "pending_confirmation" | "pending_source" | "recognized" | "expired" | "superseded" | "stale_generation";
+interface Tracking {
+    id: string;
+    status: TrackingStatus;
+    expiresAt: string;
+    operationDigest: string;
+    matched?: {
+        txHash: string;
+        blockHash: string;
+        operationIndex: string;
+    };
+    reasonCode?: string;
+    checkpointSequence?: string;
+}
+type TrackingResult = PublicResult & {
+    tracking: Tracking;
+};
+declare class TrackingStaleGenerationError extends Error {
+    constructor();
+}
+declare function validateTracking(value: unknown, expectedId?: string): Tracking;
+/** Single evaluation results are flat; aggregate members carry their own tracking records. */
+declare function preflightTracking(result: PublicResult, operationIndex: string, operationDigest: string): Tracking;
+
+declare const PROVENANCE_MANIFEST_SHA256 = "6107789c5c0d24c4130bff05da6d389336feb5ccb247c4030eae5198ab05d762";
+
+declare class RecognizedTree {
+    private readonly leaves;
+    get leafCount(): number;
+    append(value: Integer): number;
+    appendCommitment(scope: Scope, commitment: Integer): Promise<number>;
+    membershipForCommitment(scope: Scope, commitment: Integer): Promise<{
+        leafIndex: number;
+        path: bigint[];
+        root: bigint;
+    } | undefined>;
+    root(): Promise<bigint>;
+    path(index: number): Promise<{
+        path: bigint[];
+        root: bigint;
+    }>;
+}
+
+declare const DEFAULT_PROVENANCE_ENDPOINT = "https://provenance.invisipay.fi";
+type Integer = bigint | string | number;
+declare const FIELD_MODULUS = 21888242871839275222246405745257275088548364400416034343698204186575808495617n;
+declare const CAPACITIES: readonly number[];
+declare const PUBLIC_INPUTS: readonly ["chain_id", "protocol_address", "token_address", "chain_generation", "source_count", "sources_digest", "input_count", "operation_digest_hi", "operation_digest_lo", "input_digest", "binding"];
+declare function uint(value: Integer, bits: number): bigint;
+declare function field(value: Integer): bigint;
+declare const word: (value: Integer) => string;
+declare const DOMAINS: Readonly<Record<"SCOPE" | "NOTE" | "INPUTS" | "STEP" | "SOURCES" | "SOURCE_STEP" | "BIND", bigint>>;
+declare const limbs: (value: Integer) => [bigint, bigint];
+interface Scope {
+    chainId: Integer;
+    protocolAddress: Integer;
+}
+declare function scopeHash(s: Scope): Promise<bigint>;
+declare const recognizedLeaf: (scope: Integer, commitment: Integer) => Promise<bigint>;
+interface Opening {
+    owner: Integer;
+    nonce: Integer;
+    amount: Integer;
+}
+declare function noteOpening(s: Pick<Scope, "chainId" | "protocolAddress"> & Opening & {
+    tokenAddress: Integer;
+}): Promise<{
+    commitment: bigint;
+    nullifier: bigint;
+}>;
+declare function inputDigest(nullifiers: readonly Integer[]): Promise<bigint>;
+interface Source {
+    treeId: Integer;
+    root: Integer;
+    leafCount: Integer;
+}
+declare function sourcesDigest(generation: Integer, sources: readonly Source[]): Promise<bigint>;
+declare function bindingDigest(s: {
+    scope: Integer;
+    tokenAddress: Integer;
+    chainGeneration: Integer;
+    sourceCount: Integer;
+    sourcesDigest: Integer;
+    inputCount: Integer;
+    operationDigest: Integer;
+    inputDigest: Integer;
+}): Promise<bigint>;
+declare function operationDigest(s: {
+    chainId: Integer;
+    protocolAddress: Integer;
+    operationKind?: number;
+    mainCircuitCapacity: Integer;
+    publicInputs: readonly Integer[];
+}): string;
+declare const CERT_LAYOUT: readonly [readonly ["certificateVersion", 1], readonly ["providerId", 32], readonly ["signingKeyId", 32], readonly ["chainId", 8], readonly ["protocolAddress", 20], readonly ["chainGeneration", 8], readonly ["rootSequence", 8], readonly ["treeId", 8], readonly ["leafCount", 8], readonly ["root", 32], readonly ["confirmedBlockNumber", 8], readonly ["confirmedBlockHash", 32], readonly ["decisionLogHash", 32], readonly ["previousCheckpointHash", 32], readonly ["issuedAt", 8]];
+type RootCertificate = Record<(typeof CERT_LAYOUT)[number][0], Integer> & {
+    signature: string;
+};
+declare function rootCertificatePayload(c: Omit<RootCertificate, "signature">): Uint8Array;
+declare const checkpointHash: (c: Omit<RootCertificate, "signature">) => string;
+declare const rootCertificateMessage: (c: Omit<RootCertificate, "signature">) => Uint8Array;
+declare function verifyRootCertificate(c: RootCertificate, key: Uint8Array): boolean;
+interface ProofBundle {
+    format: "invisi-provenance-proof-v1";
+    circuitId: string;
+    manifestSha256: string;
+    target: "evm";
+    publicInputs: string[];
+    proof: string;
+    rootCertificates: RootCertificate[];
+}
+interface ProofSidecar {
+    operationIndex: string;
+    proofBundle: ProofBundle;
+}
+interface TrustedManifest {
+    noirVersion: string;
+    bbVersion: string;
+    depth: number;
+    family: "provenance";
+    target: "evm";
+    publicInputs: readonly string[];
+    circuits: readonly {
+        capacity: number;
+        name?: string;
+        artifactSha256: string;
+        vkSha256: string;
+    }[];
+}
+interface ManifestIdentity {
+    manifest: TrustedManifest;
+    sha256: string;
+}
+interface TrustContext extends Scope {
+    chainGeneration: Integer;
+    providerId: Integer;
+    signingKeys: Readonly<Record<string, Uint8Array>>;
+    manifestSha256: string;
+    signingKeyValidity?: Readonly<Record<string, {
+        activatedAt: string;
+        retiredAt?: string;
+    }>>;
+}
+declare function assertCertificateTrust(c: RootCertificate, trust: TrustContext): void;
+type PublicResult = Record<string, unknown> & {
+    scope: Scope;
+};
+declare function certificateToWire(c: RootCertificate): RootCertificate;
+declare function validateProofBundle(b: ProofBundle, t: TrustContext): Promise<void>;
+declare function proofSidecarToWire(sidecar: ProofSidecar): ProofSidecar;
+
+export { CAPACITIES, DEFAULT_PROVENANCE_ENDPOINT, DOMAINS, FIELD_MODULUS, type Integer, type KeyValidity, type ManifestIdentity, type Opening, PROVENANCE_MANIFEST_SHA256, PUBLIC_INPUTS, type ProofBundle, type ProofSidecar, type PublicResult, RecognizedTree, type RootCertificate, type RotationRecord, type Scope, type Source, type Tracking, type TrackingResult, TrackingStaleGenerationError, type TrackingStatus, type TrustContext, type TrustedKeyring, type TrustedManifest, assertCertificateTrust, bindingDigest, certificateToWire, checkpointHash, field, inputDigest, limbs, noteOpening, operationDigest, preflightTracking, proofSidecarToWire, recognizedLeaf, rootCertificateMessage, rootCertificatePayload, rotationHash, rotationMessage, rotationPayload, scopeHash, sourcesDigest, uint, validateProofBundle, validateTracking, verifyRootCertificate, verifyRotationChain, withRotationHistory, word };

package/dist/provenance.d.ts

@@ -0,0 +1,188 @@
+export { provenanceIntentHash } from '@invisi-labs/primitives';
+
+interface RotationRecord {
+    version: "1";
+    providerId: string;
+    oldKeyId: string;
+    newKeyId: string;
+    newPublicKey: string;
+    activatedAt: string;
+    previousRotationHash: string;
+    signature: string;
+}
+interface KeyValidity {
+    activatedAt: string;
+    retiredAt?: string;
+}
+interface TrustedKeyring {
+    providerId: string;
+    keys: Record<string, Uint8Array>;
+    validity: Record<string, KeyValidity>;
+    rotationHash: string;
+    lastActivatedAt: string;
+}
+declare function rotationPayload(r: RotationRecord): Uint8Array;
+declare const rotationMessage: (r: RotationRecord) => Uint8Array;
+declare const rotationHash: (r: RotationRecord) => string;
+declare function verifyRotationChain(initial: {
+    providerId: string;
+    keys: Readonly<Record<string, Uint8Array>>;
+    previousRotationHash: string;
+    lastActivatedAt: string;
+    now: string;
+    validity?: Readonly<Record<string, KeyValidity>>;
+}, records: readonly RotationRecord[]): TrustedKeyring;
+declare function withRotationHistory(trust: TrustContext, keyring: TrustedKeyring): TrustContext;
+
+type TrackingStatus = "pending_confirmation" | "pending_source" | "recognized" | "expired" | "superseded" | "stale_generation";
+interface Tracking {
+    id: string;
+    status: TrackingStatus;
+    expiresAt: string;
+    operationDigest: string;
+    matched?: {
+        txHash: string;
+        blockHash: string;
+        operationIndex: string;
+    };
+    reasonCode?: string;
+    checkpointSequence?: string;
+}
+type TrackingResult = PublicResult & {
+    tracking: Tracking;
+};
+declare class TrackingStaleGenerationError extends Error {
+    constructor();
+}
+declare function validateTracking(value: unknown, expectedId?: string): Tracking;
+/** Single evaluation results are flat; aggregate members carry their own tracking records. */
+declare function preflightTracking(result: PublicResult, operationIndex: string, operationDigest: string): Tracking;
+
+declare const PROVENANCE_MANIFEST_SHA256 = "6107789c5c0d24c4130bff05da6d389336feb5ccb247c4030eae5198ab05d762";
+
+declare class RecognizedTree {
+    private readonly leaves;
+    get leafCount(): number;
+    append(value: Integer): number;
+    appendCommitment(scope: Scope, commitment: Integer): Promise<number>;
+    membershipForCommitment(scope: Scope, commitment: Integer): Promise<{
+        leafIndex: number;
+        path: bigint[];
+        root: bigint;
+    } | undefined>;
+    root(): Promise<bigint>;
+    path(index: number): Promise<{
+        path: bigint[];
+        root: bigint;
+    }>;
+}
+
+declare const DEFAULT_PROVENANCE_ENDPOINT = "https://provenance.invisipay.fi";
+type Integer = bigint | string | number;
+declare const FIELD_MODULUS = 21888242871839275222246405745257275088548364400416034343698204186575808495617n;
+declare const CAPACITIES: readonly number[];
+declare const PUBLIC_INPUTS: readonly ["chain_id", "protocol_address", "token_address", "chain_generation", "source_count", "sources_digest", "input_count", "operation_digest_hi", "operation_digest_lo", "input_digest", "binding"];
+declare function uint(value: Integer, bits: number): bigint;
+declare function field(value: Integer): bigint;
+declare const word: (value: Integer) => string;
+declare const DOMAINS: Readonly<Record<"SCOPE" | "NOTE" | "INPUTS" | "STEP" | "SOURCES" | "SOURCE_STEP" | "BIND", bigint>>;
+declare const limbs: (value: Integer) => [bigint, bigint];
+interface Scope {
+    chainId: Integer;
+    protocolAddress: Integer;
+}
+declare function scopeHash(s: Scope): Promise<bigint>;
+declare const recognizedLeaf: (scope: Integer, commitment: Integer) => Promise<bigint>;
+interface Opening {
+    owner: Integer;
+    nonce: Integer;
+    amount: Integer;
+}
+declare function noteOpening(s: Pick<Scope, "chainId" | "protocolAddress"> & Opening & {
+    tokenAddress: Integer;
+}): Promise<{
+    commitment: bigint;
+    nullifier: bigint;
+}>;
+declare function inputDigest(nullifiers: readonly Integer[]): Promise<bigint>;
+interface Source {
+    treeId: Integer;
+    root: Integer;
+    leafCount: Integer;
+}
+declare function sourcesDigest(generation: Integer, sources: readonly Source[]): Promise<bigint>;
+declare function bindingDigest(s: {
+    scope: Integer;
+    tokenAddress: Integer;
+    chainGeneration: Integer;
+    sourceCount: Integer;
+    sourcesDigest: Integer;
+    inputCount: Integer;
+    operationDigest: Integer;
+    inputDigest: Integer;
+}): Promise<bigint>;
+declare function operationDigest(s: {
+    chainId: Integer;
+    protocolAddress: Integer;
+    operationKind?: number;
+    mainCircuitCapacity: Integer;
+    publicInputs: readonly Integer[];
+}): string;
+declare const CERT_LAYOUT: readonly [readonly ["certificateVersion", 1], readonly ["providerId", 32], readonly ["signingKeyId", 32], readonly ["chainId", 8], readonly ["protocolAddress", 20], readonly ["chainGeneration", 8], readonly ["rootSequence", 8], readonly ["treeId", 8], readonly ["leafCount", 8], readonly ["root", 32], readonly ["confirmedBlockNumber", 8], readonly ["confirmedBlockHash", 32], readonly ["decisionLogHash", 32], readonly ["previousCheckpointHash", 32], readonly ["issuedAt", 8]];
+type RootCertificate = Record<(typeof CERT_LAYOUT)[number][0], Integer> & {
+    signature: string;
+};
+declare function rootCertificatePayload(c: Omit<RootCertificate, "signature">): Uint8Array;
+declare const checkpointHash: (c: Omit<RootCertificate, "signature">) => string;
+declare const rootCertificateMessage: (c: Omit<RootCertificate, "signature">) => Uint8Array;
+declare function verifyRootCertificate(c: RootCertificate, key: Uint8Array): boolean;
+interface ProofBundle {
+    format: "invisi-provenance-proof-v1";
+    circuitId: string;
+    manifestSha256: string;
+    target: "evm";
+    publicInputs: string[];
+    proof: string;
+    rootCertificates: RootCertificate[];
+}
+interface ProofSidecar {
+    operationIndex: string;
+    proofBundle: ProofBundle;
+}
+interface TrustedManifest {
+    noirVersion: string;
+    bbVersion: string;
+    depth: number;
+    family: "provenance";
+    target: "evm";
+    publicInputs: readonly string[];
+    circuits: readonly {
+        capacity: number;
+        name?: string;
+        artifactSha256: string;
+        vkSha256: string;
+    }[];
+}
+interface ManifestIdentity {
+    manifest: TrustedManifest;
+    sha256: string;
+}
+interface TrustContext extends Scope {
+    chainGeneration: Integer;
+    providerId: Integer;
+    signingKeys: Readonly<Record<string, Uint8Array>>;
+    manifestSha256: string;
+    signingKeyValidity?: Readonly<Record<string, {
+        activatedAt: string;
+        retiredAt?: string;
+    }>>;
+}
+declare function assertCertificateTrust(c: RootCertificate, trust: TrustContext): void;
+type PublicResult = Record<string, unknown> & {
+    scope: Scope;
+};
+declare function certificateToWire(c: RootCertificate): RootCertificate;
+declare function validateProofBundle(b: ProofBundle, t: TrustContext): Promise<void>;
+declare function proofSidecarToWire(sidecar: ProofSidecar): ProofSidecar;
+
+export { CAPACITIES, DEFAULT_PROVENANCE_ENDPOINT, DOMAINS, FIELD_MODULUS, type Integer, type KeyValidity, type ManifestIdentity, type Opening, PROVENANCE_MANIFEST_SHA256, PUBLIC_INPUTS, type ProofBundle, type ProofSidecar, type PublicResult, RecognizedTree, type RootCertificate, type RotationRecord, type Scope, type Source, type Tracking, type TrackingResult, TrackingStaleGenerationError, type TrackingStatus, type TrustContext, type TrustedKeyring, type TrustedManifest, assertCertificateTrust, bindingDigest, certificateToWire, checkpointHash, field, inputDigest, limbs, noteOpening, operationDigest, preflightTracking, proofSidecarToWire, recognizedLeaf, rootCertificateMessage, rootCertificatePayload, rotationHash, rotationMessage, rotationPayload, scopeHash, sourcesDigest, uint, validateProofBundle, validateTracking, verifyRootCertificate, verifyRotationChain, withRotationHistory, word };