@coin-voyage/shared 2.3.5-beta.2 → 2.3.5-beta.3

package/dist/api/client.d.ts

@@ -1,5 +1,5 @@
 import { type PayOrder, PayOrderMode } from "../types";
-import type { ClaimFeesRequest, ClaimFeesResponse, CreateWebhookRequest, GetFeeBalancesResponse, OrderStatusSocket, PaymentDetails, PaymentDetailsParams, PayOrderParams, PayOrderQuoteParams, RouteQuote, SwapDataRequest, SwapDataResponse, SwapQuoteRequest, SwapQuoteResponse, UpdateWebhookRequest, WebhookResponse } from "../types/api";
+import type { ClaimFeesRequest, ClaimFeesResponse, CreateWebhookRequest, GetFeeBalancesResponse, OrderStatusSocket, PaymentDetails, PaymentDetailsParams, PaymentMethodsResponse, PayOrderParams, PayOrderQuoteParams, RouteQuote, SwapDataRequest, SwapDataResponse, SwapQuoteRequest, SwapQuoteResponse, UpdateWebhookRequest, WebhookResponse } from "../types/api";
 import { type APIEnvironment } from "./config";
 import { type APIResponse } from "./fetcher";
 type Opts = {
@@ -30,6 +30,17 @@ export declare class ApiClient {
      * const { data: payOrder, error } = await getPayOrder('123456');
      */
     getPayOrder(payOrderId: string): Promise<APIResponse<PayOrder>>;
+    /**
+     * Fetches payment method availability for a PayOrder.
+     *
+     * Retrieves the currently available payment methods for the provided PayOrder ID,
+     * including optional availability reasons and minimum fiat amounts.
+     *
+     * @param {string} payOrderId - The unique identifier of the PayOrder.
+     * @param {Opts} [opts] - Optional parameters for the request, such as additional headers.
+     * @returns {Promise<APIResponse<PaymentMethodsResponse>>} - Payment method availability wrapped in an API response.
+     */
+    getPayOrderPaymentMethods(payOrderId: string, opts?: Opts): Promise<APIResponse<PaymentMethodsResponse>>;
     /**
      * Creates a `DEPOSIT` PayOrder.
      *
@@ -175,9 +186,10 @@ export declare class ApiClient {
      *
      * @param {PaymentDetailsParams} params - Parameters to retrieve the payment details.
      * @param {string} params.payorder_id - The unique identifier of the PayOrder for which payment details are fetched.
+     * @param {PaymentRail} [params.payment_rail] - (Optional) The payment rail for which to fetch the payment details. default: CRYPTO.
      * @param {CurrencyBase} [params.source_currency] - (Optional) The source currency information.
-     * @param {string} params.quote_id - (Optional) The quote ID for the PayOrder.
-     * @param {string} params.refund_address - The address where funds will be refunded in case of a failed transaction.
+     * @param {string} [params.quote_id] - (Optional) The quote ID for the PayOrder.
+     * @param {string} [params.refund_address] - (Optional) The address where funds will be refunded in case of a failed transaction.
      * @param {Opts} [opts] - Optional parameters for the request, such as additional headers.
      *
      * @returns {Promise<APIResponse<PaymentDetails>>} - The payment details object wrapped in an API response if the request is successful.

package/dist/api/client.js

@@ -40,6 +40,25 @@ export class ApiClient {
     async getPayOrder(payOrderId) {
         return this.request({ path: `/pay-orders/${payOrderId}` });
     }
+    /**
+     * Fetches payment method availability for a PayOrder.
+     *
+     * Retrieves the currently available payment methods for the provided PayOrder ID,
+     * including optional availability reasons and minimum fiat amounts.
+     *
+     * @param {string} payOrderId - The unique identifier of the PayOrder.
+     * @param {Opts} [opts] - Optional parameters for the request, such as additional headers.
+     * @returns {Promise<APIResponse<PaymentMethodsResponse>>} - Payment method availability wrapped in an API response.
+     */
+    async getPayOrderPaymentMethods(payOrderId, opts) {
+        return this.request({
+            path: `/pay-orders/${payOrderId}/payment-methods`,
+            options: {
+                method: "GET",
+                headers: opts?.headers,
+            },
+        });
+    }
     /**
      * Creates a `DEPOSIT` PayOrder.
      *
@@ -278,9 +297,10 @@ export class ApiClient {
      *
      * @param {PaymentDetailsParams} params - Parameters to retrieve the payment details.
      * @param {string} params.payorder_id - The unique identifier of the PayOrder for which payment details are fetched.
+     * @param {PaymentRail} [params.payment_rail] - (Optional) The payment rail for which to fetch the payment details. default: CRYPTO.
      * @param {CurrencyBase} [params.source_currency] - (Optional) The source currency information.
-     * @param {string} params.quote_id - (Optional) The quote ID for the PayOrder.
-     * @param {string} params.refund_address - The address where funds will be refunded in case of a failed transaction.
+     * @param {string} [params.quote_id] - (Optional) The quote ID for the PayOrder.
+     * @param {string} [params.refund_address] - (Optional) The address where funds will be refunded in case of a failed transaction.
      * @param {Opts} [opts] - Optional parameters for the request, such as additional headers.
      *
      * @returns {Promise<APIResponse<PaymentDetails>>} - The payment details object wrapped in an API response if the request is successful.

package/dist/common/index.d.ts

@@ -8,6 +8,7 @@ export * from "./debug";
 export * from "./format";
 export * from "./local-storage";
 export * from "./organization";
+export * from "./payment-steps";
 export * from "./plural";
 export * from "./time";
 export * from "./validation";

package/dist/common/index.js

@@ -8,6 +8,7 @@ export * from "./debug";
 export * from "./format";
 export * from "./local-storage";
 export * from "./organization";
+export * from "./payment-steps";
 export * from "./plural";
 export * from "./time";
 export * from "./validation";

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

@@ -0,0 +1,12 @@
+import { BitcoinPaymentData, type CryptoPaymentData, EVMPaymentData, type FiatPaymentData, type PaymentData, type PaymentStep, SolanaPaymentData, SuiPaymentData } from "../types";
+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;
+export declare function getEvmPaymentData(paymentData?: CryptoPaymentData): EVMPaymentData | undefined;
+export declare function getBitcoinPaymentData(paymentData?: CryptoPaymentData): BitcoinPaymentData | undefined;
+export declare function getSolanaPaymentData(paymentData?: CryptoPaymentData): SolanaPaymentData | undefined;
+export declare function getSuiPaymentData(paymentData?: CryptoPaymentData): SuiPaymentData | undefined;

package/dist/common/payment-steps.js

@@ -0,0 +1,53 @@
+import { PaymentRail, StepKind, } from "../types";
+export function getFiatPaymentStep(payment) {
+    return payment?.steps.find((step) => {
+        return (step.rail === PaymentRail.FIAT || step.kind === StepKind.KIND_STRIPE_ONRAMP) && step.data?.fiat;
+    });
+}
+export function getFiatPaymentData(payment) {
+    const data = getFiatPaymentStep(payment)?.data;
+    return data?.fiat;
+}
+export function getCryptoDepositStep(payment) {
+    return payment?.steps.find((step) => {
+        return step.rail === PaymentRail.CRYPTO && step.kind === StepKind.KIND_DEPOSIT;
+    });
+}
+export function getCryptoTransactionStep(payment) {
+    return payment?.steps.find((step) => {
+        return step.rail === PaymentRail.CRYPTO && step.kind === StepKind.KIND_TRANSACTION && step.data?.crypto;
+    });
+}
+export function getWalletPaymentStep(payment) {
+    return getCryptoTransactionStep(payment) ?? getCryptoDepositStep(payment);
+}
+export function getWalletPaymentData(payment) {
+    const data = getCryptoTransactionStep(payment)?.data;
+    return data?.crypto;
+}
+export function getDepositAddress(payment) {
+    const depositStep = getCryptoDepositStep(payment);
+    if (depositStep?.deposit_address) {
+        return depositStep.deposit_address;
+    }
+    if (getCryptoTransactionStep(payment)) {
+        return undefined;
+    }
+    return payment?.deposit_address;
+}
+export function getEvmPaymentData(paymentData) {
+    const data = paymentData;
+    return data?.evm;
+}
+export function getBitcoinPaymentData(paymentData) {
+    const data = paymentData;
+    return data?.bitcoin;
+}
+export function getSolanaPaymentData(paymentData) {
+    const data = paymentData;
+    return data?.solana;
+}
+export function getSuiPaymentData(paymentData) {
+    const data = paymentData;
+    return data?.sui;
+}

package/dist/types/api.d.ts

@@ -1,7 +1,7 @@
 import { FiatCurrency } from "../common/currencies";
-import { ChainId, ChainType, PayOrderStatus } from "./enums";
+import { ChainId, ChainType, PaymentMethod, PaymentRail, PayOrderStatus } from "./enums";
 import { PayOrderEvent } from "./events";
-import { CurrencyAmount, CurrencyBase, CurrencyWithAmount, PaymentData, PayOrderMetadata, QuoteWithCurrency } from "./model";
+import { CurrencyAmount, CurrencyBase, CurrencyWithAmount, FiatAmount, PaymentData, PayOrderMetadata, QuoteWithCurrency } from "./model";
 export type PayOrderParams = {
     /**
      * Intent of the order.
@@ -17,12 +17,21 @@ export type PayOrderQuoteParams = {
     chain_type: ChainType;
     chain_id?: ChainId;
 };
-export type PaymentDetailsParams = {
+type PaymentDetailsBaseParams = {
     payorder_id: string;
-} & ({
+    payment_rail?: PaymentRail;
+};
+export type PaymentDetailsParams = (PaymentDetailsBaseParams & {
+    source_currency?: never;
+    refund_address?: never;
+    quote_id?: never;
+}) | (PaymentDetailsBaseParams & {
     source_currency: CurrencyBase;
     refund_address?: string;
-} | {
+    quote_id?: never;
+}) | (PaymentDetailsBaseParams & {
+    source_currency?: never;
+    refund_address?: never;
     quote_id: string;
 });
 export type PaymentDetails = {
@@ -30,6 +39,15 @@ export type PaymentDetails = {
     status: PayOrderStatus;
     data: PaymentData;
 };
+export type PaymentMethodAvailability = {
+    method: PaymentMethod;
+    available: boolean;
+    reason?: string;
+    minimum_amount?: FiatAmount;
+};
+export type PaymentMethodsResponse = {
+    methods: PaymentMethodAvailability[];
+};
 export type PayOrderIntent = {
     /**
      * Desired fulfillment asset.

package/dist/types/enums.d.ts

@@ -26,6 +26,20 @@ export declare enum ChainId {
     SUI = 30000000000002,
     TRX = 30000000000003
 }
+export declare enum PaymentMethod {
+    WALLET = "WALLET",
+    DEPOSIT_ADDRESS = "DEPOSIT_ADDRESS",
+    CARD = "CARD"
+}
+export declare enum PaymentRail {
+    CRYPTO = "CRYPTO",
+    FIAT = "FIAT"
+}
+export declare enum StepKind {
+    KIND_DEPOSIT = "deposit",
+    KIND_TRANSACTION = "transaction",
+    KIND_STRIPE_ONRAMP = "stripe_onramp"
+}
 export declare enum PayOrderMode {
     SALE = "SALE",
     DEPOSIT = "DEPOSIT",

package/dist/types/enums.js

@@ -36,6 +36,23 @@ export var ChainId;
     ChainId[ChainId["TRX"] = 30000000000003] = "TRX";
     // XRPL = 30000000000004,
 })(ChainId || (ChainId = {}));
+export var PaymentMethod;
+(function (PaymentMethod) {
+    PaymentMethod["WALLET"] = "WALLET";
+    PaymentMethod["DEPOSIT_ADDRESS"] = "DEPOSIT_ADDRESS";
+    PaymentMethod["CARD"] = "CARD";
+})(PaymentMethod || (PaymentMethod = {}));
+export var PaymentRail;
+(function (PaymentRail) {
+    PaymentRail["CRYPTO"] = "CRYPTO";
+    PaymentRail["FIAT"] = "FIAT";
+})(PaymentRail || (PaymentRail = {}));
+export var StepKind;
+(function (StepKind) {
+    StepKind["KIND_DEPOSIT"] = "deposit";
+    StepKind["KIND_TRANSACTION"] = "transaction";
+    StepKind["KIND_STRIPE_ONRAMP"] = "stripe_onramp";
+})(StepKind || (StepKind = {}));
 export var PayOrderMode;
 (function (PayOrderMode) {
     PayOrderMode["SALE"] = "SALE";

package/dist/types/model.d.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
-import { zPayOrderMetadata } from "../common/validation";
 import { FiatCurrency } from "../common/currencies";
-import { ChainId, PayOrderMode, PayOrderStatus, ProviderStatus } from "./enums";
+import { zPayOrderMetadata } from "../common/validation";
+import { ChainId, PaymentRail, PayOrderMode, PayOrderStatus, ProviderStatus, StepKind } from "./enums";
 export type PayOrder = {
     id: string;
     mode: PayOrderMode;
@@ -51,6 +51,54 @@ 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;
+    destination_amount: string;
+    network_fee_amount?: string;
+    transaction_fee_amount?: string;
+}
+export interface FiatPaymentData {
+    session_id: string;
+    stripe_publishable_key: string;
+    client_secret: string;
+    status: string;
+    source_currency?: string;
+    destination_currency?: string;
+    destination_network?: string;
+    destination_amount?: string;
+    wallet_address?: string;
+    quote?: FiatQuoteData;
+}
+export type SerializedSuiTransaction = unknown;
+export type SerializedSolanaTransaction = unknown;
+export interface CryptoPaymentData {
+    evm?: EVMPaymentData;
+    bitcoin?: BitcoinPaymentData;
+    solana?: SolanaPaymentData;
+    sui?: SuiPaymentData;
+}
+export interface SuiPaymentData {
+    transaction: SerializedSuiTransaction;
+}
+export interface SolanaPaymentData {
+    transaction: SerializedSolanaTransaction;
+}
+export interface BitcoinPaymentData {
+    psbt: string;
+}
+export interface EVMPaymentData {
+    from: string;
+    to: string;
+    data: string;
+    value: string;
+    chainId: ChainId;
+    maxFeePerGas?: string;
+    maxPriorityFeePerGas?: string;
+}
 export type TokenAmount = {
     ui_amount: number;
     raw_amount: BigIntStr;
@@ -84,8 +132,19 @@ export type PaymentData = {
     destination_tx_hash?: string;
     refund_tx_hash?: string;
     fee_tx_hash?: string;
+    steps: PaymentStep[];
     expires_at: Date;
 };
+export type PaymentStep = {
+    rail: PaymentRail;
+    kind: StepKind;
+    deposit_address?: string;
+    data?: PaymentStepData;
+};
+export type PaymentStepData = {
+    crypto?: CryptoPaymentData;
+    fiat?: FiatPaymentData;
+};
 export type ExecutionStep = {
     id: string;
     status: ProviderStatus;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coin-voyage/shared",
   "description": "Shared utilities for Coin Voyage",
-  "version": "2.3.5-beta.2",
+  "version": "2.3.5-beta.3",
   "private": false,
   "sideEffects": false,
   "exports": {