@orderly.network/onramper-plugin 0.0.2-alpha.0

package/dist/index.d.mts

@@ -0,0 +1,158 @@
+import React, { FC, SVGProps } from 'react';
+import { API } from '@orderly.network/types';
+import { ConnectedChain, Chain } from '@orderly.network/hooks';
+import { OrderlySDK } from '@orderly.network/plugin-core';
+
+declare const FIAT_CURRENCIES: readonly ["USD", "EUR", "CNY", "HKD", "TWD", "KRW", "JPY"];
+type FiatCurrency = (typeof FIAT_CURRENCIES)[number];
+declare const PRESET_AMOUNTS: Record<FiatCurrency, readonly number[]>;
+declare function formatCompact(n: number): string;
+
+type OnrampTransactionStatus = "new" | "pending" | "completed" | "failed" | "paid" | "canceled";
+type WebhookEvent = {
+    transactionId: string;
+    status: OnrampTransactionStatus;
+    outAmount?: number;
+    inAmount?: number;
+    statusReason?: string;
+    targetCurrency: string;
+    sourceCurrency: string;
+    onramp: string;
+    statusDate: string;
+};
+
+type CurrentChain = Pick<ConnectedChain, "namespace"> & {
+    id: number;
+    info?: Chain;
+};
+
+type OnrampPartner = {
+    id: string;
+    name: string;
+    rate: number;
+    payout: number;
+    recommendations?: string[];
+};
+
+type PaymentMethod = {
+    id: string;
+    name: string;
+    icon?: string;
+};
+
+type OnrampFormState = {
+    paymentMethods: PaymentMethod[];
+    selectedPaymentMethod: PaymentMethod | null;
+    onPaymentMethodChange: (method: PaymentMethod) => void;
+    fiatCurrencies: readonly string[];
+    selectedCurrency: FiatCurrency;
+    onCurrencyChange: (currency: FiatCurrency) => void;
+    spendAmount: string;
+    onSpendAmountChange: (value: string) => void;
+    presetAmounts: readonly number[];
+    chains: API.NetworkInfos[];
+    selectedChain: CurrentChain | null;
+    onChainChange: (chain: API.NetworkInfos) => Promise<void>;
+    wallet: any;
+    address?: string;
+    receiveQuantity: string;
+    receiveQuantityPlaceholder: string;
+    partners: OnrampPartner[];
+    selectedPartner: OnrampPartner | null;
+    onPartnerChange: (partner: OnrampPartner) => void;
+    exchangeRateText: string;
+    /** True while SWR is fetching/revalidating (for countdown reset). */
+    quoteIsValidating: boolean;
+    isAvailable: boolean;
+    isQuoteLoading: boolean;
+    /** Error message when spend amount is outside min/max limits. */
+    spendAmountError: string;
+    onContinue: () => void;
+    isContinueDisabled: boolean;
+    iframeDialogOpen: boolean;
+    setIframeDialogOpen: (open: boolean) => void;
+    onramperIframeUrl: string;
+    statusData: WebhookEvent | null | undefined;
+    transactions: WebhookEvent[];
+    pendingTransactions: WebhookEvent[];
+    historyTransactions: WebhookEvent[];
+    isStatusLoading: boolean;
+};
+declare const useOnrampFormScript: () => OnrampFormState;
+
+type OnrampFormProps = OnrampFormState & {
+    close?: () => void;
+};
+declare const OnrampFormUI: FC<OnrampFormProps>;
+
+type OnrampFormWidgetProps = {
+    close?: () => void;
+};
+declare const OnrampForm: FC<OnrampFormWidgetProps>;
+
+declare const ExchangeIcon: FC<SVGProps<SVGSVGElement>>;
+
+declare const ArrowDownIcon: FC<SVGProps<SVGSVGElement>>;
+
+declare const BuyCryptoIcon: FC<SVGProps<SVGSVGElement>>;
+
+type OnrampQuotePaymentMethod = {
+    paymentTypeId: string;
+    name: string;
+    icon: string;
+    details: {
+        currencyStatus: string;
+        limits: Record<string, {
+            min: number;
+            max: number;
+        }>;
+    };
+};
+type OnrampQuoteError = {
+    type: string;
+    errorId: number;
+    message: string;
+    onramp?: string;
+    parameter?: string;
+    value?: string;
+    name: string;
+};
+type OnrampQuoteItem = {
+    rate?: number;
+    networkFee?: number;
+    transactionFee?: number;
+    payout?: number;
+    availablePaymentMethods?: OnrampQuotePaymentMethod[];
+    ramp: string;
+    paymentMethod?: string;
+    quoteId: string;
+    errors?: OnrampQuoteError[];
+    recommendations?: string[];
+};
+/** paymentMethodId → { min, max } (from aggregatedLimit) */
+type PaymentMethodLimitsMap = Record<string, {
+    min: number;
+    max: number;
+}>;
+declare function useOnrampAvailability(currency: string): {
+    isAvailable: boolean;
+    partners: OnrampPartner[];
+    paymentMethods: PaymentMethod[];
+    paymentMethodLimits: PaymentMethodLimitsMap;
+    isLoading: boolean;
+    error: any;
+    validRamps: OnrampQuoteItem[];
+    isValidating: boolean;
+    getPaymentMethodsForPartner: (partnerId: string) => PaymentMethod[];
+};
+
+interface OnrampPluginOptions {
+    title?: string;
+    icon?: React.ReactNode;
+    apiKey: string;
+    secretKey: string;
+    workerUrl?: string;
+}
+declare function registerOnrampPlugin(options: OnrampPluginOptions): (SDK: OrderlySDK) => void;
+
+export { ArrowDownIcon, BuyCryptoIcon, ExchangeIcon, FIAT_CURRENCIES, type FiatCurrency, OnrampForm, type OnrampFormProps, type OnrampFormState, OnrampFormUI, type OnrampFormWidgetProps, type OnrampPluginOptions, PRESET_AMOUNTS, formatCompact, registerOnrampPlugin, useOnrampAvailability, useOnrampFormScript };

package/dist/index.d.ts

@@ -0,0 +1,158 @@
+import React, { FC, SVGProps } from 'react';
+import { API } from '@orderly.network/types';
+import { ConnectedChain, Chain } from '@orderly.network/hooks';
+import { OrderlySDK } from '@orderly.network/plugin-core';
+
+declare const FIAT_CURRENCIES: readonly ["USD", "EUR", "CNY", "HKD", "TWD", "KRW", "JPY"];
+type FiatCurrency = (typeof FIAT_CURRENCIES)[number];
+declare const PRESET_AMOUNTS: Record<FiatCurrency, readonly number[]>;
+declare function formatCompact(n: number): string;
+
+type OnrampTransactionStatus = "new" | "pending" | "completed" | "failed" | "paid" | "canceled";
+type WebhookEvent = {
+    transactionId: string;
+    status: OnrampTransactionStatus;
+    outAmount?: number;
+    inAmount?: number;
+    statusReason?: string;
+    targetCurrency: string;
+    sourceCurrency: string;
+    onramp: string;
+    statusDate: string;
+};
+
+type CurrentChain = Pick<ConnectedChain, "namespace"> & {
+    id: number;
+    info?: Chain;
+};
+
+type OnrampPartner = {
+    id: string;
+    name: string;
+    rate: number;
+    payout: number;
+    recommendations?: string[];
+};
+
+type PaymentMethod = {
+    id: string;
+    name: string;
+    icon?: string;
+};
+
+type OnrampFormState = {
+    paymentMethods: PaymentMethod[];
+    selectedPaymentMethod: PaymentMethod | null;
+    onPaymentMethodChange: (method: PaymentMethod) => void;
+    fiatCurrencies: readonly string[];
+    selectedCurrency: FiatCurrency;
+    onCurrencyChange: (currency: FiatCurrency) => void;
+    spendAmount: string;
+    onSpendAmountChange: (value: string) => void;
+    presetAmounts: readonly number[];
+    chains: API.NetworkInfos[];
+    selectedChain: CurrentChain | null;
+    onChainChange: (chain: API.NetworkInfos) => Promise<void>;
+    wallet: any;
+    address?: string;
+    receiveQuantity: string;
+    receiveQuantityPlaceholder: string;
+    partners: OnrampPartner[];
+    selectedPartner: OnrampPartner | null;
+    onPartnerChange: (partner: OnrampPartner) => void;
+    exchangeRateText: string;
+    /** True while SWR is fetching/revalidating (for countdown reset). */
+    quoteIsValidating: boolean;
+    isAvailable: boolean;
+    isQuoteLoading: boolean;
+    /** Error message when spend amount is outside min/max limits. */
+    spendAmountError: string;
+    onContinue: () => void;
+    isContinueDisabled: boolean;
+    iframeDialogOpen: boolean;
+    setIframeDialogOpen: (open: boolean) => void;
+    onramperIframeUrl: string;
+    statusData: WebhookEvent | null | undefined;
+    transactions: WebhookEvent[];
+    pendingTransactions: WebhookEvent[];
+    historyTransactions: WebhookEvent[];
+    isStatusLoading: boolean;
+};
+declare const useOnrampFormScript: () => OnrampFormState;
+
+type OnrampFormProps = OnrampFormState & {
+    close?: () => void;
+};
+declare const OnrampFormUI: FC<OnrampFormProps>;
+
+type OnrampFormWidgetProps = {
+    close?: () => void;
+};
+declare const OnrampForm: FC<OnrampFormWidgetProps>;
+
+declare const ExchangeIcon: FC<SVGProps<SVGSVGElement>>;
+
+declare const ArrowDownIcon: FC<SVGProps<SVGSVGElement>>;
+
+declare const BuyCryptoIcon: FC<SVGProps<SVGSVGElement>>;
+
+type OnrampQuotePaymentMethod = {
+    paymentTypeId: string;
+    name: string;
+    icon: string;
+    details: {
+        currencyStatus: string;
+        limits: Record<string, {
+            min: number;
+            max: number;
+        }>;
+    };
+};
+type OnrampQuoteError = {
+    type: string;
+    errorId: number;
+    message: string;
+    onramp?: string;
+    parameter?: string;
+    value?: string;
+    name: string;
+};
+type OnrampQuoteItem = {
+    rate?: number;
+    networkFee?: number;
+    transactionFee?: number;
+    payout?: number;
+    availablePaymentMethods?: OnrampQuotePaymentMethod[];
+    ramp: string;
+    paymentMethod?: string;
+    quoteId: string;
+    errors?: OnrampQuoteError[];
+    recommendations?: string[];
+};
+/** paymentMethodId → { min, max } (from aggregatedLimit) */
+type PaymentMethodLimitsMap = Record<string, {
+    min: number;
+    max: number;
+}>;
+declare function useOnrampAvailability(currency: string): {
+    isAvailable: boolean;
+    partners: OnrampPartner[];
+    paymentMethods: PaymentMethod[];
+    paymentMethodLimits: PaymentMethodLimitsMap;
+    isLoading: boolean;
+    error: any;
+    validRamps: OnrampQuoteItem[];
+    isValidating: boolean;
+    getPaymentMethodsForPartner: (partnerId: string) => PaymentMethod[];
+};
+
+interface OnrampPluginOptions {
+    title?: string;
+    icon?: React.ReactNode;
+    apiKey: string;
+    secretKey: string;
+    workerUrl?: string;
+}
+declare function registerOnrampPlugin(options: OnrampPluginOptions): (SDK: OrderlySDK) => void;
+
+export { ArrowDownIcon, BuyCryptoIcon, ExchangeIcon, FIAT_CURRENCIES, type FiatCurrency, OnrampForm, type OnrampFormProps, type OnrampFormState, OnrampFormUI, type OnrampFormWidgetProps, type OnrampPluginOptions, PRESET_AMOUNTS, formatCompact, registerOnrampPlugin, useOnrampAvailability, useOnrampFormScript };