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

package/utils/riskMath.d.ts

@@ -0,0 +1,30 @@
+/** Exact client-side counterparts of RiskManager's integer formulas. */
+export type IntegerLike = bigint | number | string | {
+    toString(): string;
+};
+export interface IntentExtensionTerms {
+    extensionPenaltyBpsPerHour: IntegerLike;
+}
+export interface RiskCapacity {
+    /** null means chargeback coverage is disabled and admission is unbounded by stake. */
+    chargebackCapacity: bigint | null;
+    /** Admission capacity equals chargeback capacity; extensions are funded only when purchased. */
+    totalTakingCapacity: bigint | null;
+}
+export interface IntentExtensionPenalty {
+    penalty: bigint;
+    chargeableTime: bigint;
+}
+export declare const RISK_BPS_DENOMINATOR = 10000n;
+export declare const RISK_SECONDS_PER_HOUR = 3600n;
+export declare const RISK_EXTENSION_DENOMINATOR: bigint;
+/** ceil(A * s * T / (10_000 * 1 hour)); returns zero when the curve is disabled. */
+export declare function calculateIntentExtensionCost(intentAmount: IntegerLike, extensionTime: IntegerLike, extensionPenaltyBpsPerHour: IntegerLike): bigint;
+/** Charges elapsed post-expiry time, capped by the exact duration purchased. */
+export declare function calculateIntentExtensionPenalty(intentAmount: IntegerLike, baseIntentExpiry: IntegerLike, terminalAt: IntegerLike, totalExtensionTime: IntegerLike, extensionPenaltyBpsPerHour: IntegerLike): IntentExtensionPenalty;
+/** ceil(A * r / 10_000); returns zero when chargeback coverage is disabled. */
+export declare function calculateChargebackReserve(amount: IntegerLike, reserveBps: IntegerLike): bigint;
+/** Admission reserves chargeback coverage only; extension collateral is added when time is purchased. */
+export declare function calculateRequiredReservation(amount: IntegerLike, reserveBps: IntegerLike): bigint;
+/** Inverts the exact rounded admission reserve. A null capacity is unbounded. */
+export declare function calculateTakingCapacity(freeStake: IntegerLike, reserveBps: IntegerLike): RiskCapacity;

package/utils/riskMath.ts

@@ -0,0 +1,103 @@
+/** Exact client-side counterparts of RiskManager's integer formulas. */
+
+export type IntegerLike = bigint | number | string | { toString(): string };
+
+export interface IntentExtensionTerms {
+  extensionPenaltyBpsPerHour: IntegerLike;
+}
+
+export interface RiskCapacity {
+  /** null means chargeback coverage is disabled and admission is unbounded by stake. */
+  chargebackCapacity: bigint | null;
+  /** Admission capacity equals chargeback capacity; extensions are funded only when purchased. */
+  totalTakingCapacity: bigint | null;
+}
+
+export interface IntentExtensionPenalty {
+  penalty: bigint;
+  chargeableTime: bigint;
+}
+
+export const RISK_BPS_DENOMINATOR = 10_000n;
+export const RISK_SECONDS_PER_HOUR = 3_600n;
+export const RISK_EXTENSION_DENOMINATOR = RISK_BPS_DENOMINATOR * RISK_SECONDS_PER_HOUR;
+
+function integer(value: IntegerLike, label: string): bigint {
+  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: bigint, denominator: bigint): bigint {
+  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: IntegerLike,
+  extensionTime: IntegerLike,
+  extensionPenaltyBpsPerHour: IntegerLike,
+): bigint {
+  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: IntegerLike,
+  baseIntentExpiry: IntegerLike,
+  terminalAt: IntegerLike,
+  totalExtensionTime: IntegerLike,
+  extensionPenaltyBpsPerHour: IntegerLike,
+): IntentExtensionPenalty {
+  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,
+  };
+}
+
+/** ceil(A * r / 10_000); returns zero when chargeback coverage is disabled. */
+export function calculateChargebackReserve(amount: IntegerLike, reserveBps: IntegerLike): bigint {
+  const intentAmount = integer(amount, "amount");
+  const reserveRatio = integer(reserveBps, "reserveBps");
+  if (reserveRatio > RISK_BPS_DENOMINATOR) throw new RangeError("reserveBps cannot exceed 10,000");
+  return ceilDiv(intentAmount * reserveRatio, RISK_BPS_DENOMINATOR);
+}
+
+/** Admission reserves chargeback coverage only; extension collateral is added when time is purchased. */
+export function calculateRequiredReservation(amount: IntegerLike, reserveBps: IntegerLike): bigint {
+  return calculateChargebackReserve(amount, reserveBps);
+}
+
+/** Inverts the exact rounded admission reserve. A null capacity is unbounded. */
+export function calculateTakingCapacity(
+  freeStake: IntegerLike,
+  reserveBps: IntegerLike,
+): RiskCapacity {
+  const available = integer(freeStake, "freeStake");
+  const reserveRatio = integer(reserveBps, "reserveBps");
+  if (reserveRatio > RISK_BPS_DENOMINATOR) throw new RangeError("reserveBps cannot exceed 10,000");
+
+  const chargebackCapacity = reserveRatio === 0n
+    ? null
+    : (available * RISK_BPS_DENOMINATOR) / reserveRatio;
+  return { chargebackCapacity, totalTakingCapacity: chargebackCapacity };
+}

package/_cjs/types/contracts/hooks/DeferredPayoutHook.js

@@ -1,288 +0,0 @@
-/* Autogenerated file. Do not edit manually. */
-/* tslint:disable */
-/* eslint-disable */
-import type {
-  BaseContract,
-  BigNumber,
-  BigNumberish,
-  BytesLike,
-  CallOverrides,
-  ContractTransaction,
-  Overrides,
-  PopulatedTransaction,
-  Signer,
-  utils,
-} from "ethers";
-import type {
-  FunctionFragment,
-  Result,
-  EventFragment,
-} from "@ethersproject/abi";
-import type { Listener, Provider } from "@ethersproject/providers";
-import type {
-  TypedEventFilter,
-  TypedEvent,
-  TypedListener,
-  OnEvent,
-  PromiseOrValue,
-} from "../../common";
-
-export declare namespace IPostIntentHookV2 {
-  export type HookIntentContextStruct = {
-    owner: PromiseOrValue<string>;
-    to: PromiseOrValue<string>;
-    escrow: PromiseOrValue<string>;
-    depositId: PromiseOrValue<BigNumberish>;
-    amount: PromiseOrValue<BigNumberish>;
-    timestamp: PromiseOrValue<BigNumberish>;
-    paymentMethod: PromiseOrValue<BytesLike>;
-    fiatCurrency: PromiseOrValue<BytesLike>;
-    conversionRate: PromiseOrValue<BigNumberish>;
-    payeeId: PromiseOrValue<BytesLike>;
-    signalHookData: PromiseOrValue<BytesLike>;
-  };
-
-  export type HookIntentContextStructOutput = [
-    string,
-    string,
-    string,
-    BigNumber,
-    BigNumber,
-    BigNumber,
-    string,
-    string,
-    BigNumber,
-    string,
-    string
-  ] & {
-    owner: string;
-    to: string;
-    escrow: string;
-    depositId: BigNumber;
-    amount: BigNumber;
-    timestamp: BigNumber;
-    paymentMethod: string;
-    fiatCurrency: string;
-    conversionRate: BigNumber;
-    payeeId: string;
-    signalHookData: string;
-  };
-
-  export type HookExecutionContextStruct = {
-    intentHash: PromiseOrValue<BytesLike>;
-    token: PromiseOrValue<string>;
-    executableAmount: PromiseOrValue<BigNumberish>;
-    intent: IPostIntentHookV2.HookIntentContextStruct;
-  };
-
-  export type HookExecutionContextStructOutput = [
-    string,
-    string,
-    BigNumber,
-    IPostIntentHookV2.HookIntentContextStructOutput
-  ] & {
-    intentHash: string;
-    token: string;
-    executableAmount: BigNumber;
-    intent: IPostIntentHookV2.HookIntentContextStructOutput;
-  };
-}
-
-export interface DeferredPayoutHookInterface extends utils.Interface {
-  functions: {
-    "execute((bytes32,address,uint256,(address,address,address,uint256,uint256,uint256,bytes32,bytes32,uint256,bytes32,bytes)),bytes)": FunctionFragment;
-    "orchestratorRegistry()": FunctionFragment;
-    "payoutToken()": FunctionFragment;
-    "riskTierManager()": FunctionFragment;
-    "stakeVault()": FunctionFragment;
-  };
-
-  getFunction(
-    nameOrSignatureOrTopic:
-      | "execute"
-      | "orchestratorRegistry"
-      | "payoutToken"
-      | "riskTierManager"
-      | "stakeVault"
-  ): FunctionFragment;
-
-  encodeFunctionData(
-    functionFragment: "execute",
-    values: [
-      IPostIntentHookV2.HookExecutionContextStruct,
-      PromiseOrValue<BytesLike>
-    ]
-  ): string;
-  encodeFunctionData(
-    functionFragment: "orchestratorRegistry",
-    values?: undefined
-  ): string;
-  encodeFunctionData(
-    functionFragment: "payoutToken",
-    values?: undefined
-  ): string;
-  encodeFunctionData(
-    functionFragment: "riskTierManager",
-    values?: undefined
-  ): string;
-  encodeFunctionData(
-    functionFragment: "stakeVault",
-    values?: undefined
-  ): string;
-
-  decodeFunctionResult(functionFragment: "execute", data: BytesLike): Result;
-  decodeFunctionResult(
-    functionFragment: "orchestratorRegistry",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "payoutToken",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(
-    functionFragment: "riskTierManager",
-    data: BytesLike
-  ): Result;
-  decodeFunctionResult(functionFragment: "stakeVault", data: BytesLike): Result;
-
-  events: {
-    "PayoutDeferred(bytes32,address,address,uint256)": EventFragment;
-  };
-
-  getEvent(nameOrSignatureOrTopic: "PayoutDeferred"): EventFragment;
-}
-
-export interface PayoutDeferredEventObject {
-  intentHash: string;
-  beneficiary: string;
-  vault: string;
-  amount: BigNumber;
-}
-export type PayoutDeferredEvent = TypedEvent<
-  [string, string, string, BigNumber],
-  PayoutDeferredEventObject
->;
-
-export type PayoutDeferredEventFilter = TypedEventFilter<PayoutDeferredEvent>;
-
-export interface DeferredPayoutHook extends BaseContract {
-  connect(signerOrProvider: Signer | Provider | string): this;
-  attach(addressOrName: string): this;
-  deployed(): Promise<this>;
-
-  interface: DeferredPayoutHookInterface;
-
-  queryFilter<TEvent extends TypedEvent>(
-    event: TypedEventFilter<TEvent>,
-    fromBlockOrBlockhash?: string | number | undefined,
-    toBlock?: string | number | undefined
-  ): Promise<Array<TEvent>>;
-
-  listeners<TEvent extends TypedEvent>(
-    eventFilter?: TypedEventFilter<TEvent>
-  ): Array<TypedListener<TEvent>>;
-  listeners(eventName?: string): Array<Listener>;
-  removeAllListeners<TEvent extends TypedEvent>(
-    eventFilter: TypedEventFilter<TEvent>
-  ): this;
-  removeAllListeners(eventName?: string): this;
-  off: OnEvent<this>;
-  on: OnEvent<this>;
-  once: OnEvent<this>;
-  removeListener: OnEvent<this>;
-
-  functions: {
-    execute(
-      _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-      arg1: PromiseOrValue<BytesLike>,
-      overrides?: Overrides & { from?: PromiseOrValue<string> }
-    ): Promise<ContractTransaction>;
-
-    orchestratorRegistry(overrides?: CallOverrides): Promise<[string]>;
-
-    payoutToken(overrides?: CallOverrides): Promise<[string]>;
-
-    riskTierManager(overrides?: CallOverrides): Promise<[string]>;
-
-    stakeVault(overrides?: CallOverrides): Promise<[string]>;
-  };
-
-  execute(
-    _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-    arg1: PromiseOrValue<BytesLike>,
-    overrides?: Overrides & { from?: PromiseOrValue<string> }
-  ): Promise<ContractTransaction>;
-
-  orchestratorRegistry(overrides?: CallOverrides): Promise<string>;
-
-  payoutToken(overrides?: CallOverrides): Promise<string>;
-
-  riskTierManager(overrides?: CallOverrides): Promise<string>;
-
-  stakeVault(overrides?: CallOverrides): Promise<string>;
-
-  callStatic: {
-    execute(
-      _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-      arg1: PromiseOrValue<BytesLike>,
-      overrides?: CallOverrides
-    ): Promise<void>;
-
-    orchestratorRegistry(overrides?: CallOverrides): Promise<string>;
-
-    payoutToken(overrides?: CallOverrides): Promise<string>;
-
-    riskTierManager(overrides?: CallOverrides): Promise<string>;
-
-    stakeVault(overrides?: CallOverrides): Promise<string>;
-  };
-
-  filters: {
-    "PayoutDeferred(bytes32,address,address,uint256)"(
-      intentHash?: PromiseOrValue<BytesLike> | null,
-      beneficiary?: PromiseOrValue<string> | null,
-      vault?: PromiseOrValue<string> | null,
-      amount?: null
-    ): PayoutDeferredEventFilter;
-    PayoutDeferred(
-      intentHash?: PromiseOrValue<BytesLike> | null,
-      beneficiary?: PromiseOrValue<string> | null,
-      vault?: PromiseOrValue<string> | null,
-      amount?: null
-    ): PayoutDeferredEventFilter;
-  };
-
-  estimateGas: {
-    execute(
-      _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-      arg1: PromiseOrValue<BytesLike>,
-      overrides?: Overrides & { from?: PromiseOrValue<string> }
-    ): Promise<BigNumber>;
-
-    orchestratorRegistry(overrides?: CallOverrides): Promise<BigNumber>;
-
-    payoutToken(overrides?: CallOverrides): Promise<BigNumber>;
-
-    riskTierManager(overrides?: CallOverrides): Promise<BigNumber>;
-
-    stakeVault(overrides?: CallOverrides): Promise<BigNumber>;
-  };
-
-  populateTransaction: {
-    execute(
-      _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-      arg1: PromiseOrValue<BytesLike>,
-      overrides?: Overrides & { from?: PromiseOrValue<string> }
-    ): Promise<PopulatedTransaction>;
-
-    orchestratorRegistry(
-      overrides?: CallOverrides
-    ): Promise<PopulatedTransaction>;
-
-    payoutToken(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    riskTierManager(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-
-    stakeVault(overrides?: CallOverrides): Promise<PopulatedTransaction>;
-  };
-}

package/_cjs/types/contracts/interfaces/IDeferredPayoutHook.js

@@ -1,206 +0,0 @@
-/* Autogenerated file. Do not edit manually. */
-/* tslint:disable */
-/* eslint-disable */
-import type {
-  BaseContract,
-  BigNumber,
-  BigNumberish,
-  BytesLike,
-  CallOverrides,
-  ContractTransaction,
-  Overrides,
-  PopulatedTransaction,
-  Signer,
-  utils,
-} from "ethers";
-import type {
-  FunctionFragment,
-  Result,
-  EventFragment,
-} from "@ethersproject/abi";
-import type { Listener, Provider } from "@ethersproject/providers";
-import type {
-  TypedEventFilter,
-  TypedEvent,
-  TypedListener,
-  OnEvent,
-  PromiseOrValue,
-} from "../../common";
-
-export declare namespace IPostIntentHookV2 {
-  export type HookIntentContextStruct = {
-    owner: PromiseOrValue<string>;
-    to: PromiseOrValue<string>;
-    escrow: PromiseOrValue<string>;
-    depositId: PromiseOrValue<BigNumberish>;
-    amount: PromiseOrValue<BigNumberish>;
-    timestamp: PromiseOrValue<BigNumberish>;
-    paymentMethod: PromiseOrValue<BytesLike>;
-    fiatCurrency: PromiseOrValue<BytesLike>;
-    conversionRate: PromiseOrValue<BigNumberish>;
-    payeeId: PromiseOrValue<BytesLike>;
-    signalHookData: PromiseOrValue<BytesLike>;
-  };
-
-  export type HookIntentContextStructOutput = [
-    string,
-    string,
-    string,
-    BigNumber,
-    BigNumber,
-    BigNumber,
-    string,
-    string,
-    BigNumber,
-    string,
-    string
-  ] & {
-    owner: string;
-    to: string;
-    escrow: string;
-    depositId: BigNumber;
-    amount: BigNumber;
-    timestamp: BigNumber;
-    paymentMethod: string;
-    fiatCurrency: string;
-    conversionRate: BigNumber;
-    payeeId: string;
-    signalHookData: string;
-  };
-
-  export type HookExecutionContextStruct = {
-    intentHash: PromiseOrValue<BytesLike>;
-    token: PromiseOrValue<string>;
-    executableAmount: PromiseOrValue<BigNumberish>;
-    intent: IPostIntentHookV2.HookIntentContextStruct;
-  };
-
-  export type HookExecutionContextStructOutput = [
-    string,
-    string,
-    BigNumber,
-    IPostIntentHookV2.HookIntentContextStructOutput
-  ] & {
-    intentHash: string;
-    token: string;
-    executableAmount: BigNumber;
-    intent: IPostIntentHookV2.HookIntentContextStructOutput;
-  };
-}
-
-export interface IDeferredPayoutHookInterface extends utils.Interface {
-  functions: {
-    "execute((bytes32,address,uint256,(address,address,address,uint256,uint256,uint256,bytes32,bytes32,uint256,bytes32,bytes)),bytes)": FunctionFragment;
-  };
-
-  getFunction(nameOrSignatureOrTopic: "execute"): FunctionFragment;
-
-  encodeFunctionData(
-    functionFragment: "execute",
-    values: [
-      IPostIntentHookV2.HookExecutionContextStruct,
-      PromiseOrValue<BytesLike>
-    ]
-  ): string;
-
-  decodeFunctionResult(functionFragment: "execute", data: BytesLike): Result;
-
-  events: {
-    "PayoutDeferred(bytes32,address,address,uint256)": EventFragment;
-  };
-
-  getEvent(nameOrSignatureOrTopic: "PayoutDeferred"): EventFragment;
-}
-
-export interface PayoutDeferredEventObject {
-  intentHash: string;
-  beneficiary: string;
-  vault: string;
-  amount: BigNumber;
-}
-export type PayoutDeferredEvent = TypedEvent<
-  [string, string, string, BigNumber],
-  PayoutDeferredEventObject
->;
-
-export type PayoutDeferredEventFilter = TypedEventFilter<PayoutDeferredEvent>;
-
-export interface IDeferredPayoutHook extends BaseContract {
-  connect(signerOrProvider: Signer | Provider | string): this;
-  attach(addressOrName: string): this;
-  deployed(): Promise<this>;
-
-  interface: IDeferredPayoutHookInterface;
-
-  queryFilter<TEvent extends TypedEvent>(
-    event: TypedEventFilter<TEvent>,
-    fromBlockOrBlockhash?: string | number | undefined,
-    toBlock?: string | number | undefined
-  ): Promise<Array<TEvent>>;
-
-  listeners<TEvent extends TypedEvent>(
-    eventFilter?: TypedEventFilter<TEvent>
-  ): Array<TypedListener<TEvent>>;
-  listeners(eventName?: string): Array<Listener>;
-  removeAllListeners<TEvent extends TypedEvent>(
-    eventFilter: TypedEventFilter<TEvent>
-  ): this;
-  removeAllListeners(eventName?: string): this;
-  off: OnEvent<this>;
-  on: OnEvent<this>;
-  once: OnEvent<this>;
-  removeListener: OnEvent<this>;
-
-  functions: {
-    execute(
-      _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-      _fulfillHookData: PromiseOrValue<BytesLike>,
-      overrides?: Overrides & { from?: PromiseOrValue<string> }
-    ): Promise<ContractTransaction>;
-  };
-
-  execute(
-    _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-    _fulfillHookData: PromiseOrValue<BytesLike>,
-    overrides?: Overrides & { from?: PromiseOrValue<string> }
-  ): Promise<ContractTransaction>;
-
-  callStatic: {
-    execute(
-      _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-      _fulfillHookData: PromiseOrValue<BytesLike>,
-      overrides?: CallOverrides
-    ): Promise<void>;
-  };
-
-  filters: {
-    "PayoutDeferred(bytes32,address,address,uint256)"(
-      intentHash?: PromiseOrValue<BytesLike> | null,
-      beneficiary?: PromiseOrValue<string> | null,
-      vault?: PromiseOrValue<string> | null,
-      amount?: null
-    ): PayoutDeferredEventFilter;
-    PayoutDeferred(
-      intentHash?: PromiseOrValue<BytesLike> | null,
-      beneficiary?: PromiseOrValue<string> | null,
-      vault?: PromiseOrValue<string> | null,
-      amount?: null
-    ): PayoutDeferredEventFilter;
-  };
-
-  estimateGas: {
-    execute(
-      _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-      _fulfillHookData: PromiseOrValue<BytesLike>,
-      overrides?: Overrides & { from?: PromiseOrValue<string> }
-    ): Promise<BigNumber>;
-  };
-
-  populateTransaction: {
-    execute(
-      _ctx: IPostIntentHookV2.HookExecutionContextStruct,
-      _fulfillHookData: PromiseOrValue<BytesLike>,
-      overrides?: Overrides & { from?: PromiseOrValue<string> }
-    ): Promise<PopulatedTransaction>;
-  };
-}