@rozoai/intent-common 0.1.3 → 0.1.5

package/src/rozoPay.ts

@@ -1,638 +0,0 @@
-// TODO: this file defines types that shouldn't be exposed to the client.
-// Clean this up to only expose the types that are needed by the client.
-
-import { base58 } from "@scure/base";
-import {
-  Address,
-  bytesToBigInt,
-  formatUnits,
-  getAddress,
-  Hex,
-  numberToBytes,
-  zeroAddress,
-} from "viem";
-import z from "zod";
-import { Token } from "./token";
-
-import { assertNotNull } from "./assert";
-import {
-  BigIntStr,
-  SolanaPublicKey,
-  StellarPublicKey,
-  zAddress,
-  zBigIntStr,
-} from "./primitiveTypes";
-
-// lifecycle: waiting payment -> pending processing -> start submitted -> processed (onchain tx was successful)
-export enum RozoPayOrderStatusSource {
-  WAITING_PAYMENT = "waiting_payment",
-  PENDING_PROCESSING = "pending_processing",
-  START_SUBMITTED = "start_submitted",
-  /* Start transaction receipt confirmed. */
-  PROCESSED = "processed",
-}
-
-// lifecycle: pending -> fast-finish-submitted (onchain tx submitted) -> fast-finished (onchain tx was successful) -> claimed (onchain tx was successful)
-export enum RozoPayOrderStatusDest {
-  PENDING = "pending",
-  FAST_FINISH_SUBMITTED = "fast_finish_submitted",
-  /* Fast finish transaction receipt confirmed. */
-  FAST_FINISHED = "fast_finished",
-  CLAIM_SUCCESSFUL = "claimed",
-}
-
-export enum RozoPayOrderMode {
-  SALE = "sale", // product or item sale
-  CHOOSE_AMOUNT = "choose_amount", // let the user specify the amount to pay
-  HYDRATED = "hydrated", // once hydrated, the order is final and all parameters are known and immutable
-}
-
-/**
- * Status values:
- * - `payment_unpaid` - the user has not paid yet
- * - `payment_started` - the user has paid & payment is in progress. This status
- *    typically lasts a few seconds.
- * - `payment_completed` - the final call or transfer succeeded
- * - `payment_bounced` - the final call or transfer reverted. Funds were sent
- *    to the payment's configured refund address on the destination chain.
- */
-export enum RozoPayIntentStatus {
-  UNPAID = "payment_unpaid",
-  STARTED = "payment_started",
-  COMPLETED = "payment_completed",
-  BOUNCED = "payment_bounced",
-  PAYOUT_COMPLETED = "payout_completed",
-}
-
-export interface RozoPayOrderItem {
-  name: string;
-  description: string;
-  image?: string;
-}
-
-export const zBridgeTokenOutOptions = z.array(
-  z.object({
-    token: zAddress,
-    amount: zBigIntStr.transform((a) => BigInt(a)),
-  })
-);
-
-export type BridgeTokenOutOptions = z.infer<typeof zBridgeTokenOutOptions>;
-
-// NOTE: be careful to modify this type only in backward-compatible ways.
-//       Add OPTIONAL fields, etc. Anything else requires a migration.
-export const zRozoPayOrderMetadata = z.object({
-  style: z
-    .object({
-      background: z.string().optional().describe("Background color."),
-    })
-    .optional()
-    .describe("Style of the checkout page."),
-  orgLogo: z.string().optional().describe("Logo of the organization."),
-  intent: z
-    .string()
-    .describe("Title verb, eg 'Preorder', 'Check out', 'Deposit'."),
-  items: z
-    .array(
-      z.object({
-        name: z.string(),
-        description: z.string(),
-        image: z.string().optional(),
-        price: z.string().optional(),
-        priceDetails: z.string().optional(),
-      })
-    )
-    .describe("Details about what's being ordered, donated, deposited, etc."),
-  payer: z
-    .object({
-      preferredChains: z
-        .array(z.number())
-        .optional()
-        .describe(
-          "Preferred chain IDs, in descending order. Any assets the user owns on preferred chains will appear first. Defaults to destination chain."
-        ),
-      preferredTokens: z
-        .array(
-          z.object({
-            chain: z.number(),
-            address: zAddress.transform((a) => getAddress(a)),
-          })
-        )
-        .optional()
-        .describe(
-          "Preferred tokens, in descending order. Any preferred assets the user owns will appear first. Defaults to destination token."
-        ),
-      // Filter to only allow payments on these chains. Keep this
-      // parameter undocumented. Only for specific customers.
-      evmChains: z
-        .array(z.number())
-        .optional()
-        .describe(
-          "Filter to only allow payments on these EVM chains. Defaults to all chains."
-        ),
-      paymentOptions: z
-        .array(z.string())
-        .optional()
-        .describe(
-          "Payment options like Coinbase, Binance, etc. Defaults to all available options."
-        ),
-    })
-    .optional()
-    .describe(""),
-  memo: z.string().optional().describe("Memo for the payment."),
-  customDeeplinkUrl: z
-    .string()
-    .optional()
-    .describe("Custom deeplink URL for the payment."),
-});
-
-export type RozoPayOrderMetadata = z.infer<typeof zRozoPayOrderMetadata>;
-
-/**
- * The user-passed metadata must meet these criteria:
- * - All keys must be strings
- * - All values must be strings
- * - At most 50 key-value pairs
- * - Maximum of 40 characters per key
- * - Maximum of 500 characters per value
- */
-export const zRozoPayUserMetadata = z
-  .record(
-    z.string().max(40, "Metadata keys cannot be longer than 40 characters"),
-    z.string().max(500, "Metadata values cannot be longer than 500 characters")
-  )
-  .nullable()
-  .refine(
-    (obj) => !obj || Object.keys(obj).length <= 50,
-    "Metadata cannot have more than 50 key-value pairs"
-  );
-
-export type RozoPayUserMetadata = z.infer<typeof zRozoPayUserMetadata>;
-
-export type RozoPayDehydratedOrder = {
-  mode: RozoPayOrderMode.SALE | RozoPayOrderMode.CHOOSE_AMOUNT;
-  id: bigint;
-  destFinalCallTokenAmount: RozoPayTokenAmount;
-  destFinalCall: OnChainCall;
-  nonce: bigint;
-  redirectUri: string | null;
-  orgId: string | null;
-  createdAt: number | null;
-  lastUpdatedAt: number | null;
-  intentStatus: RozoPayIntentStatus;
-  metadata: RozoPayOrderMetadata;
-  externalId: string | null;
-  userMetadata: RozoPayUserMetadata | null;
-  refundAddr: string | null;
-  preferredChainId: number | null;
-  preferredTokenAddress: string | null;
-  memo?: string | null;
-};
-
-export type RozoPayHydratedOrder = {
-  mode: RozoPayOrderMode.HYDRATED;
-  id: bigint;
-  intentAddr: string;
-  /** Nullable because old intents don't record escrow address. */
-  // escrowContractAddress: string | null;
-  /** Nullable because old intents don't record bridger address. */
-  // bridgerContractAddress: string | null;
-  destFinalCallTokenAmount: RozoPayTokenAmount;
-  destFinalCall: OnChainCall;
-  usdValue: number;
-  refundAddr: string;
-  nonce: bigint;
-  sourceFulfillerAddr: string | null;
-  sourceTokenAmount: RozoPayTokenAmount | null;
-  sourceInitiateTxHash: Hex | null;
-  // sourceStartTxHash: Hex | null;
-  sourceStatus: RozoPayOrderStatusSource;
-  destStatus: RozoPayOrderStatusDest;
-  destFastFinishTxHash: Hex | null;
-  destClaimTxHash: Hex | null;
-  redirectUri: string | null;
-  orgId: string | null;
-  createdAt: number | null;
-  lastUpdatedAt: number | null;
-  intentStatus: RozoPayIntentStatus;
-  metadata: RozoPayOrderMetadata;
-  externalId: string | null;
-  userMetadata: RozoPayUserMetadata | null;
-  /** Nullable because old intents don't have expiration time. */
-  expirationTs: bigint | null;
-  memo?: string | null;
-  preferredChainId: number | null;
-  preferredTokenAddress: string | null;
-  payoutTransactionHash?: string | null;
-  /** @deprecated included for backcompat with old versions. Remove soon. */
-  // handoffAddr: string;
-  // bridgeTokenOutOptions: RozoPayTokenAmount[];
-  // selectedBridgeTokenOutAddr: string | null;
-  // selectedBridgeTokenOutAmount: bigint | null;
-};
-
-export type RozoPayOrderWithOrg = RozoPayOrder & {
-  org: RozoPayOrgPublicInfo;
-};
-
-export type RozoPayHydratedOrderWithOrg = RozoPayHydratedOrder & {
-  org: RozoPayOrgPublicInfo;
-};
-
-export type RozoPayOrgPublicInfo = {
-  orgId: string;
-  name: string;
-  logoURI?: string;
-};
-
-export type RozoPayHydratedOrderWithoutIntentAddr = Omit<
-  RozoPayHydratedOrder,
-  "intentAddr" | "handoffAddr"
->;
-
-export type RozoPayOrder = RozoPayDehydratedOrder | RozoPayHydratedOrder;
-
-export function isHydrated(order: RozoPayOrder): order is RozoPayHydratedOrder {
-  return order.mode === RozoPayOrderMode.HYDRATED;
-}
-
-type RozoAddress = Address | SolanaPublicKey | StellarPublicKey;
-
-export type RozoPayOrderView = {
-  id: RozoPayOrderID;
-  status: RozoPayIntentStatus;
-  createdAt: string;
-  display: {
-    intent: string;
-    paymentValue: string;
-    currency: "USD";
-  };
-  source: {
-    payerAddress: RozoAddress | null;
-    txHash: Hex | string | null;
-    chainId: string;
-    amountUnits: string;
-    tokenSymbol: string;
-    tokenAddress: RozoAddress | string;
-  } | null;
-  destination: {
-    destinationAddress: RozoAddress;
-    txHash: Hex | null;
-    chainId: string;
-    amountUnits: string;
-    tokenSymbol: string;
-    tokenAddress: RozoAddress;
-    callData: Hex | null;
-  };
-  externalId: string | null;
-  metadata: RozoPayUserMetadata | null;
-};
-
-export function getOrderSourceChainId(
-  order: RozoPayHydratedOrder
-): number | null {
-  if (order.sourceTokenAmount == null) {
-    return null;
-  }
-  return order.sourceTokenAmount.token.chainId;
-}
-
-export function getOrderDestChainId(
-  order: RozoPayOrder | RozoPayHydratedOrderWithoutIntentAddr
-): number {
-  return order.destFinalCallTokenAmount.token.chainId;
-}
-
-export function mergedMetadata(data: Record<string, any>): Record<string, any> {
-  // Ignore this metadata
-  delete data.payintokenaddress;
-  delete data.preferredChain;
-  delete data.preferredToken;
-  delete data.provider;
-  delete data.receivingAddress;
-
-  return data;
-}
-
-export function getRozoPayOrderView(order: RozoPayOrder): RozoPayOrderView {
-  return {
-    id: writeRozoPayOrderID(order.id),
-    status: order.intentStatus,
-    createdAt: assertNotNull(
-      order.createdAt,
-      `createdAt is null for order with id: ${order.id}`
-    ).toString(),
-    display: {
-      intent: order.metadata.intent,
-      // Show 2 decimal places for USD
-      paymentValue: order.destFinalCallTokenAmount.usd.toFixed(2),
-      currency: "USD",
-    },
-    source:
-      order.mode === RozoPayOrderMode.HYDRATED &&
-      order.sourceTokenAmount != null
-        ? {
-            payerAddress: order.sourceFulfillerAddr,
-            txHash: order.sourceInitiateTxHash,
-            chainId: assertNotNull(
-              getOrderSourceChainId(order),
-              `source chain id is null for order with source token: ${order.id}`
-            ).toString(),
-            amountUnits: formatUnits(
-              BigInt(order.sourceTokenAmount.amount),
-              order.sourceTokenAmount.token.decimals
-            ),
-            tokenSymbol: order.sourceTokenAmount.token.symbol,
-            tokenAddress: order.sourceTokenAmount.token.token,
-          }
-        : null,
-    destination: {
-      destinationAddress: order.destFinalCall.to,
-      txHash:
-        order.mode === RozoPayOrderMode.HYDRATED
-          ? order.destFastFinishTxHash ?? order.destClaimTxHash
-          : null,
-      chainId: getOrderDestChainId(order).toString(),
-      amountUnits: formatUnits(
-        BigInt(order.destFinalCallTokenAmount.amount),
-        order.destFinalCallTokenAmount.token.decimals
-      ),
-      tokenSymbol: order.destFinalCallTokenAmount.token.symbol,
-      tokenAddress: order.destFinalCallTokenAmount.token.token,
-      callData: order.destFinalCall.data,
-    },
-    externalId: order.externalId,
-    metadata: mergedMetadata({
-      ...order.metadata,
-      ...order.userMetadata,
-    }),
-  };
-}
-
-export type WalletPaymentOption = {
-  balance: RozoPayTokenAmount;
-
-  // TODO: deprecate, replace with requiredUsd / minRequiredUsd / feesUsd
-  // These are overly large objects that duplicate RozoPayToken
-  required: RozoPayTokenAmount;
-  minimumRequired: RozoPayTokenAmount;
-  fees: RozoPayTokenAmount;
-
-  disabledReason?: string;
-};
-
-export type ExternalPaymentOptionMetadata = {
-  id: ExternalPaymentOptions;
-  optionType: "external" | "zkp2p" | "exchange" | "stellar";
-  cta: string;
-  logoURI: string;
-  logoShape: "circle" | "squircle";
-  paymentToken: RozoPayToken;
-  disabled: boolean;
-  message?: string;
-  minimumUsd?: number;
-};
-
-export enum ExternalPaymentOptions {
-  Rozo = "Rozo",
-  RampNetwork = "RampNetwork",
-  Solana = "Solana",
-  ExternalChains = "ExternalChains",
-  Stellar = "Stellar",
-  // All exchanges
-  AllExchanges = "AllExchanges",
-  Coinbase = "Coinbase",
-  Binance = "Binance",
-  Lemon = "Lemon",
-  // All available payment apps
-  AllPaymentApps = "AllPaymentApps",
-  Venmo = "Venmo",
-  CashApp = "CashApp",
-  MercadoPago = "MercadoPago",
-  Revolut = "Revolut",
-  Wise = "Wise",
-  Ethereum = "Ethereum",
-}
-
-export type ExternalPaymentOptionsString = `${ExternalPaymentOptions}`;
-
-export type ExternalPaymentOptionData = {
-  url: string;
-  waitingMessage: string;
-};
-
-export enum DepositAddressPaymentOptions {
-  TRON_USDT = "USDT on Tron",
-  BASE = "Base",
-  BSC = "BSC",
-  ARBITRUM = "Arbitrum",
-  OP_MAINNET = "Optimism",
-  POLYGON = "Polygon",
-  ETH_L1 = "Ethereum",
-  SOLANA = "Solana",
-  STELLAR = "Stellar",
-  WORLD = "Worldchain",
-
-  SOLANA_USDT = "USDT on Solana",
-  SOLANA_USDC = "USDC on Solana",
-  BASE_USDC = "USDC on Base",
-  ETHEREUM_USDT = "USDT on Ethereum",
-  ETHEREUM_USDC = "USDC on Ethereum",
-
-  /** @deprecated */
-  BITCOIN = "Bitcoin",
-  /** @deprecated */
-  TON = "TON",
-  /** @deprecated */
-  MONERO = "Monero",
-  /** @deprecated */
-  DOGE = "Doge",
-  /** @deprecated */
-  LITECOIN = "Litecoin",
-  /** @deprecated */
-  ZCASH = "Zcash",
-  /** @deprecated */
-  DASH = "Dash",
-}
-
-export type DepositAddressPaymentOptionMetadata = {
-  id: DepositAddressPaymentOptions;
-  logoURI: string;
-  minimumUsd: number;
-  chainId: number;
-  token: Token;
-};
-
-export type DepositAddressPaymentOptionData = {
-  address: string;
-  uri: string;
-  amount: string;
-  suffix: string;
-  expirationS: number;
-};
-
-export interface RozoPayToken extends Token {
-  token: string;
-  /** Price to convert 1.0 of this token to a USD stablecoin. */
-  usd: number;
-  /** Price to convert $1 to this token T. If 2.00, then we receive 0.5 T. */
-  priceFromUsd: number;
-  /** Max payment accepted in this token, based on liquidity & mode. */
-  maxAcceptUsd: number;
-  /** Max payment we can send from this token, based on liquidity & mode. */
-  maxSendUsd: number;
-  /** Display decimals, separate from token decimals. Eg: 2 for USDC. */
-  displayDecimals: number;
-  /** Symbol for fiat currency, eg: "$" */
-  fiatSymbol?: string;
-}
-
-export interface RozoPayTokenAmount {
-  token: RozoPayToken;
-  amount: BigIntStr;
-  usd: number; // amount in dollars
-}
-
-export type OnChainCall = {
-  to: string;
-  data: Hex;
-  value: bigint;
-};
-
-export const emptyOnChainCall: OnChainCall = {
-  to: zeroAddress,
-  data: "0x",
-  value: 0n,
-};
-
-// base58 encoded bigint
-const zRozoPayOrderID = z.string().regex(/^[1-9A-HJ-NP-Za-km-z]+$/);
-
-export type RozoPayOrderID = z.infer<typeof zRozoPayOrderID>;
-
-/**
- * Read a base58-encoded id into a bigint.
- */
-export function readRozoPayOrderID(id: string): bigint {
-  return bytesToBigInt(base58.decode(id));
-}
-
-/**
- * Write a bigint into a base58-encoded id.
- */
-export function writeRozoPayOrderID(id: bigint): string {
-  return base58.encode(numberToBytes(id));
-}
-
-export const zUUID = z.string().uuid();
-
-export type UUID = z.infer<typeof zUUID>;
-
-export enum RozoPayEventType {
-  PaymentStarted = "payment_started",
-  PaymentCompleted = "payment_completed",
-  PaymentBounced = "payment_bounced",
-  PaymentRefunded = "payment_refunded",
-  PaymentPayoutCompleted = "payment_payout_completed",
-}
-
-export type PaymentStartedEvent = {
-  type: RozoPayEventType.PaymentStarted;
-  isTestEvent?: boolean;
-  paymentId: RozoPayOrderID;
-  chainId: number;
-  txHash: Hex | string | null;
-  payment: RozoPayOrderView;
-};
-
-export type PaymentCompletedEvent = {
-  type: RozoPayEventType.PaymentCompleted;
-  isTestEvent?: boolean;
-  paymentId: RozoPayOrderID;
-  chainId: number;
-  txHash: string;
-  payment: RozoPayOrderView;
-  rozoPaymentId?: string;
-};
-
-export type PaymentPayoutCompletedEvent = {
-  type: RozoPayEventType.PaymentPayoutCompleted;
-  isTestEvent?: boolean;
-  paymentId: RozoPayOrderID;
-  paymentTx: {
-    hash: string;
-    chainId: number;
-    url: string;
-  };
-  payoutTx: {
-    hash: string;
-    chainId: number;
-    url: string;
-  };
-  payment: RozoPayOrderView;
-  rozoPaymentId?: string;
-};
-
-export type PaymentBouncedEvent = {
-  type: RozoPayEventType.PaymentBounced;
-  isTestEvent?: boolean;
-  paymentId: RozoPayOrderID;
-  chainId: number;
-  txHash: string;
-  payment: RozoPayOrderView;
-  rozoPaymentId?: string;
-};
-
-export type PaymentRefundedEvent = {
-  type: RozoPayEventType.PaymentRefunded;
-  isTestEvent?: boolean;
-  paymentId: RozoPayOrderID;
-  refundAddress: string;
-  chainId: number;
-  tokenAddress: string;
-  txHash: string;
-  amountUnits: string;
-  payment: RozoPayOrderView;
-};
-
-export type RozoPayEvent =
-  | PaymentStartedEvent
-  | PaymentCompletedEvent
-  | PaymentBouncedEvent
-  | PaymentRefundedEvent
-  | PaymentPayoutCompletedEvent;
-
-export interface WebhookEndpoint {
-  id: UUID;
-  orgId: UUID;
-  url: string;
-  token: string;
-  createdAt: Date;
-  deletedAt: Date | null;
-}
-
-// Lifecycle: Pending (just created) -> (if failing) Retrying (exponential backoff) -> Successful or Failed
-export enum WebhookEventStatus {
-  PENDING = "pending", // waiting to be delivered
-  RETRYING = "retrying", // currently in exponential backoff queue
-  SUCCESSFUL = "successful", // successfully delivered
-  FAILED = "failed", // gave up after retrying
-}
-
-export interface WebhookEvent {
-  id: UUID;
-  endpoint: WebhookEndpoint;
-  isTestEvent: boolean;
-  body: RozoPayEvent;
-  status: WebhookEventStatus;
-  deliveries: WebhookDelivery[];
-  createdAt: Date;
-}
-
-export interface WebhookDelivery {
-  id: UUID;
-  eventId: UUID;
-  httpStatus: number | null;
-  body: string | null;
-  createdAt: Date;
-}