@coin-voyage/shared 2.4.1 → 2.4.2

package/dist/api/client.d.ts

@@ -1,5 +1,4 @@
-import type { ClaimFeesRequest, ClaimFeesResponse, CreateWebhookRequest, GetFeeBalancesResponse, OrderStatusSocket, PaymentDetails, PaymentDetailsParams, PaymentMethodsResponse, PayOrderParams, PayOrderQuoteParams, RouteQuote, SwapDataRequest, SwapDataResponse, SwapQuoteRequest, SwapQuoteResponse, UpdateWebhookRequest, WebhookResponse } from "../types/api";
-import { PayOrderMode } from "../types/enums";
+import type { ClaimFeesRequest, ClaimFeesResponse, CreatePayOrderMode, CreateWebhookRequest, GetFeeBalancesResponse, OrderStatusSocket, PaymentDetails, PaymentDetailsParams, PaymentMethodsResponse, PayOrderParams, PayOrderQuoteParams, RouteQuote, SwapDataRequest, SwapDataResponse, SwapQuoteRequest, SwapQuoteResponse, UpdateWebhookRequest, WebhookResponse } from "../types/api";
 import type { PayOrder } from "../types/model";
 import { type APIEnvironment } from "./config";
 import { type APIResponse } from "./fetcher";
@@ -18,6 +17,7 @@ export declare class ApiClient {
         version?: string;
     });
     private request;
+    private withAuthorizationSignature;
     private getErrorMessage;
     private createBadRequestResponse;
     private validatePayOrderParams;
@@ -152,7 +152,7 @@ export declare class ApiClient {
      * }
      */
     createRefundPayOrder(payOrderId: string, params: PayOrderParams, apiSecret: string, opts?: Opts): Promise<APIResponse<PayOrder>>;
-    createPayOrder(params: PayOrderParams, mode: PayOrderMode, signature?: string, opts?: Opts): Promise<APIResponse<PayOrder>>;
+    createPayOrder(params: PayOrderParams, mode: CreatePayOrderMode, signature?: string, opts?: Opts): Promise<APIResponse<PayOrder>>;
     /**
      * Generates a PayOrder Quote.
      *
@@ -160,7 +160,7 @@ export declare class ApiClient {
      * This function requires an API key for authentication.
      *
      * @param {string} orderId - The unique identifier of the PayOrder for which the quote is requested.
-     * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, `chain_id`.
+     * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, and optional `chain_ids`.
      * @param {Opts} [opts] - Optional parameters for the request.
      * @returns {Promise<APIResponse<RouteQuote[]>>} - An array of PayTokens wrapped in an API response if the request was successful.
      *
@@ -169,7 +169,7 @@ export declare class ApiClient {
      * const quoteParams = {
      *   wallet_address: '0x1234...abcd',
      *   chain_type: ChainType.EVM,
-     *   chain_id: 1 // Ethereum Mainnet
+     *   chain_ids: [1, 10, 137]
      * };
      *
      * const response = await payOrderQuote(orderId, quoteParams);

package/dist/api/client.js

@@ -26,6 +26,17 @@ export class ApiClient {
             },
         });
     }
+    withAuthorizationSignature(signature, headers) {
+        return {
+            ...(signature
+                ? {
+                    Authorization: signature,
+                    "Authorization-Signature": signature,
+                }
+                : {}),
+            ...headers,
+        };
+    }
     getErrorMessage(error) {
         if (error instanceof Error) {
             return error.message;
@@ -220,7 +231,7 @@ export class ApiClient {
                 options: {
                     method: "POST",
                     body: JSON.stringify({ ...params }),
-                    headers: { Authorization: signature, ...opts?.headers },
+                    headers: this.withAuthorizationSignature(signature, opts?.headers),
                 },
             });
         }
@@ -230,7 +241,7 @@ export class ApiClient {
     }
     async createPayOrder(params, mode, signature, opts) {
         this.validatePayOrderParams(params);
-        if ([PayOrderMode.SALE, PayOrderMode.REFUND].includes(mode) && !signature) {
+        if (mode === PayOrderMode.SALE && !signature) {
             throw new Error(`Signature is required for ${mode} PayOrders`);
         }
         return this.request({
@@ -238,7 +249,7 @@ export class ApiClient {
             options: {
                 method: "POST",
                 body: JSON.stringify({ mode, ...params }),
-                headers: { ...(signature ? { Authorization: signature } : {}), ...opts?.headers },
+                headers: this.withAuthorizationSignature(signature, opts?.headers),
             },
         });
     }
@@ -249,7 +260,7 @@ export class ApiClient {
      * This function requires an API key for authentication.
      *
      * @param {string} orderId - The unique identifier of the PayOrder for which the quote is requested.
-     * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, `chain_id`.
+     * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, and optional `chain_ids`.
      * @param {Opts} [opts] - Optional parameters for the request.
      * @returns {Promise<APIResponse<RouteQuote[]>>} - An array of PayTokens wrapped in an API response if the request was successful.
      *
@@ -258,7 +269,7 @@ export class ApiClient {
      * const quoteParams = {
      *   wallet_address: '0x1234...abcd',
      *   chain_type: ChainType.EVM,
-     *   chain_id: 1 // Ethereum Mainnet
+     *   chain_ids: [1, 10, 137]
      * };
      *
      * const response = await payOrderQuote(orderId, quoteParams);
@@ -334,7 +345,7 @@ export class ApiClient {
             path: "/fees/balance",
             options: {
                 method: "GET",
-                headers: { Authorization: signature, ...opts?.headers },
+                headers: this.withAuthorizationSignature(signature, opts?.headers),
             },
         });
     }
@@ -353,7 +364,7 @@ export class ApiClient {
             options: {
                 method: "POST",
                 body: JSON.stringify(params),
-                headers: { Authorization: signature, ...opts?.headers },
+                headers: this.withAuthorizationSignature(signature, opts?.headers),
             },
         });
     }
@@ -373,7 +384,7 @@ export class ApiClient {
             path: "/webhooks",
             options: {
                 method: "GET",
-                headers: { Authorization: signature, ...opts?.headers },
+                headers: this.withAuthorizationSignature(signature, opts?.headers),
             },
         });
     }
@@ -392,7 +403,7 @@ export class ApiClient {
             options: {
                 method: "POST",
                 body: JSON.stringify(params),
-                headers: { Authorization: signature, ...opts?.headers },
+                headers: this.withAuthorizationSignature(signature, opts?.headers),
             },
         });
     }
@@ -412,7 +423,7 @@ export class ApiClient {
             options: {
                 method: "PUT",
                 body: JSON.stringify(params),
-                headers: { Authorization: signature, ...opts?.headers },
+                headers: this.withAuthorizationSignature(signature, opts?.headers),
             },
         });
     }
@@ -430,7 +441,7 @@ export class ApiClient {
             path: `/webhooks/${webhookId}`,
             options: {
                 method: "DELETE",
-                headers: { Authorization: signature, ...opts?.headers },
+                headers: this.withAuthorizationSignature(signature, opts?.headers),
             },
         });
     }

package/dist/currency/currencies.d.ts

@@ -1,4 +1,4 @@
-export declare const FIAT_CURRENCIES: readonly ["USD"];
+export declare const FIAT_CURRENCIES: readonly ["USD", "EUR"];
 export type FiatCurrency = (typeof FIAT_CURRENCIES)[number];
 export interface CurrencyExchangeRate {
     name: string;

package/dist/currency/currencies.js

@@ -1,4 +1,4 @@
-export const FIAT_CURRENCIES = ["USD"];
+export const FIAT_CURRENCIES = ["USD", "EUR"];
 export const currencyRateUSD = {
     name: "US Dollar",
     symbol: "$",

package/dist/payment/payment-steps.d.ts

@@ -1,11 +1,11 @@
-import type { BitcoinPaymentData, CryptoPaymentData, EVMPaymentData, FiatPaymentData, PaymentData, PaymentStep, SolanaPaymentData, SuiPaymentData } from "../types/model";
-export declare function getFiatPaymentStep(payment?: PaymentData): PaymentStep | undefined;
-export declare function getFiatPaymentData(payment?: PaymentData): FiatPaymentData | undefined;
-export declare function getCryptoDepositStep(payment?: PaymentData): PaymentStep | undefined;
-export declare function getCryptoTransactionStep(payment?: PaymentData): PaymentStep | undefined;
-export declare function getWalletPaymentStep(payment?: PaymentData): PaymentStep | undefined;
-export declare function getWalletPaymentData(payment?: PaymentData): CryptoPaymentData | undefined;
-export declare function getDepositAddress(payment?: PaymentData): string | undefined;
+import type { BitcoinPaymentData, CryptoPaymentData, EVMPaymentData, FiatPaymentData, PaymentDataBase, PaymentStep, SolanaPaymentData, SuiPaymentData } from "../types/model";
+export declare function getFiatPaymentStep(payment?: PaymentDataBase): PaymentStep | undefined;
+export declare function getFiatPaymentData(payment?: PaymentDataBase): FiatPaymentData | undefined;
+export declare function getCryptoDepositStep(payment?: PaymentDataBase): PaymentStep | undefined;
+export declare function getCryptoTransactionStep(payment?: PaymentDataBase): PaymentStep | undefined;
+export declare function getWalletPaymentStep(payment?: PaymentDataBase): PaymentStep | undefined;
+export declare function getWalletPaymentData(payment?: PaymentDataBase): CryptoPaymentData | undefined;
+export declare function getDepositAddress(payment?: PaymentDataBase): string | undefined;
 export declare function getEvmPaymentData(paymentData?: CryptoPaymentData): EVMPaymentData | undefined;
 export declare function getBitcoinPaymentData(paymentData?: CryptoPaymentData): BitcoinPaymentData | undefined;
 export declare function getSolanaPaymentData(paymentData?: CryptoPaymentData): SolanaPaymentData | undefined;

package/dist/schemas/pay-order.d.ts

@@ -19,7 +19,7 @@ export declare const zPayOrderMetadata: z.ZodObject<{
 export declare const zPayOrderSettings: z.ZodObject<{
     hide_footer: z.ZodOptional<z.ZodBoolean>;
     card_payments: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
+}, z.core.$catchall<z.ZodUnknown>>;
 export declare const zPayOrder: z.ZodObject<{
     metadata: z.ZodOptional<z.ZodObject<{
         items: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -41,7 +41,7 @@ export declare const zPayOrder: z.ZodObject<{
     settings: z.ZodOptional<z.ZodObject<{
         hide_footer: z.ZodOptional<z.ZodBoolean>;
         card_payments: z.ZodOptional<z.ZodBoolean>;
-    }, z.core.$strip>>;
+    }, z.core.$catchall<z.ZodUnknown>>>;
     intent: z.ZodObject<{
         asset: z.ZodOptional<z.ZodObject<{
             chain_id: z.ZodNumber;
@@ -53,9 +53,11 @@ export declare const zPayOrder: z.ZodObject<{
                 amount: z.ZodNumber;
                 unit: z.ZodEnum<{
                     USD: "USD";
+                    EUR: "EUR";
                 }>;
             }, z.core.$strip>>;
         }, z.core.$strip>;
         receiving_address: z.ZodOptional<z.ZodString>;
+        custom_fee_bps: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>;
 }, z.core.$strip>;

package/dist/schemas/pay-order.js

@@ -49,7 +49,7 @@ export const zPayOrderSettings = z.object({
         .boolean()
         .optional()
         .describe("Whether to enable card payments for this order. Requires approval from CoinVoyage."),
-});
+}).catchall(z.unknown());
 // also validate not both token_amount and fiat are present
 export const zPayOrder = z.object({
     metadata: zPayOrderMetadata.optional(),
@@ -81,6 +81,7 @@ export const zPayOrder = z.object({
                 .optional(),
         }),
         receiving_address: z.string().optional(),
+        custom_fee_bps: z.number().int().optional(),
     })
         .superRefine((data, ctx) => {
         const isFiat = data.amount.fiat?.amount !== undefined;

package/dist/types/api.d.ts

@@ -1,7 +1,11 @@
 import { FiatCurrency } from "../currency/currencies";
-import { ChainId, ChainType, PaymentMethod, PaymentRail, PayOrderStatus } from "./enums";
+import { ChainId, ChainType, PaymentMethod, PaymentRail, PayOrderMode, PayOrderStatus } from "./enums";
 import { PayOrderEvent } from "./events";
-import { CurrencyAmount, CurrencyBase, CurrencyWithAmount, FiatAmount, PaymentData, PayOrderMetadata, PayOrderSettings, QuoteWithCurrency } from "./model";
+import { CurrencyAmount, CurrencyBase, CurrencyWithAmount, FiatAmount, PaymentDataBase, PayOrder, PayOrderMetadata, QuoteWithCurrency } from "./model";
+export type CreatePayOrderMode = PayOrderMode.SALE | PayOrderMode.DEPOSIT;
+export type OrderRequest = PayOrderParams & {
+    mode: CreatePayOrderMode;
+};
 export type PayOrderParams = {
     /**
      * Intent of the order.
@@ -11,37 +15,23 @@ export type PayOrderParams = {
      * Metadata to attach to the payOrder.
      */
     metadata?: PayOrderMetadata;
-    /**
-     * UI and behavior settings to attach to the payOrder.
-     */
-    settings?: PayOrderSettings;
 };
 export type PayOrderQuoteParams = {
     wallet_address: string;
     chain_type: ChainType;
-    chain_id?: ChainId;
+    chain_ids?: ChainId[];
 };
-type PaymentDetailsBaseParams = {
+export type PaymentDetailsParams = {
     payorder_id: string;
     payment_rail?: PaymentRail;
-};
-export type PaymentDetailsParams = (PaymentDetailsBaseParams & {
-    source_currency?: never;
-    refund_address?: never;
-    quote_id?: never;
-}) | (PaymentDetailsBaseParams & {
-    source_currency: CurrencyBase;
+    source_currency?: CurrencyBase;
     refund_address?: string;
-    quote_id?: never;
-}) | (PaymentDetailsBaseParams & {
-    source_currency?: never;
-    refund_address?: never;
-    quote_id: string;
-});
+    quote_id?: string;
+};
 export type PaymentDetails = {
     payorder_id: string;
     status: PayOrderStatus;
-    data: PaymentData;
+    data: PaymentDataBase;
 };
 export type PaymentMethodAvailability = {
     method: PaymentMethod;
@@ -65,6 +55,10 @@ export type PayOrderIntent = {
      * Optional receiving address to fulfill the order to. If not provided, a settlement address will be selected.
      */
     receiving_address?: string;
+    /**
+     * Optional custom fee in basis points.
+     */
+    custom_fee_bps?: number;
 };
 export type IntentAmount = {
     /**
@@ -95,6 +89,44 @@ export type ClaimFeesResponse = {
     source_chain_id: ChainId;
     currency: CurrencyAmount;
 };
+export type EndorsementName = "base" | "sepa" | "spei" | "pix";
+export type KYCLinkType = "individual" | "business";
+export type KYCStatus = "not_started" | "incomplete" | "awaiting_questionnaire" | "awaiting_ubo" | "under_review" | "approved" | "rejected" | "paused" | "offboarded";
+export type TOSStatus = "pending" | "approved";
+export type KYCRejectionReason = {
+    developer_reason: string;
+    reason: string;
+    created_at: string;
+};
+export type KYCLinkRequest = {
+    email: string;
+    type: KYCLinkType;
+    full_name?: string;
+    endorsements?: EndorsementName[];
+    redirect_uri?: string;
+};
+export type KYCLinkResponse = {
+    id: string;
+    type: KYCLinkType;
+    customer_id?: string | null;
+    full_name?: string | null;
+    email: string;
+    kyc_link: string;
+    kyc_status: KYCStatus;
+    rejection_reasons?: KYCRejectionReason[];
+    tos_link: string;
+    tos_status: TOSStatus;
+    created_at?: string | null;
+};
+export type Pagination = {
+    total_count: number;
+    limit: number;
+    offset: number;
+};
+export type ResponseWithPagination = {
+    data: PayOrder[];
+    pagination: Pagination;
+};
 export type WebhookResponse = {
     id: string;
     url: string;
@@ -112,13 +144,18 @@ export type UpdateWebhookRequest = {
     active?: boolean;
 };
 export type SwapMode = "ExactIn" | "ExactOut";
-export type SwapIntent = {
+export type CryptoSwapInput = {
+    slippage_bps?: number;
     source_currency: CurrencyBase;
+    sender_address?: string;
+};
+export type SwapIntent = {
+    payment_rail?: PaymentRail;
     destination_currency: CurrencyBase;
     amount: string;
     swap_mode: SwapMode;
     receiving_address?: string;
-    slippage_bps?: number;
+    crypto?: CryptoSwapInput;
     custom_fee_bps?: number;
 };
 export type SwapQuoteRequest = {
@@ -133,34 +170,49 @@ export type SwapQuoteResponse = {
     swap_mode: SwapMode;
 };
 export type RouteQuote = QuoteWithBalance & {
-    qoute_id: string;
+    quote_id: string;
     output: CurrencyWithAmount;
     swap_mode: SwapMode;
     slippage_bps?: number;
-    price_impact?: number;
+    price_impact: number;
 };
 export type QuoteWithBalance = QuoteWithCurrency & {
     balance?: CurrencyAmount;
 };
-export type SwapDataRequest = SwapQuoteRequest & {
+export type OrderQuoteResponse = RouteQuote[];
+export type SwapDataRequest = {
+    metadata?: PayOrderMetadata;
+    intent: SwapIntent;
     receiving_address: string;
-    refund_address: string;
 };
 export type SwapDataResponse = PaymentDetails;
-declare enum WsMessageType {
-    Connected = "connected",
-    Subscription = "subscription",
-    Event = "event",
-    Error = "error"
-}
+export type WsConnectMessage = {
+    type: "connect";
+    data: {
+        api_key: string;
+    };
+};
+export type WsSubscribeMessage = {
+    type: "subscribe";
+    data: {
+        order_id?: string | null;
+    };
+};
+export type WsUnsubscribeMessage = {
+    type: "unsubscribe";
+    data: {
+        order_id?: string | null;
+    };
+};
+export type WsClientMessage = WsConnectMessage | WsSubscribeMessage | WsUnsubscribeMessage;
 export type WsConnectedMessage = {
-    type: WsMessageType.Connected;
+    type: "connected";
     data: {
         status: "authenticated";
     };
 };
 export type WsSubscriptionMessage = {
-    type: WsMessageType.Subscription;
+    type: "subscription";
     data: {
         order_id?: string;
         scope: "order" | "organization";
@@ -168,11 +220,11 @@ export type WsSubscriptionMessage = {
     };
 };
 export type WsEventMessage = {
-    type: WsMessageType.Event;
+    type: "event";
     data: PayOrderEvent;
 };
 export type WsErrorMessage = {
-    type: WsMessageType.Error;
+    type: "error";
     data: {
         message: string;
     };
@@ -189,4 +241,3 @@ export type OrderStatusSocket = {
     onError: (callback: (event: Event) => void) => void;
     close: () => void;
 };
-export {};

package/dist/types/api.js

@@ -1,9 +1 @@
-// ======== WebSocket ========
-var WsMessageType;
-(function (WsMessageType) {
-    WsMessageType["Connected"] = "connected";
-    WsMessageType["Subscription"] = "subscription";
-    WsMessageType["Event"] = "event";
-    WsMessageType["Error"] = "error";
-})(WsMessageType || (WsMessageType = {}));
 export {};

package/dist/types/enums.d.ts

@@ -43,7 +43,9 @@ export declare enum StepKind {
 export declare enum PayOrderMode {
     SALE = "SALE",
     DEPOSIT = "DEPOSIT",
-    REFUND = "REFUND"
+    REFUND = "REFUND",
+    SWAP = "SWAP",
+    FEE_CLAIM = "FEE_CLAIM"
 }
 export declare enum PayOrderStatus {
     PENDING = "PENDING",

package/dist/types/enums.js

@@ -58,6 +58,8 @@ export var PayOrderMode;
     PayOrderMode["SALE"] = "SALE";
     PayOrderMode["DEPOSIT"] = "DEPOSIT";
     PayOrderMode["REFUND"] = "REFUND";
+    PayOrderMode["SWAP"] = "SWAP";
+    PayOrderMode["FEE_CLAIM"] = "FEE_CLAIM";
 })(PayOrderMode || (PayOrderMode = {}));
 export var PayOrderStatus;
 (function (PayOrderStatus) {

package/dist/types/model.d.ts

@@ -4,18 +4,24 @@ import { zPayOrderMetadata, zPayOrderSettings } from "../schemas/pay-order";
 import { ChainId, PaymentRail, PayOrderMode, PayOrderStatus, ProviderStatus, StepKind } from "./enums";
 export type PayOrder = {
     id: string;
+    organization_id: string;
     mode: PayOrderMode;
     status: PayOrderStatus;
     metadata?: ParsedPayOrderMetadata;
     settings?: ParsedPayOrderSettings;
     fulfillment: FulfillmentData;
     payment?: PaymentData;
+    hosted_url: string;
+    created_at: Date;
+    updated_at: Date;
 };
 type MetadataExtraFields = Record<string, unknown>;
+type SettingsExtraFields = Record<string, unknown>;
 export type ParsedPayOrderMetadata = z.output<typeof zPayOrderMetadata> & MetadataExtraFields;
 export type PayOrderMetadata = z.infer<typeof zPayOrderMetadata>;
-export type ParsedPayOrderSettings = z.output<typeof zPayOrderSettings>;
-export type PayOrderSettings = z.infer<typeof zPayOrderSettings>;
+export type ParsedPayOrderSettings = z.output<typeof zPayOrderSettings> & SettingsExtraFields;
+export type PayOrderSettings = z.infer<typeof zPayOrderSettings> & SettingsExtraFields;
+export type OrganizationSettings = ParsedPayOrderSettings;
 export interface Currency extends CurrencyBase {
     id?: string;
     name: string;
@@ -38,6 +44,7 @@ export interface QuoteWithCurrency extends CurrencyWithAmount {
     gas?: CurrencyAmount;
 }
 export interface CurrencyWithBalance extends CurrencyWithAmount {
+    owner?: string;
     balance?: CurrencyAmount;
 }
 export interface CurrencyAmount {
@@ -51,28 +58,40 @@ export interface FeeBreakdown {
     protocol_fee?: CurrencyAmount;
     custom_fee?: CurrencyAmount;
 }
-export interface FiatQuoteData {
-    source_currency: string;
-    source_amount: string;
-    source_total_amount: string;
-    destination_currency: string;
-    destination_network: string;
+export interface FeeCurrencyBreakdown {
+    currency: Currency;
+    total_fee: CurrencyAmount;
+    protocol_fee?: CurrencyAmount;
+    custom_fee?: CurrencyAmount;
+}
+export type OnrampDestinationCurrency = "btc" | "eth" | "pol" | "sol" | "usdc";
+export type OnrampDestinationNetwork = "base" | "ethereum" | "optimism" | "polygon" | "solana";
+export interface OnrampQuote {
+    source_currency?: string;
+    source_amount?: string;
+    source_total_amount?: string;
+    destination_currency: OnrampDestinationCurrency;
+    destination_network: OnrampDestinationNetwork;
     destination_amount: string;
+    exchange_rate?: string;
     network_fee_amount?: string;
     transaction_fee_amount?: string;
 }
-export interface FiatPaymentData {
+export type FiatQuoteData = OnrampQuote;
+export interface OnrampPaymentData {
     session_id: string;
     stripe_publishable_key: string;
     client_secret: string;
     status: string;
+    hosted_url?: string;
     source_currency?: string;
-    destination_currency?: string;
-    destination_network?: string;
-    destination_amount?: string;
-    wallet_address?: string;
-    quote?: FiatQuoteData;
+    destination_currency: OnrampDestinationCurrency;
+    destination_network: OnrampDestinationNetwork;
+    destination_amount: string;
+    wallet_address: string;
+    quote?: OnrampQuote;
 }
+export type FiatPaymentData = OnrampPaymentData;
 export type SerializedSuiTransaction = unknown;
 export type SerializedSolanaTransaction = unknown;
 export interface CryptoPaymentData {
@@ -105,7 +124,7 @@ export type TokenAmount = {
 };
 export type FiatAmount = {
     amount: number;
-    unit: string;
+    unit: FiatCurrency;
 };
 export type RequestData = {
     currency: Currency | null;
@@ -119,22 +138,25 @@ export type FulfillmentData = {
     asset?: Currency;
     fiat?: FiatCurrency;
     amount: CurrencyAmount;
-    rate_usd?: number;
+    rate_usd?: string;
     receiving_address?: string;
     custom_fee_bps?: number;
 };
-export type PaymentData = {
+export type PaymentDataBase = {
+    payment_rail: PaymentRail;
     src: QuoteWithCurrency;
     dst: CurrencyWithAmount;
     deposit_address: string;
     receiving_address: string;
-    refund_address: string;
+    refund_address?: string;
+    steps: PaymentStep[];
+    expires_at: string;
+};
+export type PaymentData = PaymentDataBase & {
     source_tx_hash?: string;
     destination_tx_hash?: string;
     refund_tx_hash?: string;
     fee_tx_hash?: string;
-    steps: PaymentStep[];
-    expires_at: Date;
 };
 export type PaymentStep = {
     rail: PaymentRail;
@@ -152,20 +174,24 @@ export type ExecutionStep = {
     provider: string;
     receiver: string;
     deposit_address: string;
-    source_tx_hash?: string | null;
-    destination_tx_hash?: string | null;
-    error?: unknown;
+    source_tx_hash?: string;
+    destination_tx_hash?: string;
+    error?: string;
     cleanup_tx_hash?: Record<string, string>;
-    cleanup_error?: unknown;
+    cleanup_error?: string;
+    cleanup_recipient?: string;
     source_currency: CurrencyWithAmount;
     destination_currency: CurrencyWithAmount;
-    gas_amount?: CurrencyAmount;
-    fee_plan?: FeePlan;
+    chain_data?: CryptoPaymentData;
+    gas?: CurrencyWithAmount;
+    fees?: FeeCurrencyBreakdown;
     fee_tx_hash?: string;
-    fee_error?: unknown;
-    price_impact?: string;
+    fee_error?: string;
+    fee_plan?: FeePlan;
+    price_impact?: number;
 };
 export interface FeePlan extends CurrencyWithAmount {
+    placement: string;
     fee_bps?: number;
 }
 export type BigIntStr = `${bigint}`;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coin-voyage/shared",
   "description": "Shared utilities for Coin Voyage",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "private": false,
   "sideEffects": false,
   "exports": {