@zkp2p/contracts-v2 0.3.0 → 0.3.1-rc.1

package/_esm/utils/protocolUtils.js

@@ -1,71 +1,54 @@
 import { ethers } from "ethers";
 import { BigNumber } from "ethers";
-
 const CIRCOM_FIELD = BigNumber.from("21888242871839275222246405745257275088548364400416034343698204186575808495617");
-
-export const getKeccak256Hash = (value: string): string => {
-  // Convert the string to UTF-8 bytes
-  const bytes = ethers.utils.toUtf8Bytes(value);
-
-  // Compute keccak256 hash of the packed bytes
-  return ethers.utils.keccak256(bytes);
-}
-
+export const getKeccak256Hash = (value) => {
+    // Convert the string to UTF-8 bytes
+    const bytes = ethers.utils.toUtf8Bytes(value);
+    // Compute keccak256 hash of the packed bytes
+    return ethers.utils.keccak256(bytes);
+};
 export const Currency = {
-  AED: getKeccak256Hash("AED"),
-  ARS: getKeccak256Hash("ARS"),
-  AUD: getKeccak256Hash("AUD"),
-  CAD: getKeccak256Hash("CAD"),
-  CHF: getKeccak256Hash("CHF"),
-  CNY: getKeccak256Hash("CNY"),
-  CZK: getKeccak256Hash("CZK"),
-  DKK: getKeccak256Hash("DKK"),
-  EUR: getKeccak256Hash("EUR"),
-  GBP: getKeccak256Hash("GBP"),
-  HKD: getKeccak256Hash("HKD"),
-  HUF: getKeccak256Hash("HUF"),
-  IDR: getKeccak256Hash("IDR"),
-  ILS: getKeccak256Hash("ILS"),
-  INR: getKeccak256Hash("INR"),
-  JPY: getKeccak256Hash("JPY"),
-  KES: getKeccak256Hash("KES"),
-  MXN: getKeccak256Hash("MXN"),
-  MYR: getKeccak256Hash("MYR"),
-  NOK: getKeccak256Hash("NOK"),
-  NZD: getKeccak256Hash("NZD"),
-  PHP: getKeccak256Hash("PHP"),
-  PLN: getKeccak256Hash("PLN"),
-  RON: getKeccak256Hash("RON"),
-  SAR: getKeccak256Hash("SAR"),
-  SEK: getKeccak256Hash("SEK"),
-  SGD: getKeccak256Hash("SGD"),
-  THB: getKeccak256Hash("THB"),
-  TRY: getKeccak256Hash("TRY"),
-  USD: getKeccak256Hash("USD"),
-  UGX: getKeccak256Hash("UGX"),
-  VND: getKeccak256Hash("VND"),
-  ZAR: getKeccak256Hash("ZAR"),
-} as const;
-
-
-export const getCurrencyCodeFromHash = (hash: string): string => {
-  return Object.keys(Currency).find(key => Currency[key as keyof typeof Currency] === hash) || "";
-}
-
-export const calculateIntentHash = (
-  orchestrator: string,
-  intentCounter: BigNumber | number,
-): string => {
-
-  const intermediateHash = ethers.utils.solidityKeccak256(
-    ["address", "uint256"],
-    [orchestrator, intentCounter]
-  );
-
-  return ethers.utils.hexZeroPad(BigNumber.from(intermediateHash).mod(CIRCOM_FIELD).toHexString(), 32);
+    AED: getKeccak256Hash("AED"),
+    ARS: getKeccak256Hash("ARS"),
+    AUD: getKeccak256Hash("AUD"),
+    CAD: getKeccak256Hash("CAD"),
+    CHF: getKeccak256Hash("CHF"),
+    CNY: getKeccak256Hash("CNY"),
+    CZK: getKeccak256Hash("CZK"),
+    DKK: getKeccak256Hash("DKK"),
+    EUR: getKeccak256Hash("EUR"),
+    GBP: getKeccak256Hash("GBP"),
+    HKD: getKeccak256Hash("HKD"),
+    HUF: getKeccak256Hash("HUF"),
+    IDR: getKeccak256Hash("IDR"),
+    ILS: getKeccak256Hash("ILS"),
+    INR: getKeccak256Hash("INR"),
+    JPY: getKeccak256Hash("JPY"),
+    KES: getKeccak256Hash("KES"),
+    MXN: getKeccak256Hash("MXN"),
+    MYR: getKeccak256Hash("MYR"),
+    NOK: getKeccak256Hash("NOK"),
+    NZD: getKeccak256Hash("NZD"),
+    PHP: getKeccak256Hash("PHP"),
+    PLN: getKeccak256Hash("PLN"),
+    RON: getKeccak256Hash("RON"),
+    SAR: getKeccak256Hash("SAR"),
+    SEK: getKeccak256Hash("SEK"),
+    SGD: getKeccak256Hash("SGD"),
+    THB: getKeccak256Hash("THB"),
+    TRY: getKeccak256Hash("TRY"),
+    USD: getKeccak256Hash("USD"),
+    UGX: getKeccak256Hash("UGX"),
+    VND: getKeccak256Hash("VND"),
+    ZAR: getKeccak256Hash("ZAR"),
+};
+export const getCurrencyCodeFromHash = (hash) => {
+    return Object.keys(Currency).find(key => Currency[key] === hash) || "";
+};
+export const calculateIntentHash = (orchestrator, intentCounter) => {
+    const intermediateHash = ethers.utils.solidityKeccak256(["address", "uint256"], [orchestrator, intentCounter]);
+    return ethers.utils.hexZeroPad(BigNumber.from(intermediateHash).mod(CIRCOM_FIELD).toHexString(), 32);
+};
+export const calculatePaymentMethodHash = (paymentMethod) => {
+    return ethers.utils.keccak256(ethers.utils.toUtf8Bytes(paymentMethod));
 };
-
-
-export const calculatePaymentMethodHash = (paymentMethod: string): string => {
-  return ethers.utils.keccak256(ethers.utils.toUtf8Bytes(paymentMethod));
-}

package/_esm/utils/riskMath.js

@@ -0,0 +1,60 @@
+/** Exact client-side counterparts of RiskManager's integer formulas. */
+export const RISK_BPS_DENOMINATOR = 10000n;
+export const RISK_SECONDS_PER_HOUR = 3600n;
+export const RISK_EXTENSION_DENOMINATOR = RISK_BPS_DENOMINATOR * RISK_SECONDS_PER_HOUR;
+function integer(value, label) {
+    if (typeof value === "number" && (!Number.isSafeInteger(value) || value < 0)) {
+        throw new RangeError(`${label} must be a non-negative safe integer`);
+    }
+    const parsed = BigInt(value.toString());
+    if (parsed < 0n)
+        throw new RangeError(`${label} must be non-negative`);
+    return parsed;
+}
+function ceilDiv(numerator, denominator) {
+    if (denominator <= 0n)
+        throw new RangeError("denominator must be positive");
+    if (numerator === 0n)
+        return 0n;
+    return ((numerator - 1n) / denominator) + 1n;
+}
+/** ceil(A * s * T / (10_000 * 1 hour)); returns zero when the curve is disabled. */
+export function calculateIntentExtensionCost(intentAmount, extensionTime, extensionPenaltyBpsPerHour) {
+    const amount = integer(intentAmount, "intentAmount");
+    const duration = integer(extensionTime, "extensionTime");
+    const slope = integer(extensionPenaltyBpsPerHour, "extensionPenaltyBpsPerHour");
+    return ceilDiv(amount * slope * duration, RISK_EXTENSION_DENOMINATOR);
+}
+/** Charges elapsed post-expiry time, capped by the exact duration purchased. */
+export function calculateIntentExtensionPenalty(intentAmount, baseIntentExpiry, terminalAt, totalExtensionTime, extensionPenaltyBpsPerHour) {
+    const baseExpiry = integer(baseIntentExpiry, "baseIntentExpiry");
+    const terminal = integer(terminalAt, "terminalAt");
+    const purchasedTime = integer(totalExtensionTime, "totalExtensionTime");
+    if (terminal <= baseExpiry || purchasedTime === 0n)
+        return { penalty: 0n, chargeableTime: 0n };
+    const elapsed = terminal - baseExpiry;
+    const chargeableTime = elapsed < purchasedTime ? elapsed : purchasedTime;
+    return {
+        penalty: calculateIntentExtensionCost(intentAmount, chargeableTime, extensionPenaltyBpsPerHour),
+        chargeableTime,
+    };
+}
+/** Full-gross coverage required at admission; zero when chargebacks are disabled. */
+export function calculateRequiredCoverage(amount, chargebackable) {
+    return chargebackable ? integer(amount, "amount") : 0n;
+}
+/** Maximum chargebackable intent amount that can use existing stake. */
+export function calculateStakeBackedCapacity(freeStake) {
+    return integer(freeStake, "freeStake");
+}
+/** Exact admission mode selected by RiskManager's full-gross policy. */
+export function selectRiskMode(amount, freeStake, chargebackable, deferredPayoutEnabled) {
+    const required = calculateRequiredCoverage(amount, chargebackable);
+    if (!chargebackable)
+        return "UNBONDED";
+    if (integer(freeStake, "freeStake") >= required)
+        return "STAKE_BACKED";
+    if (deferredPayoutEnabled)
+        return "DEFERRED_PAYOUT";
+    throw new RangeError("insufficient collateral and deferred payout is disabled");
+}

package/_types/abis/base/index.d.ts

@@ -0,0 +1,23 @@
+export { default as AcrossBridgeHook } from './AcrossBridgeHook.json';
+export { default as AcrossBridgeHookV2 } from './AcrossBridgeHookV2.json';
+export { default as ChainlinkOracleAdapter } from './ChainlinkOracleAdapter.json';
+export { default as Escrow } from './Escrow.json';
+export { default as EscrowRegistry } from './EscrowRegistry.json';
+export { default as EscrowV2 } from './EscrowV2.json';
+export { default as MultiAttestationVerifier } from './MultiAttestationVerifier.json';
+export { default as NullifierRegistry } from './NullifierRegistry.json';
+export { default as Orchestrator } from './Orchestrator.json';
+export { default as OrchestratorRegistry } from './OrchestratorRegistry.json';
+export { default as OrchestratorV2 } from './OrchestratorV2.json';
+export { default as PaymentVerifierRegistry } from './PaymentVerifierRegistry.json';
+export { default as PostIntentHookRegistry } from './PostIntentHookRegistry.json';
+export { default as ProtocolViewer } from './ProtocolViewer.json';
+export { default as ProtocolViewerV2 } from './ProtocolViewerV2.json';
+export { default as PythOracleAdapter } from './PythOracleAdapter.json';
+export { default as RateManagerV1 } from './RateManagerV1.json';
+export { default as RelayerRegistry } from './RelayerRegistry.json';
+export { default as SignatureGatingPreIntentHook } from './SignatureGatingPreIntentHook.json';
+export { default as SimpleAttestationVerifier } from './SimpleAttestationVerifier.json';
+export { default as UnifiedPaymentVerifier } from './UnifiedPaymentVerifier.json';
+export { default as UnifiedPaymentVerifierV2 } from './UnifiedPaymentVerifierV2.json';
+export { default as WhitelistPreIntentHook } from './WhitelistPreIntentHook.json';

package/_types/abis/baseStaging/index.d.ts

@@ -0,0 +1,37 @@
+export { default as AcrossBridgeHook } from './AcrossBridgeHook.json';
+export { default as AcrossBridgeHookV2 } from './AcrossBridgeHookV2.json';
+export { default as AddressGroupRegistry } from './AddressGroupRegistry.json';
+export { default as BoundedCall } from './BoundedCall.json';
+export { default as ChainlinkOracleAdapter } from './ChainlinkOracleAdapter.json';
+export { default as DeferredPayoutHook } from './DeferredPayoutHook.json';
+export { default as Escrow } from './Escrow.json';
+export { default as EscrowRegistry } from './EscrowRegistry.json';
+export { default as EscrowV2 } from './EscrowV2.json';
+export { default as FeeSettlementLib } from './FeeSettlementLib.json';
+export { default as MultiAttestationVerifier } from './MultiAttestationVerifier.json';
+export { default as NullifierRegistry } from './NullifierRegistry.json';
+export { default as NullifierRegistryV2 } from './NullifierRegistryV2.json';
+export { default as Orchestrator } from './Orchestrator.json';
+export { default as OrchestratorRegistry } from './OrchestratorRegistry.json';
+export { default as OrchestratorV2 } from './OrchestratorV2.json';
+export { default as OrchestratorV3 } from './OrchestratorV3.json';
+export { default as PaymentVerifierRegistry } from './PaymentVerifierRegistry.json';
+export { default as PostIntentHookExecutor } from './PostIntentHookExecutor.json';
+export { default as PostIntentHookRegistry } from './PostIntentHookRegistry.json';
+export { default as ProtocolViewer } from './ProtocolViewer.json';
+export { default as ProtocolViewerV2 } from './ProtocolViewerV2.json';
+export { default as PythOracleAdapter } from './PythOracleAdapter.json';
+export { default as RateManagerV1 } from './RateManagerV1.json';
+export { default as RelayerRegistry } from './RelayerRegistry.json';
+export { default as RiskAttestationVerifier } from './RiskAttestationVerifier.json';
+export { default as RiskManager } from './RiskManager.json';
+export { default as RiskSettlementExecutor } from './RiskSettlementExecutor.json';
+export { default as SignatureGatingPreIntentHook } from './SignatureGatingPreIntentHook.json';
+export { default as SimpleAttestationVerifier } from './SimpleAttestationVerifier.json';
+export { default as StakeVault } from './StakeVault.json';
+export { default as StakeVaultRiskSettlement } from './StakeVaultRiskSettlement.json';
+export { default as UnifiedPaymentVerifier } from './UnifiedPaymentVerifier.json';
+export { default as UnifiedPaymentVerifierV2 } from './UnifiedPaymentVerifierV2.json';
+export { default as UnifiedPaymentVerifierV3 } from './UnifiedPaymentVerifierV3.json';
+export { default as WhitelistPreIntentHook } from './WhitelistPreIntentHook.json';
+export { default as WhitelistPreIntentHookV2 } from './WhitelistPreIntentHookV2.json';

package/_types/abis/baseStaging.d.ts

@@ -2,24 +2,38 @@
 import type { Abi } from 'abitype';
 export declare const AcrossBridgeHook: Abi;
 export declare const AcrossBridgeHookV2: Abi;
+export declare const AddressGroupRegistry: Abi;
+export declare const BoundedCall: Abi;
 export declare const ChainlinkOracleAdapter: Abi;
+export declare const DeferredPayoutHook: Abi;
 export declare const Escrow: Abi;
 export declare const EscrowRegistry: Abi;
 export declare const EscrowV2: Abi;
+export declare const FeeSettlementLib: Abi;
 export declare const MultiAttestationVerifier: Abi;
 export declare const NullifierRegistry: Abi;
+export declare const NullifierRegistryV2: Abi;
 export declare const Orchestrator: Abi;
 export declare const OrchestratorRegistry: Abi;
 export declare const OrchestratorV2: Abi;
+export declare const OrchestratorV3: Abi;
 export declare const PaymentVerifierRegistry: Abi;
+export declare const PostIntentHookExecutor: Abi;
 export declare const PostIntentHookRegistry: Abi;
 export declare const ProtocolViewer: Abi;
 export declare const ProtocolViewerV2: Abi;
 export declare const PythOracleAdapter: Abi;
 export declare const RateManagerV1: Abi;
 export declare const RelayerRegistry: Abi;
+export declare const RiskAttestationVerifier: Abi;
+export declare const RiskManager: Abi;
+export declare const RiskSettlementExecutor: Abi;
 export declare const SignatureGatingPreIntentHook: Abi;
 export declare const SimpleAttestationVerifier: Abi;
+export declare const StakeVault: Abi;
+export declare const StakeVaultRiskSettlement: Abi;
 export declare const UnifiedPaymentVerifier: Abi;
 export declare const UnifiedPaymentVerifierV2: Abi;
+export declare const UnifiedPaymentVerifierV3: Abi;
 export declare const WhitelistPreIntentHook: Abi;
+export declare const WhitelistPreIntentHookV2: Abi;

package/_types/abis/contracts/index.d.ts

@@ -0,0 +1,8 @@
+export { default as RiskManager } from './RiskManager.json';
+export { default as StakeVault } from './StakeVault.json';
+export { default as OrchestratorV3 } from './OrchestratorV3.json';
+export { default as IIntentRiskHook } from './IIntentRiskHook.json';
+export { default as NullifierRegistryV2 } from './NullifierRegistryV2.json';
+export { default as UnifiedPaymentVerifierV3 } from './UnifiedPaymentVerifierV3.json';
+export { default as AddressGroupRegistry } from './AddressGroupRegistry.json';
+export { default as WhitelistPreIntentHookV2 } from './WhitelistPreIntentHookV2.json';

package/_types/abis/contracts.d.ts

@@ -0,0 +1,10 @@
+// Auto-generated TypeScript definitions for contracts ABIs
+import type { Abi } from 'abitype';
+export declare const AddressGroupRegistry: Abi;
+export declare const IIntentRiskHook: Abi;
+export declare const NullifierRegistryV2: Abi;
+export declare const OrchestratorV3: Abi;
+export declare const RiskManager: Abi;
+export declare const StakeVault: Abi;
+export declare const UnifiedPaymentVerifierV3: Abi;
+export declare const WhitelistPreIntentHookV2: Abi;

package/_types/abis/index.d.ts

@@ -0,0 +1,3 @@
+export * as base from './base';
+export * as baseStaging from './baseStaging';
+export * as contracts from './contracts';

package/_types/addresses/index.d.ts

@@ -1,3 +1,2 @@
-// Typed re-exports for address files
-export { default as base } from './base';
-export { default as baseStaging } from './baseStaging';
+export { default as base } from './base.json';
+export { default as baseStaging } from './baseStaging.json';

package/_types/constants/index.d.ts

@@ -1,3 +1,2 @@
-// Typed re-exports for constants
-export { default as base } from './base';
-export { default as baseStaging } from './baseStaging';
+export { default as base } from './base.json';
+export { default as baseStaging } from './baseStaging.json';

package/_types/currencies/index.d.ts

@@ -1,3 +1,3 @@
-// Typed re-exports for currencies
-export type { CurrencyLookups } from './types';
-export { default as currencies } from './currencies';
+import type { CurrencyLookups } from './types';
+export type { CurrencyLookups };
+export { default as currencies } from './currencies.json';

package/_types/oracleFeeds/index.d.ts

@@ -1,3 +1,3 @@
-// Typed re-exports for oracle feeds
-export type { ChainlinkFeed, ChainlinkFeeds } from './types';
-export { default as chainlink } from './chainlink';
+import type { ChainlinkFeed, ChainlinkFeeds } from './types';
+export type { ChainlinkFeed, ChainlinkFeeds };
+export { default as chainlink } from './chainlink.json';

package/_types/paymentMethods/index.d.ts

@@ -1,4 +1,10 @@
-// Typed re-exports for payment methods
-export { default as base } from './base';
-export { default as baseStaging } from './baseStaging';
-export { default as lookups } from './lookups';
+import type { PaymentMethodConfig, NetworkPaymentMethods } from './types';
+export type { PaymentMethodConfig, NetworkPaymentMethods };
+export { default as base } from './base.json';
+export { default as baseStaging } from './baseStaging.json';
+export { default as lookups } from './lookups.json';
+export declare function getPaymentMethodConfig(network: string, paymentMethod: string): PaymentMethodConfig | undefined;
+export declare const paymentMethods: {
+    base: any;
+    baseStaging: any;
+};

package/_types/types/common.d.ts

@@ -0,0 +1,22 @@
+import type { Listener } from "@ethersproject/providers";
+import type { Event, EventFilter } from "ethers";
+export interface TypedEvent<TArgsArray extends Array<any> = any, TArgsObject = any> extends Event {
+    args: TArgsArray & TArgsObject;
+}
+export interface TypedEventFilter<_TEvent extends TypedEvent> extends EventFilter {
+}
+export interface TypedListener<TEvent extends TypedEvent> {
+    (...listenerArg: [...__TypechainArgsArray<TEvent>, TEvent]): void;
+}
+type __TypechainArgsArray<T> = T extends TypedEvent<infer U> ? U : never;
+export interface OnEvent<TRes> {
+    <TEvent extends TypedEvent>(eventFilter: TypedEventFilter<TEvent>, listener: TypedListener<TEvent>): TRes;
+    (eventName: string, listener: Listener): TRes;
+}
+export type MinEthersFactory<C, ARGS> = {
+    deploy(...a: ARGS[]): Promise<C>;
+};
+export type GetContractTypeFromFactory<F> = F extends MinEthersFactory<infer C, any> ? C : never;
+export type GetARGsTypeFromFactory<F> = F extends MinEthersFactory<any, any> ? Parameters<F["deploy"]> : never;
+export type PromiseOrValue<T> = T | Promise<T>;
+export {};