@kimafinance/kima-transaction-widget 1.5.0 → 1.5.2

package/dist/index.d.ts

@@ -1,10 +1,49 @@
-import * as react from 'react';
-import react__default, { ReactNode } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { LogLevelDesc } from 'loglevel';
 import { Connection, Transaction, VersionedTransaction, PublicKey } from '@solana/web3.js';
 import { TronWeb } from 'tronweb';
 import { SignedTransaction } from '@tronweb3/tronwallet-abstract-adapter';
 import { BrowserProvider, JsonRpcSigner } from 'ethers';
-import { LogLevelDesc } from 'loglevel';
+import { Chain } from 'viem';
+
+declare enum NetworkOptions {
+    testnet = "testnet",
+    mainnet = "mainnet"
+}
+declare enum ModeOptions {
+    payment = "payment",
+    bridge = "bridge",
+    status = "status",
+    light = "light"
+}
+declare enum ColorModeOptions {
+    light = "light",
+    dark = "dark"
+}
+declare enum DAppOptions {
+    None = "none",
+    LPAdd = "LPAdd",
+    LPDrain = "LPDrain"
+}
+interface ThemeOptions {
+    colorMode?: ColorModeOptions;
+    backgroundColorLight?: string;
+    backgroundColorDark?: string;
+}
+interface Web3ModalAccountInfo {
+    address?: string;
+    isConnected?: boolean;
+    chainId?: number;
+}
+declare enum LoadingErrorTitle {
+    EnvLoadingError = "Fatal ENV Initialization Error",
+    ChainLoadingError = "Fatal Chains Initialization Error"
+}
+declare enum LoadingErrorMessage {
+    EnvLoadingError = "There was an error loading the required environment variables from the backend. Please check that the backend is running properly and the widget points to the corresponding url.",
+    ChainLoadingError = "There was an error loading the chain data from the backend. Please check that the backend is running properly and the widget points to the corresponding url."
+}
 
 declare enum ChainName {
     ETHEREUM = "ETH",
@@ -28,6 +67,26 @@ declare const CHAIN_NAMES_TO_STRING: {
 declare const CHAIN_STRING_TO_NAME: {
     [chainName: string]: ChainName;
 };
+declare const CHAIN_NAMES_TO_EXPLORER_TESTNET: {
+    [chainName: string]: string;
+};
+declare const CHAIN_NAMES_TO_EXPLORER_MAINNET: {
+    [chainName: string]: string;
+};
+type Cluster = 'devnet' | 'testnet' | 'mainnet';
+declare const CLUSTER: Cluster;
+declare const SOLANA_HOST: string;
+declare const lightDemoAccounts: {
+    EVM: string;
+    SOL: string;
+    TRX: string;
+};
+declare const lightDemoNetworks: string[];
+type CoinOptions = {
+    [key: string]: any;
+};
+declare const COIN_LIST: CoinOptions;
+
 declare enum TransactionStatus {
     AVAILABLE = "Available",
     CONFIRMED = "Pull_Confirmed",
@@ -42,62 +101,6 @@ declare enum TransactionStatus {
     REFUNDCOMPLETED = "RefundCompleted",
     DECLINEDINVALID = "DeclinedInvalid"
 }
-
-declare enum NetworkOptions {
-    testnet = "testnet",
-    mainnet = "mainnet"
-}
-declare enum ModeOptions {
-    payment = "payment",
-    bridge = "bridge",
-    status = "status",
-    light = "light"
-}
-declare enum CurrencyOptions {
-    USDK = "USDK",
-    USDC = "USDC",
-    USDT = "USDT",
-    WBTC = "WBTC",
-    G$ = "GDOLLAR"
-}
-declare enum ColorModeOptions {
-    light = "light",
-    dark = "dark"
-}
-declare enum DAppOptions {
-    None = "none",
-    LPAdd = "LPAdd",
-    LPDrain = "LPDrain"
-}
-interface Option {
-    id: ChainName | string;
-    label: string;
-}
-interface TransactionOption {
-    sourceChain?: ChainName;
-    targetChain: ChainName;
-    targetAddress: string;
-    amount: number;
-    currency: string;
-}
-interface TitleOption {
-    initialTitle?: string;
-    confirmTitle?: string;
-}
-interface PaymentTitleOption {
-    title?: string;
-    style?: object;
-}
-interface CompliantOption {
-    checkCompliant: boolean;
-    xploriskBaseUrl?: string;
-    xploriskApiKey?: string;
-}
-interface ThemeOptions {
-    colorMode?: ColorModeOptions;
-    backgroundColorLight?: string;
-    backgroundColorDark?: string;
-}
 interface TransactionData {
     status: TransactionStatus;
     sourceChain: string;
@@ -111,40 +114,55 @@ interface TransactionData {
     kimaTxHash: string;
     failReason: string;
 }
-interface Web3ModalAccountInfo {
-    address?: string | undefined;
-    isConnected?: boolean | undefined;
-    chainId?: number | undefined;
-}
-interface BigintAmount<TBigInt extends bigint | string> {
-    value: TBigInt;
+type PendingTxData = {
+    expireTime: string;
+    amount: string;
+    status: string;
+    hash: string;
+};
+
+interface BigintAmount<T extends bigint | string> {
+    value: T;
     decimals: number;
 }
-interface FeeResult<TBigInt extends BigintAmount<bigint | string>> {
+interface TransactionValues<T = BigintAmount<bigint | string>> {
+    allowanceAmount: T;
+    submitAmount: T;
+    message: string;
+}
+interface FeeTransactionValues<T = BigintAmount<bigint | string>> {
+    feeFromOrigin: TransactionValues<T>;
+    feeFromTarget: TransactionValues<T>;
+}
+interface SwapInfo<T = BigintAmount<bigint | string>> {
+    amountOutFiat: string;
+    amountOutBigInt: T;
+    dex: string;
+    slippage: {
+        percentage: number;
+        minAmountFiat: string;
+        maxAmountFiat: string;
+    };
+}
+interface FeeResult<T extends BigintAmount<bigint | string>> {
     feeId: string;
     feeOriginGasFiat: string;
-    feeOriginGasBigInt: TBigInt;
+    feeOriginGasBigInt: T;
     feeKimaProcessingFiat: string;
-    feeKimaProcessingBigInt: TBigInt;
+    feeKimaProcessingBigInt: T;
     feeTargetGasFiat: string;
-    feeTargetGasBigInt: TBigInt;
+    feeTargetGasBigInt: T;
+    feeSwapFiat?: string;
+    feeSwapBigInt?: T;
     feeTotalFiat: string;
-    feeTotalBigInt: TBigInt;
+    feeTotalBigInt: T;
     peggedTo: string;
     expiration: string;
-    transactionValues: FeeTransactionValues<TBigInt>;
+    transactionValues: FeeTransactionValues<T>;
     options?: {
         payment_method: '' | 'sepa_eur' | 'credit_card' | 'swift_usd';
     };
-}
-interface FeeTransactionValues<TBigInt = BigintAmount<bigint | string>> {
-    feeFromOrigin: TransactionValues<TBigInt>;
-    feeFromTarget: TransactionValues<TBigInt>;
-}
-interface TransactionValues<TBigInt = BigintAmount<bigint | string>> {
-    allowanceAmount: TBigInt;
-    submitAmount: TBigInt;
-    message: string;
+    swapInfo?: SwapInfo<T>;
 }
 type FeeResponse = FeeResult<BigintAmount<string>>;
 interface ServiceFee {
@@ -163,28 +181,154 @@ interface ServiceFee {
     targetFee: BigintAmount<bigint>;
     kimaFee: BigintAmount<bigint>;
     totalFee: BigintAmount<bigint>;
+    swapFee?: BigintAmount<bigint>;
+    swapInfo?: SwapInfo<BigintAmount<bigint>>;
     options?: {
         payment_method: '' | 'sepa_eur' | 'credit_card' | 'swift_usd';
     };
 }
+
 interface TronProvider {
     tronWeb: TronWeb;
     signTransaction: (transaction: Transaction, privateKey?: string) => Promise<SignedTransaction>;
-    signMessage(message: string, privateKey?: string): Promise<string>;
+    signMessage: (message: string, privateKey?: string) => Promise<string>;
 }
 interface SolProvider {
     connection: Connection;
-    signTransaction: <T extends Transaction | VersionedTransaction>(transaction: T) => Promise<T>;
+    signTransaction<T extends Transaction | VersionedTransaction>(tx: T): Promise<T>;
     signMessage(message: Uint8Array): Promise<Uint8Array>;
 }
-interface ExternalProvider {
-    type: 'evm' | 'solana' | 'tron';
-    provider: BrowserProvider | SolProvider | TronProvider;
-    signer: JsonRpcSigner | PublicKey | string;
+type ExternalProvider = {
+    type: 'evm';
+    provider: BrowserProvider;
+    signer: JsonRpcSigner;
+} | {
+    type: 'solana';
+    provider: SolProvider;
+    signer: PublicKey;
+} | {
+    type: 'tron';
+    provider: TronProvider;
+    signer: string;
+};
+declare const isSolProvider: (provider: SolProvider) => boolean;
+declare const isTronProvider: (provider: TronProvider) => boolean;
+
+interface Option {
+    id: ChainName | string;
+    label: string;
+}
+interface TransactionOption {
+    sourceChain?: ChainName;
+    targetChain: ChainName;
+    targetAddress: string;
+    amount: number;
+    currency: string;
+}
+interface TitleOption {
+    initialTitle?: string;
+    confirmTitle?: string;
+}
+interface PaymentTitleOption {
+    title?: string;
+    style?: object;
+}
+interface CompliantOption {
+    checkCompliant: boolean;
+    xploriskBaseUrl?: string;
+    xploriskApiKey?: string;
+}
+
+interface Plugin {
+    compatibility: ChainCompatibility;
+    data: PluginData;
+    id: string;
+    initialize: () => PluginInit;
+    isCompatible: (chain: ChainData) => boolean;
+    Provider: React.FC<PluginProviderProps>;
+    useAllowance?: (args?: any) => PluginUseAllowanceResult;
+    useNativeBalance?: () => PluginUseBalanceResult | undefined;
+    useTokenBalance?: () => PluginUseBalanceResult | undefined;
+    useIsWalletReady?: () => PluginUseIsWalletReadyResult;
+    useDisconnectWallet?: () => PluginUseDisconnectWalletResult;
+    getAllowance?(): Promise<GetTokenAllowanceResult & {
+        isApproved: boolean;
+    }>;
+    getNativeBalance?(): Promise<PluginUseBalanceResult>;
+    getTokenBalance?(): Promise<PluginUseBalanceResult>;
+    isWalletReady?(): Promise<PluginUseIsWalletReadyResult>;
+    disconnectWallet?(): Promise<void>;
+}
+interface SignDataType {
+    targetAddress: string;
+    targetChain: string;
+    originChain: string;
+    originSymbol: string;
+}
+interface GetTokenAllowanceResult {
+    allowance?: bigint | undefined;
+    decimals?: number | undefined;
+}
+interface PluginUseAllowanceResult extends GetTokenAllowanceResult {
+    isApproved: boolean;
+    approve: (isCancel?: boolean) => Promise<void>;
+    signMessage?: (data: SignDataType) => Promise<any>;
+}
+interface PluginUseBalanceResult {
+    balance?: bigint | undefined;
+    decimals?: number | undefined;
+}
+interface PluginUseIsWalletReadyResult {
+    isReady: boolean;
+    statusMessage: string;
+    connectedAddress?: string;
+}
+interface PluginUseDisconnectWalletResult {
+    disconnectWallet: () => Promise<void>;
+}
+interface PluginInit {
+    data: PluginData;
+    provider: React.FC<PluginProviderProps>;
+}
+interface PluginProviderProps {
+    children: React.ReactNode;
+    networkOption?: NetworkOptions;
+    projectId?: string;
+    isLoading?: boolean;
+}
+interface PluginData {
+    id: string;
+    pluginData: {
+        [key: string]: any;
+    };
+}
+type ChainLocation = 'origin' | 'target';
+interface ChainData extends Chain {
+    compatibility: ChainCompatibility;
+    name: string;
+    shortName: string;
+    supportedTokens: ChainToken[];
+    supportedLocations: ChainLocation[];
+    disabled: boolean;
+}
+interface ChainToken {
+    address: string;
+    decimals: number;
+    symbol: string;
+    peggedTo: string;
+}
+declare enum ChainCompatibility {
+    BTC = "BTC",
+    EVM = "EVM",
+    FIAT = "FIAT",
+    COSMOS = "COSMOS",
+    SELF = "SELF",
+    CC = "CC",
+    BANK = "BANK"
 }
 
 interface KimaProviderProps {
-    walletConnectProjectId: string;
+    projectId: string;
     externalProvider?: ExternalProvider;
     kimaBackendUrl: string;
     children: ReactNode;
@@ -195,7 +339,7 @@ interface KimaProviderProps {
     keplrHandler?: (e: any) => void;
     switchChainHandler?: (e: any) => void;
 }
-declare const KimaProvider: ({ walletConnectProjectId, children, externalProvider, kimaBackendUrl, logLevel, keplrHandler, successHandler, closeHandler, errorHandler, switchChainHandler }: KimaProviderProps) => react.JSX.Element;
+declare const KimaProvider: ({ projectId, children, externalProvider, kimaBackendUrl, logLevel, keplrHandler, successHandler, closeHandler, errorHandler, switchChainHandler }: KimaProviderProps) => react_jsx_runtime.JSX.Element;
 
 interface Props {
     theme: ThemeOptions;
@@ -208,6 +352,6 @@ interface Props {
     transactionOption?: TransactionOption;
     paymentTitleOption?: PaymentTitleOption;
 }
-declare const KimaTransactionWidget: ({ mode, txId, dAppOption, theme, titleOption, paymentTitleOption, helpURL, compliantOption, transactionOption }: Props) => react__default.JSX.Element;
+declare const KimaTransactionWidget: ({ mode, txId, dAppOption, theme, titleOption, paymentTitleOption, helpURL, compliantOption, transactionOption }: Props) => react_jsx_runtime.JSX.Element;
 
-export { type BigintAmount, CHAIN_NAMES_TO_STRING, CHAIN_STRING_TO_NAME, ColorModeOptions, type CompliantOption, CurrencyOptions, DAppOptions, type ExternalProvider, type FeeResponse, type FeeResult, type FeeTransactionValues, KimaProvider, KimaTransactionWidget, ModeOptions, NetworkOptions, type Option, type PaymentTitleOption, type ServiceFee, type SolProvider, ChainName as SupportNetworks, type ThemeOptions, type TitleOption, type TransactionData, type TransactionOption, type TransactionValues, type TronProvider, type Web3ModalAccountInfo };
+export { type BigintAmount, CHAIN_NAMES_TO_EXPLORER_MAINNET, CHAIN_NAMES_TO_EXPLORER_TESTNET, CHAIN_NAMES_TO_STRING, CHAIN_STRING_TO_NAME, CLUSTER, COIN_LIST, ChainCompatibility, type ChainData, type ChainLocation, ChainName, type ChainToken, type Cluster, ColorModeOptions, type CompliantOption, DAppOptions, type ExternalProvider, type FeeResponse, type FeeResult, type FeeTransactionValues, type GetTokenAllowanceResult, KimaProvider, KimaTransactionWidget, LoadingErrorMessage, LoadingErrorTitle, ModeOptions, NetworkOptions, type Option, type PaymentTitleOption, type PendingTxData, type Plugin, type PluginData, type PluginInit, type PluginProviderProps, type PluginUseAllowanceResult, type PluginUseBalanceResult, type PluginUseDisconnectWalletResult, type PluginUseIsWalletReadyResult, SOLANA_HOST, type ServiceFee, type SignDataType, type SolProvider, type SwapInfo, type ThemeOptions, type TitleOption, type TransactionData, type TransactionOption, TransactionStatus, type TransactionValues, type TronProvider, type Web3ModalAccountInfo, isSolProvider, isTronProvider, lightDemoAccounts, lightDemoNetworks };