@provex/utils 1.0.16 → 1.2.4

package/dist/src/deposit.d.ts

@@ -1 +0,0 @@
-export type StatusMutatingAction = "deposit" | "withdrawal" | "closed" | "exchange";

package/dist/src/events.d.ts

@@ -1,3 +0,0 @@
-export declare const eventOrder: readonly ["deposit", "verifier_added", "currency_added", "rate_update", "intent", "exchange", "pruned", "withdrawal", "closed"];
-export type EventType = (typeof eventOrder)[number];
-export declare const eventOrderId: Map<"deposit" | "withdrawal" | "closed" | "exchange" | "verifier_added" | "currency_added" | "rate_update" | "intent" | "pruned", number>;

package/dist/src/events.js

@@ -1,16 +0,0 @@
-export const eventOrder = [
-    // deposit open events
-    'deposit',
-    'verifier_added',
-    'currency_added',
-    // configuration events
-    'rate_update',
-    // intent events
-    'intent',
-    'exchange',
-    'pruned',
-    // deposit close events
-    'withdrawal',
-    'closed',
-];
-export const eventOrderId = new Map(eventOrder.map((event, index) => [event, index]));

package/dist/src/ids.d.ts

@@ -1,72 +0,0 @@
-import { type Hex } from "viem";
-import { type EventType } from "./events.js";
-import { type TimeResolutionKey } from "./time.js";
-import type { StatAction } from "./stats.js";
-export type DepositVerifierInputs = {
-    verifier: Hex;
-    depositId: Hex;
-};
-export type DepositCurrencyInputs = DepositVerifierInputs & {
-    currency: Hex;
-};
-export type ConversionRateUpdatedInputs = DepositCurrencyInputs & {
-    changeId: number;
-};
-export type ProviderHashInputs = {
-    chainId: bigint | number;
-    hash: Hex;
-};
-export type OnChainHashInputs = {
-    chainId: bigint | number;
-    hash: Hex;
-};
-export type OnChainAddressInputs = {
-    chainId: bigint | number;
-    address: Hex;
-};
-export declare const onChainHash: ({ chainId, hash }: OnChainHashInputs) => `0x${string}`;
-export declare const onChainAddress: ({ chainId, address }: OnChainAddressInputs) => `0x${string}`;
-export declare const ids: {
-    block: ({ chainId, hash }: OnChainHashInputs) => `0x${string}`;
-    transaction: ({ chainId, hash }: OnChainHashInputs) => `0x${string}`;
-    participant: ({ chainId, address }: OnChainAddressInputs) => `0x${string}`;
-    providerHash: ({ chainId, hash }: OnChainHashInputs) => `0x${string}`;
-    verifier: ({ chainId, address }: OnChainAddressInputs) => `0x${string}`;
-    depositVerifierAdded: ({ depositId, verifier }: DepositVerifierInputs) => `0x${string}`;
-    depositCurrencyAdded: ({ depositId, currency, verifier }: DepositCurrencyInputs) => `0x${string}`;
-    depositConversionRateUpdated: ({ currency, verifier, depositId, changeId }: ConversionRateUpdatedInputs) => `0x${string}`;
-};
-export type OrderIdInputs = {
-    timestamp: bigint;
-    chainId: bigint;
-};
-export type OrderIdTransactionInputs = OrderIdInputs & {
-    transactionIndex: bigint;
-};
-export type OrderIdLogInputs = OrderIdTransactionInputs & {
-    logIndex: bigint;
-};
-export type OrderIdOrderInputs = OrderIdLogInputs & {
-    name: EventType;
-};
-export type DepositIdInputs = {
-    chainId: bigint | number;
-    depositId: bigint | number;
-};
-export type LogStatsIdInputs = {
-    timestamp: bigint;
-    type: TimeResolutionKey;
-    action: StatAction;
-    currency: Hex | null;
-    token: Hex;
-    verifier: Hex;
-    chainId: bigint | number;
-};
-export declare const orderId: {
-    deposit: ({ chainId, depositId }: DepositIdInputs) => `0x${string}`;
-    block: ({ timestamp, chainId }: OrderIdInputs) => `0x${string}`;
-    transaction: ({ timestamp, chainId, transactionIndex }: OrderIdTransactionInputs) => `0x${string}`;
-    log: ({ timestamp, chainId, transactionIndex, logIndex }: OrderIdLogInputs) => `0x${string}`;
-    order: ({ timestamp, chainId, transactionIndex, logIndex, name }: OrderIdOrderInputs) => `0x${string}`;
-    stat: ({ timestamp, type, action, currency, verifier, token, chainId }: LogStatsIdInputs) => `0x${string}`;
-};

package/dist/src/ids.js

@@ -1,81 +0,0 @@
-import { concatHex, keccak256, numberToHex, stringToHex } from "viem";
-import { eventOrderId } from "./events.js";
-import { interval } from "./time.js";
-export const onChainHash = ({ chainId, hash }) => (keccak256(concatHex([
-    numberToHex(chainId, { size: 8 }),
-    hash,
-])));
-export const onChainAddress = ({ chainId, address }) => (onChainHash({ chainId, hash: address }));
-export const ids = {
-    block: onChainHash,
-    transaction: onChainHash,
-    participant: onChainAddress,
-    providerHash: onChainHash,
-    verifier: onChainAddress,
-    depositVerifierAdded: ({ depositId, verifier }) => {
-        return keccak256(concatHex([depositId, verifier]));
-    },
-    depositCurrencyAdded: ({ depositId, currency, verifier }) => {
-        return keccak256(concatHex([
-            ids.depositVerifierAdded({ verifier, depositId }),
-            currency,
-        ]));
-    },
-    depositConversionRateUpdated: ({ currency, verifier, depositId, changeId }) => {
-        return concatHex([
-            ids.depositCurrencyAdded({ currency, verifier, depositId }),
-            numberToHex(changeId, { size: 4 }),
-        ]);
-    },
-};
-const hourFactor = BigInt(interval.hour) / BigInt(interval.second);
-const dayFactor = BigInt(interval.day) / BigInt(interval.second);
-const monthFactor = BigInt(interval.month) / BigInt(interval.second);
-export const orderId = {
-    deposit: ({ chainId, depositId }) => concatHex([
-        numberToHex(depositId, { size: 8 }),
-        numberToHex(chainId, { size: 4 }),
-    ]),
-    block: ({ timestamp, chainId }) => concatHex([
-        numberToHex(timestamp, { size: 8 }),
-        numberToHex(chainId, { size: 4 }),
-    ]),
-    transaction: ({ timestamp, chainId, transactionIndex }) => concatHex([
-        numberToHex(timestamp, { size: 8 }),
-        numberToHex(transactionIndex, { size: 4 }),
-        numberToHex(chainId, { size: 4 }),
-    ]),
-    log: ({ timestamp, chainId, transactionIndex, logIndex }) => concatHex([
-        numberToHex(timestamp, { size: 8 }),
-        numberToHex(transactionIndex, { size: 4 }),
-        numberToHex(logIndex, { size: 4 }),
-        numberToHex(chainId, { size: 4 }),
-    ]),
-    order: ({ timestamp, chainId, transactionIndex, logIndex, name }) => concatHex([
-        numberToHex(timestamp, { size: 8 }),
-        numberToHex(transactionIndex, { size: 4 }),
-        numberToHex(eventOrderId.get(name), { size: 1 }),
-        numberToHex(logIndex, { size: 4 }),
-        numberToHex(chainId, { size: 4 }),
-    ]),
-    stat: ({ timestamp, type, action, currency, verifier, token, chainId }) => {
-        const hour = (timestamp / hourFactor) * hourFactor;
-        const day = (timestamp / dayFactor) * dayFactor;
-        const month = (timestamp / monthFactor) * monthFactor;
-        let time = timestamp;
-        if (type === "hour") {
-            time = hour;
-        }
-        if (type === "day") {
-            time = day;
-        }
-        if (type === "month") {
-            time = month;
-        }
-        return concatHex([
-            numberToHex(time, { size: 8 }),
-            `0x${keccak256(concatHex([stringToHex(type), stringToHex(action), token, currency ?? '0x', verifier])).slice(26)}`,
-            numberToHex(chainId, { size: 4 }),
-        ]);
-    },
-};

package/dist/src/index.d.ts

@@ -1,16 +0,0 @@
-export * from './currencies.js';
-export * from './units.js';
-export * from './contracts.js';
-export * from './participants.js';
-export * from './chain.js';
-export * from './intent.js';
-export * from './conversionRates.js';
-export * from './payment.js';
-export * from './sort.js';
-export * from './time.js';
-export * from './tokens.js';
-export * from './stats.js';
-export * from './deposit.js';
-export * from './ids.js';
-export * from './events.js';
-export * from './zkp2p-types.js';

package/dist/src/index.js

@@ -1,16 +0,0 @@
-export * from './currencies.js';
-export * from './units.js';
-export * from './contracts.js';
-export * from './participants.js';
-export * from './chain.js';
-export * from './intent.js';
-export * from './conversionRates.js';
-export * from './payment.js';
-export * from './sort.js';
-export * from './time.js';
-export * from './tokens.js';
-export * from './stats.js';
-export * from './deposit.js';
-export * from './ids.js';
-export * from './events.js';
-export * from './zkp2p-types.js';

package/dist/src/input.d.ts

@@ -1,7 +0,0 @@
-/**
- * Adjust the lowest decimal place directly on the string, preserving all trailing zeros
- * @param inputVal - The input value
- * @param direction - The direction to adjust the decimal place
- * @returns The adjusted value
- */
-export declare const adjustLowestDecimal: (inputVal: string, direction: 1 | -1) => string;

package/dist/src/intent.d.ts

@@ -1,14 +0,0 @@
-import type { Hex } from "viem";
-/**
- * Structure for an intent
- */
-export interface IntentStruct {
-    owner: Hex;
-    to: Hex;
-    depositId: bigint;
-    amount: bigint;
-    timestamp: bigint;
-    paymentVerifier: Hex;
-    fiatCurrency: Hex;
-    conversionRate: bigint;
-}

package/dist/src/json.d.ts

@@ -1,18 +0,0 @@
-/**
- * JSON serializer
- */
-export declare const jsonSerializer: {
-    /**
-     * Parse a JSON string
-     * @param str - The JSON string to parse
-     * @returns The parsed object
-     */
-    parse: (text: string, reviver?: (this: any, key: string, value: any) => any) => any;
-    /**
-     * Stringify an object
-     * @param obj - The object to stringify
-     * @returns The stringified object
-     */
-    stringify: (obj: unknown) => string;
-};
-export declare function mapBigIntFields<T>(obj: T, fields: string[]): T;

package/dist/src/json.js

@@ -1,44 +0,0 @@
-/**
- * JSON serializer
- */
-export const jsonSerializer = {
-    /**
-     * Parse a JSON string
-     * @param str - The JSON string to parse
-     * @returns The parsed object
-     */
-    parse: JSON.parse,
-    /**
-     * Stringify an object
-     * @param obj - The object to stringify
-     * @returns The stringified object
-     */
-    stringify: (obj) => JSON.stringify(obj, (_key, value) => {
-        if (typeof value === 'bigint') {
-            return value.toString();
-        }
-        return value;
-    })
-};
-// Recursively convert specified fields to BigInt in an object or array
-export function mapBigIntFields(obj, fields) {
-    if (Array.isArray(obj)) {
-        return obj.map(item => mapBigIntFields(item, fields));
-    }
-    if (obj && typeof obj === 'object') {
-        const result = {};
-        for (const [key, value] of Object.entries(obj)) {
-            if (fields.includes(key) && typeof value === 'string' && value.match(/^-?\d+$/)) {
-                result[key] = BigInt(value);
-            }
-            else if (Array.isArray(value) || (value && typeof value === 'object')) {
-                result[key] = mapBigIntFields(value, fields);
-            }
-            else {
-                result[key] = value;
-            }
-        }
-        return result;
-    }
-    return obj;
-}

package/dist/src/participants.d.ts

@@ -1,7 +0,0 @@
-/**
- * Generate a participantId from chainId and address using the same logic as the indexer
- * @param chainId - The chain ID
- * @param address - The address
- * @returns The participant ID
- */
-export declare function generateParticipantId(chainId: number | bigint, address: string): string;

package/dist/src/participants.js

@@ -1,13 +0,0 @@
-import { concatHex, keccak256, numberToHex } from 'viem';
-/**
- * Generate a participantId from chainId and address using the same logic as the indexer
- * @param chainId - The chain ID
- * @param address - The address
- * @returns The participant ID
- */
-export function generateParticipantId(chainId, address) {
-    return keccak256(concatHex([
-        numberToHex(chainId, { size: 8 }),
-        address
-    ]));
-}

package/dist/src/payment.d.ts

@@ -1,164 +0,0 @@
-import { type Hex } from "viem";
-import type { TokenInfo } from "./tokens.js";
-import type { ConversionRateInfo, ProviderRates } from "./conversionRates.js";
-import { ChainId } from "./chain.js";
-/**
- * Payment providers, including manual
- */
-export declare const providers: {
-    readonly VENMO: "venmo";
-    readonly ZELLE: "zelle";
-    readonly CASHAPP: "cashapp";
-    readonly REVOLUT: "revolut";
-    readonly WISE: "wise";
-    readonly MERCADOPAGO: "mercadopago";
-    readonly MANUAL: "manual";
-    readonly PAYPAL: "paypal";
-    readonly MONZO: "monzo";
-};
-export type ProviderKey = typeof providers[keyof typeof providers];
-/** Distinct keys for payment sub-providers (currently only used by Zelle) */
-export declare const subProviders: {
-    readonly CHASE: "chase";
-    readonly BANK_OF_AMERICA: "bank_of_america";
-    readonly CITI: "citi";
-};
-/** Sub-provider key (providers within providers) */
-export type SubProviderKey = typeof subProviders[keyof typeof subProviders];
-/** Action type for a provider */
-export type ProviderKeyActionType = 'transfer' | 'send';
-/** Validatable provider key */
-export type ValidatableProviderKey = Exclude<ProviderKey, typeof providers.MANUAL>;
-/** Transparent platforms */
-export type TransparentPlatforms = typeof providers.ZELLE;
-/** Platform key */
-export type PlatformKey = Exclude<ValidatableProviderKey, TransparentPlatforms> | SubProviderKey;
-/** Action type */
-export type ActionType = `${ProviderKeyActionType}_${ProviderKey}`;
-/** Provider key to validation key */
-export declare const providerKeyToValidationKey: Record<ValidatableProviderKey, string>;
-/** Validation key */
-export type ValidationKey = typeof providerKeyToValidationKey[keyof typeof providerKeyToValidationKey];
-/** Limits for a payment method */
-export type Limits = {
-    min: number;
-};
-/** Send link options */
-export type SendLinkOptions = {
-    username: string;
-    amount: bigint;
-    subProvider?: SubProviderKey;
-    qrCode?: boolean;
-};
-/** Send link */
-export type SendLink = (options: SendLinkOptions) => string | null;
-/** Payment sub-provider config */
-export type PaymentSubProviderConfig = {
-    key: SubProviderKey;
-    name: string;
-    icon?: string;
-    color?: string;
-    usernameType?: string;
-    verifiers: (chain: ChainId) => Hex[];
-    sendLink: SendLink;
-    paymentMethod: number;
-};
-/** Payment config */
-export type PaymentConfig = {
-    icon: string;
-    key: ProviderKey;
-    name: string;
-    color: string;
-    usernameType: string;
-    validationKey: ValidationKey | null;
-    verifiers: string[];
-    limits: Limits;
-    /**
-     * Set of sub-provider keys that this payment method supports. Empty when none.
-     */
-    subProviders: Set<PaymentSubProviderConfig>;
-    list: Hex[];
-    sendLink?: SendLink;
-};
-/** Validation deposit data payment identifier */
-export type ValidationDepositDataPaymentIdentifier = Partial<{
-    [key in Exclude<ValidationKey, null>]: string;
-}>;
-/** Validation deposit data */
-export type ValidationDepositData = ValidationDepositDataPaymentIdentifier & {
-    telegramUsername: string;
-};
-/** Data encoding for zelle urls */
-export declare const dataEncoding: (data: string) => string;
-/** Default Zelle send link */
-export declare const defaultZelleSendLink: (options: SendLinkOptions) => string | null;
-/** Global configuration for all supported sub-providers. Other modules can import this directly. */
-export declare const subProviderConfigs: Partial<Record<ProviderKey, Record<SubProviderKey, PaymentSubProviderConfig>>>;
-/** Payment method icon mappings */
-export declare const providerConfigs: (chainId: ChainId) => Record<ProviderKey, PaymentConfig>;
-/** Payment verifier to key map */
-export declare const paymentVerifierToKey: (chainId: ChainId | null) => Map<string, ProviderKey>;
-/** Provider key to verifiers map */
-export declare const providerKeyToVerifiersMap: (chainId: ChainId) => Map<ProviderKey, `0x${string}`[]>;
-/** Provider key to verifiers */
-export declare const providerKeyToVerifiers: (chainId: ChainId, providerKey: ProviderKey) => Hex[] | null;
-/** Verifier gets key */
-export declare const verifierGetsKey: (chainId: ChainId | null, verifierAddress: string) => ProviderKey;
-/**
- * Utility function to get payment method icon
- * @param key - The provider key
- * @returns The icon string used for iconify
- */
-export declare const getPaymentIcon: (chainId: ChainId | null, key: ProviderKey) => string;
-/**
- * Utility function to get payment method configuration by verifier address
- * @param verifierAddress - The verifier address
- * @returns The payment method configuration
- */
-export declare const getPaymentMethodConfig: (chainId: ChainId | null, verifierAddress: string) => PaymentConfig | null;
-/**
- * Utility function to get payment method minimum limit by verifier address
- * @param key - The provider key
- * @returns The minimum limit
- */
-export declare const getPaymentMethodMinimum: (chainId: ChainId | null, key: ProviderKey) => number;
-/**
- * Utility function to get payment method name by verifier address
- */
-export declare const getPaymentMethodName: (chainId: ChainId | null, verifierAddress: string | ProviderKey) => string;
-/**
- * Calculate effective minimum amount (higher of user minimum or payment provider minimum)
- * @param userMinAmountWei - The user minimum amount
- * @param tokenInfo - The token info
- * @param providerRates - The provider rates
- * @returns The effective minimum amount
- */
-export declare function calculateEffectiveMinimum(chainId: ChainId, userMinAmountWei: string | bigint, tokenInfo: TokenInfo, providerRates?: ProviderRates<ConversionRateInfo>): {
-    userMinAmountWei: bigint;
-    providerMinAmountWei: bigint;
-    effectiveMinAmountWei: bigint;
-    formattedEffectiveMin: string;
-};
-/**
- * Helper function to get payment provider minimum limit (returns decimal number for config)
- * @param key - The provider key
- * @returns The minimum limit
- */
-export declare function getPaymentProviderMinimum(chainId: ChainId, key: ProviderKey): number;
-/**
- * Check if a payment method is known
- * @param chainId - The chain ID
- * @param verifierAddress - The verifier address
- * @returns True if the payment method is known, false otherwise
- */
-export declare const isPaymentMethodKnown: (chainId: ChainId | null, verifierAddress: string) => boolean;
-/**
- * Get all payment methods
- * @returns All payment methods
- */
-export declare const getAllPaymentMethods: (chainId: ChainId) => ProviderKey[];
-/**
- * Get all verifiable payment methods
- * @returns All verifiable payment methods
- */
-export declare const verifiablePaymentMethods: (chainId: ChainId) => ProviderKey[];