@zkp2p/pay-shared

Shared TypeScript types, enums, and chain utilities used by ZKP2P Pay API, SDK, and frontend apps.

• Package: @zkp2p/pay-shared
• Module format: ESM
• Contains runtime utilities and compile-time types

Install

npm install @zkp2p/[email protected]

Published artifacts

• Includes compiled ESM JavaScript and .d.ts type declarations.
• Does not publish declaration maps (.d.ts.map) or JavaScript source maps (.js.map).

What This Package Includes

• Checkout API types (CreateOrderRequest, CheckoutOrder, CheckoutPayment, CheckoutAggregate, etc.)
• Canonical constants (PaymentPlatform, FeePayer, CheckoutOrderStatus, CheckoutPaymentStatus, OrderErrorCode)
• Merchant model types and environment constants (Merchant, MerchantEnvironment)
• Central chain/token helpers for supported destination chains and token aliases

Usage

Shared API Types

import type { CreateOrderRequest, CheckoutOrder } from '@zkp2p/pay-shared';

const request: CreateOrderRequest = {
  requestedUsdcAmount: '25.00',
  destinationChainId: 8453,
  destinationToken: 'USDC',
  destinationAddress: '0xYourRecipientAddress',
};

function readOrder(order: CheckoutOrder) {
  console.log(order.status, order.requestedUsdcAmount, order.remainingUsdcAmount);
}

Constants and Enums

import { FeePayer, PaymentPlatform, CheckoutOrderStatus } from '@zkp2p/pay-shared';

console.log(FeePayer.MERCHANT); // "MERCHANT"
console.log(PaymentPlatform.VENMO); // "venmo"
console.log(CheckoutOrderStatus.CREATED); // "CREATED"

Chain and Token Utilities

import {
  BASE_CHAIN_ID,
  getSupportedChainIds,
  parseSupportedChainSelection,
  resolveDestinationTokenAddress,
  getSupportedDestinationTokenAliasesForChain,
} from '@zkp2p/pay-shared';

const chainId = parseSupportedChainSelection('polygon'); // 137
const usdc = resolveDestinationTokenAddress('USDC', 137); // Chain-specific USDC address
const supportedAliases = getSupportedDestinationTokenAliasesForChain(BASE_CHAIN_ID); // ["USDC"]

console.log(getSupportedChainIds(), chainId, usdc, supportedAliases);

Key Exports

Core type exports:

• CreateOrderRequest
• CreateOrderResponse
• CreatePaymentRequest
• CheckoutOrder
• CheckoutPayment
• CheckoutAggregate
• CheckoutQuotes
• MerchantProfile

Core constants:

• PaymentPlatform
• FeePayer
• CheckoutOrderStatus
• CheckoutPaymentStatus
• OrderStatus
• ProofAttemptStatus
• OrderErrorCode
• MerchantEnvironment

Chain constants and helpers:

• BASE_CHAIN_ID
• HYPEREVM_CHAIN_ID
• SOLANA_CHAIN_ID
• SUPPORTED_DESTINATION_TOKEN_ALIASES
• parseSupportedChainSelection(...)
• resolveDestinationTokenAddress(...)
• getChainConfig(...)
• getSupportedChainIds(...)
• getDestinationChainIds(...)
• getEvmChainIds(...)
• getNonEvmChainIds(...)

Notes

• Amount fields are strings to preserve precision across APIs and clients.
• Canonical order/payment amounts are available on CheckoutOrder and CheckoutPayment (for example requestedUsdcAmount, remainingUsdcAmount, netSettledUsdcAmount).
• This package is ESM-only.