@hyperlane-xyz/sdk/dist/token/EvmWarpRouteReader.d.ts

The official SDK for the Hyperlane Network

import { Address } from '@hyperlane-xyz/utils';
import { ContractVerifier } from '../deploy/verify/ContractVerifier.js';
import { DerivedTokenFeeConfig, EvmTokenFeeReader } from '../fee/EvmTokenFeeReader.js';
import { EvmHookReader } from '../hook/EvmHookReader.js';
import { EvmIsmReader } from '../ism/EvmIsmReader.js';
import { MultiProvider } from '../providers/MultiProvider.js';
import { EvmRouterReader } from '../router/EvmRouterReader.js';
import { DestinationGas } from '../router/types.js';
import { ChainName, ChainNameOrId, DeployedOwnableConfig } from '../types.js';
import { NormalizedScale } from '../utils/decimals.js';
import { TokenType } from './config.js';
import { ContractVerificationStatus, DerivedTokenRouterConfig, HypTokenConfig, HypTokenRouterVirtualConfig, OwnerStatus, TokenMetadata, XERC20TokenMetadata } from './types.js';
export declare const TOKEN_FEE_CONTRACT_VERSION = "10.0.0";
export declare const CCTP_PPM_STORAGE_VERSION = "10.2.0";
export declare const CCTP_PPM_PRECISION_VERSION = "11.0.0";
export declare class EvmWarpRouteReader extends EvmRouterReader {
    protected readonly multiProvider: MultiProvider;
    protected readonly chain: ChainNameOrId;
    protected readonly concurrency: number;
    protected readonly logger: import("pino").default.Logger<never>;
    private readonly depositAddressDomainConfigsCache;
    protected readonly deriveTokenConfigMap: Record<TokenType, ((address: Address) => Promise<HypTokenConfig>) | null>;
    evmHookReader: EvmHookReader;
    evmIsmReader: EvmIsmReader;
    evmTokenFeeReader: EvmTokenFeeReader;
    contractVerifier: ContractVerifier;
    constructor(multiProvider: MultiProvider, chain: ChainNameOrId, concurrency?: number, contractVerifier?: ContractVerifier);
    /**
     * Derives the configuration for a Hyperlane warp route token router contract at the given address.
     *
     * @param warpRouteAddress - The address of the Hyperlane warp route token router contract.
     * @returns The configuration for the Hyperlane warp route token router.
     *
     */
    deriveWarpRouteConfig(warpRouteAddress: Address): Promise<DerivedTokenRouterConfig>;
    /**
     * Searches the derived hook tree for a PredicateRouterWrapper and, if found,
     * reads its on-chain config (registry, policyId, owner).
     *
     * EvmHookReader.preserveUnredeployable() stores PREDICATE sub-hooks as bare address
     * strings (to survive normalizeConfig and deploy's string branch). The sync
     * findPredicateAddressInHook() returns undefined for bare strings, so we fall back to
     * an on-chain hookType() probe on bare string sub-hooks of aggregation hooks.
     */
    private derivePredicateWrapperConfig;
    private findPredicateAddressInHook;
    fetchTokenFee(routerAddress: Address, destinations?: number[], crossCollateralRouters?: Record<string, string[]>): Promise<DerivedTokenFeeConfig | undefined>;
    getContractVerificationStatus(chain: ChainName, address: Address): Promise<Record<string, ContractVerificationStatus>>;
    getOwnerStatus(chain: ChainName, address: Address): Promise<Record<string, OwnerStatus>>;
    deriveWarpRouteVirtualConfig(chain: ChainName, address: Address): Promise<HypTokenRouterVirtualConfig>;
    /**
     * Derives the token type for a given Warp Route address using specific methods
     *
     * @param warpRouteAddress - The Warp Route address to derive the token type for.
     * @returns The derived token type, which can be one of: collateralVault, collateral, native, or synthetic.
     */
    deriveTokenType(warpRouteAddress: Address): Promise<TokenType>;
    private isNativeWarpToken;
    private isSyntheticWarpToken;
    fetchXERC20Config(xERC20Address: Address, warpRouteAddress: Address): Promise<XERC20TokenMetadata>;
    /**
     * Fetches the metadata for a token address.
     *
     * @param warpRouteAddress - The address of the token.
     * @returns A partial ERC20 metadata object containing the token name, symbol, total supply, and decimals.
     * Throws if unsupported token type
     */
    fetchTokenConfig(type: TokenType, warpRouteAddress: Address): Promise<HypTokenConfig>;
    private deriveHypXERC20TokenConfig;
    private deriveHypXERC20LockboxTokenConfig;
    private deriveHypCollateralCctpTokenConfig;
    private deriveHypCollateralDepositAddressTokenConfig;
    private deriveHypCollateralOftTokenConfig;
    private deriveHypCollateralTokenConfig;
    private deriveHypCollateralFiatTokenConfig;
    private deriveHypCollateralVaultTokenConfig;
    private deriveHypCollateralVaultRebaseTokenConfig;
    private deriveHypSyntheticTokenConfig;
    private deriveHypNativeTokenConfig;
    private deriveOpL2TokenConfig;
    private deriveOpL1TokenConfig;
    private deriveHypSyntheticRebaseConfig;
    private deriveEverclearBaseBridgeConfig;
    private deriveEverclearEthTokenBridgeConfig;
    private deriveEverclearCollateralTokenBridgeConfig;
    /**
     * Derives the configuration for a CrossCollateralRouter router.
     */
    private deriveCrossCollateralTokenConfig;
    fetchERC20Metadata(tokenAddress: Address): Promise<TokenMetadata>;
    /**
     * Fetches the scale configuration from a TokenRouter contract.
     * Handles version compatibility based on contract version - reads scaleNumerator/scaleDenominator
     * for contracts >= 11.0.0, otherwise reads legacy scale value.
     *
     * @param tokenRouterAddress - The address of the TokenRouter contract.
     * @returns The scale as a NormalizedScale, or undefined when the scale is the identity (1/1).
     */
    fetchScale(tokenRouterAddress: Address): Promise<NormalizedScale | undefined>;
    fetchPackageVersion(address: Address): Promise<string>;
    fetchProxyAdminConfig(tokenAddress: Address): Promise<DeployedOwnableConfig>;
    fetchDestinationGas(warpRouteAddress: Address, additionalDomains?: number[]): Promise<DestinationGas>;
}
//# sourceMappingURL=EvmWarpRouteReader.d.ts.map