@daimo/pay-common 0.0.1 → 1.6.1

package/dist/chain.d.ts

@@ -14,7 +14,7 @@ export declare const optimism: Chain;
 export declare const polygon: Chain;
 export declare const solana: Chain;
 export declare const worldchain: Chain;
-export declare const chainConfigs: Chain[];
+export declare const supportedChains: Chain[];
 /** Given a chainId, return the chain. */
 export declare function getChainById(chainId: number): Chain;
 /** Returns the chain name for the given chainId. */

package/dist/chain.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chainConfigs = exports.worldchain = exports.solana = exports.polygon = exports.optimism = exports.mantle = exports.linea = exports.ethereum = exports.bsc = exports.blast = exports.base = exports.arbitrum = void 0;
+exports.supportedChains = exports.worldchain = exports.solana = exports.polygon = exports.optimism = exports.mantle = exports.linea = exports.ethereum = exports.bsc = exports.blast = exports.base = exports.arbitrum = void 0;
 exports.getChainById = getChainById;
 exports.getChainName = getChainName;
 exports.getChainExplorerByChainId = getChainExplorerByChainId;
@@ -61,7 +61,7 @@ exports.worldchain = {
     name: "Worldchain",
     cctpDomain: null,
 };
-exports.chainConfigs = [
+exports.supportedChains = [
     exports.arbitrum,
     exports.base,
     exports.blast,
@@ -76,7 +76,7 @@ exports.chainConfigs = [
 ];
 /** Given a chainId, return the chain. */
 function getChainById(chainId) {
-    const ret = exports.chainConfigs.find((c) => c.chainId === chainId);
+    const ret = exports.supportedChains.find((c) => c.chainId === chainId);
     if (ret == null)
         throw new Error(`Unknown chainId ${chainId}`);
     return ret;

package/dist/chain.js.map

@@ -1 +1 @@
-{"version":3,"file":"chain.js","sourceRoot":"","sources":["../src/chain.ts"],"names":[],"mappings":";;;AAuFA,oCAIC;AAGD,oCAEC;AAKD,8DA2BC;AAKD,gEAMC;AAKD,sDAMC;AAhJY,QAAA,QAAQ,GAAU;IAC7B,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,IAAI,GAAU;IACzB,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,KAAK,GAAU;IAC1B,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,OAAO;IACb,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,GAAG,GAAU;IACxB,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,iBAAiB;IACvB,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,QAAQ,GAAU;IAC7B,OAAO,EAAE,CAAC;IACV,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,KAAK,GAAU;IAC1B,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,OAAO;IACb,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,MAAM,GAAU;IAC3B,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,QAAQ,GAAU;IAC7B,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,OAAO,GAAU;IAC5B,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,SAAS;IACf,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,MAAM,GAAU;IAC3B,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,UAAU,GAAU;IAC/B,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,YAAY;IAClB,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,YAAY,GAAY;IACnC,gBAAQ;IACR,YAAI;IACJ,aAAK;IACL,WAAG;IACH,gBAAQ;IACR,aAAK;IACL,cAAM;IACN,gBAAQ;IACR,eAAO;IACP,cAAM;IACN,kBAAU;CACX,CAAC;AAEF,yCAAyC;AACzC,SAAgB,YAAY,CAAC,OAAe;IAC1C,MAAM,GAAG,GAAG,oBAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IAC5D,IAAI,GAAG,IAAI,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,EAAE,CAAC,CAAC;IAC/D,OAAO,GAAG,CAAC;AACb,CAAC;AAED,oDAAoD;AACpD,SAAgB,YAAY,CAAC,OAAe;IAC1C,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;AACpC,CAAC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CAAC,OAAe;IACvD,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,gBAAQ,CAAC,OAAO;YACnB,OAAO,qBAAqB,CAAC;QAC/B,KAAK,YAAI,CAAC,OAAO;YACf,OAAO,sBAAsB,CAAC;QAChC,KAAK,aAAK,CAAC,OAAO;YAChB,OAAO,sBAAsB,CAAC;QAChC,KAAK,WAAG,CAAC,OAAO;YACd,OAAO,qBAAqB,CAAC;QAC/B,KAAK,gBAAQ,CAAC,OAAO;YACnB,OAAO,sBAAsB,CAAC;QAChC,KAAK,aAAK,CAAC,OAAO;YAChB,OAAO,yBAAyB,CAAC;QACnC,KAAK,cAAM,CAAC,OAAO;YACjB,OAAO,wBAAwB,CAAC;QAClC,KAAK,gBAAQ,CAAC,OAAO;YACnB,OAAO,iCAAiC,CAAC;QAC3C,KAAK,eAAO,CAAC,OAAO;YAClB,OAAO,yBAAyB,CAAC;QACnC,KAAK,cAAM,CAAC,OAAO;YACjB,OAAO,oBAAoB,CAAC;QAC9B,KAAK,kBAAU,CAAC,OAAO;YACrB,OAAO,uBAAuB,CAAC;QACjC;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,0BAA0B,CAAC,OAAe,EAAE,OAAe;IACzE,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,QAAQ,YAAY,OAAO,EAAE,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,OAAe,EAAE,MAAc;IACnE,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,QAAQ,OAAO,MAAM,EAAE,CAAC;AACpC,CAAC"}
+{"version":3,"file":"chain.js","sourceRoot":"","sources":["../src/chain.ts"],"names":[],"mappings":";;;AAuFA,oCAIC;AAGD,oCAEC;AAKD,8DA2BC;AAKD,gEAMC;AAKD,sDAMC;AAhJY,QAAA,QAAQ,GAAU;IAC7B,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,IAAI,GAAU;IACzB,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,KAAK,GAAU;IAC1B,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,OAAO;IACb,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,GAAG,GAAU;IACxB,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,iBAAiB;IACvB,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,QAAQ,GAAU;IAC7B,OAAO,EAAE,CAAC;IACV,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,KAAK,GAAU;IAC1B,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,OAAO;IACb,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,MAAM,GAAU;IAC3B,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,QAAQ,GAAU;IAC7B,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,UAAU;IAChB,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,OAAO,GAAU;IAC5B,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,SAAS;IACf,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,MAAM,GAAU;IAC3B,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE,CAAC;CACd,CAAC;AAEW,QAAA,UAAU,GAAU;IAC/B,OAAO,EAAE,GAAG;IACZ,IAAI,EAAE,YAAY;IAClB,UAAU,EAAE,IAAI;CACjB,CAAC;AAEW,QAAA,eAAe,GAAY;IACtC,gBAAQ;IACR,YAAI;IACJ,aAAK;IACL,WAAG;IACH,gBAAQ;IACR,aAAK;IACL,cAAM;IACN,gBAAQ;IACR,eAAO;IACP,cAAM;IACN,kBAAU;CACX,CAAC;AAEF,yCAAyC;AACzC,SAAgB,YAAY,CAAC,OAAe;IAC1C,MAAM,GAAG,GAAG,uBAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IAC/D,IAAI,GAAG,IAAI,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,OAAO,EAAE,CAAC,CAAC;IAC/D,OAAO,GAAG,CAAC;AACb,CAAC;AAED,oDAAoD;AACpD,SAAgB,YAAY,CAAC,OAAe;IAC1C,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC;AACpC,CAAC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CAAC,OAAe;IACvD,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,gBAAQ,CAAC,OAAO;YACnB,OAAO,qBAAqB,CAAC;QAC/B,KAAK,YAAI,CAAC,OAAO;YACf,OAAO,sBAAsB,CAAC;QAChC,KAAK,aAAK,CAAC,OAAO;YAChB,OAAO,sBAAsB,CAAC;QAChC,KAAK,WAAG,CAAC,OAAO;YACd,OAAO,qBAAqB,CAAC;QAC/B,KAAK,gBAAQ,CAAC,OAAO;YACnB,OAAO,sBAAsB,CAAC;QAChC,KAAK,aAAK,CAAC,OAAO;YAChB,OAAO,yBAAyB,CAAC;QACnC,KAAK,cAAM,CAAC,OAAO;YACjB,OAAO,wBAAwB,CAAC;QAClC,KAAK,gBAAQ,CAAC,OAAO;YACnB,OAAO,iCAAiC,CAAC;QAC3C,KAAK,eAAO,CAAC,OAAO;YAClB,OAAO,yBAAyB,CAAC;QACnC,KAAK,cAAM,CAAC,OAAO;YACjB,OAAO,oBAAoB,CAAC;QAC9B,KAAK,kBAAU,CAAC,OAAO;YACrB,OAAO,uBAAuB,CAAC;QACjC;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,0BAA0B,CAAC,OAAe,EAAE,OAAe;IACzE,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,QAAQ,YAAY,OAAO,EAAE,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,OAAe,EAAE,MAAc;IACnE,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,QAAQ,OAAO,MAAM,EAAE,CAAC;AACpC,CAAC"}

package/dist/daimoPay.d.ts

@@ -0,0 +1,405 @@
+import { Address, Hex } from "viem";
+import z from "zod";
+import { Token } from "./token";
+import { BigIntStr, SolanaPublicKey } from "./primitiveTypes";
+export declare enum DaimoPayOrderStatusSource {
+    WAITING_PAYMENT = "waiting_payment",
+    PENDING_PROCESSING = "pending_processing",
+    START_SUBMITTED = "start_submitted",
+    PROCESSED = "processed"
+}
+export declare enum DaimoPayOrderStatusDest {
+    PENDING = "pending",
+    FAST_FINISH_SUBMITTED = "fast_finish_submitted",
+    FAST_FINISHED = "fast_finished",
+    CLAIM_SUCCESSFUL = "claimed"
+}
+export declare enum DaimoPayOrderMode {
+    SALE = "sale",// product or item sale
+    CHOOSE_AMOUNT = "choose_amount",// let the user specify the amount to pay
+    HYDRATED = "hydrated"
+}
+/**
+ * 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 declare enum DaimoPayIntentStatus {
+    UNPAID = "payment_unpaid",
+    STARTED = "payment_started",
+    COMPLETED = "payment_completed",
+    BOUNCED = "payment_bounced"
+}
+/** Order updates used by services outside orderProcessor to listen for any
+ * relevant or interesting changes to the order status. */
+export type DaimoPayOrderUpdate = {
+    type: "mode";
+    value: DaimoPayOrderMode;
+} | {
+    type: "source";
+    value: DaimoPayOrderStatusSource;
+    txHash: string | undefined;
+} | {
+    type: "dest";
+    value: DaimoPayOrderStatusDest;
+    txHash: Hex;
+} | {
+    type: "intent";
+    value: DaimoPayIntentStatus;
+    txHash: Hex;
+};
+export interface DaimoPayOrderItem {
+    name: string;
+    description: string;
+    image?: string;
+}
+export declare const zBridgeTokenOutOptions: z.ZodArray<z.ZodObject<{
+    token: z.ZodEffects<z.ZodString, `0x${string}`, string>;
+    amount: z.ZodEffects<z.ZodEffects<z.ZodString, `${bigint}`, string>, bigint, string>;
+}, "strip", z.ZodTypeAny, {
+    token: `0x${string}`;
+    amount: bigint;
+}, {
+    token: string;
+    amount: string;
+}>, "many">;
+export type BridgeTokenOutOptions = z.infer<typeof zBridgeTokenOutOptions>;
+export declare const zDaimoPayOrderMetadata: z.ZodObject<{
+    style: z.ZodOptional<z.ZodObject<{
+        background: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        background?: string | undefined;
+    }, {
+        background?: string | undefined;
+    }>>;
+    orgLogo: z.ZodOptional<z.ZodString>;
+    intent: z.ZodString;
+    items: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        image: z.ZodOptional<z.ZodString>;
+        price: z.ZodOptional<z.ZodString>;
+        priceDetails: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description: string;
+        image?: string | undefined;
+        price?: string | undefined;
+        priceDetails?: string | undefined;
+    }, {
+        name: string;
+        description: string;
+        image?: string | undefined;
+        price?: string | undefined;
+        priceDetails?: string | undefined;
+    }>, "many">;
+    payer: z.ZodOptional<z.ZodObject<{
+        preferredChains: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+        preferredTokens: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            chain: z.ZodNumber;
+            address: z.ZodEffects<z.ZodEffects<z.ZodString, `0x${string}`, string>, `0x${string}`, string>;
+        }, "strip", z.ZodTypeAny, {
+            chain: number;
+            address: `0x${string}`;
+        }, {
+            chain: number;
+            address: string;
+        }>, "many">>;
+        evmChains: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+        paymentOptions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        preferredChains?: number[] | undefined;
+        preferredTokens?: {
+            chain: number;
+            address: `0x${string}`;
+        }[] | undefined;
+        evmChains?: number[] | undefined;
+        paymentOptions?: string[] | undefined;
+    }, {
+        preferredChains?: number[] | undefined;
+        preferredTokens?: {
+            chain: number;
+            address: string;
+        }[] | undefined;
+        evmChains?: number[] | undefined;
+        paymentOptions?: string[] | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    intent: string;
+    items: {
+        name: string;
+        description: string;
+        image?: string | undefined;
+        price?: string | undefined;
+        priceDetails?: string | undefined;
+    }[];
+    style?: {
+        background?: string | undefined;
+    } | undefined;
+    orgLogo?: string | undefined;
+    payer?: {
+        preferredChains?: number[] | undefined;
+        preferredTokens?: {
+            chain: number;
+            address: `0x${string}`;
+        }[] | undefined;
+        evmChains?: number[] | undefined;
+        paymentOptions?: string[] | undefined;
+    } | undefined;
+}, {
+    intent: string;
+    items: {
+        name: string;
+        description: string;
+        image?: string | undefined;
+        price?: string | undefined;
+        priceDetails?: string | undefined;
+    }[];
+    style?: {
+        background?: string | undefined;
+    } | undefined;
+    orgLogo?: string | undefined;
+    payer?: {
+        preferredChains?: number[] | undefined;
+        preferredTokens?: {
+            chain: number;
+            address: string;
+        }[] | undefined;
+        evmChains?: number[] | undefined;
+        paymentOptions?: string[] | undefined;
+    } | undefined;
+}>;
+export type DaimoPayOrderMetadata = z.infer<typeof zDaimoPayOrderMetadata>;
+/**
+ * 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 declare const zDaimoPayUserMetadata: z.ZodEffects<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>, Record<string, string> | null, Record<string, string> | null>;
+export type DaimoPayUserMetadata = z.infer<typeof zDaimoPayUserMetadata>;
+export type DaimoPayDehydratedOrder = {
+    mode: DaimoPayOrderMode.SALE | DaimoPayOrderMode.CHOOSE_AMOUNT;
+    id: bigint;
+    destFinalCallTokenAmount: DaimoPayTokenAmount;
+    destFinalCall: OnChainCall;
+    destNonce: bigint;
+    redirectUri: string | null;
+    orgId: string | null;
+    createdAt: number | null;
+    lastUpdatedAt: number | null;
+    intentStatus: DaimoPayIntentStatus;
+    metadata: DaimoPayOrderMetadata;
+    externalId: string | null;
+    userMetadata: DaimoPayUserMetadata | null;
+};
+export type DaimoPayHydratedOrder = {
+    mode: DaimoPayOrderMode.HYDRATED;
+    id: bigint;
+    intentAddr: Address;
+    escrowContractAddress: Address | null;
+    /**
+     * @deprecated included for backcompat with old paykit versions. Remove once
+     * new paykit version is deployed.
+     * */
+    handoffAddr: Address;
+    bridgeTokenOutOptions: DaimoPayTokenAmount[];
+    selectedBridgeTokenOutAddr: Address | null;
+    selectedBridgeTokenOutAmount: bigint | null;
+    destFinalCallTokenAmount: DaimoPayTokenAmount;
+    destFinalCall: OnChainCall;
+    usdValue: number;
+    destRefundAddr: Address;
+    destNonce: bigint;
+    sourceFulfillerAddr: Address | SolanaPublicKey | null;
+    sourceTokenAmount: DaimoPayTokenAmount | null;
+    sourceInitiateTxHash: Hex | null;
+    sourceStartTxHash: Hex | null;
+    sourceStatus: DaimoPayOrderStatusSource;
+    destStatus: DaimoPayOrderStatusDest;
+    destFastFinishTxHash: Hex | null;
+    destClaimTxHash: Hex | null;
+    redirectUri: string | null;
+    orgId: string | null;
+    createdAt: number | null;
+    lastUpdatedAt: number | null;
+    intentStatus: DaimoPayIntentStatus;
+    metadata: DaimoPayOrderMetadata;
+    externalId: string | null;
+    userMetadata: DaimoPayUserMetadata | null;
+};
+export type DaimoPayHydratedOrderWithoutIntentAddr = Omit<DaimoPayHydratedOrder, "intentAddr" | "handoffAddr">;
+export type DaimoPayOrder = DaimoPayDehydratedOrder | DaimoPayHydratedOrder;
+export type DaimoPayOrderView = {
+    id: DaimoPayOrderID;
+    status: DaimoPayIntentStatus;
+    createdAt: string;
+    display: {
+        intent: string;
+        paymentValue: string;
+        currency: "USD";
+    };
+    source: {
+        payerAddress: Address | SolanaPublicKey | null;
+        txHash: Hex | string;
+        chainId: string;
+        amountUnits: string;
+        tokenSymbol: string;
+        tokenAddress: Address | string;
+    } | null;
+    destination: {
+        destinationAddress: Address;
+        txHash: Hex | null;
+        chainId: string;
+        amountUnits: string;
+        tokenSymbol: string;
+        tokenAddress: Address;
+        callData: Hex | null;
+    };
+    externalId: string | null;
+    metadata: DaimoPayUserMetadata | null;
+};
+export declare function getOrderSourceChainId(order: DaimoPayHydratedOrder): number | null;
+export declare function getOrderDestChainId(order: DaimoPayOrder | DaimoPayHydratedOrderWithoutIntentAddr): number;
+export declare function getDaimoPayOrderView(order: DaimoPayOrder): DaimoPayOrderView;
+export type WalletPaymentOption = {
+    required: DaimoPayTokenAmount;
+    balance: DaimoPayTokenAmount;
+    minimumRequired: DaimoPayTokenAmount;
+    fees: DaimoPayTokenAmount;
+    disabledReason?: string;
+};
+export type ExternalPaymentOptionMetadata = {
+    id: ExternalPaymentOptions;
+    cta: string;
+    logoURI: string;
+    logoShape: "circle" | "squircle";
+    paymentToken: DaimoPayToken;
+    disabled: boolean;
+    message?: string;
+    minimumUsd?: number;
+};
+export declare enum ExternalPaymentOptions {
+    Daimo = "Daimo",
+    Coinbase = "Coinbase",
+    RampNetwork = "RampNetwork",
+    Binance = "Binance",
+    Solana = "Solana",
+    ExternalChains = "ExternalChains",
+    Lemon = "Lemon"
+}
+export type ExternalPaymentOptionData = {
+    url: string;
+    waitingMessage: string;
+};
+export declare enum DepositAddressPaymentOptions {
+    BITCOIN = "Bitcoin",
+    TRON_USDT = "USDT on Tron",
+    TON = "TON",
+    MONERO = "Monero",
+    DOGE = "Doge",
+    LITECOIN = "Litecoin",
+    ZCASH = "Zcash",
+    DASH = "Dash"
+}
+export type DepositAddressPaymentOptionMetadata = {
+    id: DepositAddressPaymentOptions;
+    logoURI: string;
+};
+export type DepositAddressPaymentOptionData = {
+    address: string;
+    uri: string;
+    amount: string;
+    suffix: string;
+};
+export interface DaimoPayToken extends Token {
+    token: Address | SolanaPublicKey;
+    usd: number;
+    displayDecimals: number;
+    fiatSymbol?: string;
+}
+export interface DaimoPayTokenAmount {
+    token: DaimoPayToken;
+    amount: BigIntStr;
+    usd: number;
+}
+export type OnChainCall = {
+    to: Address;
+    data: Hex;
+    value: bigint;
+};
+export declare const emptyOnChainCall: OnChainCall;
+declare const zDaimoPayOrderID: z.ZodString;
+export type DaimoPayOrderID = z.infer<typeof zDaimoPayOrderID>;
+/**
+ * Read a base58-encoded id into a bigint.
+ */
+export declare function readDaimoPayOrderID(id: string): bigint;
+/**
+ * Write a bigint into a base58-encoded id.
+ */
+export declare function writeDaimoPayOrderID(id: bigint): string;
+export declare const zUUID: z.ZodString;
+export type UUID = z.infer<typeof zUUID>;
+export type PaymentStartedEvent = {
+    type: "payment_started";
+    isTestEvent?: boolean;
+    paymentId: DaimoPayOrderID;
+    chainId: number;
+    txHash: Hex | string | null;
+    payment: DaimoPayOrderView;
+};
+export type PaymentCompletedEvent = {
+    type: "payment_completed";
+    isTestEvent?: boolean;
+    paymentId: DaimoPayOrderID;
+    chainId: number;
+    txHash: Hex | string;
+    payment: DaimoPayOrderView;
+};
+export type PaymentBouncedEvent = {
+    type: "payment_bounced";
+    isTestEvent?: boolean;
+    paymentId: DaimoPayOrderID;
+    chainId: number;
+    txHash: Hex | string;
+    payment: DaimoPayOrderView;
+};
+export type DaimoPayEvent = PaymentStartedEvent | PaymentCompletedEvent | PaymentBouncedEvent;
+export interface WebhookEndpoint {
+    id: UUID;
+    orgId: UUID;
+    url: string;
+    token: string;
+    createdAt: Date;
+    deletedAt: Date | null;
+}
+export declare enum WebhookEventStatus {
+    PENDING = "pending",// waiting to be delivered
+    RETRYING = "retrying",// currently in exponential backoff queue
+    SUCCESSFUL = "successful",// successfully delivered
+    FAILED = "failed"
+}
+export interface WebhookEvent {
+    id: UUID;
+    endpoint: WebhookEndpoint;
+    isTestEvent: boolean;
+    body: DaimoPayEvent;
+    status: WebhookEventStatus;
+    deliveries: WebhookDelivery[];
+    createdAt: Date;
+}
+export interface WebhookDelivery {
+    id: UUID;
+    eventId: UUID;
+    httpStatus: number | null;
+    body: string | null;
+    createdAt: Date;
+}
+export {};

package/dist/daimoPay.js

@@ -0,0 +1,220 @@
+"use strict";
+// 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.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookEventStatus = exports.zUUID = exports.emptyOnChainCall = exports.DepositAddressPaymentOptions = exports.ExternalPaymentOptions = exports.zDaimoPayUserMetadata = exports.zDaimoPayOrderMetadata = exports.zBridgeTokenOutOptions = exports.DaimoPayIntentStatus = exports.DaimoPayOrderMode = exports.DaimoPayOrderStatusDest = exports.DaimoPayOrderStatusSource = void 0;
+exports.getOrderSourceChainId = getOrderSourceChainId;
+exports.getOrderDestChainId = getOrderDestChainId;
+exports.getDaimoPayOrderView = getDaimoPayOrderView;
+exports.readDaimoPayOrderID = readDaimoPayOrderID;
+exports.writeDaimoPayOrderID = writeDaimoPayOrderID;
+const base_1 = require("@scure/base");
+const viem_1 = require("viem");
+const zod_1 = __importDefault(require("zod"));
+const assert_1 = require("./assert");
+const primitiveTypes_1 = require("./primitiveTypes");
+// lifecycle: waiting payment -> pending processing -> start submitted -> processed (onchain tx was successful)
+var DaimoPayOrderStatusSource;
+(function (DaimoPayOrderStatusSource) {
+    DaimoPayOrderStatusSource["WAITING_PAYMENT"] = "waiting_payment";
+    DaimoPayOrderStatusSource["PENDING_PROCESSING"] = "pending_processing";
+    DaimoPayOrderStatusSource["START_SUBMITTED"] = "start_submitted";
+    /* Start transaction receipt confirmed. */
+    DaimoPayOrderStatusSource["PROCESSED"] = "processed";
+})(DaimoPayOrderStatusSource || (exports.DaimoPayOrderStatusSource = DaimoPayOrderStatusSource = {}));
+// lifecycle: pending -> fast-finish-submitted (onchain tx submitted) -> fast-finished (onchain tx was successful) -> claimed (onchain tx was successful)
+var DaimoPayOrderStatusDest;
+(function (DaimoPayOrderStatusDest) {
+    DaimoPayOrderStatusDest["PENDING"] = "pending";
+    DaimoPayOrderStatusDest["FAST_FINISH_SUBMITTED"] = "fast_finish_submitted";
+    /* Fast finish transaction receipt confirmed. */
+    DaimoPayOrderStatusDest["FAST_FINISHED"] = "fast_finished";
+    DaimoPayOrderStatusDest["CLAIM_SUCCESSFUL"] = "claimed";
+})(DaimoPayOrderStatusDest || (exports.DaimoPayOrderStatusDest = DaimoPayOrderStatusDest = {}));
+var DaimoPayOrderMode;
+(function (DaimoPayOrderMode) {
+    DaimoPayOrderMode["SALE"] = "sale";
+    DaimoPayOrderMode["CHOOSE_AMOUNT"] = "choose_amount";
+    DaimoPayOrderMode["HYDRATED"] = "hydrated";
+})(DaimoPayOrderMode || (exports.DaimoPayOrderMode = DaimoPayOrderMode = {}));
+/**
+ * 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.
+ */
+var DaimoPayIntentStatus;
+(function (DaimoPayIntentStatus) {
+    DaimoPayIntentStatus["UNPAID"] = "payment_unpaid";
+    DaimoPayIntentStatus["STARTED"] = "payment_started";
+    DaimoPayIntentStatus["COMPLETED"] = "payment_completed";
+    DaimoPayIntentStatus["BOUNCED"] = "payment_bounced";
+})(DaimoPayIntentStatus || (exports.DaimoPayIntentStatus = DaimoPayIntentStatus = {}));
+exports.zBridgeTokenOutOptions = zod_1.default.array(zod_1.default.object({
+    token: primitiveTypes_1.zAddress,
+    amount: primitiveTypes_1.zBigIntStr.transform((a) => BigInt(a)),
+}));
+// NOTE: be careful to modify this type only in backward-compatible ways.
+//       Add OPTIONAL fields, etc. Anything else requires a migration.
+exports.zDaimoPayOrderMetadata = zod_1.default.object({
+    style: zod_1.default
+        .object({
+        background: zod_1.default.string().optional().describe("Background color."),
+    })
+        .optional()
+        .describe("Style of the checkout page."),
+    orgLogo: zod_1.default.string().optional().describe("Logo of the organization."),
+    intent: zod_1.default
+        .string()
+        .describe("Title verb, eg 'Preorder', 'Check out', 'Deposit'."),
+    items: zod_1.default
+        .array(zod_1.default.object({
+        name: zod_1.default.string(),
+        description: zod_1.default.string(),
+        image: zod_1.default.string().optional(),
+        price: zod_1.default.string().optional(),
+        priceDetails: zod_1.default.string().optional(),
+    }))
+        .describe("Details about what's being ordered, donated, deposited, etc."),
+    payer: zod_1.default
+        .object({
+        preferredChains: zod_1.default
+            .array(zod_1.default.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: zod_1.default
+            .array(zod_1.default.object({
+            chain: zod_1.default.number(),
+            address: primitiveTypes_1.zAddress.transform((a) => (0, viem_1.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: zod_1.default
+            .array(zod_1.default.number())
+            .optional()
+            .describe("Filter to only allow payments on these EVM chains. Defaults to all chains."),
+        paymentOptions: zod_1.default
+            .array(zod_1.default.string())
+            .optional()
+            .describe("Payment options like Coinbase, Binance, etc. Defaults to all available options."),
+    })
+        .optional()
+        .describe(""),
+});
+/**
+ * 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
+ */
+exports.zDaimoPayUserMetadata = zod_1.default
+    .record(zod_1.default.string().max(40, "Metadata keys cannot be longer than 40 characters"), zod_1.default.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");
+function getOrderSourceChainId(order) {
+    if (order.sourceTokenAmount == null) {
+        return null;
+    }
+    return order.sourceTokenAmount.token.chainId;
+}
+function getOrderDestChainId(order) {
+    return order.destFinalCallTokenAmount.token.chainId;
+}
+function getDaimoPayOrderView(order) {
+    return {
+        id: writeDaimoPayOrderID(order.id),
+        status: order.intentStatus,
+        createdAt: (0, assert_1.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 === DaimoPayOrderMode.HYDRATED &&
+            order.sourceTokenAmount != null
+            ? {
+                payerAddress: order.sourceFulfillerAddr,
+                txHash: (0, assert_1.assertNotNull)(order.sourceInitiateTxHash, `sourceInitiateTxHash is null for order with source token: ${order.id}`),
+                chainId: (0, assert_1.assertNotNull)(getOrderSourceChainId(order), `source chain id is null for order with source token: ${order.id}`).toString(),
+                amountUnits: (0, viem_1.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 === DaimoPayOrderMode.HYDRATED
+                ? (order.destFastFinishTxHash ?? order.destClaimTxHash)
+                : null,
+            chainId: getOrderDestChainId(order).toString(),
+            amountUnits: (0, viem_1.formatUnits)(BigInt(order.destFinalCallTokenAmount.amount), order.destFinalCallTokenAmount.token.decimals),
+            tokenSymbol: order.destFinalCallTokenAmount.token.symbol,
+            tokenAddress: (0, viem_1.getAddress)(order.destFinalCallTokenAmount.token.token),
+            callData: order.destFinalCall.data,
+        },
+        externalId: order.externalId,
+        metadata: order.userMetadata,
+    };
+}
+var ExternalPaymentOptions;
+(function (ExternalPaymentOptions) {
+    ExternalPaymentOptions["Daimo"] = "Daimo";
+    ExternalPaymentOptions["Coinbase"] = "Coinbase";
+    ExternalPaymentOptions["RampNetwork"] = "RampNetwork";
+    ExternalPaymentOptions["Binance"] = "Binance";
+    ExternalPaymentOptions["Solana"] = "Solana";
+    // ChangeNow chains. Bitcoin, Litecoin, Doge, Tron, etc.
+    ExternalPaymentOptions["ExternalChains"] = "ExternalChains";
+    ExternalPaymentOptions["Lemon"] = "Lemon";
+})(ExternalPaymentOptions || (exports.ExternalPaymentOptions = ExternalPaymentOptions = {}));
+var DepositAddressPaymentOptions;
+(function (DepositAddressPaymentOptions) {
+    DepositAddressPaymentOptions["BITCOIN"] = "Bitcoin";
+    DepositAddressPaymentOptions["TRON_USDT"] = "USDT on Tron";
+    DepositAddressPaymentOptions["TON"] = "TON";
+    DepositAddressPaymentOptions["MONERO"] = "Monero";
+    DepositAddressPaymentOptions["DOGE"] = "Doge";
+    DepositAddressPaymentOptions["LITECOIN"] = "Litecoin";
+    DepositAddressPaymentOptions["ZCASH"] = "Zcash";
+    DepositAddressPaymentOptions["DASH"] = "Dash";
+})(DepositAddressPaymentOptions || (exports.DepositAddressPaymentOptions = DepositAddressPaymentOptions = {}));
+exports.emptyOnChainCall = {
+    to: viem_1.zeroAddress,
+    data: "0x",
+    value: 0n,
+};
+// base58 encoded bigint
+const zDaimoPayOrderID = zod_1.default.string().regex(/^[1-9A-HJ-NP-Za-km-z]+$/);
+/**
+ * Read a base58-encoded id into a bigint.
+ */
+function readDaimoPayOrderID(id) {
+    return (0, viem_1.bytesToBigInt)(base_1.base58.decode(id));
+}
+/**
+ * Write a bigint into a base58-encoded id.
+ */
+function writeDaimoPayOrderID(id) {
+    return base_1.base58.encode((0, viem_1.numberToBytes)(id));
+}
+exports.zUUID = zod_1.default.string().uuid();
+// Lifecycle: Pending (just created) -> (if failing) Retrying (exponential backoff) -> Successful or Failed
+var WebhookEventStatus;
+(function (WebhookEventStatus) {
+    WebhookEventStatus["PENDING"] = "pending";
+    WebhookEventStatus["RETRYING"] = "retrying";
+    WebhookEventStatus["SUCCESSFUL"] = "successful";
+    WebhookEventStatus["FAILED"] = "failed";
+})(WebhookEventStatus || (exports.WebhookEventStatus = WebhookEventStatus = {}));
+//# sourceMappingURL=daimoPay.js.map