@hyperlane-xyz/rebalancer 0.1.0-beta.5a8bd28ab

package/dist/interfaces/IMetrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMetrics.js","sourceRoot":"","sources":["../../src/interfaces/IMetrics.ts"],"names":[],"mappings":""}

package/dist/interfaces/IMonitor.d.ts

@@ -0,0 +1,51 @@
+import { Token } from '@hyperlane-xyz/sdk';
+import { WrappedError } from '../utils/errors.js';
+export declare class MonitorStartError extends WrappedError {
+    name: string;
+}
+export declare class MonitorPollingError extends WrappedError {
+    name: string;
+}
+export declare enum MonitorEventType {
+    TokenInfo = "TokenInfo",
+    Error = "Error",
+    Start = "Start"
+}
+/**
+ * Represents an event emitted by the monitor containing bridgedSupply and token information.
+ */
+export type MonitorEvent = {
+    /**
+     * Collection of objects containing the information retrieved by the Monitor.
+     */
+    tokensInfo: {
+        token: Token;
+        bridgedSupply?: bigint;
+    }[];
+};
+/**
+ * Interface for a monitoring service that tracks token information across different chains.
+ */
+export interface IMonitor {
+    /**
+     * Allows subscribers to listen to hyperlane's tokens info.
+     */
+    on(eventName: MonitorEventType.TokenInfo, fn: (event: MonitorEvent) => void): this;
+    /**
+     * Allows subscribers to listen to error events.
+     */
+    on(eventName: MonitorEventType.Error, fn: (event: Error) => void): this;
+    /**
+     * Allows subscribers to listen to start events.
+     */
+    on(eventName: MonitorEventType.Start, fn: () => void): this;
+    /**
+     * Starts the monitoring long-running process.
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the monitoring long-running process.
+     */
+    stop(): void;
+}
+//# sourceMappingURL=IMonitor.d.ts.map

package/dist/interfaces/IMonitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMonitor.d.ts","sourceRoot":"","sources":["../../src/interfaces/IMonitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,IAAI,SAAuB;CAC5B;AAED,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,IAAI,SAAyB;CAC9B;AAED,oBAAY,gBAAgB;IAC1B,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,UAAU,EAAE;QACV,KAAK,EAAE,KAAK,CAAC;QACb,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,EAAE,CAAC;CACL,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,CACA,SAAS,EAAE,gBAAgB,CAAC,SAAS,EACrC,EAAE,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,GAChC,IAAI,CAAC;IAER;;OAEG;IACH,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;IAExE;;OAEG;IACH,EAAE,CAAC,SAAS,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;CACd"}

package/dist/interfaces/IMonitor.js

@@ -0,0 +1,14 @@
+import { WrappedError } from '../utils/errors.js';
+export class MonitorStartError extends WrappedError {
+    name = 'MonitorStartError';
+}
+export class MonitorPollingError extends WrappedError {
+    name = 'MonitorPollingError';
+}
+export var MonitorEventType;
+(function (MonitorEventType) {
+    MonitorEventType["TokenInfo"] = "TokenInfo";
+    MonitorEventType["Error"] = "Error";
+    MonitorEventType["Start"] = "Start";
+})(MonitorEventType || (MonitorEventType = {}));
+//# sourceMappingURL=IMonitor.js.map

package/dist/interfaces/IMonitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMonitor.js","sourceRoot":"","sources":["../../src/interfaces/IMonitor.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,OAAO,iBAAkB,SAAQ,YAAY;IACjD,IAAI,GAAG,mBAAmB,CAAC;CAC5B;AAED,MAAM,OAAO,mBAAoB,SAAQ,YAAY;IACnD,IAAI,GAAG,qBAAqB,CAAC;CAC9B;AAED,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,2CAAuB,CAAA;IACvB,mCAAe,CAAA;IACf,mCAAe,CAAA;AACjB,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B"}

package/dist/interfaces/IRebalancer.d.ts

@@ -0,0 +1,15 @@
+import { EvmMovableCollateralAdapter, TokenAmount } from '@hyperlane-xyz/sdk';
+import { RebalancingRoute } from './IStrategy.js';
+export type PreparedTransaction = {
+    populatedTx: Awaited<ReturnType<EvmMovableCollateralAdapter['populateRebalanceTx']>>;
+    route: RebalancingRoute;
+    originTokenAmount: TokenAmount;
+};
+export type RebalanceMetrics = {
+    route: RebalancingRoute;
+    originTokenAmount: TokenAmount;
+};
+export interface IRebalancer {
+    rebalance(routes: RebalancingRoute[]): Promise<void>;
+}
+//# sourceMappingURL=IRebalancer.d.ts.map

package/dist/interfaces/IRebalancer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRebalancer.d.ts","sourceRoot":"","sources":["../../src/interfaces/IRebalancer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,OAAO,CAClB,UAAU,CAAC,2BAA2B,CAAC,qBAAqB,CAAC,CAAC,CAC/D,CAAC;IACF,KAAK,EAAE,gBAAgB,CAAC;IACxB,iBAAiB,EAAE,WAAW,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,gBAAgB,CAAC;IACxB,iBAAiB,EAAE,WAAW,CAAC;CAChC,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD"}

package/dist/interfaces/IRebalancer.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRebalancer.js.map

package/dist/interfaces/IRebalancer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRebalancer.js","sourceRoot":"","sources":["../../src/interfaces/IRebalancer.ts"],"names":[],"mappings":""}

package/dist/interfaces/IStrategy.d.ts

@@ -0,0 +1,11 @@
+import { ChainMap, ChainName } from '@hyperlane-xyz/sdk';
+export type RawBalances = ChainMap<bigint>;
+export type RebalancingRoute = {
+    origin: ChainName;
+    destination: ChainName;
+    amount: bigint;
+};
+export interface IStrategy {
+    getRebalancingRoutes(rawBalances: RawBalances): RebalancingRoute[];
+}
+//# sourceMappingURL=IStrategy.d.ts.map

package/dist/interfaces/IStrategy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStrategy.d.ts","sourceRoot":"","sources":["../../src/interfaces/IStrategy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEzD,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AAE3C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,SAAS,CAAC;IAClB,WAAW,EAAE,SAAS,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,WAAW,SAAS;IACxB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,gBAAgB,EAAE,CAAC;CACpE"}

package/dist/interfaces/IStrategy.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IStrategy.js.map

package/dist/interfaces/IStrategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IStrategy.js","sourceRoot":"","sources":["../../src/interfaces/IStrategy.ts"],"names":[],"mappings":""}

package/dist/metrics/Metrics.d.ts

@@ -0,0 +1,31 @@
+import { Logger } from 'pino';
+import { Token, TokenAmount, WarpCore, WarpRouteDeployConfig } from '@hyperlane-xyz/sdk';
+import { IMetrics } from '../interfaces/IMetrics.js';
+import { MonitorEvent } from '../interfaces/IMonitor.js';
+import { RebalancingRoute } from '../interfaces/IStrategy.js';
+import { PriceGetter } from './PriceGetter.js';
+export declare class Metrics implements IMetrics {
+    private readonly tokenPriceGetter;
+    private readonly warpDeployConfig;
+    private readonly warpCore;
+    private readonly warpRouteId;
+    private readonly managedLockBoxMinimalABI;
+    private readonly logger;
+    constructor(tokenPriceGetter: PriceGetter, warpDeployConfig: WarpRouteDeployConfig | null, warpCore: WarpCore, warpRouteId: string, logger: Logger);
+    recordRebalancerSuccess(): void;
+    recordRebalanceAmount(route: RebalancingRoute, originTokenAmount: TokenAmount): void;
+    recordRebalancerFailure(): void;
+    recordPollingError(): void;
+    processToken({ token, bridgedSupply, }: MonitorEvent['tokensInfo'][number]): Promise<void>;
+    private updateTokenMetrics;
+    private getTokenBridgedBalance;
+    private getSealevelAtaPayerBalance;
+    private getXERC20Info;
+    private getXERC20Limit;
+    private getExtraLockboxInfo;
+    private getManagedLockBox;
+    private getExtraLockboxBalance;
+    private getManagedLockBoxCollateralInfo;
+    static getWarpRouteCollateralTokenSymbol(tokens: Token[]): string;
+}
+//# sourceMappingURL=Metrics.d.ts.map

package/dist/metrics/Metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metrics.d.ts","sourceRoot":"","sources":["../../src/metrics/Metrics.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAG9B,OAAO,EAML,KAAK,EACL,WAAW,EAGX,QAAQ,EACR,qBAAqB,EACtB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAG9D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAmB/C,qBAAa,OAAQ,YAAW,QAAQ;IAQpC,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAV9B,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAG9B;IACX,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAGb,gBAAgB,EAAE,WAAW,EAC7B,gBAAgB,EAAE,qBAAqB,GAAG,IAAI,EAC9C,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,MAAM,EACpC,MAAM,EAAE,MAAM;IAMhB,uBAAuB;IAMvB,qBAAqB,CACnB,KAAK,EAAE,gBAAgB,EACvB,iBAAiB,EAAE,WAAW;IAYhC,uBAAuB;IAMvB,kBAAkB;IAMZ,YAAY,CAAC,EACjB,KAAK,EACL,aAAa,GACd,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC;YAWvB,kBAAkB;YAkKlB,sBAAsB;YAwDtB,0BAA0B;YA8B1B,aAAa;YAyBb,cAAc;YAmBd,mBAAmB;YAmCnB,iBAAiB;YAcjB,sBAAsB;YAiDtB,+BAA+B;IA0B7C,MAAM,CAAC,iCAAiC,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM;CAkClE"}

package/dist/metrics/Metrics.js

@@ -0,0 +1,302 @@
+import { Contract } from 'ethers';
+import { IXERC20VS__factory } from '@hyperlane-xyz/core';
+import { EvmTokenAdapter, Token, TokenStandard, TokenType, } from '@hyperlane-xyz/sdk';
+import { ProtocolType } from '@hyperlane-xyz/utils';
+import { formatBigInt, tryFn } from '../utils/index.js';
+import { metricsRegister, rebalancerExecutionAmount, rebalancerExecutionTotal, rebalancerPollingErrorsTotal, updateManagedLockboxBalanceMetrics, updateNativeWalletBalanceMetrics, updateTokenBalanceMetrics, updateXERC20LimitsMetrics, } from './scripts/metrics.js';
+import { startMetricsServer } from './utils/metrics.js';
+export class Metrics {
+    tokenPriceGetter;
+    warpDeployConfig;
+    warpCore;
+    warpRouteId;
+    managedLockBoxMinimalABI = [
+        'function XERC20() view returns (address)',
+        'function ERC20() view returns (address)',
+    ];
+    logger;
+    constructor(tokenPriceGetter, warpDeployConfig, warpCore, warpRouteId, logger) {
+        this.tokenPriceGetter = tokenPriceGetter;
+        this.warpDeployConfig = warpDeployConfig;
+        this.warpCore = warpCore;
+        this.warpRouteId = warpRouteId;
+        this.logger = logger.child({ class: Metrics.name });
+        startMetricsServer(metricsRegister);
+    }
+    recordRebalancerSuccess() {
+        rebalancerExecutionTotal
+            .labels({ warp_route_id: this.warpRouteId, succeeded: 'true' })
+            .inc();
+    }
+    recordRebalanceAmount(route, originTokenAmount) {
+        rebalancerExecutionAmount
+            .labels({
+            warp_route_id: this.warpRouteId,
+            origin: route.origin,
+            destination: route.destination,
+            token: originTokenAmount.token.symbol,
+        })
+            .inc(originTokenAmount.getDecimalFormattedAmount());
+    }
+    recordRebalancerFailure() {
+        rebalancerExecutionTotal
+            .labels({ warp_route_id: this.warpRouteId, succeeded: 'false' })
+            .inc();
+    }
+    recordPollingError() {
+        rebalancerPollingErrorsTotal
+            .labels({ warp_route_id: this.warpRouteId })
+            .inc();
+    }
+    async processToken({ token, bridgedSupply, }) {
+        await tryFn(async () => {
+            await this.updateTokenMetrics(token, bridgedSupply);
+        }, 'Updating warp route metrics', this.logger);
+    }
+    // Updates the metrics for a single token in a warp route.
+    async updateTokenMetrics(token, bridgedSupply) {
+        const promises = [
+            tryFn(async () => {
+                const balanceInfo = await this.getTokenBridgedBalance(token, bridgedSupply);
+                if (!balanceInfo) {
+                    return;
+                }
+                updateTokenBalanceMetrics(this.warpCore, token, balanceInfo, this.warpRouteId, this.logger);
+            }, 'Getting bridged balance and value', this.logger),
+        ];
+        // For Sealevel collateral and synthetic tokens, there is an
+        // "Associated Token Account" (ATA) rent payer that has a balance
+        // that's used to pay for rent for the accounts that store user balances.
+        // This is necessary if the recipient has never received any tokens before.
+        if (token.protocol === ProtocolType.Sealevel && !token.isNative()) {
+            promises.push(tryFn(async () => {
+                const balance = await this.getSealevelAtaPayerBalance(token, this.warpRouteId);
+                updateNativeWalletBalanceMetrics(balance, this.logger);
+            }, 'Getting ATA payer balance', this.logger));
+        }
+        if (token.isXerc20()) {
+            promises.push(tryFn(async () => {
+                const { limits, xERC20Address } = await this.getXERC20Info(token);
+                const routerAddress = token.addressOrDenom;
+                updateXERC20LimitsMetrics(token, limits, routerAddress, token.standard, xERC20Address, this.logger);
+            }, 'Getting xERC20 limits', this.logger));
+            if (!this.warpDeployConfig) {
+                this.logger.warn({
+                    tokenSymbol: token.symbol,
+                    chain: token.chainName,
+                }, "Can't read warp deploy config, skipping extra lockboxes");
+                return;
+            }
+            // If the current token is an xERC20, we need to check if there are any extra lockboxes
+            const currentTokenDeployConfig = this.warpDeployConfig[token.chainName];
+            if (currentTokenDeployConfig.type !== TokenType.XERC20 &&
+                currentTokenDeployConfig.type !== TokenType.XERC20Lockbox) {
+                this.logger.error({
+                    tokenSymbol: token.symbol,
+                    chain: token.chainName,
+                    expectedType: [TokenType.XERC20, TokenType.XERC20Lockbox],
+                    actualType: currentTokenDeployConfig.type,
+                }, 'Token type mismatch in deploy config for xERC20 token');
+                return;
+            }
+            const extraLockboxes = currentTokenDeployConfig.xERC20?.extraBridges ?? [];
+            for (const lockbox of extraLockboxes) {
+                promises.push(tryFn(async () => {
+                    const { limits, xERC20Address } = await this.getExtraLockboxInfo(token, lockbox.lockbox);
+                    updateXERC20LimitsMetrics(token, limits, lockbox.lockbox, 'EvmManagedLockbox', xERC20Address, this.logger);
+                }, 'Getting extra lockbox limits', this.logger), tryFn(async () => {
+                    const balance = await this.getExtraLockboxBalance(token, lockbox.lockbox);
+                    if (balance) {
+                        const { tokenName, tokenAddress } = await this.getManagedLockBoxCollateralInfo(token, lockbox.lockbox);
+                        updateManagedLockboxBalanceMetrics(this.warpCore, token.chainName, tokenName, tokenAddress, lockbox.lockbox, balance, this.warpRouteId, this.logger);
+                    }
+                }, `Updating extra lockbox balance for contract at "${lockbox.lockbox}" on chain ${token.chainName}`, this.logger));
+            }
+        }
+        await Promise.all(promises);
+    }
+    // Gets the bridged balance and value of a token in a warp route.
+    async getTokenBridgedBalance(token, bridgedSupply) {
+        if (!token.isHypToken()) {
+            this.logger.warn({
+                tokenChain: token.chainName,
+                tokenSymbol: token.symbol,
+                tokenAddress: token.addressOrDenom,
+            }, 'Cannot get bridged balance for a non-Hyperlane token');
+            return undefined;
+        }
+        const adapter = token.getHypAdapter(this.warpCore.multiProvider);
+        let tokenAddress = token.collateralAddressOrDenom ?? token.addressOrDenom;
+        if (bridgedSupply === undefined) {
+            this.logger.warn({
+                tokenChain: token.chainName,
+                tokenSymbol: token.symbol,
+                tokenAddress: token.addressOrDenom,
+            }, 'Bridged supply not found for token');
+            return undefined;
+        }
+        const balance = token.amount(bridgedSupply).getDecimalFormattedAmount();
+        let tokenPrice;
+        // Only record value for collateralized and xERC20 lockbox tokens.
+        // removed the check for `EvmHypXERC20Lockbox` as it's already listed as collateralized
+        if (token.isCollateralized()) {
+            tokenPrice = await this.tokenPriceGetter.tryGetTokenPrice(token);
+        }
+        if (token.standard === TokenStandard.EvmHypXERC20Lockbox) {
+            tokenAddress = (await adapter.getXERC20())
+                .address;
+        }
+        return {
+            balance,
+            valueUSD: tokenPrice ? balance * tokenPrice : undefined,
+            tokenAddress,
+        };
+    }
+    // Gets the native balance of the ATA payer, which is used to pay for
+    // rent when delivering tokens to an account that previously didn't
+    // have a balance.
+    // Only intended for Collateral or Synthetic Sealevel tokens.
+    async getSealevelAtaPayerBalance(token, warpRouteId) {
+        if (token.protocol !== ProtocolType.Sealevel || token.isNative()) {
+            throw new Error(`Unsupported ATA payer protocol type ${token.protocol} or standard ${token.standard}`);
+        }
+        const adapter = token.getHypAdapter(this.warpCore.multiProvider);
+        const ataPayer = adapter.deriveAtaPayerAccount().toString();
+        const nativeToken = Token.FromChainMetadataNativeToken(this.warpCore.multiProvider.getChainMetadata(token.chainName));
+        const ataPayerBalance = await nativeToken.getBalance(this.warpCore.multiProvider, ataPayer);
+        return {
+            chain: token.chainName,
+            walletAddress: ataPayer.toString(),
+            walletName: `${warpRouteId}/ata-payer`,
+            balance: ataPayerBalance.getDecimalFormattedAmount(),
+        };
+    }
+    async getXERC20Info(token) {
+        if (token.protocol !== ProtocolType.Ethereum) {
+            throw new Error(`Unsupported XERC20 protocol type ${token.protocol}`);
+        }
+        if (token.standard === TokenStandard.EvmHypXERC20) {
+            const adapter = token.getAdapter(this.warpCore.multiProvider);
+            return {
+                limits: await this.getXERC20Limit(token, adapter),
+                xERC20Address: (await adapter.getXERC20()).address,
+            };
+        }
+        else if (token.standard === TokenStandard.EvmHypXERC20Lockbox) {
+            const adapter = token.getAdapter(this.warpCore.multiProvider);
+            return {
+                limits: await this.getXERC20Limit(token, adapter),
+                xERC20Address: (await adapter.getXERC20()).address,
+            };
+        }
+        throw new Error(`Unsupported XERC20 token standard ${token.standard}`);
+    }
+    async getXERC20Limit(token, xerc20) {
+        const [mintCurrent, mintMax, burnCurrent, burnMax] = await Promise.all([
+            xerc20.getMintLimit(),
+            xerc20.getMintMaxLimit(),
+            xerc20.getBurnLimit(),
+            xerc20.getBurnMaxLimit(),
+        ]);
+        return {
+            mint: formatBigInt(token, mintCurrent),
+            mintMax: formatBigInt(token, mintMax),
+            burn: formatBigInt(token, burnCurrent),
+            burnMax: formatBigInt(token, burnMax),
+        };
+    }
+    async getExtraLockboxInfo(warpToken, lockboxAddress) {
+        const currentChainProvider = this.warpCore.multiProvider.getEthersV5Provider(warpToken.chainName);
+        const lockboxInstance = await this.getManagedLockBox(warpToken, lockboxAddress);
+        const xERC20Address = await lockboxInstance.XERC20();
+        const vsXERC20Address = IXERC20VS__factory.connect(xERC20Address, currentChainProvider); // todo use adapter
+        const [mintMax, burnMax, mint, burn] = await Promise.all([
+            vsXERC20Address.mintingMaxLimitOf(lockboxAddress),
+            vsXERC20Address.burningMaxLimitOf(lockboxAddress),
+            vsXERC20Address.mintingCurrentLimitOf(lockboxAddress),
+            vsXERC20Address.burningCurrentLimitOf(lockboxAddress),
+        ]);
+        return {
+            limits: {
+                burn: formatBigInt(warpToken, burn.toBigInt()),
+                burnMax: formatBigInt(warpToken, burnMax.toBigInt()),
+                mint: formatBigInt(warpToken, mint.toBigInt()),
+                mintMax: formatBigInt(warpToken, mintMax.toBigInt()),
+            },
+            xERC20Address,
+        };
+    }
+    async getManagedLockBox(warpToken, lockboxAddress) {
+        const chainName = warpToken.chainName;
+        const provider = this.warpCore.multiProvider.getEthersV5Provider(chainName);
+        return new Contract(lockboxAddress, this.managedLockBoxMinimalABI, provider);
+    }
+    async getExtraLockboxBalance(warpToken, lockboxAddress) {
+        if (!warpToken.isXerc20()) {
+            return;
+        }
+        const lockboxInstance = await this.getManagedLockBox(warpToken, lockboxAddress);
+        const erc20TokenAddress = await lockboxInstance.ERC20();
+        const erc20tokenAdapter = new EvmTokenAdapter(warpToken.chainName, this.warpCore.multiProvider, {
+            token: erc20TokenAddress,
+        });
+        let balance;
+        try {
+            balance = await erc20tokenAdapter.getBalance(lockboxAddress);
+        }
+        catch (error) {
+            this.logger.error({
+                lockboxAddress,
+                chain: warpToken.chainName,
+                erc20TokenAddress,
+                error: error,
+            }, 'Error getting balance for contract at lockbox');
+            return;
+        }
+        const tokenPrice = await this.tokenPriceGetter.tryGetTokenPrice(warpToken);
+        const balanceNumber = formatBigInt(warpToken, balance);
+        return {
+            balance: balanceNumber,
+            valueUSD: tokenPrice ? balanceNumber * tokenPrice : undefined,
+            tokenAddress: erc20TokenAddress,
+        };
+    }
+    async getManagedLockBoxCollateralInfo(warpToken, lockBoxAddress) {
+        const lockBoxInstance = await this.getManagedLockBox(warpToken, lockBoxAddress);
+        const collateralTokenAddress = await lockBoxInstance.ERC20();
+        const collateralTokenAdapter = new EvmTokenAdapter(warpToken.chainName, this.warpCore.multiProvider, {
+            token: collateralTokenAddress,
+        });
+        const { name } = await collateralTokenAdapter.getMetadata();
+        return {
+            tokenName: name,
+            tokenAddress: collateralTokenAddress,
+        };
+    }
+    static getWarpRouteCollateralTokenSymbol(tokens) {
+        // We need to have a deterministic way to determine the symbol of the warp route
+        // as its used to identify the warp route in metrics. This method should support routes where:
+        // - All tokens have the same symbol, token standards can be all collateral, all synthetic or a mix
+        // - All tokens have different symbol, but there is a collateral token to break the tie, where there are multiple collateral tokens, alphabetically first is chosen
+        // - All tokens have different symbol, but there is no collateral token to break the tie, pick the alphabetically first symbol
+        // Get all unique symbols from the tokens array
+        const uniqueSymbols = new Set(tokens.map((token) => token.symbol));
+        // If all tokens have the same symbol, return that symbol
+        if (uniqueSymbols.size === 1) {
+            return tokens[0].symbol;
+        }
+        // Find all collateralized tokens
+        const collateralTokens = tokens.filter((token) => token.isCollateralized() ||
+            token.standard === TokenStandard.EvmHypXERC20Lockbox);
+        if (collateralTokens.length === 0) {
+            // If there are no collateralized tokens, return the alphabetically first symbol
+            return [...uniqueSymbols].sort()[0];
+        }
+        // if there is a single unique collateral symbol return it or
+        // if there are multiple, return the alphabetically first symbol
+        const collateralSymbols = collateralTokens.map((token) => token.symbol);
+        const uniqueCollateralSymbols = [...new Set(collateralSymbols)];
+        return uniqueCollateralSymbols.sort()[0];
+    }
+}
+//# sourceMappingURL=Metrics.js.map

package/dist/metrics/Metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../../src/metrics/Metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAwB,MAAM,QAAQ,CAAC;AAGxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EAGL,eAAe,EAGf,KAAK,EAEL,aAAa,EACb,SAAS,GAGV,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAW,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAK7D,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAGxD,OAAO,EACL,eAAe,EACf,yBAAyB,EACzB,wBAAwB,EACxB,4BAA4B,EAC5B,kCAAkC,EAClC,gCAAgC,EAChC,yBAAyB,EACzB,yBAAyB,GAC1B,MAAM,sBAAsB,CAAC;AAO9B,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,OAAO,OAAO;IAQC;IACA;IACA;IACA;IAVF,wBAAwB,GAAG;QAC1C,0CAA0C;QAC1C,yCAAyC;KACjC,CAAC;IACM,MAAM,CAAS;IAEhC,YACmB,gBAA6B,EAC7B,gBAA8C,EAC9C,QAAkB,EAClB,WAAmB,EACpC,MAAc;QAJG,qBAAgB,GAAhB,gBAAgB,CAAa;QAC7B,qBAAgB,GAAhB,gBAAgB,CAA8B;QAC9C,aAAQ,GAAR,QAAQ,CAAU;QAClB,gBAAW,GAAX,WAAW,CAAQ;QAGpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QACpD,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACtC,CAAC;IAED,uBAAuB;QACrB,wBAAwB;aACrB,MAAM,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;aAC9D,GAAG,EAAE,CAAC;IACX,CAAC;IAED,qBAAqB,CACnB,KAAuB,EACvB,iBAA8B;QAE9B,yBAAyB;aACtB,MAAM,CAAC;YACN,aAAa,EAAE,IAAI,CAAC,WAAW;YAC/B,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,KAAK,EAAE,iBAAiB,CAAC,KAAK,CAAC,MAAM;SACtC,CAAC;aACD,GAAG,CAAC,iBAAiB,CAAC,yBAAyB,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,uBAAuB;QACrB,wBAAwB;aACrB,MAAM,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;aAC/D,GAAG,EAAE,CAAC;IACX,CAAC;IAED,kBAAkB;QAChB,4BAA4B;aACzB,MAAM,CAAC,EAAE,aAAa,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;aAC3C,GAAG,EAAE,CAAC;IACX,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,EACjB,KAAK,EACL,aAAa,GACsB;QACnC,MAAM,KAAK,CACT,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QACtD,CAAC,EACD,6BAA6B,EAC7B,IAAI,CAAC,MAAM,CACZ,CAAC;IACJ,CAAC;IAED,0DAA0D;IAClD,KAAK,CAAC,kBAAkB,CAC9B,KAAY,EACZ,aAAsB;QAEtB,MAAM,QAAQ,GAAG;YACf,KAAK,CACH,KAAK,IAAI,EAAE;gBACT,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,sBAAsB,CACnD,KAAK,EACL,aAAa,CACd,CAAC;gBAEF,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,OAAO;gBACT,CAAC;gBAED,yBAAyB,CACvB,IAAI,CAAC,QAAQ,EACb,KAAK,EACL,WAAW,EACX,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,MAAM,CACZ,CAAC;YACJ,CAAC,EACD,mCAAmC,EACnC,IAAI,CAAC,MAAM,CACZ;SACF,CAAC;QAEF,4DAA4D;QAC5D,iEAAiE;QACjE,yEAAyE;QACzE,2EAA2E;QAC3E,IAAI,KAAK,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;YAClE,QAAQ,CAAC,IAAI,CACX,KAAK,CACH,KAAK,IAAI,EAAE;gBACT,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,0BAA0B,CACnD,KAAK,EACL,IAAI,CAAC,WAAW,CACjB,CAAC;gBAEF,gCAAgC,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACzD,CAAC,EACD,2BAA2B,EAC3B,IAAI,CAAC,MAAM,CACZ,CACF,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;YACrB,QAAQ,CAAC,IAAI,CACX,KAAK,CACH,KAAK,IAAI,EAAE;gBACT,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBAClE,MAAM,aAAa,GAAG,KAAK,CAAC,cAAc,CAAC;gBAE3C,yBAAyB,CACvB,KAAK,EACL,MAAM,EACN,aAAa,EACb,KAAK,CAAC,QAAQ,EACd,aAAa,EACb,IAAI,CAAC,MAAM,CACZ,CAAC;YACJ,CAAC,EACD,uBAAuB,EACvB,IAAI,CAAC,MAAM,CACZ,CACF,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,IAAI,CAAC,MAAM,CAAC,IAAI,CACd;oBACE,WAAW,EAAE,KAAK,CAAC,MAAM;oBACzB,KAAK,EAAE,KAAK,CAAC,SAAS;iBACvB,EACD,yDAAyD,CAC1D,CAAC;gBACF,OAAO;YACT,CAAC;YAED,uFAAuF;YACvF,MAAM,wBAAwB,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAExE,IACE,wBAAwB,CAAC,IAAI,KAAK,SAAS,CAAC,MAAM;gBAClD,wBAAwB,CAAC,IAAI,KAAK,SAAS,CAAC,aAAa,EACzD,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,KAAK,CACf;oBACE,WAAW,EAAE,KAAK,CAAC,MAAM;oBACzB,KAAK,EAAE,KAAK,CAAC,SAAS;oBACtB,YAAY,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,aAAa,CAAC;oBACzD,UAAU,EAAE,wBAAwB,CAAC,IAAI;iBAC1C,EACD,uDAAuD,CACxD,CAAC;gBACF,OAAO;YACT,CAAC;YAED,MAAM,cAAc,GAClB,wBAAwB,CAAC,MAAM,EAAE,YAAY,IAAI,EAAE,CAAC;YAEtD,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;gBACrC,QAAQ,CAAC,IAAI,CACX,KAAK,CACH,KAAK,IAAI,EAAE;oBACT,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAC9D,KAAK,EACL,OAAO,CAAC,OAAO,CAChB,CAAC;oBAEF,yBAAyB,CACvB,KAAK,EACL,MAAM,EACN,OAAO,CAAC,OAAO,EACf,mBAAmB,EACnB,aAAa,EACb,IAAI,CAAC,MAAM,CACZ,CAAC;gBACJ,CAAC,EACD,8BAA8B,EAC9B,IAAI,CAAC,MAAM,CACZ,EACD,KAAK,CACH,KAAK,IAAI,EAAE;oBACT,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAC/C,KAAK,EACL,OAAO,CAAC,OAAO,CAChB,CAAC;oBAEF,IAAI,OAAO,EAAE,CAAC;wBACZ,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAC/B,MAAM,IAAI,CAAC,+BAA+B,CACxC,KAAK,EACL,OAAO,CAAC,OAAO,CAChB,CAAC;wBAEJ,kCAAkC,CAChC,IAAI,CAAC,QAAQ,EACb,KAAK,CAAC,SAAS,EACf,SAAS,EACT,YAAY,EACZ,OAAO,CAAC,OAAO,EACf,OAAO,EACP,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,MAAM,CACZ,CAAC;oBACJ,CAAC;gBACH,CAAC,EACD,mDAAmD,OAAO,CAAC,OAAO,cAAc,KAAK,CAAC,SAAS,EAAE,EACjG,IAAI,CAAC,MAAM,CACZ,CACF,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED,iEAAiE;IACzD,KAAK,CAAC,sBAAsB,CAClC,KAAY,EACZ,aAAsB;QAEtB,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,IAAI,CACd;gBACE,UAAU,EAAE,KAAK,CAAC,SAAS;gBAC3B,WAAW,EAAE,KAAK,CAAC,MAAM;gBACzB,YAAY,EAAE,KAAK,CAAC,cAAc;aACnC,EACD,sDAAsD,CACvD,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACjE,IAAI,YAAY,GAAG,KAAK,CAAC,wBAAwB,IAAI,KAAK,CAAC,cAAc,CAAC;QAE1E,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,IAAI,CACd;gBACE,UAAU,EAAE,KAAK,CAAC,SAAS;gBAC3B,WAAW,EAAE,KAAK,CAAC,MAAM;gBACzB,YAAY,EAAE,KAAK,CAAC,cAAc;aACnC,EACD,oCAAoC,CACrC,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,yBAAyB,EAAE,CAAC;QAExE,IAAI,UAAU,CAAC;QACf,kEAAkE;QAClE,uFAAuF;QACvF,IAAI,KAAK,CAAC,gBAAgB,EAAE,EAAE,CAAC;YAC7B,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,KAAK,CAAC,QAAQ,KAAK,aAAa,CAAC,mBAAmB,EAAE,CAAC;YACzD,YAAY,GAAG,CAAC,MAAO,OAAsC,CAAC,SAAS,EAAE,CAAC;iBACvE,OAAO,CAAC;QACb,CAAC;QAED,OAAO;YACL,OAAO;YACP,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,SAAS;YACvD,YAAY;SACb,CAAC;IACJ,CAAC;IAED,qEAAqE;IACrE,mEAAmE;IACnE,kBAAkB;IAClB,6DAA6D;IACrD,KAAK,CAAC,0BAA0B,CACtC,KAAY,EACZ,WAAmB;QAEnB,IAAI,KAAK,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC;YACjE,MAAM,IAAI,KAAK,CACb,uCAAuC,KAAK,CAAC,QAAQ,gBAAgB,KAAK,CAAC,QAAQ,EAAE,CACtF,CAAC;QACJ,CAAC;QACD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CACjC,IAAI,CAAC,QAAQ,CAAC,aAAa,CACD,CAAC;QAE7B,MAAM,QAAQ,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC5D,MAAM,WAAW,GAAG,KAAK,CAAC,4BAA4B,CACpD,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,CAC9D,CAAC;QACF,MAAM,eAAe,GAAG,MAAM,WAAW,CAAC,UAAU,CAClD,IAAI,CAAC,QAAQ,CAAC,aAAa,EAC3B,QAAQ,CACT,CAAC;QAEF,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,SAAS;YACtB,aAAa,EAAE,QAAQ,CAAC,QAAQ,EAAE;YAClC,UAAU,EAAE,GAAG,WAAW,YAAY;YACtC,OAAO,EAAE,eAAe,CAAC,yBAAyB,EAAE;SACrD,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,aAAa,CAAC,KAAY;QACtC,IAAI,KAAK,CAAC,QAAQ,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,KAAK,CAAC,QAAQ,KAAK,aAAa,CAAC,YAAY,EAAE,CAAC;YAClD,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAC9B,IAAI,CAAC,QAAQ,CAAC,aAAa,CACL,CAAC;YACzB,OAAO;gBACL,MAAM,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC;gBACjD,aAAa,EAAE,CAAC,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO;aACnD,CAAC;QACJ,CAAC;aAAM,IAAI,KAAK,CAAC,QAAQ,KAAK,aAAa,CAAC,mBAAmB,EAAE,CAAC;YAChE,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAC9B,IAAI,CAAC,QAAQ,CAAC,aAAa,CACE,CAAC;YAChC,OAAO;gBACL,MAAM,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC;gBACjD,aAAa,EAAE,CAAC,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO;aACnD,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,qCAAqC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzE,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,KAAY,EACZ,MAA+C;QAE/C,MAAM,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACrE,MAAM,CAAC,YAAY,EAAE;YACrB,MAAM,CAAC,eAAe,EAAE;YACxB,MAAM,CAAC,YAAY,EAAE;YACrB,MAAM,CAAC,eAAe,EAAE;SACzB,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC;YACtC,OAAO,EAAE,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC;YACrC,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,WAAW,CAAC;YACtC,OAAO,EAAE,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC;SACtC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAC/B,SAAgB,EAChB,cAAuB;QAEvB,MAAM,oBAAoB,GACxB,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,mBAAmB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACvE,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAClD,SAAS,EACT,cAAc,CACf,CAAC;QAEF,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,CAAC;QACrD,MAAM,eAAe,GAAG,kBAAkB,CAAC,OAAO,CAChD,aAAa,EACb,oBAAoB,CACrB,CAAC,CAAC,mBAAmB;QAEtB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACvD,eAAe,CAAC,iBAAiB,CAAC,cAAc,CAAC;YACjD,eAAe,CAAC,iBAAiB,CAAC,cAAc,CAAC;YACjD,eAAe,CAAC,qBAAqB,CAAC,cAAc,CAAC;YACrD,eAAe,CAAC,qBAAqB,CAAC,cAAc,CAAC;SACtD,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE;gBACN,IAAI,EAAE,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC9C,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACpD,IAAI,EAAE,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC9C,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;aACrD;YACD,aAAa;SACd,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC7B,SAAgB,EAChB,cAAuB;QAEvB,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC;QACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QAE5E,OAAO,IAAI,QAAQ,CACjB,cAAc,EACd,IAAI,CAAC,wBAAwB,EAC7B,QAAQ,CACT,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAClC,SAAgB,EAChB,cAAuB;QAEvB,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAClD,SAAS,EACT,cAAc,CACf,CAAC;QAEF,MAAM,iBAAiB,GAAG,MAAM,eAAe,CAAC,KAAK,EAAE,CAAC;QACxD,MAAM,iBAAiB,GAAG,IAAI,eAAe,CAC3C,SAAS,CAAC,SAAS,EACnB,IAAI,CAAC,QAAQ,CAAC,aAAa,EAC3B;YACE,KAAK,EAAE,iBAAiB;SACzB,CACF,CAAC;QAEF,IAAI,OAAO,CAAC;QACZ,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QAC/D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,KAAK,CACf;gBACE,cAAc;gBACd,KAAK,EAAE,SAAS,CAAC,SAAS;gBAC1B,iBAAiB;gBACjB,KAAK,EAAE,KAAc;aACtB,EACD,+CAA+C,CAChD,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAE3E,MAAM,aAAa,GAAG,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAEvD,OAAO;YACL,OAAO,EAAE,aAAa;YACtB,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,aAAa,GAAG,UAAU,CAAC,CAAC,CAAC,SAAS;YAC7D,YAAY,EAAE,iBAAiB;SAChC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,+BAA+B,CAC3C,SAAgB,EAChB,cAAuB;QAEvB,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAClD,SAAS,EACT,cAAc,CACf,CAAC;QAEF,MAAM,sBAAsB,GAAG,MAAM,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7D,MAAM,sBAAsB,GAAG,IAAI,eAAe,CAChD,SAAS,CAAC,SAAS,EACnB,IAAI,CAAC,QAAQ,CAAC,aAAa,EAC3B;YACE,KAAK,EAAE,sBAAsB;SAC9B,CACF,CAAC;QAEF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,sBAAsB,CAAC,WAAW,EAAE,CAAC;QAE5D,OAAO;YACL,SAAS,EAAE,IAAI;YACf,YAAY,EAAE,sBAAsB;SACrC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,iCAAiC,CAAC,MAAe;QACtD,gFAAgF;QAChF,8FAA8F;QAC9F,mGAAmG;QACnG,mKAAmK;QACnK,8HAA8H;QAE9H,+CAA+C;QAC/C,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAEnE,yDAAyD;QACzD,IAAI,aAAa,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAC1B,CAAC;QAED,iCAAiC;QACjC,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CACpC,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,gBAAgB,EAAE;YACxB,KAAK,CAAC,QAAQ,KAAK,aAAa,CAAC,mBAAmB,CACvD,CAAC;QAEF,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,gFAAgF;YAChF,OAAO,CAAC,GAAG,aAAa,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACtC,CAAC;QAED,6DAA6D;QAC7D,gEAAgE;QAChE,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACxE,MAAM,uBAAuB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAEhE,OAAO,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;CACF"}

package/dist/metrics/PriceGetter.d.ts

@@ -0,0 +1,10 @@
+import { Logger } from 'pino';
+import { ChainMap, ChainMetadata, CoinGeckoTokenPriceGetter, Token } from '@hyperlane-xyz/sdk';
+export declare class PriceGetter extends CoinGeckoTokenPriceGetter {
+    private readonly logger;
+    private constructor();
+    static create(chainMetadata: ChainMap<ChainMetadata>, logger: Logger, coingeckoApiKey?: string, expirySeconds?: number, sleepMsBetweenRequests?: number): PriceGetter;
+    tryGetTokenPrice(token: Token): Promise<number | undefined>;
+    getCoingeckoPrice(coingeckoId: string): Promise<number | undefined>;
+}
+//# sourceMappingURL=PriceGetter.d.ts.map

package/dist/metrics/PriceGetter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PriceGetter.d.ts","sourceRoot":"","sources":["../../src/metrics/PriceGetter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EACL,QAAQ,EACR,aAAa,EACb,yBAAyB,EACzB,KAAK,EACN,MAAM,oBAAoB,CAAC;AAE5B,qBAAa,WAAY,SAAQ,yBAAyB;IACxD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC,OAAO;WAiBO,MAAM,CAClB,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,EACtC,MAAM,EAAE,MAAM,EACd,eAAe,CAAC,EAAE,MAAM,EACxB,aAAa,CAAC,EAAE,MAAM,EACtB,sBAAsB,CAAC,EAAE,MAAM;IAa3B,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAqB3D,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAK1E"}

package/dist/metrics/PriceGetter.js

@@ -0,0 +1,41 @@
+import { CoinGeckoTokenPriceGetter, } from '@hyperlane-xyz/sdk';
+export class PriceGetter extends CoinGeckoTokenPriceGetter {
+    logger;
+    constructor({ chainMetadata, logger, apiKey, expirySeconds, sleepMsBetweenRequests, }) {
+        super({ chainMetadata, apiKey, expirySeconds, sleepMsBetweenRequests });
+        this.logger = logger;
+    }
+    static create(chainMetadata, logger, coingeckoApiKey, expirySeconds, sleepMsBetweenRequests) {
+        return new PriceGetter({
+            chainMetadata,
+            logger,
+            apiKey: coingeckoApiKey,
+            expirySeconds,
+            sleepMsBetweenRequests,
+        });
+    }
+    // Tries to get the price of a token from CoinGecko. Returns undefined if there's no
+    // CoinGecko ID for the token.
+    async tryGetTokenPrice(token) {
+        // We only get a price if the token defines a CoinGecko ID.
+        // This way we can ignore values of certain types of collateralized warp routes,
+        // e.g. Native warp routes on rollups that have been pre-funded.
+        const coinGeckoId = token.coinGeckoId;
+        if (!coinGeckoId) {
+            this.logger.warn({
+                tokenSymbol: token.symbol,
+                chain: token.chainName,
+                tokenAddress: token.addressOrDenom,
+            }, 'CoinGecko ID missing for token');
+            return undefined;
+        }
+        return this.getCoingeckoPrice(coinGeckoId);
+    }
+    async getCoingeckoPrice(coingeckoId) {
+        const prices = await this.getTokenPriceByIds([coingeckoId]);
+        if (!prices)
+            return undefined;
+        return prices[0];
+    }
+}
+//# sourceMappingURL=PriceGetter.js.map

package/dist/metrics/PriceGetter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PriceGetter.js","sourceRoot":"","sources":["../../src/metrics/PriceGetter.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,yBAAyB,GAE1B,MAAM,oBAAoB,CAAC;AAE5B,MAAM,OAAO,WAAY,SAAQ,yBAAyB;IACvC,MAAM,CAAS;IAEhC,YAAoB,EAClB,aAAa,EACb,MAAM,EACN,MAAM,EACN,aAAa,EACb,sBAAsB,GAOvB;QACC,KAAK,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,sBAAsB,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,MAAM,CAClB,aAAsC,EACtC,MAAc,EACd,eAAwB,EACxB,aAAsB,EACtB,sBAA+B;QAE/B,OAAO,IAAI,WAAW,CAAC;YACrB,aAAa;YACb,MAAM;YACN,MAAM,EAAE,eAAe;YACvB,aAAa;YACb,sBAAsB;SACvB,CAAC,CAAC;IACL,CAAC;IAED,oFAAoF;IACpF,8BAA8B;IAC9B,KAAK,CAAC,gBAAgB,CAAC,KAAY;QACjC,2DAA2D;QAC3D,gFAAgF;QAChF,gEAAgE;QAChE,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAEtC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CACd;gBACE,WAAW,EAAE,KAAK,CAAC,MAAM;gBACzB,KAAK,EAAE,KAAK,CAAC,SAAS;gBACtB,YAAY,EAAE,KAAK,CAAC,cAAc;aACnC,EACD,gCAAgC,CACjC,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,WAAmB;QACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM;YAAE,OAAO,SAAS,CAAC;QAC9B,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;CACF"}

package/dist/metrics/scripts/metrics.d.ts

@@ -0,0 +1,14 @@
+import { Logger } from 'pino';
+import { Counter, Registry } from 'prom-client';
+import { ChainName, Token, WarpCore } from '@hyperlane-xyz/sdk';
+import { Address } from '@hyperlane-xyz/utils';
+import { NativeWalletBalance, WarpRouteBalance, XERC20Limit } from '../types.js';
+export declare const metricsRegister: Registry;
+export declare const rebalancerExecutionTotal: Counter<"warp_route_id" | "succeeded">;
+export declare const rebalancerExecutionAmount: Counter<"token" | "warp_route_id" | "origin" | "destination">;
+export declare const rebalancerPollingErrorsTotal: Counter<"warp_route_id">;
+export declare function updateTokenBalanceMetrics(warpCore: WarpCore, token: Token, balanceInfo: WarpRouteBalance, warpRouteId: string, logger: Logger): void;
+export declare function updateManagedLockboxBalanceMetrics(warpCore: WarpCore, chainName: ChainName, tokenName: string, tokenAddress: string, lockBoxAddress: string, balanceInfo: WarpRouteBalance, warpRouteId: string, logger: Logger): void;
+export declare function updateNativeWalletBalanceMetrics(balance: NativeWalletBalance, logger: Logger): void;
+export declare function updateXERC20LimitsMetrics(token: Token, limits: XERC20Limit, bridgeAddress: Address, bridgeLabel: string, xERC20Address: Address, logger: Logger): void;
+//# sourceMappingURL=metrics.d.ts.map

package/dist/metrics/scripts/metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../../../src/metrics/scripts/metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAS,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvD,OAAO,EAAE,SAAS,EAAE,KAAK,EAAiB,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC/E,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAE/C,OAAO,EACL,mBAAmB,EACnB,gBAAgB,EAChB,WAAW,EACZ,MAAM,aAAa,CAAC;AAErB,eAAO,MAAM,eAAe,UAAiB,CAAC;AA+D9C,eAAO,MAAM,wBAAwB,wCAKnC,CAAC;AAEH,eAAO,MAAM,yBAAyB,+DAKpC,CAAC;AAEH,eAAO,MAAM,4BAA4B,0BAKvC,CAAC;AA+BH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,KAAK,EACZ,WAAW,EAAE,gBAAgB,EAC7B,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,QAkEf;AAGD,wBAAgB,kCAAkC,CAChD,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,gBAAgB,EAC7B,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,QAmCf;AAED,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,mBAAmB,EAC5B,MAAM,EAAE,MAAM,QAiBf;AAED,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,WAAW,EACnB,aAAa,EAAE,OAAO,EACtB,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,OAAO,EACtB,MAAM,EAAE,MAAM,QA0Bf"}