import {z} from 'zod' export type ChainID = 1 | 10 | 56 | 137 | 4663 | 8453 | 42161 | 20000000000001 | 20000000000002 | 30000000000001 | 30000000000002; export type CurrencyBase = {address?: (string | null) | undefined, chain_id: ChainID}; export type LiquidationAddressPaymentRail = 'ach' | 'wire' | 'ach_push' | 'ach_same_day' | 'sepa' | 'spei' | 'pix' | 'swift' | 'faster_payments' | 'bre_b' | 'co_bank_transfer' | 'fiat_deposit_return'; export type CreateOfframpIntentRequest = {src: CurrencyBase, amount: number, bank_account_id: string, withdraw_currency: string, payment_rail: LiquidationAddressPaymentRail, destination_reference?: (string | null) | undefined, sender_address?: (string | null) | undefined, slippage_bps?: (number | null) | undefined}; export type CreateApiOffRampIntentsArgs = {'Authorization-Signature': string, body: CreateOfframpIntentRequest}; export type CreateApiOffRampIntentsOptions = {baseUrl?: string | undefined, Authorization?: string | undefined, fetch?: typeof fetch | undefined}; export const rampingTransactionType = z.enum(["OFF_RAMP", "ON_RAMP"]); export const offrampStatus = z.enum(["PENDING", "FUNDS_RECEIVED", "KYC_PENDING", "COMPLETED", "FAILED"]); export const chainID = z.union([z.literal(1), z.literal(10), z.literal(56), z.literal(137), z.literal(4663), z.literal(8453), z.literal(42161), z.literal(20000000000001), z.literal(20000000000002), z.literal(30000000000001), z.literal(30000000000002)]); export const bigInt = z.string(); export const amount = z.object({ui: z.string(), raw: bigInt, value_usd: z.number().nullable().optional()}); export const currencyWithAmount = z.object({id: z.string(), chain_id: chainID, address: z.string().nullable().optional(), symbol: z.string(), name: z.string().optional(), decimals: z.number().int(), image_uri: z.string().nullable().optional(), chain_image_uri: z.string().nullable().optional(), price_usd: z.number().nullable().optional(), amount: amount, ticker: z.string().optional()}); export const bankAccountType = z.enum(["us", "iban", "swift", "clabe", "pix", "gb", "bre_b", "co_bank_transfer"]); export const accountOwnerType = z.enum(["individual", "business"]); export const accountDetails = z.object({bank_name: z.string().nullable().optional(), routing_number: z.string().nullable().optional(), sort_code: z.string().nullable().optional(), account_number: z.string(), checking_or_savings: z.string().nullable().optional(), bic: z.string().nullable().optional(), pix_key: z.string().nullable().optional(), bank_code: z.string().nullable().optional(), account_type_detail: z.string().nullable().optional()}); export const fiatCurrency = z.enum(["usd", "eur", "mxn", "brl", "gbp", "cop"]); export const bankAccountDetails = z.object({id: z.string(), account_name: z.string().nullable().optional(), bank_name: z.string().nullable().optional(), account_type: bankAccountType, account_owner_type: accountOwnerType.nullable().optional(), account_details: accountDetails, currency: fiatCurrency, active: z.boolean(), beneficiary_address_valid: z.boolean().nullable().optional(), deactivation_reason: z.string().nullable().optional(), deactivation_details: z.string().nullable().optional()}); export const offrampDestination = z.object({bank_account_details: bankAccountDetails, withdraw_currency: z.string()}); export const liquidationAddressPaymentRail = z.enum(["ach", "wire", "ach_push", "ach_same_day", "sepa", "spei", "pix", "swift", "faster_payments", "bre_b", "co_bank_transfer", "fiat_deposit_return"]); export const orderStatus = z.enum(["PENDING", "EXPIRED", "FAILED", "AWAITING_PAYMENT", "OPTIMISTIC_CONFIRMED", "AWAITING_CONFIRMATION", "EXECUTING_ORDER", "COMPLETED", "REFUNDED", "PARTIAL_PAYMENT"]); export const offrampSwap = z.object({required: z.boolean(), order_id: z.string().optional(), status: orderStatus.optional(), receiving_address: z.string().optional(), deposit_address: z.string().optional(), refund_address: z.string().optional(), source_transaction_hash: z.string().optional(), destination_transaction_hash: z.string().optional(), fee_amount_usd: z.number().optional()}); export const liquidationTransactionState = z.enum(["awaiting_funds", "funds_received", "payment_submitted", "payment_processed", "in_review", "kyc_required", "kyc_in_review", "developer_kyb_required", "canceled", "error", "undeliverable", "refunded"]); export const liquidationDestinationDetails = z.object({payment_rail: z.string(), currency: z.string(), to_address: z.string().optional(), blockchain_memo: z.string().optional(), external_account_id: z.string().optional(), wire_message: z.string().optional(), sepa_reference: z.string().optional(), spei_reference: z.string().optional(), reference: z.string().optional(), ach_reference: z.string().optional(), imad: z.string().optional(), trace_number: z.string().optional(), tracking_number: z.string().optional(), transaction_id: z.string().optional(), sending_institution_name: z.string().optional(), uetr: z.string().optional()}); export const liquidationReceipt = z.object({initial_amount: z.string(), developer_fee: z.string(), subtotal_amount: z.string(), converted_amount: z.string(), exchange_rate: z.string(), outgoing_amount: z.string(), destination_currency: z.string(), gas_fee: z.string().optional(), url: z.string().optional()}); export const liquidationReturnDetails = z.object({reason: z.string().optional(), risk_rejection_reason: z.string().optional()}); export const liquidationTransaction = z.object({id: z.string(), amount: z.string(), customer_id: z.string(), liquidation_address_id: z.string(), currency: z.string(), state: liquidationTransactionState, created_at: z.string(), updated_at: z.string(), deposit_tx_hash: z.string().optional(), from_address: z.string().optional(), source_payment_rail: z.string().optional(), destination: liquidationDestinationDetails.nullable().optional(), destination_tx_hash: z.string().optional(), receipt: liquidationReceipt.nullable().optional(), refund_tx_hash: z.string().optional(), return_details: liquidationReturnDetails.nullable().optional()}); export const offrampData = z.object({source: currencyWithAmount, destination: offrampDestination, payment_rail: liquidationAddressPaymentRail, destination_reference: z.string().nullable().optional(), liquidation_address_id: z.string().optional(), swap: offrampSwap.nullable().optional(), drain: liquidationTransaction.nullable().optional()}); export const paymentRail = z.enum(["CRYPTO", "FIAT"]); export const currency = z.object({id: z.string(), chain_id: chainID, address: z.string().nullable().optional(), symbol: z.string(), name: z.string().optional(), decimals: z.number().int(), image_uri: z.string().nullable().optional(), chain_image_uri: z.string().nullable().optional(), price_usd: z.number().nullable().optional()}); export const quoteFees = z.object({total_fee: amount, protocol_fee: amount.nullable().optional(), custom_fee: amount.nullable().optional(), relayer_fee: amount.nullable().optional()}); export const quoteBreakdown = z.object({total: amount, base: amount, fees: quoteFees.nullable().optional(), gas: amount.nullable().optional()}); export const quoteInput = z.object({currency: currency, amount: amount, balance: amount.nullable().optional(), breakdown: quoteBreakdown.nullable().optional()}); export const quoteOutput = z.object({currency: currency, amount: amount, amount_out_minimum: amount.nullable().optional()}); export const paymentFundingTransaction = z.object({tx_hash: z.string(), amount: amount}); export const paymentFunding = z.object({required_amount: amount, received_amount: amount, remaining_amount: amount, transactions: z.array(paymentFundingTransaction)}); export const stepKind = z.enum(["deposit", "transaction", "stripe_onramp"]); export const currencyBase = z.object({address: z.string().nullable().optional(), chain_id: chainID}); export const depositStepData = z.object({deposit_address: z.string(), currency: currencyBase, amount: bigInt}); export const eVMPaymentData = z.object({from: z.string(), to: z.string(), data: z.string(), value: z.string(), chainId: chainID, maxFeePerGas: z.string().optional(), maxPriorityFeePerGas: z.string().optional()}); export const bitcoinPaymentData = z.object({transaction: z.string()}); export const solanaPaymentData = z.object({transaction: z.string()}); export const suiPaymentData = z.object({transaction: z.string()}); export const chainPaymentData = z.union([eVMPaymentData, bitcoinPaymentData, solanaPaymentData, suiPaymentData]); export const stripeOnrampCurrency = z.enum(["usd", "eur"]); export const stripeCryptoCurrency = z.enum(["usdc", "usdb", "usdsui", "usdt", "phantom_cash"]); export const stripeCryptoNetwork = z.enum(["arbitrum", "base", "bitcoin", "ethereum", "polygon", "solana", "sui", "tempo", "worldchain"]); export const stripeOnrampPaymentData = z.object({session_id: z.string().optional(), stripe_publishable_key: z.string(), status: z.string(), source_currency: stripeOnrampCurrency.nullable().optional(), destination_currency: stripeCryptoCurrency, destination_network: stripeCryptoNetwork, destination_amount: z.string(), wallet_address: z.string()}); export const paymentStep = z.object({id: z.string().optional(), purpose: z.string().optional(), status: z.string().optional(), expires_at: z.string().nullable().optional(), rail: paymentRail, kind: stepKind, action: z.string().optional(), description: z.string().optional(), data: z.union([depositStepData, chainPaymentData, stripeOnrampPaymentData]).optional()}); export const paymentRefund = z.object({address: z.string().nullable().optional(), tx_hash: z.string().nullable().optional(), reason: z.string().nullable().optional()}); export const paymentView = z.object({payment_rail: paymentRail, input: quoteInput, output: quoteOutput, funding: paymentFunding.nullable().optional(), recipient: z.string(), steps: z.array(paymentStep), expires_at: z.string(), estimated_duration_seconds: z.number().nullable().optional(), source_tx_hash: z.string().nullable().optional(), destination_tx_hash: z.string().nullable().optional(), fee_tx_hash: z.string().nullable().optional(), refund: paymentRefund.nullable().optional()}); export const offrampIntent = z.object({id: z.string(), organization_id: z.string(), type: rampingTransactionType, status: offrampStatus, source_transaction_hash: z.string().nullable().optional(), data: offrampData, execution: paymentView.nullable().optional(), created_at: z.string(), updated_at: z.string(), processed_at: z.string().nullable().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Create Off-ramp Intent * * POST /off-ramp/intents */ export const createApiOffRampIntents = async (args: CreateApiOffRampIntentsArgs, options?: CreateApiOffRampIntentsOptions) => { const {baseUrl = "https://api.coinvoyage.io/v3", fetch: fetchFn = fetch, Authorization} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (args['Authorization-Signature'] != null) headers.set("Authorization-Signature", String(args['Authorization-Signature'])) if (Authorization !== undefined) headers.set("Authorization", Authorization) const url = `${baseUrl.replace(/\/+$/, '')}/off-ramp/intents${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(offrampIntent, await res.json()) };