@invisi-labs/protocol 1.1.6 → 1.2.0

package/dist/validation-8g0SQVE5.d.ts

@@ -0,0 +1,235 @@
+import { Hex, Address } from '@invisi-labs/primitives';
+import { F as FundingParams, D as Delivery, I as InputSource } from './types-CUnFzl5S.js';
+
+interface DeploymentContext {
+    chainId: bigint;
+    protocolAddress: Address;
+}
+interface CanonicalBlock {
+    number: bigint;
+    hash: Hex;
+    parentHash: Hex;
+    timestamp: bigint;
+}
+interface Membership {
+    treeId: bigint;
+    leafIndex: number;
+    leaf: Hex;
+    root: Hex;
+    path: readonly bigint[];
+    block: CanonicalBlock;
+}
+/** Indexed service data is untrusted; the wallet verifies canonical facts through ChainReader. */
+interface ProtocolDataStatus {
+    indexedHead: CanonicalBlock | null;
+    detectionEnabled: boolean;
+    checkedBits: number;
+}
+interface ProtocolUpdateRange {
+    fromBlock: bigint;
+    toBlock: bigint;
+    detectionKey?: Uint8Array;
+    signal?: AbortSignal;
+}
+interface ProtocolNoteUpdates {
+    block: CanonicalBlock;
+    notes: readonly ProtocolNoteOutput[];
+}
+interface ProtocolCreditUpdates {
+    block: CanonicalBlock;
+    transitions: readonly ProtocolCreditTransition[];
+}
+interface ProtocolCreditCandidates {
+    block: CanonicalBlock;
+    states: readonly IndexedCreditState[];
+}
+interface ProtocolDataProvider {
+    getMembership(context: DeploymentContext, input: {
+        treeId: bigint;
+        leafIndex: number;
+        commitment: Hex;
+        root?: Hex;
+    }, block: CanonicalBlock): Promise<Membership>;
+    getStatus(context: DeploymentContext, options?: {
+        signal?: AbortSignal;
+    }): Promise<ProtocolDataStatus>;
+    getNoteUpdates(context: DeploymentContext, range: ProtocolUpdateRange): Promise<ProtocolNoteUpdates>;
+    getCreditTransitions(context: DeploymentContext, range: ProtocolUpdateRange): Promise<ProtocolCreditUpdates>;
+    detectNotes(context: DeploymentContext, range: ProtocolUpdateRange): Promise<ProtocolNoteUpdates>;
+    detectCreditStates(context: DeploymentContext, range: ProtocolUpdateRange): Promise<ProtocolCreditCandidates>;
+}
+/** Registered public receiving address returned by a trusted indexed RPC read. */
+interface RegisteredReceivingAddress {
+    receivingAddress: string;
+    nonce: bigint;
+    block: CanonicalBlock;
+}
+/** Indexed encrypted output; authenticate decryption and verify membership before spending. */
+interface ProtocolNoteOutput {
+    block: CanonicalBlock;
+    treeId: bigint;
+    leafIndex: number;
+    commitment: Hex;
+    tokenAddress: Address;
+    ciphertext: Hex;
+    clue: Hex;
+    transactionHash: Hex;
+    logIndex: number;
+    kind: string;
+}
+/** Public indexed Credit event data; verify the canonical receipt before using it. */
+interface ProtocolCreditTransition {
+    block: CanonicalBlock;
+    name: "CreditCreated" | "CreditDraw" | "CreditUpdated" | "CreditRevoked";
+    transactionHash: Hex;
+    logIndex: number;
+    data: Readonly<Record<string, unknown>>;
+}
+/** One public authority leaf retains both owner/spender deliveries in on-chain order. */
+interface IndexedCreditState {
+    block: CanonicalBlock;
+    treeId: bigint;
+    leafIndex: number;
+    commitment: Hex;
+    tokenAddress: Address;
+    deliveries: readonly {
+        ciphertext: Hex;
+        clue: Hex;
+    }[];
+    transactionHash: Hex;
+    logIndex: number;
+    kind: "CreditCreated" | "CreditDraw" | "CreditUpdated";
+}
+interface TransactionCommon {
+    transactionHash: Hex;
+    indexedHead: CanonicalBlock | null;
+}
+type Availability<Collections> = TransactionCommon & (({
+    status: "not_found";
+    block: null;
+    receiptStatus: null;
+} & {
+    [K in keyof Collections]: null;
+}) | ({
+    status: "pending_index";
+    block: CanonicalBlock;
+    receiptStatus: 0 | 1;
+} & {
+    [K in keyof Collections]: null;
+}) | ({
+    status: "indexed";
+    block: CanonicalBlock;
+    receiptStatus: 0 | 1;
+} & Collections));
+type ProtocolTransactionNoteUpdates = Availability<{
+    notes: readonly ProtocolNoteOutput[];
+}>;
+type ProtocolTransactionCreditUpdates = Availability<{
+    states: readonly IndexedCreditState[];
+    transitions: readonly ProtocolCreditTransition[];
+}>;
+interface IndexedCreditAllocation {
+    block: CanonicalBlock;
+    shard: bigint;
+    slot: number;
+}
+interface IndexedCreditRevocationBitmap {
+    block: CanonicalBlock;
+    bitmap: bigint;
+}
+/** Public operator metadata from the selected registry's indexed state; not an endorsement. */
+interface RegisteredBroadcaster {
+    block: CanonicalBlock;
+    operator: Address;
+    /** Raw contract declaration; the contact client must validate URL safety before use. */
+    endpoint: string;
+    metadataURI: string;
+    quoteSigner: Address;
+    feeRecipient: Address;
+    enabled: boolean;
+}
+interface BroadcasterQuery {
+    enabled?: boolean;
+    after?: Address;
+    limit?: number;
+    block?: CanonicalBlock;
+    signal?: AbortSignal;
+}
+interface BroadcasterPage {
+    block: CanonicalBlock;
+    broadcasters: readonly RegisteredBroadcaster[];
+    next?: Address;
+}
+
+interface TransactionContext extends DeploymentContext {
+    tokenAddress: Address;
+    now?: bigint;
+    /** Explicit chain timestamp used to bind Credit draw UTC periods. */
+    timestamp?: bigint;
+}
+declare const FIELD_MODULUS = 21888242871839275222246405745257275088548364400416034343698204186575808495617n;
+declare const ZERO_ADDRESS: "0x0000000000000000000000000000000000000000";
+declare const ZERO_WORD: Hex;
+declare const EMPTY_PERMIT: {
+    readonly deadline: 0n;
+    readonly v: 0;
+    readonly r: `0x${string}`;
+    readonly s: `0x${string}`;
+};
+declare const EMPTY_FUNDING: FundingParams;
+type FundingInput = Partial<Omit<FundingParams, "permit">> & {
+    permit?: FundingParams["permit"];
+};
+declare function uint(v: bigint | number | string, bits: number, name?: string): bigint;
+declare function field(v: bigint | string, name?: string): bigint;
+declare const word: (v: bigint | string) => Hex;
+declare function dense<T>(v: readonly T[], name: string): readonly T[];
+declare function known(v: object, keys: readonly string[], name?: string): void;
+declare function notes(v: readonly Hex[], name: string): `0x${string}`[];
+declare function envelope(v: Hex, length: number, version?: number, maximum?: number): Hex;
+declare function normalizeContext(c: TransactionContext): {
+    chainId: bigint;
+    protocolAddress: Hex;
+    tokenAddress: Hex;
+    now?: bigint;
+    /** Explicit chain timestamp used to bind Credit draw UTC periods. */
+    timestamp?: bigint;
+};
+declare function checkDeadline(c: TransactionContext, value: bigint): bigint;
+declare function normalizeSources(sources: readonly InputSource[], inputCount: number, capacity: number): {
+    treeId: bigint;
+    merkleRoot: `0x${string}`;
+}[];
+declare const pad: (v: readonly bigint[], n: number) => bigint[];
+/** Receipt/transport validation must not reject unrelated future wallet codecs. */
+declare function normalizeOpaqueDelivery(value: Delivery, options?: {
+    empty?: boolean;
+    allowEmpty?: boolean;
+}): Delivery;
+declare const deliveriesHash: (v: readonly Delivery[]) => Hex;
+declare function normalizeFunding(input?: FundingInput): FundingParams;
+declare function validateFundingSubmission(f: FundingParams, caller?: Address, now?: bigint): void;
+declare const getEIP712Domain: (c: TransactionContext) => {
+    name: string;
+    version: string;
+    chainId: bigint;
+    verifyingContract: Hex;
+};
+declare const fundingFields: readonly [{
+    readonly name: "requestHash";
+    readonly type: "bytes32";
+}, {
+    readonly name: "payer";
+    readonly type: "address";
+}, {
+    readonly name: "amount";
+    readonly type: "uint256";
+}, {
+    readonly name: "sigNonce";
+    readonly type: "uint256";
+}, {
+    readonly name: "deadline";
+    readonly type: "uint256";
+}];
+
+export { normalizeOpaqueDelivery as A, type BroadcasterPage as B, type CanonicalBlock as C, type DeploymentContext as D, EMPTY_FUNDING as E, type FundingInput as F, normalizeSources as G, notes as H, type IndexedCreditAllocation as I, pad as J, uint as K, validateFundingSubmission as L, type Membership as M, word as N, type ProtocolCreditCandidates as P, type RegisteredBroadcaster as R, type TransactionContext as T, ZERO_ADDRESS as Z, type BroadcasterQuery as a, EMPTY_PERMIT as b, FIELD_MODULUS as c, type IndexedCreditRevocationBitmap as d, type IndexedCreditState as e, type ProtocolCreditTransition as f, type ProtocolCreditUpdates as g, type ProtocolDataProvider as h, type ProtocolDataStatus as i, type ProtocolNoteOutput as j, type ProtocolNoteUpdates as k, type ProtocolTransactionCreditUpdates as l, type ProtocolTransactionNoteUpdates as m, type ProtocolUpdateRange as n, type RegisteredReceivingAddress as o, ZERO_WORD as p, checkDeadline as q, deliveriesHash as r, dense as s, envelope as t, field as u, fundingFields as v, getEIP712Domain as w, known as x, normalizeContext as y, normalizeFunding as z };

package/dist/validation-MgURYiNF.d.cts

@@ -0,0 +1,235 @@
+import { Hex, Address } from '@invisi-labs/primitives';
+import { F as FundingParams, D as Delivery, I as InputSource } from './types-CUnFzl5S.cjs';
+
+interface DeploymentContext {
+    chainId: bigint;
+    protocolAddress: Address;
+}
+interface CanonicalBlock {
+    number: bigint;
+    hash: Hex;
+    parentHash: Hex;
+    timestamp: bigint;
+}
+interface Membership {
+    treeId: bigint;
+    leafIndex: number;
+    leaf: Hex;
+    root: Hex;
+    path: readonly bigint[];
+    block: CanonicalBlock;
+}
+/** Indexed service data is untrusted; the wallet verifies canonical facts through ChainReader. */
+interface ProtocolDataStatus {
+    indexedHead: CanonicalBlock | null;
+    detectionEnabled: boolean;
+    checkedBits: number;
+}
+interface ProtocolUpdateRange {
+    fromBlock: bigint;
+    toBlock: bigint;
+    detectionKey?: Uint8Array;
+    signal?: AbortSignal;
+}
+interface ProtocolNoteUpdates {
+    block: CanonicalBlock;
+    notes: readonly ProtocolNoteOutput[];
+}
+interface ProtocolCreditUpdates {
+    block: CanonicalBlock;
+    transitions: readonly ProtocolCreditTransition[];
+}
+interface ProtocolCreditCandidates {
+    block: CanonicalBlock;
+    states: readonly IndexedCreditState[];
+}
+interface ProtocolDataProvider {
+    getMembership(context: DeploymentContext, input: {
+        treeId: bigint;
+        leafIndex: number;
+        commitment: Hex;
+        root?: Hex;
+    }, block: CanonicalBlock): Promise<Membership>;
+    getStatus(context: DeploymentContext, options?: {
+        signal?: AbortSignal;
+    }): Promise<ProtocolDataStatus>;
+    getNoteUpdates(context: DeploymentContext, range: ProtocolUpdateRange): Promise<ProtocolNoteUpdates>;
+    getCreditTransitions(context: DeploymentContext, range: ProtocolUpdateRange): Promise<ProtocolCreditUpdates>;
+    detectNotes(context: DeploymentContext, range: ProtocolUpdateRange): Promise<ProtocolNoteUpdates>;
+    detectCreditStates(context: DeploymentContext, range: ProtocolUpdateRange): Promise<ProtocolCreditCandidates>;
+}
+/** Registered public receiving address returned by a trusted indexed RPC read. */
+interface RegisteredReceivingAddress {
+    receivingAddress: string;
+    nonce: bigint;
+    block: CanonicalBlock;
+}
+/** Indexed encrypted output; authenticate decryption and verify membership before spending. */
+interface ProtocolNoteOutput {
+    block: CanonicalBlock;
+    treeId: bigint;
+    leafIndex: number;
+    commitment: Hex;
+    tokenAddress: Address;
+    ciphertext: Hex;
+    clue: Hex;
+    transactionHash: Hex;
+    logIndex: number;
+    kind: string;
+}
+/** Public indexed Credit event data; verify the canonical receipt before using it. */
+interface ProtocolCreditTransition {
+    block: CanonicalBlock;
+    name: "CreditCreated" | "CreditDraw" | "CreditUpdated" | "CreditRevoked";
+    transactionHash: Hex;
+    logIndex: number;
+    data: Readonly<Record<string, unknown>>;
+}
+/** One public authority leaf retains both owner/spender deliveries in on-chain order. */
+interface IndexedCreditState {
+    block: CanonicalBlock;
+    treeId: bigint;
+    leafIndex: number;
+    commitment: Hex;
+    tokenAddress: Address;
+    deliveries: readonly {
+        ciphertext: Hex;
+        clue: Hex;
+    }[];
+    transactionHash: Hex;
+    logIndex: number;
+    kind: "CreditCreated" | "CreditDraw" | "CreditUpdated";
+}
+interface TransactionCommon {
+    transactionHash: Hex;
+    indexedHead: CanonicalBlock | null;
+}
+type Availability<Collections> = TransactionCommon & (({
+    status: "not_found";
+    block: null;
+    receiptStatus: null;
+} & {
+    [K in keyof Collections]: null;
+}) | ({
+    status: "pending_index";
+    block: CanonicalBlock;
+    receiptStatus: 0 | 1;
+} & {
+    [K in keyof Collections]: null;
+}) | ({
+    status: "indexed";
+    block: CanonicalBlock;
+    receiptStatus: 0 | 1;
+} & Collections));
+type ProtocolTransactionNoteUpdates = Availability<{
+    notes: readonly ProtocolNoteOutput[];
+}>;
+type ProtocolTransactionCreditUpdates = Availability<{
+    states: readonly IndexedCreditState[];
+    transitions: readonly ProtocolCreditTransition[];
+}>;
+interface IndexedCreditAllocation {
+    block: CanonicalBlock;
+    shard: bigint;
+    slot: number;
+}
+interface IndexedCreditRevocationBitmap {
+    block: CanonicalBlock;
+    bitmap: bigint;
+}
+/** Public operator metadata from the selected registry's indexed state; not an endorsement. */
+interface RegisteredBroadcaster {
+    block: CanonicalBlock;
+    operator: Address;
+    /** Raw contract declaration; the contact client must validate URL safety before use. */
+    endpoint: string;
+    metadataURI: string;
+    quoteSigner: Address;
+    feeRecipient: Address;
+    enabled: boolean;
+}
+interface BroadcasterQuery {
+    enabled?: boolean;
+    after?: Address;
+    limit?: number;
+    block?: CanonicalBlock;
+    signal?: AbortSignal;
+}
+interface BroadcasterPage {
+    block: CanonicalBlock;
+    broadcasters: readonly RegisteredBroadcaster[];
+    next?: Address;
+}
+
+interface TransactionContext extends DeploymentContext {
+    tokenAddress: Address;
+    now?: bigint;
+    /** Explicit chain timestamp used to bind Credit draw UTC periods. */
+    timestamp?: bigint;
+}
+declare const FIELD_MODULUS = 21888242871839275222246405745257275088548364400416034343698204186575808495617n;
+declare const ZERO_ADDRESS: "0x0000000000000000000000000000000000000000";
+declare const ZERO_WORD: Hex;
+declare const EMPTY_PERMIT: {
+    readonly deadline: 0n;
+    readonly v: 0;
+    readonly r: `0x${string}`;
+    readonly s: `0x${string}`;
+};
+declare const EMPTY_FUNDING: FundingParams;
+type FundingInput = Partial<Omit<FundingParams, "permit">> & {
+    permit?: FundingParams["permit"];
+};
+declare function uint(v: bigint | number | string, bits: number, name?: string): bigint;
+declare function field(v: bigint | string, name?: string): bigint;
+declare const word: (v: bigint | string) => Hex;
+declare function dense<T>(v: readonly T[], name: string): readonly T[];
+declare function known(v: object, keys: readonly string[], name?: string): void;
+declare function notes(v: readonly Hex[], name: string): `0x${string}`[];
+declare function envelope(v: Hex, length: number, version?: number, maximum?: number): Hex;
+declare function normalizeContext(c: TransactionContext): {
+    chainId: bigint;
+    protocolAddress: Hex;
+    tokenAddress: Hex;
+    now?: bigint;
+    /** Explicit chain timestamp used to bind Credit draw UTC periods. */
+    timestamp?: bigint;
+};
+declare function checkDeadline(c: TransactionContext, value: bigint): bigint;
+declare function normalizeSources(sources: readonly InputSource[], inputCount: number, capacity: number): {
+    treeId: bigint;
+    merkleRoot: `0x${string}`;
+}[];
+declare const pad: (v: readonly bigint[], n: number) => bigint[];
+/** Receipt/transport validation must not reject unrelated future wallet codecs. */
+declare function normalizeOpaqueDelivery(value: Delivery, options?: {
+    empty?: boolean;
+    allowEmpty?: boolean;
+}): Delivery;
+declare const deliveriesHash: (v: readonly Delivery[]) => Hex;
+declare function normalizeFunding(input?: FundingInput): FundingParams;
+declare function validateFundingSubmission(f: FundingParams, caller?: Address, now?: bigint): void;
+declare const getEIP712Domain: (c: TransactionContext) => {
+    name: string;
+    version: string;
+    chainId: bigint;
+    verifyingContract: Hex;
+};
+declare const fundingFields: readonly [{
+    readonly name: "requestHash";
+    readonly type: "bytes32";
+}, {
+    readonly name: "payer";
+    readonly type: "address";
+}, {
+    readonly name: "amount";
+    readonly type: "uint256";
+}, {
+    readonly name: "sigNonce";
+    readonly type: "uint256";
+}, {
+    readonly name: "deadline";
+    readonly type: "uint256";
+}];
+
+export { normalizeOpaqueDelivery as A, type BroadcasterPage as B, type CanonicalBlock as C, type DeploymentContext as D, EMPTY_FUNDING as E, type FundingInput as F, normalizeSources as G, notes as H, type IndexedCreditAllocation as I, pad as J, uint as K, validateFundingSubmission as L, type Membership as M, word as N, type ProtocolCreditCandidates as P, type RegisteredBroadcaster as R, type TransactionContext as T, ZERO_ADDRESS as Z, type BroadcasterQuery as a, EMPTY_PERMIT as b, FIELD_MODULUS as c, type IndexedCreditRevocationBitmap as d, type IndexedCreditState as e, type ProtocolCreditTransition as f, type ProtocolCreditUpdates as g, type ProtocolDataProvider as h, type ProtocolDataStatus as i, type ProtocolNoteOutput as j, type ProtocolNoteUpdates as k, type ProtocolTransactionCreditUpdates as l, type ProtocolTransactionNoteUpdates as m, type ProtocolUpdateRange as n, type RegisteredReceivingAddress as o, ZERO_WORD as p, checkDeadline as q, deliveriesHash as r, dense as s, envelope as t, field as u, fundingFields as v, getEIP712Domain as w, known as x, normalizeContext as y, normalizeFunding as z };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@invisi-labs/protocol",
-  "version": "1.1.6",
-  "description": "Deployment-scoped protocol statements, witnesses and contract operations",
+  "version": "1.2.0",
+  "description": "Pure Invisi public ABIs, types, strict codecs, statements, signatures, capacities and gas references",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -16,13 +16,28 @@
       "types": "./dist/contracts.d.ts",
       "import": "./dist/contracts.js",
       "require": "./dist/contracts.cjs"
+    },
+    "./note": {
+      "types": "./dist/note.d.ts",
+      "import": "./dist/note.js",
+      "require": "./dist/note.cjs"
+    },
+    "./credit": {
+      "types": "./dist/credit.d.ts",
+      "import": "./dist/credit.js",
+      "require": "./dist/credit.cjs"
+    },
+    "./provenance": {
+      "types": "./dist/provenance.d.ts",
+      "import": "./dist/provenance.js",
+      "require": "./dist/provenance.cjs"
     }
   },
   "dependencies": {
     "ethers": "^6.17.0",
-    "@invisi-labs/core": "1.1.6",
-    "@invisi-labs/prover": "1.1.6",
-    "@invisi-labs/rpc": "1.1.6"
+    "@noble/hashes": "1.8.0",
+    "@noble/curves": "1.9.1",
+    "@invisi-labs/primitives": "1.2.0"
   },
   "devDependencies": {
     "tsup": "^8.0.0",