feat: escape hatch that allows overriding addresses in address provider

Author: doomsower

src/sdk/core/address-provider/AbstractAddressProviderContract.ts

@@ -6,20 +6,34 @@ import type { VersionRange } from "../../constants/index.js";
 import { NO_VERSION } from "../../constants/index.js";
 import type { AddressProviderV3StateHuman } from "../../types/index.js";
 import { TypedObjectUtils } from "../../utils/mappers.js";
-import type { AddressProviderState } from "./types.js";
+import type {
+  AddressProviderAddresses,
+  AddressProviderState,
+} from "./types.js";
 
 export default abstract class AbstractAddressProviderContract<
   abi extends Abi | readonly unknown[],
 > extends BaseContract<abi> {
-  #addresses: Record<string, Record<number, Address>> = {};
+  readonly #addresses: Record<string, Record<number, Address>>;
+  readonly #overrides: Record<string, Record<number, Address>>;
 
   constructor(
     options: ConstructOptions,
     args: BaseContractArgs<abi>,
-    addresses: Record<string, Record<number, Address>> = {},
+    addresses?: AddressProviderAddresses,
   ) {
     super(options, args);
-    this.#addresses = addresses;
+    this.#addresses = addresses?.addresses ?? {};
+    this.#overrides = addresses?.overrides ?? {};
+
+    for (const [contract, vs] of TypedObjectUtils.entries(this.#overrides)) {
+      for (const [version, address] of TypedObjectUtils.entries(vs)) {
+        this.#addresses[contract] = {
+          ...this.#addresses[contract],
+          [version]: address,
+        };
+      }
+    }
   }
 
   protected setInternalAddress(key: string, address: Address, version: number) {
@@ -29,6 +43,14 @@ export default abstract class AbstractAddressProviderContract<
     }
     this.#addresses[k][version] = address;
     this.logger?.debug(`Set address for ${k}@${version} to ${address}`);
+
+    const overriden = this.#overrides[k]?.[version];
+    if (overriden) {
+      this.logger?.warn(
+        `address for ${k}@${version} was overriden, hardcode ${overriden} instead of ${address}`,
+      );
+      this.#addresses[k][version] = overriden;
+    }
   }
 
   public getAddress(contract: string, version = NO_VERSION): Address {

src/sdk/core/address-provider/AddressProviderV300Contract.ts

@@ -11,7 +11,10 @@ import type { ConstructOptions } from "../../base/Construct.js";
 import type { GearboxChain } from "../../chain/index.js";
 import { getLogsSafe } from "../../utils/viem/index.js";
 import AbstractAddressProviderContract from "./AbstractAddressProviderContract.js";
-import type { IAddressProviderContract } from "./types.js";
+import type {
+  AddressProviderAddresses,
+  IAddressProviderContract,
+} from "./types.js";
 
 const abi = iAddressProviderV300Abi;
 type abi = typeof abi;
@@ -24,7 +27,7 @@ export class AddressProviderV300Contract
     options: ConstructOptions,
     address: Address,
     version: number,
-    addresses: Record<string, Record<number, Address>> = {},
+    addresses?: AddressProviderAddresses,
   ) {
     super(
       options,

src/sdk/core/address-provider/AddressProviderV310Contract.ts

@@ -9,7 +9,10 @@ import { bytesToString, parseEventLogs, toBytes } from "viem";
 import { iAddressProviderV310Abi } from "../../../abi/310/generated.js";
 import type { ConstructOptions } from "../../base/Construct.js";
 import AbstractAddressProviderContract from "./AbstractAddressProviderContract.js";
-import type { IAddressProviderContract } from "./types.js";
+import type {
+  AddressProviderAddresses,
+  IAddressProviderContract,
+} from "./types.js";
 
 const abi = iAddressProviderV310Abi;
 type abi = typeof abi;
@@ -22,7 +25,7 @@ export class AddressProviderV310Contract
     options: ConstructOptions,
     address: Address,
     version: number = 310,
-    addresses: Record<string, Record<number, Address>> = {},
+    addresses?: AddressProviderAddresses,
   ) {
     super(
       options,

src/sdk/core/address-provider/createAddressProvider.ts

@@ -1,8 +1,11 @@
 import type { Address } from "viem";
 
 import { iVersionAbi } from "../../../abi/iVersion.js";
+import type { NetworkType } from "../../chain/chains.js";
 import {
   ADDRESS_PROVIDER_V310,
+  AP_MARKET_COMPRESSOR,
+  AP_PRICE_FEED_COMPRESSOR,
   isV300,
   isV310,
 } from "../../constants/index.js";
@@ -11,10 +14,26 @@ import { hexEq } from "../../utils/hex.js";
 import { AddressProviderV300Contract } from "./AddressProviderV300Contract.js";
 import { AddressProviderV310Contract } from "./AddressProviderV310Contract.js";
 import type {
+  AddressProviderAddresses,
   AddressProviderState,
   IAddressProviderContract,
 } from "./types.js";
 
+const OVERRIDE_ADDRESSES: Partial<
+  Record<NetworkType, AddressProviderAddresses["overrides"]>
+> = {
+  // Override price feed compressor and market feed compressor
+  // we urgently deployed fix and it has not been added to the address provider yet
+  Mainnet: {
+    [AP_PRICE_FEED_COMPRESSOR]: {
+      311: "0x1fA2637B9fab0CD14290A7EE908DDc9688a15120",
+    },
+    [AP_MARKET_COMPRESSOR]: {
+      311: "0x0C27F242f6e9F2A9AD3261bE6e439De3B948bcA2",
+    },
+  },
+};
+
 export async function createAddressProvider(
   sdk: GearboxSDK,
   address: Address,
@@ -46,11 +65,15 @@ function newAddressProvider(
   version: number,
   addresses?: Record<string, Record<number, Address>>,
 ): IAddressProviderContract {
+  const addrOptions: AddressProviderAddresses = {
+    addresses,
+    overrides: OVERRIDE_ADDRESSES[sdk.networkType],
+  };
   if (isV300(version)) {
-    return new AddressProviderV300Contract(sdk, address, version, addresses);
+    return new AddressProviderV300Contract(sdk, address, version, addrOptions);
   }
   if (isV310(version)) {
-    return new AddressProviderV310Contract(sdk, address, version, addresses);
+    return new AddressProviderV310Contract(sdk, address, version, addrOptions);
   }
   throw new Error(`unsupported address provider version: ${version}`);
 }

src/sdk/core/address-provider/types.ts

@@ -4,6 +4,22 @@ import type { BaseParams, IBaseContract } from "../../base/index.js";
 import type { VersionRange } from "../../constants/versions.js";
 import type { AddressProviderV3StateHuman } from "../../types/index.js";
 
+export interface AddressProviderAddresses {
+  /**
+   * Initialize address provider with these addresses
+   * Used in hydration
+   */
+  addresses?: Record<string, Record<number, Address>>;
+  /**
+   * Override addresses for this address provider
+   * These addresses will precede over addresses loaded from chain
+   *
+   * This is an escape hatch.
+   * We used it when we need to fix price feed compressor/market compressor urgently
+   */
+  overrides?: Record<string, Record<number, Address>>;
+}
+
 export interface AddressProviderState {
   baseParams: BaseParams;
   addresses: Record<string, Record<number, Address>>;