@daimo/pay-common 1.19.9 → 1.19.11

package/src/daimoPay.ts

@@ -18,6 +18,7 @@ import { assertNotNull } from "./assert";
 import {
   BigIntStr,
   SolanaPublicKey,
+  UUID,
   zAddress,
   zBigIntStr,
 } from "./primitiveTypes";
@@ -60,6 +61,7 @@ export enum DaimoPayIntentStatus {
   STARTED = "payment_started",
   COMPLETED = "payment_completed",
   BOUNCED = "payment_bounced",
+  REFUNDED = "payment_refunded",
 }
 
 /**
@@ -241,7 +243,7 @@ export type DaimoPayHydratedOrder = {
   userMetadata: DaimoPayUserMetadata | null;
   /** Nullable because old intents don't have expiration time. */
   expirationTs: bigint | null;
-  /** External source type, or null. EG "untron", "zkp2p". */
+  /** External source type, or null. EG "untron". */
   extSourceType: string | null;
   /** External source ID. Set when extSourceType is set. */
   extSourceId: string | null;
@@ -249,6 +251,12 @@ export type DaimoPayHydratedOrder = {
   hopChainId: number | null;
   /** Transaction hash for hop start */
   hopStartTxHash: Hex | null;
+  /** If set, indicates slow finish with estimated completion time. Unix timestamp. */
+  finishSlowEta: number | null;
+  /** Next time this fulfillment can be retried for processing. Unix timestamp. */
+  retryProcessingAt: number | null;
+  /** Number of retry attempts for this fulfillment. */
+  retryCount: number;
 };
 
 export type DaimoPayOrderWithOrg = DaimoPayOrder & {
@@ -290,7 +298,7 @@ export function isDehydrated(
 export type DaimoPayOrderView = {
   id: DaimoPayOrderID;
   status: DaimoPayIntentStatus;
-  createdAt: string;
+  createdAt: string; // Seconds since epoch
   display: {
     intent: string;
     paymentValue: string;
@@ -403,7 +411,7 @@ export type WalletPaymentOption = {
 
 export type ExternalPaymentOptionMetadata = {
   id: ExternalPaymentOptions;
-  optionType: "external" | "zkp2p" | "exchange";
+  optionType: "external" | "exchange";
   cta: string;
   logoURI: string;
   logoShape: "circle" | "squircle";
@@ -443,13 +451,19 @@ export enum ExternalPaymentOptions {
   Optimism = "Optimism",
   Polygon = "Polygon",
   Ethereum = "Ethereum",
-  //Payment apps options (only available on desktop)
+  /** @deprecated - ZKP2P payment apps no longer supported */
   AllPaymentApps = "AllPaymentApps",
+  /** @deprecated - ZKP2P payment apps no longer supported */
   Venmo = "Venmo",
+  /** @deprecated - ZKP2P payment apps no longer supported */
   CashApp = "CashApp",
+  /** @deprecated - ZKP2P payment apps no longer supported */
   MercadoPago = "MercadoPago",
+  /** @deprecated - ZKP2P payment apps no longer supported */
   Revolut = "Revolut",
+  /** @deprecated - ZKP2P payment apps no longer supported */
   Wise = "Wise",
+  /** @deprecated - ZKP2P payment apps no longer supported */
   Zelle = "Zelle",
   /** @deprecated - kept for backwards compatibility with old SDK versions */
   Daimo = "Daimo",
@@ -574,7 +588,10 @@ export enum DaimoPayEventType {
 export type PaymentStartedEvent = {
   type: DaimoPayEventType.PaymentStarted;
   isTestEvent?: boolean;
+  /** Order ID (base58) for order flows, session ID for DA flows */
   paymentId: DaimoPayOrderID;
+  /** Session ID (always present) */
+  sessionId: string;
   chainId: number;
   txHash: Hex | string | null;
   payment: DaimoPayOrderView;
@@ -583,7 +600,10 @@ export type PaymentStartedEvent = {
 export type PaymentCompletedEvent = {
   type: DaimoPayEventType.PaymentCompleted;
   isTestEvent?: boolean;
+  /** Order ID (base58) for order flows, session ID for DA flows */
   paymentId: DaimoPayOrderID;
+  /** Session ID (always present) */
+  sessionId: string;
   chainId: number;
   txHash: Hex;
   payment: DaimoPayOrderView;
@@ -592,7 +612,10 @@ export type PaymentCompletedEvent = {
 export type PaymentBouncedEvent = {
   type: DaimoPayEventType.PaymentBounced;
   isTestEvent?: boolean;
+  /** Order ID (base58) for order flows, session ID for DA flows */
   paymentId: DaimoPayOrderID;
+  /** Session ID (always present) */
+  sessionId: string;
   chainId: number;
   txHash: Hex;
   payment: DaimoPayOrderView;
@@ -601,7 +624,10 @@ export type PaymentBouncedEvent = {
 export type PaymentRefundedEvent = {
   type: DaimoPayEventType.PaymentRefunded;
   isTestEvent?: boolean;
+  /** Order ID (base58) for order flows, session ID for DA flows */
   paymentId: DaimoPayOrderID;
+  /** Session ID (always present) */
+  sessionId: string;
   refundAddress: Address;
   chainId: number;
   tokenAddress: Address;
@@ -615,3 +641,121 @@ export type DaimoPayEvent =
   | PaymentCompletedEvent
   | PaymentBouncedEvent
   | PaymentRefundedEvent;
+
+export enum DAFulfillmentStatus {
+  STARTED = "deposit_started",
+  COMPLETED = "deposit_completed",
+  BOUNCED = "deposit_bounced",
+}
+
+export type DAFulfillment = {
+  id: UUID;
+  daAddr: Address;
+  status: DAFulfillmentStatus;
+  createdAt: string; // Seconds since epoch
+  source: {
+    payerAddress: Address | SolanaPublicKey | null;
+    txHash: Hex | string | null;
+    chainId: string;
+    tokenAddress: Address | SolanaPublicKey;
+    tokenSymbol: string;
+    amountUnits: string;
+    usdValue: string;
+  };
+  destination: {
+    destinationAddress: Address;
+    chainId: string;
+    tokenAddress: Address;
+    tokenSymbol: string;
+    amountUnits: string | null;
+    txHash: Hex | null;
+  };
+};
+
+export type DA = {
+  daAddr: Address;
+  org: DaimoPayOrgPublicInfo;
+  destinationChainId: string;
+  destinationAddress: Address;
+  destinationTokenAddress: Address;
+  destinationTokenSymbol: string;
+  refundAddress: Address;
+  expiresAt: string; // Seconds since epoch
+  createdAt: string; // Seconds since epoch
+  fulfillments: DAFulfillment[];
+};
+
+// Session types for the new modal flow
+
+export type SessionState =
+  | "pending"
+  | "processing"
+  | "completed"
+  | "bounced"
+  | "expired";
+
+/** Common fields for all navigation nodes */
+type NavNodeCommon = {
+  id: string;
+  /** Page header title when this node is active */
+  title: string;
+  /** Button label when shown as option in parent (defaults to title) */
+  label?: string;
+  /** Icons to display on option button (defaults to child icons or node icon) */
+  icons?: string[];
+};
+
+export type NavNodeChooseOption = NavNodeCommon & {
+  type: "ChooseOption";
+  options: NavNode[];
+  /** Layout for displaying options. Defaults to "list". */
+  layout?: "list" | "grid";
+};
+
+export type NavNodeDepositAddress = NavNodeCommon & {
+  type: "DepositAddress";
+  address: Address;
+  chainId: number;
+  icon?: string;
+  minimumUsd: number;
+  maximumUsd: number;
+  expiresAt: number; // Unix timestamp (createdAt + 1 hour)
+  tokenSuffix: string; // e.g., "USDT or USDC"
+};
+
+export type NavNodeDeeplink = NavNodeCommon & {
+  type: "Deeplink";
+  url: string;
+  icon?: string;
+};
+
+export type NavNodeExchange = NavNodeCommon & {
+  type: "Exchange";
+  exchangeId: "Coinbase" | "Binance" | "Lemon";
+  icon?: string;
+  minimumUsd: number;
+  maximumUsd: number;
+};
+
+export type NavNodeTronDeposit = NavNodeCommon & {
+  type: "TronDeposit";
+  icon?: string;
+  minimumUsd: number;
+  maximumUsd: number;
+};
+
+export type NavNode =
+  | NavNodeChooseOption
+  | NavNodeDepositAddress
+  | NavNodeDeeplink
+  | NavNodeExchange
+  | NavNodeTronDeposit;
+
+export type Session = {
+  sessionId: UUID;
+  state: SessionState;
+  da: DA;
+  navTree: NavNode[];
+  /** Custom theme CSS URL, overrides default theme */
+  themeCssUrl?: string;
+};

package/src/token.ts

@@ -7,6 +7,7 @@ import {
   celo,
   ethereum,
   gnosis,
+  hyperEvm,
   linea,
   monad,
   optimism,
@@ -44,6 +45,7 @@ export enum TokenLogo {
   ETH = "https://pay.daimo.com/coin-logos/eth.png",
   EURC = "https://pay.daimo.com/coin-logos/eurc.png",
   EURe = "https://pay.daimo.com/coin-logos/eure.png",
+  HYPE = "https://pay.daimo.com/coin-logos/hype.png",
   MON = "https://pay.daimo.com/coin-logos/mon.png",
   POL = "https://pay.daimo.com/coin-logos/pol.png",
   SOL = "https://pay.daimo.com/coin-logos/sol.png",
@@ -85,16 +87,6 @@ export const arbitrumUSDC: Token = token({
   logoURI: TokenLogo.USDC,
 });
 
-export const arbitrumAxlUSDC: Token = token({
-  chainId: arbitrum.chainId,
-  token: getAddress("0xEB466342C4d449BC9f53A865D5Cb90586f405215"),
-  decimals: 6,
-  fiatISO: "USD",
-  name: "Axelar Wrapped USDC",
-  symbol: "axlUSDC",
-  logoURI: TokenLogo.USDC,
-});
-
 export const arbitrumDAI: Token = token({
   chainId: arbitrum.chainId,
   token: getAddress("0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1"),
@@ -129,7 +121,6 @@ const arbitrumTokens: Token[] = [
   arbitrumETH,
   arbitrumWETH,
   arbitrumUSDC,
-  arbitrumAxlUSDC,
   arbitrumDAI,
   arbitrumUSDT,
   arbitrumUSDCe,
@@ -200,16 +191,6 @@ export const baseUSDT: Token = token({
   logoURI: TokenLogo.USDT,
 });
 
-export const baseAxlUSDC: Token = token({
-  chainId: base.chainId,
-  token: getAddress("0xEB466342C4d449BC9f53A865D5Cb90586f405215"),
-  decimals: 6,
-  fiatISO: "USD",
-  name: "Axelar Wrapped USDC",
-  symbol: "axlUSDC",
-  logoURI: TokenLogo.USDC,
-});
-
 const baseTokens: Token[] = [
   baseETH,
   baseWETH,
@@ -218,7 +199,6 @@ const baseTokens: Token[] = [
   baseUSDbC,
   baseDAI,
   baseUSDT,
-  baseAxlUSDC,
 ];
 
 //
@@ -241,16 +221,6 @@ export const bscWBNB: Token = token({
   logoURI: TokenLogo.BNB,
 });
 
-export const bscAxlUSDC: Token = token({
-  chainId: bsc.chainId,
-  token: getAddress("0x4268B8F0B87b6Eae5d897996E6b845ddbD99Adf3"),
-  decimals: 6,
-  fiatISO: "USD",
-  name: "Axelar Wrapped USDC",
-  symbol: "axlUSDC",
-  logoURI: TokenLogo.USDC,
-});
-
 export const bscUSDC: Token = token({
   chainId: bsc.chainId,
   token: getAddress("0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d"),
@@ -271,7 +241,7 @@ export const bscUSDT: Token = token({
   logoURI: TokenLogo.USDT,
 });
 
-const bscTokens: Token[] = [bscBNB, bscWBNB, bscAxlUSDC, bscUSDC, bscUSDT];
+const bscTokens: Token[] = [bscBNB, bscWBNB, bscUSDC, bscUSDT];
 
 //
 // Celo
@@ -287,16 +257,6 @@ export const celoCelo: Token = token({
   logoURI: TokenLogo.CELO,
 });
 
-export const celoAxlUSDC: Token = token({
-  chainId: celo.chainId,
-  token: getAddress("0xEB466342C4d449BC9f53A865D5Cb90586f405215"),
-  decimals: 6,
-  fiatISO: "USD",
-  name: "Axelar Wrapped USDC",
-  symbol: "axlUSDC",
-  logoURI: TokenLogo.USDC,
-});
-
 export const celoUSDC: Token = token({
   chainId: celo.chainId,
   token: getAddress("0xcebA9300f2b948710d2653dD7B07f33A8B32118C"),
@@ -327,13 +287,7 @@ export const celoCUSD: Token = token({
   logoURI: TokenLogo.cUSD,
 });
 
-const celoTokens: Token[] = [
-  celoCelo,
-  celoAxlUSDC,
-  celoUSDC,
-  celoUSDT,
-  celoCUSD,
-];
+const celoTokens: Token[] = [celoCelo, celoUSDC, celoUSDT, celoCUSD];
 
 //
 // Ethereum
@@ -434,6 +388,38 @@ export const gnosisEURe: Token = token({
 
 const gnosisTokens: Token[] = [gnosisXDAI, gnosisUSDCe, gnosisEURe];
 
+//
+// HyperEVM
+//
+
+export const hyperEvmHYPE = nativeToken({
+  chainId: hyperEvm.chainId,
+  name: "HYPE",
+  symbol: "HYPE",
+  logoURI: TokenLogo.HYPE,
+});
+
+export const hyperEvmWHYPE: Token = token({
+  chainId: hyperEvm.chainId,
+  token: getAddress("0x5555555555555555555555555555555555555555"),
+  decimals: 18,
+  name: "Wrapped HYPE",
+  symbol: "WHYPE",
+  logoURI: TokenLogo.HYPE,
+});
+
+export const hyperEvmUSDC: Token = token({
+  chainId: hyperEvm.chainId,
+  token: getAddress("0xb88339CB7199b77E23DB6E890353E22632Ba630f"),
+  decimals: 6,
+  fiatISO: "USD",
+  name: "USD Coin",
+  symbol: "USDC",
+  logoURI: TokenLogo.USDC,
+});
+
+const hyperEvmTokens: Token[] = [hyperEvmHYPE, hyperEvmWHYPE, hyperEvmUSDC];
+
 //
 // Linea
 //
@@ -459,16 +445,6 @@ export const lineaUSDC: Token = token({
   logoURI: TokenLogo.USDC,
 });
 
-export const lineaAxlUSDC: Token = token({
-  chainId: linea.chainId,
-  token: getAddress("0xEB466342C4d449BC9f53A865D5Cb90586f405215"),
-  decimals: 6,
-  fiatISO: "USD",
-  name: "Axelar Wrapped USDC",
-  symbol: "axlUSDC",
-  logoURI: TokenLogo.USDC,
-});
-
 export const lineaDAI: Token = token({
   chainId: linea.chainId,
   token: getAddress("0x4AF15ec2A0BD43Db75dd04E62FAA3B8EF36b00d5"),
@@ -479,13 +455,7 @@ export const lineaDAI: Token = token({
   logoURI: TokenLogo.DAI,
 });
 
-const lineaTokens: Token[] = [
-  lineaETH,
-  lineaWETH,
-  lineaUSDC,
-  lineaAxlUSDC,
-  lineaDAI,
-];
+const lineaTokens: Token[] = [lineaETH, lineaWETH, lineaUSDC, lineaDAI];
 
 //
 // Monad
@@ -554,16 +524,6 @@ export const optimismUSDC: Token = token({
   logoURI: TokenLogo.USDC,
 });
 
-export const optimismAxlUSDC: Token = token({
-  chainId: optimism.chainId,
-  token: getAddress("0xEB466342C4d449BC9f53A865D5Cb90586f405215"),
-  decimals: 6,
-  fiatISO: "USD",
-  name: "Axelar Wrapped USDC",
-  symbol: "axlUSDC",
-  logoURI: TokenLogo.USDC,
-});
-
 export const optimismDAI: Token = token({
   chainId: optimism.chainId,
   token: getAddress("0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1"),
@@ -598,7 +558,6 @@ const optimismTokens = [
   optimismETH,
   optimismWETH,
   optimismUSDC,
-  optimismAxlUSDC,
   optimismDAI,
   optimismUSDT,
   optimismUSDCe,
@@ -643,16 +602,6 @@ export const polygonUSDC: Token = token({
   logoURI: TokenLogo.USDC,
 });
 
-export const polygonAxlUSDC: Token = token({
-  chainId: polygon.chainId,
-  token: getAddress("0x750e4C4984a9e0f12978eA6742Bc1c5D248f40ed"),
-  decimals: 6,
-  fiatISO: "USD",
-  name: "Axelar Wrapped USDC",
-  symbol: "axlUSDC",
-  logoURI: TokenLogo.USDC,
-});
-
 export const polygonDAI: Token = token({
   chainId: polygon.chainId,
   token: getAddress("0x8f3Cf7ad23Cd3CaDbD9735AFf958023239c6A063"),
@@ -688,7 +637,6 @@ const polygonTokens: Token[] = [
   polygonWPOL,
   polygonWETH,
   polygonUSDC,
-  polygonAxlUSDC,
   polygonDAI,
   polygonUSDT,
   polygonUSDCe,
@@ -763,7 +711,17 @@ export const solanaUSDC: Token = token({
   logoURI: TokenLogo.USDC,
 });
 
-const solanaTokens: Token[] = [solanaUSDC, solanaWSOL, solanaSOL];
+export const solanaUSDT: Token = token({
+  chainId: solana.chainId,
+  token: "Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB",
+  decimals: 6,
+  fiatISO: "USD",
+  name: "Tether USD",
+  symbol: "USDT",
+  logoURI: TokenLogo.USDT,
+});
+
+const solanaTokens: Token[] = [solanaUSDC, solanaUSDT, solanaWSOL, solanaSOL];
 
 //
 // Tron
@@ -839,6 +797,7 @@ const knownTokensByChain = new Map<number, Token[]>([
   [celo.chainId, celoTokens],
   [ethereum.chainId, ethereumTokens],
   [gnosis.chainId, gnosisTokens],
+  [hyperEvm.chainId, hyperEvmTokens],
   [linea.chainId, lineaTokens],
   [monad.chainId, monadTokens],
   [optimism.chainId, optimismTokens],
@@ -879,7 +838,6 @@ enum TokenType {
   WRAPPED_NATIVE = "WRAPPED_NATIVE",
   NATIVE_USDC = "NATIVE_USDC",
   BRIDGED_USDC = "BRIDGED_USDC",
-  AXL_USDC = "AXL_USDC",
   DAI = "DAI",
 }
 
@@ -894,7 +852,6 @@ const tokensByChainAndType: Map<
       [TokenType.WRAPPED_NATIVE]: arbitrumWETH,
       [TokenType.NATIVE_USDC]: arbitrumUSDC,
       [TokenType.BRIDGED_USDC]: arbitrumUSDCe,
-      [TokenType.AXL_USDC]: arbitrumAxlUSDC,
       [TokenType.DAI]: arbitrumDAI,
     },
   ],
@@ -905,7 +862,6 @@ const tokensByChainAndType: Map<
       [TokenType.WRAPPED_NATIVE]: baseWETH,
       [TokenType.NATIVE_USDC]: baseUSDC,
       [TokenType.BRIDGED_USDC]: baseUSDbC,
-      [TokenType.AXL_USDC]: baseAxlUSDC,
       [TokenType.DAI]: baseDAI,
     },
   ],
@@ -915,7 +871,6 @@ const tokensByChainAndType: Map<
       [TokenType.NATIVE]: bscBNB,
       [TokenType.WRAPPED_NATIVE]: bscWBNB,
       [TokenType.BRIDGED_USDC]: bscUSDC,
-      [TokenType.AXL_USDC]: bscAxlUSDC,
     },
   ],
   [
@@ -925,7 +880,6 @@ const tokensByChainAndType: Map<
       [TokenType.NATIVE]: celoCelo,
       [TokenType.WRAPPED_NATIVE]: celoCelo,
       [TokenType.NATIVE_USDC]: celoUSDC,
-      [TokenType.AXL_USDC]: celoAxlUSDC,
     },
   ],
   [
@@ -944,13 +898,20 @@ const tokensByChainAndType: Map<
       [TokenType.NATIVE_USDC]: gnosisUSDCe,
     },
   ],
+  [
+    hyperEvm.chainId,
+    {
+      [TokenType.NATIVE]: hyperEvmHYPE,
+      [TokenType.WRAPPED_NATIVE]: hyperEvmWHYPE,
+      [TokenType.NATIVE_USDC]: hyperEvmUSDC,
+    },
+  ],
   [
     linea.chainId,
     {
       [TokenType.NATIVE]: lineaETH,
       [TokenType.WRAPPED_NATIVE]: lineaWETH,
       [TokenType.NATIVE_USDC]: lineaUSDC,
-      [TokenType.AXL_USDC]: lineaAxlUSDC,
       [TokenType.DAI]: lineaDAI,
     },
   ],
@@ -969,7 +930,6 @@ const tokensByChainAndType: Map<
       [TokenType.WRAPPED_NATIVE]: optimismWETH,
       [TokenType.NATIVE_USDC]: optimismUSDC,
       [TokenType.BRIDGED_USDC]: optimismUSDCe,
-      [TokenType.AXL_USDC]: optimismAxlUSDC,
       [TokenType.DAI]: optimismDAI,
     },
   ],
@@ -980,7 +940,6 @@ const tokensByChainAndType: Map<
       [TokenType.WRAPPED_NATIVE]: polygonWPOL,
       [TokenType.NATIVE_USDC]: polygonUSDC,
       [TokenType.BRIDGED_USDC]: polygonUSDCe,
-      [TokenType.AXL_USDC]: polygonAxlUSDC,
       [TokenType.DAI]: polygonDAI,
     },
   ],
@@ -1036,10 +995,6 @@ export function getChainNativeUSDC(chainId: number): Token | undefined {
   return tokensByChainAndType.get(chainId)?.[TokenType.NATIVE_USDC];
 }
 
-export function getChainAxlUSDC(chainId: number): Token | undefined {
-  return tokensByChainAndType.get(chainId)?.[TokenType.AXL_USDC];
-}
-
 /** Returns native USDC when available, otherwise bridged USDC. */
 export function getChainBestUSDC(chainId: number): Token | undefined {
   const t = tokensByChainAndType.get(chainId);
@@ -1055,6 +1010,39 @@ export function tokensEqual(a: Token, b: Token): boolean {
   return a.chainId === b.chainId && a.token === b.token;
 }
 
+/**
+ * Returns true if the token is the native token or wrapped native token.
+ * Useful for checking if a token needs special native/wrapped handling.
+ */
+export function isNativeOrWrappedNative(
+  chainId: number,
+  tokenAddr: string,
+): boolean {
+  const tokens = tokensByChainAndType.get(chainId);
+  if (!tokens) return false;
+  return (
+    tokens[TokenType.NATIVE]?.token === tokenAddr ||
+    tokens[TokenType.WRAPPED_NATIVE]?.token === tokenAddr
+  );
+}
+
+/**
+ * For pricing/API lookups, native tokens should use their wrapped equivalent.
+ * Returns the wrapped native address if given native or wrapped native,
+ * otherwise returns the original address unchanged.
+ */
+export function getWrappedAddressForLookup(
+  chainId: number,
+  tokenAddr: string,
+): string {
+  if (isNativeOrWrappedNative(chainId, tokenAddr)) {
+    const wrapped =
+      tokensByChainAndType.get(chainId)?.[TokenType.WRAPPED_NATIVE];
+    if (wrapped) return wrapped.token;
+  }
+  return tokenAddr;
+}
+
 /* --------------------- Native Token Utils --------------------- */
 
 function nativeETH(chainId: number): Token {