Skip to content

chore: Use Address.toNative() in HubPoolClient #1156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

chore: Use Address.toNative() in HubPoolClient #1156

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc66396
chore: Use Address.toNative() in HubPoolClient
pxrl Jul 25, 2025
6195178
lint
pxrl Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 32 additions & 28 deletions src/clients/HubPoolClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,14 +193,14 @@ export class HubPoolClient extends BaseAbstractClient {
destinationChainId: number,
latestHubBlock = Number.MAX_SAFE_INTEGER
): Address {
if (!this.l1TokensToDestinationTokensWithBlock?.[l1Token.toEvmAddress()]?.[destinationChainId]) {
if (!this.l1TokensToDestinationTokensWithBlock?.[l1Token.toNative()]?.[destinationChainId]) {
const chain = getNetworkName(destinationChainId);
const { symbol } = this.l1Tokens.find(({ address }) => address.eq(l1Token)) ?? { symbol: l1Token.toString() };
throw new Error(`Could not find SpokePool mapping for ${symbol} on ${chain} and L1 token ${l1Token}`);
}
// Find the last mapping published before the target block.
const l2Token: DestinationTokenWithBlock | undefined = sortEventsDescending(
this.l1TokensToDestinationTokensWithBlock[l1Token.toEvmAddress()][destinationChainId]
this.l1TokensToDestinationTokensWithBlock[l1Token.toNative()][destinationChainId]
).find((mapping: DestinationTokenWithBlock) => mapping.blockNumber <= latestHubBlock);
if (!l2Token) {
const chain = getNetworkName(destinationChainId);
Expand Down Expand Up @@ -250,13 +250,13 @@ export class HubPoolClient extends BaseAbstractClient {
}

l2TokenEnabledForL1Token(l1Token: EvmAddress, destinationChainId: number): boolean {
return this.l1TokensToDestinationTokens?.[l1Token.toEvmAddress()]?.[destinationChainId] != undefined;
return this.l1TokensToDestinationTokens?.[l1Token.toNative()]?.[destinationChainId] != undefined;
}

l2TokenEnabledForL1TokenAtBlock(l1Token: EvmAddress, destinationChainId: number, hubBlockNumber: number): boolean {
// Find the last mapping published before the target block.
const l2Token: DestinationTokenWithBlock | undefined = sortEventsDescending(
this.l1TokensToDestinationTokensWithBlock?.[l1Token.toEvmAddress()]?.[destinationChainId] ?? []
this.l1TokensToDestinationTokensWithBlock?.[l1Token.toNative()]?.[destinationChainId] ?? []
).find((mapping: DestinationTokenWithBlock) => mapping.blockNumber <= hubBlockNumber);
return l2Token !== undefined;
}
Expand Down Expand Up @@ -340,18 +340,13 @@ export class HubPoolClient extends BaseAbstractClient {
timeToCache: number
): Promise<BigNumber> {
// Resolve this function call as an async anonymous function
const resolver = async () => {
const resolver = () => {
const overrides = { blockTag: blockNumber };
if (depositAmount.eq(0)) {
// For zero amount, just get the utilisation at `blockNumber`.
return await this.hubPool.callStatic.liquidityUtilizationCurrent(hubPoolToken.toEvmAddress(), overrides);
}

return await this.hubPool.callStatic.liquidityUtilizationPostRelay(
hubPoolToken.toEvmAddress(),
depositAmount,
overrides
);
// For zero amount, just get the utilisation at `blockNumber`.
return depositAmount.eq(bnZero)
? this.hubPool.callStatic.liquidityUtilizationCurrent(hubPoolToken.toNative(), overrides)
: this.hubPool.callStatic.liquidityUtilizationPostRelay(hubPoolToken.toNative(), depositAmount, overrides);
};

// Resolve the cache locally so that we can appease typescript
Expand All @@ -363,11 +358,9 @@ export class HubPoolClient extends BaseAbstractClient {
}

// Otherwise, let's resolve the key
// @note Avoid collisions with pre-existing cache keys by appending an underscore (_) for post-relay utilization.
// @fixme This can be removed once the existing keys have been ejected from the cache (i.e. 7 days).
const key = depositAmount.eq(0)
? `utilization_${hubPoolToken.toEvmAddress()}_${blockNumber}`
: `utilization_${hubPoolToken.toEvmAddress()}_${blockNumber}_${depositAmount.toString()}_`;
const key = depositAmount.eq(bnZero)
? `utilization_${hubPoolToken.toNative()}_${blockNumber}`
: `utilization_${hubPoolToken.toNative()}_${blockNumber}_${depositAmount.toString()}`;
const result = await cache.get<string>(key);
if (isDefined(result)) {
return BigNumber.from(result);
Expand Down Expand Up @@ -409,9 +402,19 @@ export class HubPoolClient extends BaseAbstractClient {
const tokenKey = `${deposit.originChainId}-${deposit.inputToken}`;
if (this.l2TokenHasPoolRebalanceRoute(deposit.inputToken, deposit.originChainId, quoteBlockNumber)) {
return (hubPoolTokens[tokenKey] ??= this.getL1TokenForDeposit({ ...deposit, quoteBlockNumber }));
} else return undefined;
}

return undefined;
};
const getHubPoolTokens = (): EvmAddress[] => dedupArray(Object.values(hubPoolTokens).filter(isDefined));

// Filter hubPoolTokens for duplicates by reverting to their native string
// representation. This is required for deduplication to work reliably.
const getHubPoolTokens = (): EvmAddress[] =>
dedupArray(
Object.values(hubPoolTokens)
.filter(isDefined)
.map((token) => token.toNative())
).map((token) => EvmAddress.from(token));

// Helper to resolve the unqiue hubPoolToken & quoteTimestamp mappings.
const resolveUniqueQuoteTimestamps = (deposit: LpFeeRequest): void => {
Expand All @@ -425,17 +428,17 @@ export class HubPoolClient extends BaseAbstractClient {
}

// Append the quoteTimestamp for this HubPool token, if it isn't already enqueued.
utilizationTimestamps[hubPoolToken.toEvmAddress()] ??= [];
if (!utilizationTimestamps[hubPoolToken.toEvmAddress()].includes(quoteTimestamp)) {
utilizationTimestamps[hubPoolToken.toEvmAddress()].push(quoteTimestamp);
utilizationTimestamps[hubPoolToken.toNative()] ??= [];
if (!utilizationTimestamps[hubPoolToken.toNative()].includes(quoteTimestamp)) {
utilizationTimestamps[hubPoolToken.toNative()].push(quoteTimestamp);
}
};

// Helper to resolve existing HubPool token utilisation for an array of unique block numbers.
// Produces a mapping of blockNumber -> utilization for a specific token.
const resolveUtilization = async (hubPoolToken: EvmAddress): Promise<Record<number, BigNumber>> => {
return Object.fromEntries(
await mapAsync(utilizationTimestamps[hubPoolToken.toEvmAddress()], async (quoteTimestamp) => {
await mapAsync(utilizationTimestamps[hubPoolToken.toNative()], async (quoteTimestamp) => {
const blockNumber = quoteBlocks[quoteTimestamp];
const utilization = await this.getUtilization(
hubPoolToken,
Expand Down Expand Up @@ -471,7 +474,7 @@ export class HubPoolClient extends BaseAbstractClient {
quoteBlock
);

const preUtilization = utilization[hubPoolToken.toEvmAddress()][quoteBlock];
const preUtilization = utilization[hubPoolToken.toNative()][quoteBlock];
const postUtilization = await this.getUtilization(
hubPoolToken,
quoteBlock,
Expand Down Expand Up @@ -500,7 +503,7 @@ export class HubPoolClient extends BaseAbstractClient {
// This can be reused for each deposit with the same HubPool token and quoteTimestamp pair.
utilization = Object.fromEntries(
await mapAsync(getHubPoolTokens(), async (hubPoolToken) => [
hubPoolToken.toEvmAddress(),
hubPoolToken.toNative(),
await resolveUtilization(hubPoolToken),
])
);
Expand Down Expand Up @@ -529,7 +532,7 @@ export class HubPoolClient extends BaseAbstractClient {
}

getLpTokenInfoForL1Token(l1Token: EvmAddress): LpToken | undefined {
return this.lpTokens[l1Token.toEvmAddress()];
return this.lpTokens[l1Token.toNative()];
}

areTokensEquivalent(
Expand Down Expand Up @@ -925,6 +928,7 @@ export class HubPoolClient extends BaseAbstractClient {
if (!this.configStoreClient.isUpdated) {
throw new Error("ConfigStoreClient not updated");
}

const update = await this._update(eventsToQuery);
if (!update.success) {
if (update.reason !== UpdateFailureReason.AlreadyUpdated) {
Expand Down