@reown/appkit-common/dist/types/src/utils/TypeUtil.d.ts

The full stack toolkit to build onchain app UX.

import type { Address, ChainFormatters, Hex, HttpTransportConfig } from 'viem';
import type { Chain as BaseChain } from 'viem/chains';
export type { BaseChain, Address, Hex };
export type BaseNetwork<formatters extends ChainFormatters | undefined = ChainFormatters | undefined, custom extends Record<string, unknown> | undefined = Record<string, unknown> | undefined> = BaseChain<formatters, custom>;
export type CaipNetwork<formatters extends ChainFormatters | undefined = ChainFormatters | undefined, custom extends Record<string, unknown> | undefined = Record<string, unknown> | undefined, N extends string = InternalChainNamespace> = Omit<BaseChain<formatters, custom>, 'id'> & {
    id: number | string;
    chainNamespace: ChainNamespace<N>;
    caipNetworkId: CaipNetworkId<N>;
    assets?: {
        imageId: string | undefined;
        imageUrl: string | undefined;
    };
};
export type CustomCaipNetwork<T extends string = InternalChainNamespace> = CaipNetwork<ChainFormatters, Record<string, unknown>, T>;
export type CustomRpcUrlMap = Record<CaipNetworkId, CustomRpcUrl[]>;
export type ConnectorType = 'EXTERNAL' | 'WALLET_CONNECT' | 'INJECTED' | 'ANNOUNCED' | 'AUTH' | 'MULTI_CHAIN';
export type CustomRpcUrl = {
    url: string;
    config?: HttpTransportConfig;
};
export type AppKitNetwork = BaseNetwork | CaipNetwork;
export type CaipNetworkId<N extends string = InternalChainNamespace> = `${ChainNamespace<N>}:${ChainId}`;
export type CaipAddress = `${ChainNamespace}:${ChainId}:${string}`;
export type ChainId = string | number;
export type InternalChainNamespace = 'eip155' | 'solana' | 'polkadot' | 'bip122' | 'cosmos' | 'sui' | 'stacks' | 'ton' | 'tron';
export type ChainNamespace<T extends string = InternalChainNamespace> = T | InternalChainNamespace;
export type AdapterType = 'solana' | 'wagmi' | 'ethers' | 'ethers5' | 'universal' | 'bip122' | 'polkadot' | 'ton' | 'tron';
export type TransactionStatus = 'confirmed' | 'failed' | 'pending';
export type TransactionDirection = 'in' | 'out' | 'self';
export type TransactionImage = {
    type: 'FUNGIBLE' | 'NFT' | undefined;
    url: string | undefined;
};
export interface Transaction {
    id: string;
    metadata: TransactionMetadata;
    transfers: TransactionTransfer[] | null;
}
export interface TransactionMetadata {
    operationType: string;
    hash: string;
    chain: `${string}:${string}`;
    minedAt: string;
    sentFrom: string;
    sentTo: string;
    status: TransactionStatus;
    nonce: number;
}
export interface TransactionTransfer {
    fungible_info?: {
        name?: string;
        symbol?: string;
        icon?: {
            url: string;
        };
    };
    nft_info?: TransactionNftInfo;
    direction: TransactionDirection;
    quantity: TransactionQuantity;
    value?: number;
    price?: number;
}
export interface TransactionNftInfo {
    name?: string;
    content?: TransactionContent;
    flags: TransactionNftInfoFlags;
}
export interface TransactionNftInfoFlags {
    is_spam: boolean;
}
export interface TransactionContent {
    preview?: TransactionPreview;
    detail?: TransactionDetail;
}
export interface TransactionPreview {
    url: string;
    content_type?: null;
}
export interface TransactionDetail {
    url: string;
    content_type?: null;
}
export interface TransactionQuantity {
    numeric: string;
}
export interface Balance {
    name: string;
    symbol: string;
    chainId: string;
    address?: string;
    value?: number;
    price: number;
    quantity: BalanceQuantity;
    iconUrl: string;
}
type BalanceQuantity = {
    decimals: string;
    numeric: string;
};
export type SIWEStatus = 'uninitialized' | 'ready' | 'loading' | 'success' | 'rejected' | 'error';
export type SdkFramework = 'html' | 'react' | 'vue' | 'cdn' | 'unity';
export type SdkVersion = `${SdkFramework}-${AdapterType}-${string}`;
export type AppKitSdkVersion = `${SdkFramework}-${string}-${string}`;
export type AssetNamespace = 'slip44' | 'erc20' | 'erc721' | 'erc1155' | 'nft' | (string & Record<never, never>);
export type AssetReference = string;
export type AssetType = `${CaipNetworkId}/${AssetNamespace}:${AssetReference}`;
export type TokenId = string;
export type CaipAsset = AssetType | `${AssetType}/${TokenId}`;
export type EmbeddedWalletTimeoutReason = 'iframe_load_failed' | 'iframe_request_timeout' | 'unverified_domain';
export type SocialProvider = 'google' | 'github' | 'apple' | 'facebook' | 'x' | 'discord' | 'farcaster';
export type SwapProvider = '1inch';
export type OnRampProvider = 'meld';
export type InferredCaipNetwork<T extends {
    chainNamespace: string;
} = {
    chainNamespace: string;
}> = T extends {
    chainNamespace: infer N extends string;
} ? CustomCaipNetwork<N> : CustomCaipNetwork;
export type Connection = {
    name?: string;
    icon?: string;
    networkIcon?: string;
    accounts: {
        type?: string;
        address: string;
        publicKey?: string;
        caipAddress?: CaipAddress;
    }[];
    caipNetwork?: CaipNetwork;
    connectorId: string;
    auth?: {
        name: string | undefined;
        username: string | undefined;
    };
};