@cofhe/react 0.5.1 → 0.5.2

package/dist/types-BzYdBjL5.d.cts

@@ -0,0 +1,234 @@
+import { FheTypeValue } from '@cofhe/sdk';
+import { Address } from 'viem';
+
+interface BaseProps {
+    /** Additional CSS class names */
+    className?: string;
+    /** Test ID for testing purposes */
+    testId?: string;
+}
+type ComponentSize = 'sm' | 'md' | 'lg';
+interface DropdownOption {
+    label: string;
+    value: FheTypeValue;
+    maxValue?: bigint | null;
+    description?: string;
+}
+interface EncryptionProgressData {
+    step: string;
+    progress: number;
+    label: string;
+}
+interface EncryptionResultData {
+    value: string;
+    encrypted: any;
+}
+interface EncryptionStartData {
+    value: string;
+    type: string;
+}
+
+declare enum FloatingButtonPage$1 {
+    Main = "main",
+    Settings = "settings",
+    TokenInfo = "tokeninfo",
+    Send = "send",
+    Shield = "shield",
+    Activity = "activity",
+    Permits = "permits",
+    GeneratePermits = "generatePermit",
+    DelegatePermits = "delegatePermit",
+    ReceivePermits = "receivePermit",
+    Debug = "debug",
+    Portfolio = "portfolio",
+    ClaimableTokens = "claimableTokens"
+}
+interface FloatingButtonPagePropsRegistry {
+}
+type FloatingButtonPagePropsMap = {
+    [K in FloatingButtonPage$1]: K extends keyof FloatingButtonPagePropsRegistry ? FloatingButtonPagePropsRegistry[K] : void;
+};
+type PageState<K extends keyof FloatingButtonPagePropsMap = FloatingButtonPage$1> = {
+    page: K;
+    props?: FloatingButtonPagePropsMap[K];
+};
+
+type FloatingButtonPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+type FloatingButtonPositionType = 'fixed' | 'absolute';
+interface CofheFloatingButtonProps extends BaseProps {
+    children?: React.ReactNode;
+    /** Position of the floating button */
+    position?: FloatingButtonPosition;
+    /** Z-index value (default: 9999) */
+    zIndex?: number;
+    /** Position type: 'fixed' stays on screen, 'absolute' positions within parent (default: 'fixed') */
+    positionType?: FloatingButtonPositionType;
+    /** Dark mode for the button (independent of page theme) */
+    darkMode?: boolean;
+    overriddingPage?: PageState;
+}
+
+/**
+ * Token types shared across hooks/components/utils.
+ *
+ * IMPORTANT: Keep this file dependency-free (no imports from hooks/providers/utils)
+ * to avoid circular dependencies.
+ */
+
+/**
+ * Special address representing native ETH (used in erc20Pair for ConfidentialETH tokens)
+ */
+declare const ETH_ADDRESS_LOWERCASE: "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee";
+/**
+ * ERC20 pair information for wrapped confidential tokens
+ */
+type Erc20Pair = {
+    /** Address of the underlying ERC20 token (or ETH_ADDRESS for native ETH) */
+    address: Address;
+    symbol: string;
+    decimals: number;
+    logoURI?: string;
+};
+declare const TOKEN_CONFIDENTIALITY_SUPPORT: {
+    readonly wrapped: {
+        readonly enabled: true;
+        readonly label: "Wrapped confidential token";
+        readonly confidentialValueType: "uint128";
+        readonly publicBalanceSource: "erc20Pair";
+        readonly operations: {
+            readonly confidentialBalance: true;
+            readonly transfer: true;
+            readonly publicBalance: true;
+            readonly shield: true;
+            readonly unshield: true;
+            readonly claim: true;
+            readonly claimable: true;
+        };
+    };
+    readonly pure: {
+        readonly enabled: false;
+        readonly label: "Pure confidential token";
+        readonly confidentialValueType: "uint64";
+        readonly publicBalanceSource: null;
+        readonly operations: {
+            readonly confidentialBalance: false;
+            readonly transfer: false;
+            readonly publicBalance: false;
+            readonly shield: false;
+            readonly unshield: false;
+            readonly claim: false;
+            readonly claimable: false;
+        };
+    };
+    readonly dual: {
+        readonly enabled: false;
+        readonly label: "Dual-balance confidential token";
+        readonly confidentialValueType: "uint64";
+        readonly publicBalanceSource: "token";
+        readonly operations: {
+            readonly confidentialBalance: false;
+            readonly transfer: false;
+            readonly publicBalance: false;
+            readonly shield: false;
+            readonly unshield: false;
+            readonly claim: false;
+            readonly claimable: false;
+        };
+    };
+};
+type TokenConfidentialityType = keyof typeof TOKEN_CONFIDENTIALITY_SUPPORT;
+type Token = {
+    chainId: number;
+    address: `0x${string}`;
+    symbol: string;
+    decimals: number;
+    name: string;
+    logoURI?: string;
+    extensions: Record<string, unknown> & {
+        fhenix: {
+            confidentialityType: TokenConfidentialityType;
+            confidentialValueType: 'uint64' | 'uint128';
+            /** ERC20 pair for wrapped tokens - contains underlying token info */
+            erc20Pair?: Erc20Pair;
+        };
+    };
+};
+
+/**
+ * Gets the block explorer URL for a given chain ID
+ * @param chainId - The chain ID to look up
+ * @returns The block explorer base URL, or undefined if not found
+ */
+declare const getBlockExplorerUrl: (chainId: number) => string | undefined;
+/**
+ * Gets the block explorer transaction URL for a given chain ID and transaction hash
+ * @param chainId - The chain ID
+ * @param hash - The transaction hash
+ * @returns The full transaction URL, or undefined if chain not found
+ */
+declare const getBlockExplorerTxUrl: (chainId: number, hash: string) => string | undefined;
+/**
+ * Gets the block explorer address URL for a given chain ID and address
+ * @param chainId - The chain ID
+ * @param address - The address
+ * @returns The full address URL, or undefined if chain not found
+ */
+declare const getBlockExplorerAddressUrl: (chainId: number, address: string) => string | undefined;
+/**
+ * Gets the block explorer token URL for a given chain ID and token address
+ * @param chainId - The chain ID
+ * @param tokenAddress - The token contract address
+ * @returns The full token URL, or undefined if chain not found
+ */
+declare const getBlockExplorerTokenUrl: (chainId: number, tokenAddress: string) => string | undefined;
+/**
+ * Check if an erc20Pair address is the native ETH address
+ * @param erc20Pair - The ERC20 pair object from token extensions
+ * @returns True if the pair address matches ETH_ADDRESS
+ */
+declare const isEthPair: (erc20Pair: Erc20Pair | undefined) => boolean;
+/**
+ * Check if a token is a wrapped ETH token (ConfidentialETH)
+ * @param token - The token object
+ * @returns True if the token is a wrapped token with ETH as the underlying pair
+ */
+declare const isWrappedEthToken: (token: Token) => boolean;
+interface FheTypeOption {
+    label: string;
+    value: FheTypeValue;
+    maxValue: bigint | null;
+    description: string;
+}
+declare const FheTypesList: FheTypeOption[];
+/**
+ * Truncates a hex string (address or hash) to show beginning and end with ellipsis
+ * @param value - The hex string to truncate (address, hash, etc.)
+ * @param start - Number of characters to show at the start (default: 6, includes 0x)
+ * @param end - Number of characters to show at the end (default: 4)
+ * @returns Truncated string, or original if too short
+ *
+ * @example
+ * truncateHash('0x1234567890abcdef1234567890abcdef12345678')
+ * // Returns: '0x1234...5678'
+ */
+declare const truncateHash: (value: string, start?: number, end?: number) => string;
+/**
+ * Formats a timestamp as a relative time string (e.g., "2 hours ago")
+ * @param timestamp - Unix timestamp in milliseconds
+ * @returns Formatted relative time string
+ */
+declare const formatRelativeTime: (timestamp: number) => string;
+
+type GeneratePermitPageProps = {
+    onSuccessNavigateTo?: () => void;
+    onCancel?: () => void;
+    onBack?: () => void;
+    cause?: 'clicked_on_confidential_balance';
+};
+declare module '../../../pagesConfig/types' {
+    interface FloatingButtonPagePropsRegistry {
+        [FloatingButtonPage.GeneratePermits]: GeneratePermitPageProps;
+    }
+}
+
+export { type BaseProps as B, type CofheFloatingButtonProps as C, type DropdownOption as D, ETH_ADDRESS_LOWERCASE as E, type FloatingButtonPosition as F, type GeneratePermitPageProps as G, type Token as T, type Erc20Pair as a, FheTypesList as b, getBlockExplorerTxUrl as c, getBlockExplorerAddressUrl as d, getBlockExplorerTokenUrl as e, formatRelativeTime as f, getBlockExplorerUrl as g, isWrappedEthToken as h, isEthPair as i, type ComponentSize as j, type EncryptionStartData as k, type EncryptionProgressData as l, type EncryptionResultData as m, truncateHash as t };

package/dist/types-BzYdBjL5.d.ts

@@ -0,0 +1,234 @@
+import { FheTypeValue } from '@cofhe/sdk';
+import { Address } from 'viem';
+
+interface BaseProps {
+    /** Additional CSS class names */
+    className?: string;
+    /** Test ID for testing purposes */
+    testId?: string;
+}
+type ComponentSize = 'sm' | 'md' | 'lg';
+interface DropdownOption {
+    label: string;
+    value: FheTypeValue;
+    maxValue?: bigint | null;
+    description?: string;
+}
+interface EncryptionProgressData {
+    step: string;
+    progress: number;
+    label: string;
+}
+interface EncryptionResultData {
+    value: string;
+    encrypted: any;
+}
+interface EncryptionStartData {
+    value: string;
+    type: string;
+}
+
+declare enum FloatingButtonPage$1 {
+    Main = "main",
+    Settings = "settings",
+    TokenInfo = "tokeninfo",
+    Send = "send",
+    Shield = "shield",
+    Activity = "activity",
+    Permits = "permits",
+    GeneratePermits = "generatePermit",
+    DelegatePermits = "delegatePermit",
+    ReceivePermits = "receivePermit",
+    Debug = "debug",
+    Portfolio = "portfolio",
+    ClaimableTokens = "claimableTokens"
+}
+interface FloatingButtonPagePropsRegistry {
+}
+type FloatingButtonPagePropsMap = {
+    [K in FloatingButtonPage$1]: K extends keyof FloatingButtonPagePropsRegistry ? FloatingButtonPagePropsRegistry[K] : void;
+};
+type PageState<K extends keyof FloatingButtonPagePropsMap = FloatingButtonPage$1> = {
+    page: K;
+    props?: FloatingButtonPagePropsMap[K];
+};
+
+type FloatingButtonPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+type FloatingButtonPositionType = 'fixed' | 'absolute';
+interface CofheFloatingButtonProps extends BaseProps {
+    children?: React.ReactNode;
+    /** Position of the floating button */
+    position?: FloatingButtonPosition;
+    /** Z-index value (default: 9999) */
+    zIndex?: number;
+    /** Position type: 'fixed' stays on screen, 'absolute' positions within parent (default: 'fixed') */
+    positionType?: FloatingButtonPositionType;
+    /** Dark mode for the button (independent of page theme) */
+    darkMode?: boolean;
+    overriddingPage?: PageState;
+}
+
+/**
+ * Token types shared across hooks/components/utils.
+ *
+ * IMPORTANT: Keep this file dependency-free (no imports from hooks/providers/utils)
+ * to avoid circular dependencies.
+ */
+
+/**
+ * Special address representing native ETH (used in erc20Pair for ConfidentialETH tokens)
+ */
+declare const ETH_ADDRESS_LOWERCASE: "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee";
+/**
+ * ERC20 pair information for wrapped confidential tokens
+ */
+type Erc20Pair = {
+    /** Address of the underlying ERC20 token (or ETH_ADDRESS for native ETH) */
+    address: Address;
+    symbol: string;
+    decimals: number;
+    logoURI?: string;
+};
+declare const TOKEN_CONFIDENTIALITY_SUPPORT: {
+    readonly wrapped: {
+        readonly enabled: true;
+        readonly label: "Wrapped confidential token";
+        readonly confidentialValueType: "uint128";
+        readonly publicBalanceSource: "erc20Pair";
+        readonly operations: {
+            readonly confidentialBalance: true;
+            readonly transfer: true;
+            readonly publicBalance: true;
+            readonly shield: true;
+            readonly unshield: true;
+            readonly claim: true;
+            readonly claimable: true;
+        };
+    };
+    readonly pure: {
+        readonly enabled: false;
+        readonly label: "Pure confidential token";
+        readonly confidentialValueType: "uint64";
+        readonly publicBalanceSource: null;
+        readonly operations: {
+            readonly confidentialBalance: false;
+            readonly transfer: false;
+            readonly publicBalance: false;
+            readonly shield: false;
+            readonly unshield: false;
+            readonly claim: false;
+            readonly claimable: false;
+        };
+    };
+    readonly dual: {
+        readonly enabled: false;
+        readonly label: "Dual-balance confidential token";
+        readonly confidentialValueType: "uint64";
+        readonly publicBalanceSource: "token";
+        readonly operations: {
+            readonly confidentialBalance: false;
+            readonly transfer: false;
+            readonly publicBalance: false;
+            readonly shield: false;
+            readonly unshield: false;
+            readonly claim: false;
+            readonly claimable: false;
+        };
+    };
+};
+type TokenConfidentialityType = keyof typeof TOKEN_CONFIDENTIALITY_SUPPORT;
+type Token = {
+    chainId: number;
+    address: `0x${string}`;
+    symbol: string;
+    decimals: number;
+    name: string;
+    logoURI?: string;
+    extensions: Record<string, unknown> & {
+        fhenix: {
+            confidentialityType: TokenConfidentialityType;
+            confidentialValueType: 'uint64' | 'uint128';
+            /** ERC20 pair for wrapped tokens - contains underlying token info */
+            erc20Pair?: Erc20Pair;
+        };
+    };
+};
+
+/**
+ * Gets the block explorer URL for a given chain ID
+ * @param chainId - The chain ID to look up
+ * @returns The block explorer base URL, or undefined if not found
+ */
+declare const getBlockExplorerUrl: (chainId: number) => string | undefined;
+/**
+ * Gets the block explorer transaction URL for a given chain ID and transaction hash
+ * @param chainId - The chain ID
+ * @param hash - The transaction hash
+ * @returns The full transaction URL, or undefined if chain not found
+ */
+declare const getBlockExplorerTxUrl: (chainId: number, hash: string) => string | undefined;
+/**
+ * Gets the block explorer address URL for a given chain ID and address
+ * @param chainId - The chain ID
+ * @param address - The address
+ * @returns The full address URL, or undefined if chain not found
+ */
+declare const getBlockExplorerAddressUrl: (chainId: number, address: string) => string | undefined;
+/**
+ * Gets the block explorer token URL for a given chain ID and token address
+ * @param chainId - The chain ID
+ * @param tokenAddress - The token contract address
+ * @returns The full token URL, or undefined if chain not found
+ */
+declare const getBlockExplorerTokenUrl: (chainId: number, tokenAddress: string) => string | undefined;
+/**
+ * Check if an erc20Pair address is the native ETH address
+ * @param erc20Pair - The ERC20 pair object from token extensions
+ * @returns True if the pair address matches ETH_ADDRESS
+ */
+declare const isEthPair: (erc20Pair: Erc20Pair | undefined) => boolean;
+/**
+ * Check if a token is a wrapped ETH token (ConfidentialETH)
+ * @param token - The token object
+ * @returns True if the token is a wrapped token with ETH as the underlying pair
+ */
+declare const isWrappedEthToken: (token: Token) => boolean;
+interface FheTypeOption {
+    label: string;
+    value: FheTypeValue;
+    maxValue: bigint | null;
+    description: string;
+}
+declare const FheTypesList: FheTypeOption[];
+/**
+ * Truncates a hex string (address or hash) to show beginning and end with ellipsis
+ * @param value - The hex string to truncate (address, hash, etc.)
+ * @param start - Number of characters to show at the start (default: 6, includes 0x)
+ * @param end - Number of characters to show at the end (default: 4)
+ * @returns Truncated string, or original if too short
+ *
+ * @example
+ * truncateHash('0x1234567890abcdef1234567890abcdef12345678')
+ * // Returns: '0x1234...5678'
+ */
+declare const truncateHash: (value: string, start?: number, end?: number) => string;
+/**
+ * Formats a timestamp as a relative time string (e.g., "2 hours ago")
+ * @param timestamp - Unix timestamp in milliseconds
+ * @returns Formatted relative time string
+ */
+declare const formatRelativeTime: (timestamp: number) => string;
+
+type GeneratePermitPageProps = {
+    onSuccessNavigateTo?: () => void;
+    onCancel?: () => void;
+    onBack?: () => void;
+    cause?: 'clicked_on_confidential_balance';
+};
+declare module '../../../pagesConfig/types' {
+    interface FloatingButtonPagePropsRegistry {
+        [FloatingButtonPage.GeneratePermits]: GeneratePermitPageProps;
+    }
+}
+
+export { type BaseProps as B, type CofheFloatingButtonProps as C, type DropdownOption as D, ETH_ADDRESS_LOWERCASE as E, type FloatingButtonPosition as F, type GeneratePermitPageProps as G, type Token as T, type Erc20Pair as a, FheTypesList as b, getBlockExplorerTxUrl as c, getBlockExplorerAddressUrl as d, getBlockExplorerTokenUrl as e, formatRelativeTime as f, getBlockExplorerUrl as g, isWrappedEthToken as h, isEthPair as i, type ComponentSize as j, type EncryptionStartData as k, type EncryptionProgressData as l, type EncryptionResultData as m, truncateHash as t };