@across-protocol/sdk 3.0.0

package/dist/types/contracts/acrossConfigStore.d.ts

@@ -0,0 +1,58 @@
+import { Provider } from "@ethersproject/providers";
+import { AcrossConfigStore } from "../typechain";
+import { Infer } from "superstruct";
+import type { CallOverrides } from "@ethersproject/contracts";
+declare const RateModelSs: import("superstruct").Struct<{
+    UBar: string;
+    R0: string;
+    R1: string;
+    R2: string;
+}, {
+    UBar: import("superstruct").Struct<string, null>;
+    R0: import("superstruct").Struct<string, null>;
+    R1: import("superstruct").Struct<string, null>;
+    R2: import("superstruct").Struct<string, null>;
+}>;
+declare const L1TokenConfigSs: import("superstruct").Struct<{
+    rateModel: {
+        UBar: string;
+        R0: string;
+        R1: string;
+        R2: string;
+    };
+    routeRateModel?: Record<string, {
+        UBar: string;
+        R0: string;
+        R1: string;
+        R2: string;
+    }> | undefined;
+}, {
+    rateModel: import("superstruct").Struct<{
+        UBar: string;
+        R0: string;
+        R1: string;
+        R2: string;
+    }, {
+        UBar: import("superstruct").Struct<string, null>;
+        R0: import("superstruct").Struct<string, null>;
+        R1: import("superstruct").Struct<string, null>;
+        R2: import("superstruct").Struct<string, null>;
+    }>;
+    routeRateModel: import("superstruct").Struct<Record<string, {
+        UBar: string;
+        R0: string;
+        R1: string;
+        R2: string;
+    }> | undefined, null>;
+}>;
+export type RateModel = Infer<typeof RateModelSs>;
+export type L1TokenConfig = Infer<typeof L1TokenConfigSs>;
+export declare class Client {
+    readonly contract: AcrossConfigStore;
+    constructor(address: string, provider: Provider);
+    static parseL1TokenConfig(data: string): L1TokenConfig;
+    getL1TokenConfig(l1TokenAddress: string, overrides?: CallOverrides): Promise<L1TokenConfig>;
+    getRateModel(l1TokenAddress: string, overrides?: CallOverrides, originChainId?: number, destinationChainId?: number): Promise<RateModel>;
+}
+export {};
+//# sourceMappingURL=acrossConfigStore.d.ts.map

package/dist/types/contracts/acrossConfigStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acrossConfigStore.d.ts","sourceRoot":"","sources":["../../../src/contracts/acrossConfigStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAA8B,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAkB,KAAK,EAAkC,MAAM,aAAa,CAAC;AACpF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAG9D,QAAA,MAAM,WAAW;;;;;;;;;;EAKf,CAAC;AACH,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGnB,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAClD,MAAM,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE1D,qBAAa,MAAM;IACjB,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;gBAChC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;IAG/C,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;IAMhD,gBAAgB,CAAC,cAAc,EAAE,MAAM,EAAE,SAAS,GAAE,aAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAI/F,YAAY,CAChB,cAAc,EAAE,MAAM,EACtB,SAAS,GAAE,aAAkB,EAC7B,aAAa,CAAC,EAAE,MAAM,EACtB,kBAAkB,CAAC,EAAE,MAAM,GAC1B,OAAO,CAAC,SAAS,CAAC;CAStB"}

package/dist/types/contracts/hubPool.d.ts

@@ -0,0 +1,18 @@
+import { HubPool, HubPool__factory, HubPoolInterface } from "../typechain";
+import { providers, Signer } from "ethers";
+import { Balances, SerializableEvent } from "./utils";
+export type Instance = HubPool;
+export declare const Factory: typeof HubPool__factory;
+export type Interface = HubPoolInterface;
+export declare function connect(address: string, provider: providers.Provider | Signer): Instance;
+export type TokenEventState = {
+    tokenBalances: Balances;
+    lpTokenBalances: Balances;
+    l1Token?: string;
+    lpToken?: string;
+    enabled?: boolean;
+};
+export type EventState = Record<string, TokenEventState>;
+export declare function eventStateDefaults(): EventState;
+export declare function getEventState(events: SerializableEvent[], eventState?: EventState): EventState;
+//# sourceMappingURL=hubPool.d.ts.map

package/dist/types/contracts/hubPool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hubPool.d.ts","sourceRoot":"","sources":["../../../src/contracts/hubPool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAE3E,OAAO,EAAE,SAAS,EAAwB,MAAM,EAAE,MAAM,QAAQ,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEtD,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC;AAC/B,eAAO,MAAM,OAAO,yBAAmB,CAAC;AACxC,MAAM,MAAM,SAAS,GAAG,gBAAgB,CAAC;AAEzC,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAExF;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,EAAE,QAAQ,CAAC;IACxB,eAAe,EAAE,QAAQ,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAEzD,wBAAgB,kBAAkB,IAAI,UAAU,CAE/C;AA+DD,wBAAgB,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,EAAE,UAAU,GAAE,UAAiC,GAAG,UAAU,CAEpH"}

package/dist/types/contracts/index.d.ts

@@ -0,0 +1,3 @@
+export * as acrossConfigStore from "./acrossConfigStore";
+export * as hubPool from "./hubPool";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/contracts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/contracts/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,iBAAiB,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC"}

package/dist/types/contracts/utils.d.ts

@@ -0,0 +1,24 @@
+import { BigNumberish, Event } from "ethers";
+/**
+ * @dev Originally imported from @uma/sdk.
+ * @dev This code is intended to support existing use of contracts/hubPool.ts and should not be used for new code.
+ * @todo Refactor contracts/hubPool.ts to avoid the need for this.
+ */
+export type SerializableEvent = Omit<Event, "decode" | "removeListener" | "getBlock" | "getTransaction" | "getTransactionReceipt">;
+export type Balances = {
+    [key: string]: string;
+};
+/**
+ * Utility for maintaining records of a token balance.
+ */
+export declare function Balances(balances?: Balances): {
+    create: (id: string, amount?: string) => string;
+    add: (id: string, amount: BigNumberish) => string;
+    sub: (id: string, amount: BigNumberish) => string;
+    get: (id: string) => string;
+    balances: Balances;
+    set: (id: string, amount: string) => string;
+    has: (id: string) => boolean;
+    getOrCreate: (id: string) => string;
+};
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/contracts/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/contracts/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,YAAY,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAGxD;;;;GAIG;AAEH,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAClC,KAAK,EACL,QAAQ,GAAG,gBAAgB,GAAG,UAAU,GAAG,gBAAgB,GAAG,uBAAuB,CACtF,CAAC;AAGF,MAAM,MAAM,QAAQ,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAC;AAEjD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,GAAE,QAAa;iBAC1B,MAAM;cAcT,MAAM,UAAU,YAAY;cAI5B,MAAM,UAAU,YAAY;cAI5B,MAAM;;cAbN,MAAM,UAAU,MAAM;cAJtB,MAAM;sBAsBE,MAAM;EAMhC"}

package/dist/types/gasPriceOracle/adapters/arbitrum.d.ts

@@ -0,0 +1,4 @@
+import { providers } from "ethers";
+import { GasPriceEstimate } from "../types";
+export declare function eip1559_arbitrum(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;
+//# sourceMappingURL=arbitrum.d.ts.map

package/dist/types/gasPriceOracle/adapters/arbitrum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arbitrum.d.ts","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/arbitrum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,SAAS,EAAwB,MAAM,QAAQ,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAM5C,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAa/G"}

package/dist/types/gasPriceOracle/adapters/ethereum.d.ts

@@ -0,0 +1,5 @@
+import { providers } from "ethers";
+import { GasPriceEstimate } from "../types";
+export declare function eip1559(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;
+export declare function legacy(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;
+//# sourceMappingURL=ethereum.d.ts.map

package/dist/types/gasPriceOracle/adapters/ethereum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ethereum.d.ts","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/ethereum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,SAAS,EAAU,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAG5C,wBAAsB,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAWtG;AAED,wBAAsB,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CASrG"}

package/dist/types/gasPriceOracle/adapters/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ethereum";
+export * from "./arbitrum";
+export * from "./polygon";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/gasPriceOracle/adapters/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/dist/types/gasPriceOracle/adapters/polygon.d.ts

@@ -0,0 +1,4 @@
+import { providers } from "ethers";
+import { GasPriceEstimate } from "../types";
+export declare function polygonGasStation(provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;
+//# sourceMappingURL=polygon.d.ts.map

package/dist/types/gasPriceOracle/adapters/polygon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polygon.d.ts","sourceRoot":"","sources":["../../../../src/gasPriceOracle/adapters/polygon.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAwB,MAAM,QAAQ,CAAC;AAGzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAiE5C,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAQhH"}

package/dist/types/gasPriceOracle/index.d.ts

@@ -0,0 +1,3 @@
+export { getGasPriceEstimate } from "./oracle";
+export { GasPriceEstimate } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/gasPriceOracle/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/gasPriceOracle/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC"}

package/dist/types/gasPriceOracle/oracle.d.ts

@@ -0,0 +1,11 @@
+import { providers } from "ethers";
+import { GasPriceEstimate } from "./types";
+/**
+ * Provide an estimate for the current gas price for a particular chain.
+ * @param chainId The chain ID to query for gas prices.
+ * @param provider A valid ethers provider.
+ * @param legacyFallback In the case of an unrecognised chain, fall back to type 0 gas estimation.
+ * @returns Am object of type GasPriceEstimate.
+ */
+export declare function getGasPriceEstimate(provider: providers.Provider, chainId?: number, legacyFallback?: boolean): Promise<GasPriceEstimate>;
+//# sourceMappingURL=oracle.d.ts.map

package/dist/types/gasPriceOracle/oracle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oracle.d.ts","sourceRoot":"","sources":["../../../src/gasPriceOracle/oracle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC,OAAO,EAAE,gBAAgB,EAAgB,MAAM,SAAS,CAAC;AAEzD;;;;;;GAMG;AACH,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAC5B,OAAO,CAAC,EAAE,MAAM,EAChB,cAAc,UAAO,GACpB,OAAO,CAAC,gBAAgB,CAAC,CA0B3B"}

package/dist/types/gasPriceOracle/types.d.ts

@@ -0,0 +1,9 @@
+import { BigNumber, providers } from "ethers";
+export type GasPriceEstimate = {
+    maxFeePerGas: BigNumber;
+    maxPriorityFeePerGas: BigNumber;
+};
+export interface GasPriceFeed {
+    (provider: providers.Provider, chainId: number): Promise<GasPriceEstimate>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types/gasPriceOracle/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/gasPriceOracle/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAE9C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,EAAE,SAAS,CAAC;IACxB,oBAAoB,EAAE,SAAS,CAAC;CACjC,CAAC;AAEF,MAAM,WAAW,YAAY;IAC3B,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC5E"}

package/dist/types/gasPriceOracle/util.d.ts

@@ -0,0 +1,3 @@
+import { BigNumber, providers } from "ethers";
+export declare function gasPriceError(method: string, chainId: number, data: providers.FeeData | BigNumber): void;
+//# sourceMappingURL=util.d.ts.map

package/dist/types/gasPriceOracle/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/gasPriceOracle/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAE9C,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,OAAO,GAAG,SAAS,GAAG,IAAI,CAExG"}

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+export * as lpFeeCalculator from "./lpFeeCalculator";
+export * as pool from "./pool";
+export * as relayFeeCalculator from "./relayFeeCalculator";
+export * as utils from "./utils";
+export * as contracts from "./contracts";
+export * as coingecko from "./coingecko";
+export * as gasPriceOracle from "./gasPriceOracle";
+export * as priceClient from "./priceClient";
+export * as merkleDistributor from "./merkleDistributor";
+export * as constants from "./constants";
+export * as interfaces from "./interfaces";
+export * as typeguards from "./typeguards";
+export * as clients from "./clients";
+export * as typechain from "./typechain";
+export * as caching from "./caching";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,eAAe,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,kBAAkB,MAAM,sBAAsB,CAAC;AAC3D,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,WAAW,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,iBAAiB,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC"}

package/dist/types/interfaces/Bridge.d.ts

@@ -0,0 +1,10 @@
+import { BigNumber } from "ethers";
+export interface OutstandingTransfers {
+    [address: string]: {
+        [l1Token: string]: {
+            totalAmount: BigNumber;
+            depositTxHashes: string[];
+        };
+    };
+}
+//# sourceMappingURL=Bridge.d.ts.map

package/dist/types/interfaces/Bridge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bridge.d.ts","sourceRoot":"","sources":["../../../src/interfaces/Bridge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC,MAAM,WAAW,oBAAoB;IACnC,CAAC,OAAO,EAAE,MAAM,GAAG;QACjB,CAAC,OAAO,EAAE,MAAM,GAAG;YACjB,WAAW,EAAE,SAAS,CAAC;YACvB,eAAe,EAAE,MAAM,EAAE,CAAC;SAC3B,CAAC;KACH,CAAC;CACH"}

package/dist/types/interfaces/CachingMechanism.d.ts

@@ -0,0 +1,27 @@
+import { Struct } from "superstruct";
+/**
+ * The interface for a caching mechanism. This is used to store and retrieve values from a cache.
+ * @interface CachingInterface
+ * @exports
+ */
+export interface CachingMechanismInterface {
+    /**
+     * Attempts to retrieve a value from the cache.
+     * @param key The key to retrieve.
+     * @returns The value if it exists, otherwise null.
+     */
+    get<ObjectType, OverrideType = unknown>(key?: string, structValidator?: Struct<unknown, unknown>, overrides?: OverrideType): Promise<ObjectType | null>;
+    /**
+     * Attempts to set a key in the caching store. Returns the ID of the value stored. This is useful for storing values
+     * in a cache that are not known ahead of time. For example, if you want to store a value in a cache that is the result of a
+     * computation, you can use this method to store the value and retrieve the ID of the value stored.
+     * @param key The canonical key to store.
+     * @param value The value to store.
+     * @param ttl The time to live in seconds.
+     * @param overrides Any overrides to the default caching mechanism configuration for the given caching protocol.
+     * @note Caching mechanisms where the `key` is directly used to store values will return `key` on success.
+     * @returns The ID of the value stored. If the value could not be stored, undefined is returned. If the caching mechanism uses the `key` as the ID, the `key` is returned.
+     */
+    set<ObjectType, OverrideType>(key: string, value: ObjectType, ttl?: number, overrides?: OverrideType): Promise<string | undefined>;
+}
+//# sourceMappingURL=CachingMechanism.d.ts.map

package/dist/types/interfaces/CachingMechanism.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CachingMechanism.d.ts","sourceRoot":"","sources":["../../../src/interfaces/CachingMechanism.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,GAAG,CAAC,UAAU,EAAE,YAAY,GAAG,OAAO,EACpC,GAAG,CAAC,EAAE,MAAM,EACZ,eAAe,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,EAC1C,SAAS,CAAC,EAAE,YAAY,GACvB,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAE9B;;;;;;;;;;OAUG;IACH,GAAG,CAAC,UAAU,EAAE,YAAY,EAC1B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,UAAU,EACjB,GAAG,CAAC,EAAE,MAAM,EACZ,SAAS,CAAC,EAAE,YAAY,GACvB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAChC"}

package/dist/types/interfaces/Common.d.ts

@@ -0,0 +1,11 @@
+import { BigNumber } from "ethers";
+export interface SortableEvent {
+    blockNumber: number;
+    transactionIndex: number;
+    logIndex: number;
+    transactionHash: string;
+}
+export interface BigNumberForToken {
+    [l1TokenAddress: string]: BigNumber;
+}
+//# sourceMappingURL=Common.d.ts.map

package/dist/types/interfaces/Common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Common.d.ts","sourceRoot":"","sources":["../../../src/interfaces/Common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC"}

package/dist/types/interfaces/ConfigStore.d.ts

@@ -0,0 +1,158 @@
+import { BigNumber } from "ethers";
+import { RateModelDictionary } from "../lpFeeCalculator/rateModel";
+import { SortableEvent } from "./Common";
+export interface ParsedTokenConfig {
+    rateModel: RateModelDictionary;
+    routeRateModel?: {
+        [path: string]: RateModelDictionary;
+    };
+    uba?: UBAOnChainConfigType;
+    spokeTargetBalances?: {
+        [chainId: number]: {
+            target: string;
+            threshold: string;
+        };
+    };
+}
+export interface SpokePoolTargetBalance {
+    target: BigNumber;
+    threshold: BigNumber;
+}
+export type SpokePoolTargetBalanceStringified = Omit<SpokePoolTargetBalance, "threshold" | "target"> & {
+    target: string;
+    threshold: string;
+};
+export interface SpokeTargetBalanceUpdate extends SortableEvent {
+    spokeTargetBalances?: {
+        [chainId: number]: SpokePoolTargetBalance;
+    };
+    l1Token: string;
+}
+export interface SpokeTargetBalanceUpdateStringified extends SortableEvent {
+    spokeTargetBalances?: {
+        [chainId: number]: SpokePoolTargetBalanceStringified;
+    };
+    l1Token: string;
+}
+export interface RouteRateModelUpdate extends SortableEvent {
+    routeRateModel: {
+        [path: string]: string;
+    };
+    l1Token: string;
+}
+export interface TokenConfig extends SortableEvent {
+    key: string;
+    value: string;
+}
+export interface GlobalConfigUpdate<ValueStore = number> extends SortableEvent {
+    value: ValueStore;
+}
+export interface ConfigStoreVersionUpdate<ValueStore = number> extends GlobalConfigUpdate<ValueStore> {
+    timestamp: number;
+}
+export interface DisabledChainsUpdate extends SortableEvent {
+    chainIds: number[];
+}
+/**
+ * A generic type of a dictionary that has string keys and values of type T. This
+ * record is enforced to have a default entry within the "default" key.
+ * @type Value The type of the values in the dictionary.
+ */
+type RecordWithDefaultEntry<Value> = Record<string, Value>;
+/**
+ * A generic type for an array of tuples.
+ * @type Value The type of the values in the array.
+ */
+type ArrayOfTuples<Value> = [Value, Value][];
+/**
+ * A type for the UBA config object stored both on and off chain.
+ * @type T The type of the values in the config.
+ * @note This is a dictionary of parameters that defines a fee curve for the token.
+ *       These parameters can be further subindexed by a route (e.g. using the key "1-10" or "42161-1")
+ *       to create a specific fee curve for a token per route. The subkeys are as followed:
+ *         - alpha: The alpha parameter of the fee curve.
+ *         - gamma: The gamma parameter of the fee curve.
+ *         - omega: The omega parameter of the fee curve.
+ *         - rebalance: The rebalance parameters of the fee curve.
+ */
+type UBAAgnosticConfigType<T> = {
+    /**
+     * A DAO controlled variable to track any donations made to the incentivePool liquidity
+     */
+    incentivePoolAdjustment?: Record<string, T>;
+    /**
+     * Used to scale rewards when a fee is larger than the incentive balance
+     */
+    ubaRewardMultiplier?: Record<string, T>;
+    /**
+     * This is a scalar value that is a constant percentage of each transfer that is allocated for LPs.
+     * This value can be determined by token and route-by-route.
+     */
+    alpha: RecordWithDefaultEntry<T>;
+    /**
+     * This is a piecewise linear function (defined by a vector of cut-off points and the values at
+     * those points) that determine additional LP fees as a function of utilization. This piecewise
+     * linear function can be determined by token and chain-by-chain.
+     */
+    gamma: RecordWithDefaultEntry<ArrayOfTuples<T>>;
+    /**
+     * This is a piecewise linear function (defined by a vector of cut-off points and the values at
+     * those points) that determine the balancing fees (rewards) that are imposed on (paid to) a user
+     * who makes a transfer involving a particular chain. There is a single piecewise linear function for
+     * each token/chain combination. A transfer will incur a balancing fee on both the origin and destination
+     * chains.
+     */
+    omega: RecordWithDefaultEntry<ArrayOfTuples<T>>;
+    /**
+     * This is a set of parameters that determine when a rebalance is triggered. A rebalance is triggered
+     * when the utilization of a pool is outside of the range defined by the lower and upper thresholds.
+     */
+    rebalance: RecordWithDefaultEntry<{
+        /**
+         * For tokens/chains that have a supported bridge, these are the lower and upper threshold that trigger
+         * the reallocation of funds. i.e. If the running balance on a chain moves below (above) threshold_lower
+         * (threshold_upper) then the bridge moves funds from Ethereum to the chain (from the chain to Ethereum).
+         */
+        threshold_lower?: T;
+        /**
+         * For tokens/chains that have a supported bridge, these are the lower and upper threshold that trigger
+         * the reallocation of funds. i.e. If the running balance on a chain moves below (above) threshold_lower
+         * (threshold_upper) then the bridge moves funds from Ethereum to the chain (from the chain to Ethereum).
+         */
+        threshold_upper?: T;
+        /**
+         * For tokens/chains that have a supported bridge, these are the values that are targeted whenever funds
+         * are reallocated.
+         */
+        target_lower?: T;
+        /**
+         * For tokens/chains that have a supported bridge, these are the values that are targeted whenever funds
+         * are reallocated.
+         */
+        target_upper?: T;
+    }>;
+};
+/**
+ * A type for the UBA config object stored on chain.
+ */
+export type UBAOnChainConfigType = UBAAgnosticConfigType<string>;
+/**
+ * A type for the UBA config object after it has been parsed.
+ */
+export type UBAParsedConfigType = UBAAgnosticConfigType<BigNumber>;
+/**
+ * A type for UBAConfig Update events.
+ */
+export type UBAConfigUpdates = SortableEvent & {
+    config: UBAParsedConfigType;
+    l1Token: string;
+};
+/**
+ * A type for stringified UBAConfig Update events.
+ */
+export type UBASerializedConfigUpdates = SortableEvent & {
+    config: UBAOnChainConfigType;
+    l1Token: string;
+};
+export {};
+//# sourceMappingURL=ConfigStore.d.ts.map

package/dist/types/interfaces/ConfigStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigStore.d.ts","sourceRoot":"","sources":["../../../src/interfaces/ConfigStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,cAAc,CAAC,EAAE;QACf,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAAC;KACrC,CAAC;IACF,GAAG,CAAC,EAAE,oBAAoB,CAAC;IAC3B,mBAAmB,CAAC,EAAE;QACpB,CAAC,OAAO,EAAE,MAAM,GAAG;YACjB,MAAM,EAAE,MAAM,CAAC;YACf,SAAS,EAAE,MAAM,CAAC;SACnB,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,SAAS,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,MAAM,iCAAiC,GAAG,IAAI,CAAC,sBAAsB,EAAE,WAAW,GAAG,QAAQ,CAAC,GAAG;IACrG,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,wBAAyB,SAAQ,aAAa;IAC7D,mBAAmB,CAAC,EAAE;QACpB,CAAC,OAAO,EAAE,MAAM,GAAG,sBAAsB,CAAC;KAC3C,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mCAAoC,SAAQ,aAAa;IACxE,mBAAmB,CAAC,EAAE;QACpB,CAAC,OAAO,EAAE,MAAM,GAAG,iCAAiC,CAAC;KACtD,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,cAAc,EAAE;QACd,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB,CAAC,UAAU,GAAG,MAAM,CAAE,SAAQ,aAAa;IAC5E,KAAK,EAAE,UAAU,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB,CAAC,UAAU,GAAG,MAAM,CAAE,SAAQ,kBAAkB,CAAC,UAAU,CAAC;IACnG,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;GAIG;AACH,KAAK,sBAAsB,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE3D;;;GAGG;AACH,KAAK,aAAa,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;AAE7C;;;;;;;;;;GAUG;AACH,KAAK,qBAAqB,CAAC,CAAC,IAAI;IAC9B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5C;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACxC;;;OAGG;IACH,KAAK,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC;IACjC;;;;OAIG;IACH,KAAK,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD;;;;;;OAMG;IACH,KAAK,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD;;;OAGG;IACH,SAAS,EAAE,sBAAsB,CAAC;QAChC;;;;WAIG;QACH,eAAe,CAAC,EAAE,CAAC,CAAC;QACpB;;;;WAIG;QACH,eAAe,CAAC,EAAE,CAAC,CAAC;QACpB;;;WAGG;QACH,YAAY,CAAC,EAAE,CAAC,CAAC;QACjB;;;WAGG;QACH,YAAY,CAAC,EAAE,CAAC,CAAC;KAClB,CAAC,CAAC;CACJ,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,aAAa,GAAG;IACvD,MAAM,EAAE,oBAAoB,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/types/interfaces/Error.d.ts

@@ -0,0 +1,6 @@
+export type EthersError = Error & {
+    code: string;
+    reason: string;
+    error?: Error;
+};
+//# sourceMappingURL=Error.d.ts.map

package/dist/types/interfaces/Error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../../src/interfaces/Error.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC"}

package/dist/types/interfaces/HubPool.d.ts

@@ -0,0 +1,99 @@
+import { BigNumber } from "ethers";
+import { SortableEvent } from "./Common";
+export interface PoolRebalanceLeaf {
+    chainId: number;
+    groupIndex: number;
+    bundleLpFees: BigNumber[];
+    netSendAmounts: BigNumber[];
+    runningBalances: BigNumber[];
+    leafId: number;
+    l1Tokens: string[];
+}
+export interface RelayerRefundLeaf {
+    amountToReturn: BigNumber;
+    chainId: number;
+    refundAmounts: BigNumber[];
+    leafId: number;
+    l2TokenAddress: string;
+    refundAddresses: string[];
+}
+export interface ProposedRootBundle extends SortableEvent {
+    challengePeriodEndTimestamp: number;
+    poolRebalanceLeafCount: number;
+    bundleEvaluationBlockNumbers: BigNumber[];
+    poolRebalanceRoot: string;
+    relayerRefundRoot: string;
+    slowRelayRoot: string;
+    proposer: string;
+}
+export type RealizedLpFee = {
+    quoteBlock: number;
+    realizedLpFeePct: BigNumber;
+};
+export type ProposedRootBundleStringified = Omit<ProposedRootBundle, "bundleEvaluationBlockNumbers"> & {
+    bundleEvaluationBlockNumbers: string[];
+};
+export interface CancelledRootBundle extends SortableEvent {
+    disputer: string;
+    requestTime: number;
+}
+export interface DisputedRootBundle extends SortableEvent {
+    disputer: string;
+    requestTime: number;
+}
+export interface ExecutedRootBundle extends SortableEvent {
+    chainId: number;
+    bundleLpFees: BigNumber[];
+    netSendAmounts: BigNumber[];
+    runningBalances: BigNumber[];
+    incentiveBalances: BigNumber[];
+    leafId: number;
+    l1Tokens: string[];
+    proof: string[];
+}
+export type ExecutedRootBundleStringified = Omit<ExecutedRootBundle, "bundleLpFees" | "netSendAmounts" | "runningBalances" | "incentiveBalances"> & {
+    bundleLpFees: string[];
+    netSendAmounts: string[];
+    runningBalances: string[];
+    incentiveBalances: string[];
+};
+export type TokenRunningBalance = {
+    runningBalance: BigNumber;
+    incentiveBalance: BigNumber;
+};
+export interface RelayerRefundLeafWithGroup extends RelayerRefundLeaf {
+    groupIndex: number;
+}
+export interface L1Token {
+    address: string;
+    symbol: string;
+    decimals: number;
+}
+export interface LpToken {
+    lastLpFeeUpdate: number;
+    liquidReserves: BigNumber;
+}
+export interface CrossChainContractsSet extends SortableEvent {
+    l2ChainId: number;
+    spokePool: string;
+}
+export interface DestinationTokenWithBlock extends SortableEvent {
+    l2Token: string;
+    l1Token: string;
+}
+export interface SetPoolRebalanceRoot extends SortableEvent {
+    destinationChainId: number;
+    l1Token: string;
+    destinationToken: string;
+}
+export interface PendingRootBundle {
+    poolRebalanceRoot: string;
+    relayerRefundRoot: string;
+    slowRelayRoot: string;
+    proposer: string;
+    unclaimedPoolRebalanceLeafCount: number;
+    challengePeriodEndTimestamp: number;
+    bundleEvaluationBlockNumbers: number[];
+    proposalBlockNumber?: number;
+}
+//# sourceMappingURL=HubPool.d.ts.map

package/dist/types/interfaces/HubPool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubPool.d.ts","sourceRoot":"","sources":["../../../src/interfaces/HubPool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,SAAS,EAAE,CAAC;IAC1B,cAAc,EAAE,SAAS,EAAE,CAAC;IAC5B,eAAe,EAAE,SAAS,EAAE,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,cAAc,EAAE,SAAS,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,2BAA2B,EAAE,MAAM,CAAC;IACpC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,4BAA4B,EAAE,SAAS,EAAE,CAAC;IAC1C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,SAAS,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,kBAAkB,EAAE,8BAA8B,CAAC,GAAG;IACrG,4BAA4B,EAAE,MAAM,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,WAAW,mBAAoB,SAAQ,aAAa;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,SAAS,EAAE,CAAC;IAC1B,cAAc,EAAE,SAAS,EAAE,CAAC;IAC5B,eAAe,EAAE,SAAS,EAAE,CAAC;IAC7B,iBAAiB,EAAE,SAAS,EAAE,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAC9C,kBAAkB,EAClB,cAAc,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,mBAAmB,CAC5E,GAAG;IACF,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,EAAE,SAAS,CAAC;IAC1B,gBAAgB,EAAE,SAAS,CAAC;CAC7B,CAAC;AAEF,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACnE,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,OAAO;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,sBAAuB,SAAQ,aAAa;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,yBAA0B,SAAQ,aAAa;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B,EAAE,MAAM,CAAC;IACxC,2BAA2B,EAAE,MAAM,CAAC;IACpC,4BAA4B,EAAE,MAAM,EAAE,CAAC;IACvC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B"}