@invisi-labs/sdk 1.1.0

package/dist/gas-estimation-Byi278aa.d.cts

@@ -0,0 +1,239 @@
+import { Note, CreditDeliveryState, ViewingCapability, Wallet, WalletAuthorizationProvider, ReceivingKeyLookup, Hex as Hex$1 } from '@invisi-labs/core';
+import { S as StoredNote, W as WalletScope, b as WalletStore } from './state-DHl6j33x.cjs';
+import { TransactionContext, CanonicalBlock, NoteMembership, FundingInput, TransactRequestParams, CreditMembership, Protocol, ChainReader, ProtocolDataProvider, TokenProtocol } from '@invisi-labs/protocol';
+import * as _invisi_labs_prover from '@invisi-labs/prover';
+import { Prover, ProofTarget, AggregateMember } from '@invisi-labs/prover';
+import { Signer } from 'ethers';
+import { Address, Hex, Delivery, ShieldParams, ShieldOutput, CreateCreditParams, CreditDrawParams, CancelCreditParams, TopUpCreditParams, TransactRequest } from '@invisi-labs/protocol/contracts';
+
+interface CoinSelector {
+    select(candidates: readonly StoredNote[], requiredAmount: bigint): readonly Hex[] | Promise<readonly Hex[]>;
+}
+interface FundingTypedData {
+    domain: Record<string, unknown>;
+    primaryType: string;
+    types: Record<string, readonly {
+        name: string;
+        type: string;
+    }[]>;
+    message: Record<string, unknown>;
+}
+interface FundingSigner {
+    readonly address: Address;
+    signTypedData(data: FundingTypedData): Promise<Hex>;
+}
+interface FundingAuthorizationVerifier {
+    verifyTypedData(data: FundingTypedData & {
+        address: Address;
+        signature: Hex;
+    }): Promise<boolean>;
+}
+interface FundingSource {
+    payer: Address;
+    amount: bigint;
+    authorization?: "signature" | "caller";
+    sigNonce?: bigint;
+    deadline?: bigint;
+    permit?: NonNullable<FundingInput["permit"]>;
+}
+interface PaymentOutput {
+    to: string;
+    amount: bigint;
+}
+interface TransferPreparation {
+    tokenAddress: Address;
+    outputs: readonly PaymentOutput[];
+    funding?: FundingSource;
+    deadline?: bigint;
+    target?: ProofTarget;
+}
+interface WithdrawalPreparation {
+    tokenAddress: Address;
+    to: Address;
+    amount: bigint;
+    deadline?: bigint;
+    target?: ProofTarget;
+}
+interface SweepPreparation {
+    tokenAddress: Address;
+    commitments?: readonly Hex[];
+    deadline?: bigint;
+    target?: ProofTarget;
+}
+interface ShieldPreparation {
+    tokenAddress: Address;
+    outputs: readonly PaymentOutput[];
+    funding: FundingSource;
+    deadline?: bigint;
+}
+interface PreparedOutput {
+    note: Note;
+    commitment: Hex;
+    identity: Hex;
+    delivery: Delivery;
+    address: string;
+    change: boolean;
+}
+interface CreateCreditPreparation {
+    tokenAddress: Address;
+    spender: string;
+    amount: bigint;
+    expiry: bigint;
+    funding?: FundingSource;
+    deadline?: bigint;
+}
+interface DrawCreditPreparation {
+    tokenAddress: Address;
+    credits: readonly {
+        credit: Hex;
+        amount: bigint;
+    }[];
+    deadline?: bigint;
+}
+interface TopUpCreditPreparation {
+    tokenAddress: Address;
+    credit: Hex;
+    additionalAmount: bigint;
+    expiry?: bigint;
+    funding?: FundingSource;
+    deadline?: bigint;
+}
+interface CancelCreditPreparation {
+    tokenAddress: Address;
+    credit: Hex;
+    deadline?: bigint;
+}
+interface PreparedCreditOutput {
+    state: CreditDeliveryState;
+    commitment: Hex;
+    deliveries: [Delivery, Delivery];
+}
+interface PreparedCreditInput extends CreditMembership {
+    commitment: Hex;
+    role: "owner" | "spender";
+}
+interface CreditPlan {
+    inputs: PreparedCreditInput[];
+    outputs: PreparedCreditOutput[];
+    deliveries: Delivery[];
+    creation?: CreateCreditParams;
+    draw?: CreditDrawParams;
+    cancel?: CancelCreditParams;
+    topUp?: TopUpCreditParams;
+    amounts?: bigint[];
+}
+interface OperationPlan {
+    version: 1;
+    id: string;
+    kind: "transfer" | "withdraw" | "sweep" | "shield" | "create-credit" | "draw-credit" | "top-up-credit" | "cancel-credit";
+    context: TransactionContext;
+    scope: WalletScope;
+    preparedAt: CanonicalBlock;
+    deadline: bigint;
+    outputs: PreparedOutput[];
+    inputs: Array<NoteMembership & {
+        commitment: Hex;
+    }>;
+    funding: FundingInput;
+    fundingMode: "none" | "signature" | "caller";
+    params?: TransactRequestParams;
+    shieldParams?: ShieldParams;
+    shieldOutputs?: ShieldOutput[];
+    capacity?: number;
+    credit?: CreditPlan;
+    statement?: _invisi_labs_prover.ProofStatement;
+}
+interface WalletSessionOptions {
+    gasBenchmarks?: readonly GasBenchmarkProfile[];
+    /** Optional ethers gas/funding signer; distinct from the Invisi wallet authority. */
+    signer?: Signer;
+    viewing?: Pick<ViewingCapability, "walletIdentity" | "decryptNote" | "decryptCredit">;
+    wallet: Wallet;
+    protocol: Protocol;
+    namespace?: string;
+    store?: WalletStore;
+    chainReader?: ChainReader;
+    protocolRpc?: ProtocolDataProvider;
+    authorization?: WalletAuthorizationProvider;
+    prover?: Prover;
+    fundingSigner?: FundingSigner;
+    fundingVerifier?: FundingAuthorizationVerifier;
+    addressResolver?: ReceivingKeyLookup;
+    coinSelector?: CoinSelector;
+    transactionTTL?: bigint;
+}
+interface OperationRuntime {
+    options: Omit<WalletSessionOptions, "protocol"> & {
+        protocol: TokenProtocol;
+    };
+    scope: WalletScope;
+    store: WalletStore;
+    reader: ChainReader;
+    authorization: () => WalletAuthorizationProvider;
+}
+interface OperationAggregateMember extends AggregateMember {
+    context: TransactionContext;
+    request: TransactRequest;
+}
+
+interface GasBenchmarkShape {
+    kind: OperationPlan["kind"];
+    target: string;
+    capacity: number;
+    noteInputs: number;
+    noteOutputs: number;
+    sourceTrees: number;
+    creditInputs: number;
+    creditOutputs: number;
+    creditRemainders: number;
+    funding: "none" | "caller" | "signature";
+    permit: boolean;
+    deliveryBytes: number;
+}
+interface GasBenchmarkDeployment {
+    chainId: string;
+    protocolAddress: Hex$1;
+    runtimeCodeHash: Hex$1 | null;
+    tokenAddress: Hex$1;
+}
+interface GasBenchmarkCircuit {
+    circuitName: string;
+    target: string;
+    artifactSha256: string;
+    vkSha256: string;
+}
+interface GasBenchmarkSample {
+    gasUsed: string;
+    transactionHash: Hex$1;
+    blockNumber: string;
+    blockHash: Hex$1;
+    calldataBytes: number;
+}
+interface GasBenchmarkProfile {
+    formatVersion: 1;
+    id: string;
+    deployment: GasBenchmarkDeployment;
+    source: {
+        protocolCommit: string;
+        measuredAt: string;
+        chain: string;
+        hardfork: string;
+        token: string;
+        verifier: "real";
+        assumptions: string[];
+    };
+    measurements: Array<{
+        id: string;
+        shape: GasBenchmarkShape;
+        circuit: GasBenchmarkCircuit | null;
+        samples: GasBenchmarkSample[];
+    }>;
+}
+/** Parse a trusted, JSON-compatible benchmark catalog. No network access or publisher authentication. */
+declare function defineGasBenchmarks(input: unknown): GasBenchmarkProfile[];
+/** Pre-proof reference only; ethers must estimate the final transaction independently. */
+interface GasReference {
+    gasUnits: bigint;
+}
+
+export { type CancelCreditPreparation as C, type DrawCreditPreparation as D, type FundingSigner as F, type GasReference as G, type OperationRuntime as O, type ShieldPreparation as S, type TopUpCreditPreparation as T, type WithdrawalPreparation as W, type OperationPlan as a, type OperationAggregateMember as b, type CreateCreditPreparation as c, type SweepPreparation as d, type TransferPreparation as e, type WalletSessionOptions as f, type CoinSelector as g, type FundingAuthorizationVerifier as h, type FundingSource as i, type FundingTypedData as j, type GasBenchmarkCircuit as k, type GasBenchmarkDeployment as l, type GasBenchmarkProfile as m, type GasBenchmarkSample as n, type GasBenchmarkShape as o, defineGasBenchmarks as p };

package/dist/gas-estimation-CUZXjsO7.d.ts

@@ -0,0 +1,239 @@
+import { Note, CreditDeliveryState, ViewingCapability, Wallet, WalletAuthorizationProvider, ReceivingKeyLookup, Hex as Hex$1 } from '@invisi-labs/core';
+import { S as StoredNote, W as WalletScope, b as WalletStore } from './state-DHl6j33x.js';
+import { TransactionContext, CanonicalBlock, NoteMembership, FundingInput, TransactRequestParams, CreditMembership, Protocol, ChainReader, ProtocolDataProvider, TokenProtocol } from '@invisi-labs/protocol';
+import * as _invisi_labs_prover from '@invisi-labs/prover';
+import { Prover, ProofTarget, AggregateMember } from '@invisi-labs/prover';
+import { Signer } from 'ethers';
+import { Address, Hex, Delivery, ShieldParams, ShieldOutput, CreateCreditParams, CreditDrawParams, CancelCreditParams, TopUpCreditParams, TransactRequest } from '@invisi-labs/protocol/contracts';
+
+interface CoinSelector {
+    select(candidates: readonly StoredNote[], requiredAmount: bigint): readonly Hex[] | Promise<readonly Hex[]>;
+}
+interface FundingTypedData {
+    domain: Record<string, unknown>;
+    primaryType: string;
+    types: Record<string, readonly {
+        name: string;
+        type: string;
+    }[]>;
+    message: Record<string, unknown>;
+}
+interface FundingSigner {
+    readonly address: Address;
+    signTypedData(data: FundingTypedData): Promise<Hex>;
+}
+interface FundingAuthorizationVerifier {
+    verifyTypedData(data: FundingTypedData & {
+        address: Address;
+        signature: Hex;
+    }): Promise<boolean>;
+}
+interface FundingSource {
+    payer: Address;
+    amount: bigint;
+    authorization?: "signature" | "caller";
+    sigNonce?: bigint;
+    deadline?: bigint;
+    permit?: NonNullable<FundingInput["permit"]>;
+}
+interface PaymentOutput {
+    to: string;
+    amount: bigint;
+}
+interface TransferPreparation {
+    tokenAddress: Address;
+    outputs: readonly PaymentOutput[];
+    funding?: FundingSource;
+    deadline?: bigint;
+    target?: ProofTarget;
+}
+interface WithdrawalPreparation {
+    tokenAddress: Address;
+    to: Address;
+    amount: bigint;
+    deadline?: bigint;
+    target?: ProofTarget;
+}
+interface SweepPreparation {
+    tokenAddress: Address;
+    commitments?: readonly Hex[];
+    deadline?: bigint;
+    target?: ProofTarget;
+}
+interface ShieldPreparation {
+    tokenAddress: Address;
+    outputs: readonly PaymentOutput[];
+    funding: FundingSource;
+    deadline?: bigint;
+}
+interface PreparedOutput {
+    note: Note;
+    commitment: Hex;
+    identity: Hex;
+    delivery: Delivery;
+    address: string;
+    change: boolean;
+}
+interface CreateCreditPreparation {
+    tokenAddress: Address;
+    spender: string;
+    amount: bigint;
+    expiry: bigint;
+    funding?: FundingSource;
+    deadline?: bigint;
+}
+interface DrawCreditPreparation {
+    tokenAddress: Address;
+    credits: readonly {
+        credit: Hex;
+        amount: bigint;
+    }[];
+    deadline?: bigint;
+}
+interface TopUpCreditPreparation {
+    tokenAddress: Address;
+    credit: Hex;
+    additionalAmount: bigint;
+    expiry?: bigint;
+    funding?: FundingSource;
+    deadline?: bigint;
+}
+interface CancelCreditPreparation {
+    tokenAddress: Address;
+    credit: Hex;
+    deadline?: bigint;
+}
+interface PreparedCreditOutput {
+    state: CreditDeliveryState;
+    commitment: Hex;
+    deliveries: [Delivery, Delivery];
+}
+interface PreparedCreditInput extends CreditMembership {
+    commitment: Hex;
+    role: "owner" | "spender";
+}
+interface CreditPlan {
+    inputs: PreparedCreditInput[];
+    outputs: PreparedCreditOutput[];
+    deliveries: Delivery[];
+    creation?: CreateCreditParams;
+    draw?: CreditDrawParams;
+    cancel?: CancelCreditParams;
+    topUp?: TopUpCreditParams;
+    amounts?: bigint[];
+}
+interface OperationPlan {
+    version: 1;
+    id: string;
+    kind: "transfer" | "withdraw" | "sweep" | "shield" | "create-credit" | "draw-credit" | "top-up-credit" | "cancel-credit";
+    context: TransactionContext;
+    scope: WalletScope;
+    preparedAt: CanonicalBlock;
+    deadline: bigint;
+    outputs: PreparedOutput[];
+    inputs: Array<NoteMembership & {
+        commitment: Hex;
+    }>;
+    funding: FundingInput;
+    fundingMode: "none" | "signature" | "caller";
+    params?: TransactRequestParams;
+    shieldParams?: ShieldParams;
+    shieldOutputs?: ShieldOutput[];
+    capacity?: number;
+    credit?: CreditPlan;
+    statement?: _invisi_labs_prover.ProofStatement;
+}
+interface WalletSessionOptions {
+    gasBenchmarks?: readonly GasBenchmarkProfile[];
+    /** Optional ethers gas/funding signer; distinct from the Invisi wallet authority. */
+    signer?: Signer;
+    viewing?: Pick<ViewingCapability, "walletIdentity" | "decryptNote" | "decryptCredit">;
+    wallet: Wallet;
+    protocol: Protocol;
+    namespace?: string;
+    store?: WalletStore;
+    chainReader?: ChainReader;
+    protocolRpc?: ProtocolDataProvider;
+    authorization?: WalletAuthorizationProvider;
+    prover?: Prover;
+    fundingSigner?: FundingSigner;
+    fundingVerifier?: FundingAuthorizationVerifier;
+    addressResolver?: ReceivingKeyLookup;
+    coinSelector?: CoinSelector;
+    transactionTTL?: bigint;
+}
+interface OperationRuntime {
+    options: Omit<WalletSessionOptions, "protocol"> & {
+        protocol: TokenProtocol;
+    };
+    scope: WalletScope;
+    store: WalletStore;
+    reader: ChainReader;
+    authorization: () => WalletAuthorizationProvider;
+}
+interface OperationAggregateMember extends AggregateMember {
+    context: TransactionContext;
+    request: TransactRequest;
+}
+
+interface GasBenchmarkShape {
+    kind: OperationPlan["kind"];
+    target: string;
+    capacity: number;
+    noteInputs: number;
+    noteOutputs: number;
+    sourceTrees: number;
+    creditInputs: number;
+    creditOutputs: number;
+    creditRemainders: number;
+    funding: "none" | "caller" | "signature";
+    permit: boolean;
+    deliveryBytes: number;
+}
+interface GasBenchmarkDeployment {
+    chainId: string;
+    protocolAddress: Hex$1;
+    runtimeCodeHash: Hex$1 | null;
+    tokenAddress: Hex$1;
+}
+interface GasBenchmarkCircuit {
+    circuitName: string;
+    target: string;
+    artifactSha256: string;
+    vkSha256: string;
+}
+interface GasBenchmarkSample {
+    gasUsed: string;
+    transactionHash: Hex$1;
+    blockNumber: string;
+    blockHash: Hex$1;
+    calldataBytes: number;
+}
+interface GasBenchmarkProfile {
+    formatVersion: 1;
+    id: string;
+    deployment: GasBenchmarkDeployment;
+    source: {
+        protocolCommit: string;
+        measuredAt: string;
+        chain: string;
+        hardfork: string;
+        token: string;
+        verifier: "real";
+        assumptions: string[];
+    };
+    measurements: Array<{
+        id: string;
+        shape: GasBenchmarkShape;
+        circuit: GasBenchmarkCircuit | null;
+        samples: GasBenchmarkSample[];
+    }>;
+}
+/** Parse a trusted, JSON-compatible benchmark catalog. No network access or publisher authentication. */
+declare function defineGasBenchmarks(input: unknown): GasBenchmarkProfile[];
+/** Pre-proof reference only; ethers must estimate the final transaction independently. */
+interface GasReference {
+    gasUnits: bigint;
+}
+
+export { type CancelCreditPreparation as C, type DrawCreditPreparation as D, type FundingSigner as F, type GasReference as G, type OperationRuntime as O, type ShieldPreparation as S, type TopUpCreditPreparation as T, type WithdrawalPreparation as W, type OperationPlan as a, type OperationAggregateMember as b, type CreateCreditPreparation as c, type SweepPreparation as d, type TransferPreparation as e, type WalletSessionOptions as f, type CoinSelector as g, type FundingAuthorizationVerifier as h, type FundingSource as i, type FundingTypedData as j, type GasBenchmarkCircuit as k, type GasBenchmarkDeployment as l, type GasBenchmarkProfile as m, type GasBenchmarkSample as n, type GasBenchmarkShape as o, defineGasBenchmarks as p };