@reown/appkit-core 1.7.0-rc.4.0 → 1.7.0

package/dist/types/src/utils/SIWXUtil.d.ts

@@ -1,183 +0,0 @@
-import UniversalProvider from '@walletconnect/universal-provider';
-import type { CaipNetworkId } from '@reown/appkit-common';
-/**
- * SIWXUtil holds the methods to interact with the SIWX plugin and must be called internally on AppKit.
- */
-export declare const SIWXUtil: {
-    getSIWX(): SIWXConfig | undefined;
-    initializeIfEnabled(): Promise<void>;
-    requestSignMessage(): Promise<void>;
-    cancelSignMessage(): Promise<void>;
-    getSessions(): Promise<SIWXSession[]>;
-    isSIWXCloseDisabled(): Promise<boolean | undefined>;
-    universalProviderAuthenticate({ universalProvider, chains, methods }: {
-        universalProvider: UniversalProvider;
-        chains: CaipNetworkId[];
-        methods: string[];
-    }): Promise<boolean>;
-    getSIWXEventProperties(): {
-        network: string;
-        isSmartAccount: boolean;
-    };
-    clearSessions(): Promise<void>;
-};
-/**
- * This interface represents the SIWX configuration plugin, which is used to create and manage SIWX messages and sessions.
- * AppKit provides predefined implementations for this interface through `@reown/appkit-siwx`.
- * You may use it to create a custom implementation following your needs, but watch close for the methods requirements.
- */
-export interface SIWXConfig {
-    /**
-     * This method will be called to create a new message to be signed by the user.
-     *
-     * Constraints:
-     * - The message MUST be unique and contain all the necessary information to verify the user's identity.
-     * - SIWXMessage.toString() method MUST be implemented to return the message string.
-     *
-     * @param input SIWXMessage.Input
-     * @returns SIWXMessage
-     */
-    createMessage: (input: SIWXMessage.Input) => Promise<SIWXMessage>;
-    /**
-     * This method will be called to store a new single session.
-     *
-     * Constraints:
-     * - This method MUST verify if the session is valid and store it in the storage successfully.
-     *
-     * @param session SIWXSession
-     */
-    addSession: (session: SIWXSession) => Promise<void>;
-    /**
-     * This method will be called to revoke all the sessions stored for a specific chain and address.
-     *
-     * Constraints:
-     * - This method MUST delete all the sessions stored for the specific chain and address successfully.
-     *
-     * @param chainId CaipNetworkId
-     * @param address string
-     */
-    revokeSession: (chainId: CaipNetworkId, address: string) => Promise<void>;
-    /**
-     * This method will be called to replace all the sessions in the storage with the new ones.
-     *
-     * Constraints:
-     * - This method MUST verify all the sessions before storing them in the storage;
-     * - This method MUST replace all the sessions in the storage with the new ones succesfully otherwise it MUST throw an error.
-     *
-     * @param sessions SIWXSession[]
-     */
-    setSessions: (sessions: SIWXSession[]) => Promise<void>;
-    /**
-     * This method will be called to get all the sessions stored for a specific chain and address.
-     *
-     * Constraints:
-     * - This method MUST return only sessions that are verified and valid;
-     * - This method MUST NOT return expired sessions.
-     *
-     * @param chainId CaipNetworkId
-     * @param address string
-     * @returns
-     */
-    getSessions: (chainId: CaipNetworkId, address: string) => Promise<SIWXSession[]>;
-    /**
-     * This method determines whether the wallet stays connected when the user denies the signature request.
-     *
-     * @returns {boolean}
-     */
-    getRequired?: () => boolean;
-}
-/**
- * This interface represents a SIWX session, which is used to store the user's identity information.
- */
-export interface SIWXSession {
-    data: SIWXMessage.Data;
-    message: string;
-    signature: string;
-    cacao?: Cacao;
-}
-/**
- * This interface represents a SIWX message, which is used to create a message to be signed by the user.
- * This must contain the necessary information to verify the user's identity and how to generate the string message.
- */
-export interface SIWXMessage extends SIWXMessage.Data, SIWXMessage.Methods {
-}
-export declare namespace SIWXMessage {
-    /**
-     * This interface represents the SIWX message data, which is used to create a message to be signed by the user.
-     */
-    interface Data extends Input, Metadata, Identifier {
-    }
-    /**
-     * This interface represents the SIWX message input.
-     * Here must contain what is different for each user of the application.
-     */
-    interface Input {
-        accountAddress: string;
-        chainId: CaipNetworkId;
-        notBefore?: Timestamp;
-    }
-    /**
-     * This interface represents the SIWX message metadata.
-     * Here must contain the main data related to the app.
-     */
-    interface Metadata {
-        domain: string;
-        uri: string;
-        version: string;
-        nonce: string;
-        statement?: string;
-        resources?: string[];
-    }
-    /**
-     * This interface represents the SIWX message identifier.
-     * Here must contain the request id and the timestamps.
-     */
-    interface Identifier {
-        requestId?: string;
-        issuedAt?: Timestamp;
-        expirationTime?: Timestamp;
-    }
-    /**
-     * This interface represents the SIWX message methods.
-     * Here must contain the method to generate the message string and any other method performed by the SIWX message.
-     */
-    interface Methods {
-        toString: () => string;
-    }
-    /**
-     * The timestamp is a UTC string representing the time in ISO 8601 format.
-     */
-    type Timestamp = string;
-}
-/**
- * The Cacao interface is a reference of CAIP-74 and represents a chain-agnostic Object Capability (OCAP).
- * https://chainagnostic.org/CAIPs/caip-74
- */
-export interface Cacao {
-    h: Cacao.Header;
-    p: Cacao.Payload;
-    s: {
-        t: 'eip191' | 'eip1271';
-        s: string;
-        m?: string;
-    };
-}
-export declare namespace Cacao {
-    interface Header {
-        t: 'caip122';
-    }
-    interface Payload {
-        domain: string;
-        aud: string;
-        nonce: string;
-        iss: string;
-        version?: string;
-        iat?: string;
-        nbf?: string;
-        exp?: string;
-        statement?: string;
-        requestId?: string;
-        resources?: string[];
-        type?: string;
-    }
-}

package/dist/types/src/utils/SendApiUtil.d.ts

@@ -1,13 +0,0 @@
-import type { CaipNetwork } from '@reown/appkit-common';
-import type { SwapTokenWithBalance } from './TypeUtil.js';
-import type { BlockchainApiBalanceResponse } from './TypeUtil.js';
-export declare const SendApiUtil: {
-    getMyTokensWithBalance(forceUpdate?: string): Promise<BlockchainApiBalanceResponse["balances"]>;
-    getEIP155Balances(address: string, caipNetwork: CaipNetwork): Promise<import("@reown/appkit-common").Balance[] | null>;
-    /**
-     * The 1Inch API includes many low-quality tokens in the balance response,
-     * which appear inconsistently. This filter prevents them from being displayed.
-     */
-    filterLowQualityTokens(balances: BlockchainApiBalanceResponse["balances"]): import("@reown/appkit-common").Balance[];
-    mapBalancesToSwapTokens(balances: BlockchainApiBalanceResponse["balances"]): SwapTokenWithBalance[];
-};

package/dist/types/src/utils/StorageUtil.d.ts

@@ -1,99 +0,0 @@
-import { type CaipNetworkId, type ChainNamespace } from '@reown/appkit-common';
-import type { BlockchainApiBalanceResponse, BlockchainApiIdentityResponse, BlockchainApiLookupEnsName, ConnectionStatus, SocialProvider, WcWallet } from './TypeUtil.js';
-export declare const StorageUtil: {
-    cacheExpiry: {
-        portfolio: number;
-        nativeBalance: number;
-        ens: number;
-        identity: number;
-    };
-    isCacheExpired(timestamp: number, cacheExpiry: number): boolean;
-    getActiveNetworkProps(): {
-        namespace: ChainNamespace | undefined;
-        caipNetworkId: `eip155:${string}` | `eip155:${number}` | `solana:${string}` | `solana:${number}` | `polkadot:${string}` | `polkadot:${number}` | `bip122:${string}` | `bip122:${number}` | undefined;
-        chainId: string | number | undefined;
-    };
-    setWalletConnectDeepLink({ name, href }: {
-        href: string;
-        name: string;
-    }): void;
-    getWalletConnectDeepLink(): any;
-    deleteWalletConnectDeepLink(): void;
-    setActiveNamespace(namespace: ChainNamespace): void;
-    setActiveCaipNetworkId(caipNetworkId: CaipNetworkId): void;
-    getActiveCaipNetworkId(): `eip155:${string}` | `solana:${string}` | `polkadot:${string}` | `bip122:${string}` | undefined;
-    deleteActiveCaipNetworkId(): void;
-    deleteConnectedConnectorId(namespace: ChainNamespace): void;
-    setAppKitRecent(wallet: WcWallet): void;
-    getRecentWallets(): WcWallet[];
-    setConnectedConnectorId(namespace: ChainNamespace, connectorId: string): void;
-    getActiveNamespace(): ChainNamespace | undefined;
-    getConnectedConnectorId(namespace: ChainNamespace | undefined): string | undefined;
-    setConnectedSocialProvider(socialProvider: SocialProvider): void;
-    getConnectedSocialProvider(): string | undefined;
-    deleteConnectedSocialProvider(): void;
-    getConnectedSocialUsername(): string | undefined;
-    getStoredActiveCaipNetworkId(): string | undefined;
-    setConnectionStatus(status: ConnectionStatus): void;
-    getConnectionStatus(): ConnectionStatus | undefined;
-    getConnectedNamespaces(): ChainNamespace[];
-    setConnectedNamespaces(namespaces: ChainNamespace[]): void;
-    addConnectedNamespace(namespace: ChainNamespace): void;
-    removeConnectedNamespace(namespace: ChainNamespace): void;
-    getTelegramSocialProvider(): SocialProvider | null | undefined;
-    setTelegramSocialProvider(socialProvider: SocialProvider): void;
-    removeTelegramSocialProvider(): void;
-    getBalanceCache(): Record<string, {
-        timestamp: number;
-        balance: BlockchainApiBalanceResponse;
-    }>;
-    removeAddressFromBalanceCache(caipAddress: string): void;
-    getBalanceCacheForCaipAddress(caipAddress: string): BlockchainApiBalanceResponse | undefined;
-    updateBalanceCache(params: {
-        caipAddress: string;
-        balance: BlockchainApiBalanceResponse;
-        timestamp: number;
-    }): void;
-    getNativeBalanceCache(): Record<string, {
-        caipAddress: string;
-        balance: string;
-        symbol: string;
-        timestamp: number;
-    }>;
-    removeAddressFromNativeBalanceCache(caipAddress: string): void;
-    getNativeBalanceCacheForCaipAddress(caipAddress: string): {
-        caipAddress: string;
-        balance: string;
-        symbol: string;
-        timestamp: number;
-    } | undefined;
-    updateNativeBalanceCache(params: {
-        caipAddress: string;
-        balance: string;
-        symbol: string;
-        timestamp: number;
-    }): void;
-    getEnsCache(): Record<string, {
-        ens: BlockchainApiLookupEnsName[];
-        timestamp: number;
-    }>;
-    getEnsFromCacheForAddress(address: string): BlockchainApiLookupEnsName[] | undefined;
-    updateEnsCache(params: {
-        address: string;
-        timestamp: number;
-        ens: BlockchainApiLookupEnsName[];
-    }): void;
-    removeEnsFromCache(address: string): void;
-    getIdentityCache(): Record<string, {
-        identity: BlockchainApiIdentityResponse;
-        timestamp: number;
-    }>;
-    getIdentityFromCacheForAddress(address: string): BlockchainApiIdentityResponse | undefined;
-    updateIdentityCache(params: {
-        address: string;
-        timestamp: number;
-        identity: BlockchainApiIdentityResponse;
-    }): void;
-    removeIdentityFromCache(address: string): void;
-    clearAddressCache(): void;
-};

package/dist/types/src/utils/SwapApiUtil.d.ts

@@ -1,27 +0,0 @@
-import type { SwapTokenWithBalance } from './TypeUtil.js';
-import type { BlockchainApiBalanceResponse, BlockchainApiSwapAllowanceRequest } from './TypeUtil.js';
-export type TokenInfo = {
-    address: `0x${string}`;
-    symbol: string;
-    name: string;
-    decimals: number;
-    logoURI: string;
-    domainVersion?: string;
-    eip2612?: boolean;
-    isFoT?: boolean;
-    tags?: string[];
-};
-export declare const SwapApiUtil: {
-    getTokenList(): Promise<SwapTokenWithBalance[]>;
-    fetchGasPrice(): Promise<{
-        standard: string | undefined;
-        fast: string | undefined;
-        instant: string | undefined;
-    } | null>;
-    fetchSwapAllowance({ tokenAddress, userAddress, sourceTokenAmount, sourceTokenDecimals }: Pick<BlockchainApiSwapAllowanceRequest, "tokenAddress" | "userAddress"> & {
-        sourceTokenAmount: string;
-        sourceTokenDecimals: number;
-    }): Promise<boolean>;
-    getMyTokensWithBalance(forceUpdate?: string): Promise<SwapTokenWithBalance[]>;
-    mapBalancesToSwapTokens(balances: BlockchainApiBalanceResponse["balances"]): SwapTokenWithBalance[];
-};

package/dist/types/src/utils/SwapCalculationUtil.d.ts

@@ -1,22 +0,0 @@
-import type { SwapTokenWithBalance } from './TypeUtil.js';
-export declare const SwapCalculationUtil: {
-    getGasPriceInEther(gas: bigint, gasPrice: bigint): number;
-    getGasPriceInUSD(networkPrice: string, gas: bigint, gasPrice: bigint): number;
-    getPriceImpact({ sourceTokenAmount, sourceTokenPriceInUSD, toTokenPriceInUSD, toTokenAmount }: {
-        sourceTokenAmount: string;
-        sourceTokenPriceInUSD: number;
-        toTokenPriceInUSD: number;
-        toTokenAmount: string;
-    }): number;
-    getMaxSlippage(slippage: number, toTokenAmount: string): number;
-    getProviderFee(sourceTokenAmount: string, feePercentage?: number): string;
-    isInsufficientNetworkTokenForGas(networkBalanceInUSD: string, gasPriceInUSD: number | undefined): boolean;
-    isInsufficientSourceTokenForSwap(sourceTokenAmount: string, sourceTokenAddress: string, balance: SwapTokenWithBalance[] | undefined): boolean;
-    getToTokenAmount({ sourceToken, toToken, sourceTokenPrice, toTokenPrice, sourceTokenAmount }: {
-        sourceToken: SwapTokenWithBalance | undefined;
-        toToken: SwapTokenWithBalance | undefined;
-        sourceTokenPrice: number;
-        toTokenPrice: number;
-        sourceTokenAmount: string;
-    }): string;
-};