@coin-voyage/shared 2.4.2 → 2.4.3

package/dist/currency/currencies.d.ts

@@ -1,3 +1,4 @@
+import { CurrencyBase } from "../types";
 export declare const FIAT_CURRENCIES: readonly ["USD", "EUR"];
 export type FiatCurrency = (typeof FIAT_CURRENCIES)[number];
 export interface CurrencyExchangeRate {
@@ -14,3 +15,4 @@ export declare const nonUsdCurrencies: {
     currency: string;
     decimals: number;
 }[];
+export declare function currencyID(currency: CurrencyBase): string;

package/dist/currency/currencies.js

@@ -25,3 +25,6 @@ export const nonUsdCurrencies = data.map(([name, symbol, currency, decimals]) =>
     currency,
     decimals,
 }));
+export function currencyID(currency) {
+    return currency.address ? `${currency.address}:${currency.chain_id}` : currency.chain_id.toString();
+}

package/dist/currency/token-list.js

@@ -1,6 +1,8 @@
+import { currencyID } from "./currencies";
 const TOKEN_LIST_URL = "https://raw.githubusercontent.com/coin-voyage/token-list/main/tokenlist.json";
 export function tokenToCurrency(token) {
     return {
+        id: currencyID({ chain_id: token.chainId, address: token.address }),
         chain_id: token.chainId,
         address: token.address,
         name: token.name,

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

@@ -1,12 +1,9 @@
-import type { BitcoinPaymentData, CryptoPaymentData, EVMPaymentData, FiatPaymentData, PaymentDataBase, PaymentStep, SolanaPaymentData, SuiPaymentData } from "../types/model";
-export declare function getFiatPaymentStep(payment?: PaymentDataBase): PaymentStep | undefined;
+import type { CryptoPaymentData, DepositStepData, FiatPaymentData, PaymentDataBase, PaymentStep } from "../types/model";
+type PaymentStepData = DepositStepData | CryptoPaymentData | FiatPaymentData;
+export declare function isDepositStepData(data: PaymentStepData): data is DepositStepData;
+export declare function isCryptoPaymentData(data: PaymentStepData): data is CryptoPaymentData;
+export declare function isFiatPaymentData(data: PaymentStepData): data is FiatPaymentData;
 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;
-export declare function getSuiPaymentData(paymentData?: CryptoPaymentData): SuiPaymentData | undefined;
+export declare function getPaymentStep(payment?: PaymentDataBase, stepIndex?: number): PaymentStep | undefined;
+export declare function getDepositAddress(payment?: PaymentDataBase, stepIndex?: number): string | undefined;
+export {};

package/dist/payment/payment-steps.js

@@ -1,53 +1,31 @@
 import { PaymentRail, StepKind } from "../types/enums";
-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 isDepositStepData(data) {
+    return Boolean("amount" in data && "currency" in data && "deposit_address" in data);
 }
-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 isCryptoPaymentData(data) {
+    return Boolean(!isDepositStepData(data) && !isFiatPaymentData(data));
 }
-export function getWalletPaymentStep(payment) {
-    return getCryptoTransactionStep(payment) ?? getCryptoDepositStep(payment);
+export function isFiatPaymentData(data) {
+    return Boolean("session_id" in data);
 }
-export function getWalletPaymentData(payment) {
-    const data = getCryptoTransactionStep(payment)?.data;
-    return data?.crypto;
+export function getFiatPaymentData(payment) {
+    const step = getPaymentStep(payment);
+    if (step?.rail !== PaymentRail.FIAT || step.kind !== StepKind.KIND_STRIPE_ONRAMP)
+        return undefined;
+    return isFiatPaymentData(step.data) ? step.data : undefined;
 }
-export function getDepositAddress(payment) {
-    const depositStep = getCryptoDepositStep(payment);
-    if (depositStep?.deposit_address) {
-        return depositStep.deposit_address;
+export function getPaymentStep(payment, stepIndex) {
+    const steps = payment?.steps ?? [];
+    if (stepIndex !== undefined) {
+        return steps[stepIndex];
     }
-    if (getCryptoTransactionStep(payment)) {
+    return steps[0];
+}
+export function getDepositAddress(payment, stepIndex) {
+    const step = getPaymentStep(payment, stepIndex);
+    if (step?.kind !== StepKind.KIND_DEPOSIT) {
         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;
+    const data = isDepositStepData(step.data) ? step.data : undefined;
+    return data?.deposit_address;
 }

package/dist/schemas/pay-order.js

@@ -43,13 +43,15 @@ export const zPayOrderMetadata = z
 });
 // NOTE: be careful to modify this type only in backward-compatible ways.
 // Add OPTIONAL fields, etc. Anything else requires a migration.
-export const zPayOrderSettings = z.object({
+export const zPayOrderSettings = z
+    .object({
     hide_footer: z.boolean().optional().describe("Hide the CoinVoyage footer in supported payment UIs."),
     card_payments: z
         .boolean()
         .optional()
         .describe("Whether to enable card payments for this order. Requires approval from CoinVoyage."),
-}).catchall(z.unknown());
+})
+    .catchall(z.unknown());
 // also validate not both token_amount and fiat are present
 export const zPayOrder = z.object({
     metadata: zPayOrderMetadata.optional(),

package/dist/types/api.d.ts

@@ -55,10 +55,6 @@ 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 = {
     /**
@@ -86,6 +82,7 @@ export type ClaimFeesRequest = {
 export type ClaimFeesResponse = {
     claim_order_id: string;
     source_transaction_hash: string;
+    transaction_hash: string;
     source_chain_id: ChainId;
     currency: CurrencyAmount;
 };

package/dist/types/model.d.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
 import { FiatCurrency } from "../currency/currencies";
 import { zPayOrderMetadata, zPayOrderSettings } from "../schemas/pay-order";
-import { ChainId, PaymentRail, PayOrderMode, PayOrderStatus, ProviderStatus, StepKind } from "./enums";
+import { ChainId, PaymentRail, PayOrderMode, PayOrderStatus, StepKind } from "./enums";
 export type PayOrder = {
     id: string;
     organization_id: string;
@@ -23,7 +23,7 @@ export type ParsedPayOrderSettings = z.output<typeof zPayOrderSettings> & Settin
 export type PayOrderSettings = z.infer<typeof zPayOrderSettings> & SettingsExtraFields;
 export type OrganizationSettings = ParsedPayOrderSettings;
 export interface Currency extends CurrencyBase {
-    id?: string;
+    id: string;
     name: string;
     ticker: string;
     decimals: number;
@@ -45,7 +45,7 @@ export interface QuoteWithCurrency extends CurrencyWithAmount {
 }
 export interface CurrencyWithBalance extends CurrencyWithAmount {
     owner?: string;
-    balance?: CurrencyAmount;
+    balance: CurrencyAmount;
 }
 export interface CurrencyAmount {
     ui_amount: number;
@@ -141,12 +141,21 @@ export type FulfillmentData = {
     rate_usd?: string;
     receiving_address?: string;
     custom_fee_bps?: number;
+    swap?: SwapContext;
+};
+export type SwapContext = {
+    requested_destination_currency?: CurrencyBase;
+    requested_source_currency?: CurrencyBase;
+};
+export type DepositStepData = {
+    deposit_address: string;
+    currency: CurrencyBase;
+    amount: BigIntStr;
 };
 export type PaymentDataBase = {
-    payment_rail: PaymentRail;
+    payment_rail?: PaymentRail;
     src: QuoteWithCurrency;
     dst: CurrencyWithAmount;
-    deposit_address: string;
     receiving_address: string;
     refund_address?: string;
     steps: PaymentStep[];
@@ -161,38 +170,11 @@ export type PaymentData = PaymentDataBase & {
 export type PaymentStep = {
     rail: PaymentRail;
     kind: StepKind;
-    deposit_address?: string;
-    data?: PaymentStepData;
+    data: DepositStepData | CryptoPaymentData | FiatPaymentData;
 };
 export type PaymentStepData = {
     crypto?: CryptoPaymentData;
     fiat?: FiatPaymentData;
 };
-export type ExecutionStep = {
-    id: string;
-    status: ProviderStatus;
-    provider: string;
-    receiver: string;
-    deposit_address: string;
-    source_tx_hash?: string;
-    destination_tx_hash?: string;
-    error?: string;
-    cleanup_tx_hash?: Record<string, string>;
-    cleanup_error?: string;
-    cleanup_recipient?: string;
-    source_currency: CurrencyWithAmount;
-    destination_currency: CurrencyWithAmount;
-    chain_data?: CryptoPaymentData;
-    gas?: CurrencyWithAmount;
-    fees?: FeeCurrencyBreakdown;
-    fee_tx_hash?: string;
-    fee_error?: string;
-    fee_plan?: FeePlan;
-    price_impact?: number;
-};
-export interface FeePlan extends CurrencyWithAmount {
-    placement: string;
-    fee_bps?: number;
-}
 export type BigIntStr = `${bigint}`;
 export {};

package/package.json

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