@across-protocol/sdk 3.0.0

package/dist/types/apiClient/abstractClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstractClient.d.ts","sourceRoot":"","sources":["../../../src/apiClient/abstractClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,0BAA0B,EAC3B,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,iBAAiB;IAC7C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC;;;;OAIG;IACH,SAAS,aAAa,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAKrE;;;OAGG;IACH,SAAS,CAAC,mBAAmB,IAAI,MAAM;IAIvC;;;OAGG;IACH,SAAS,CAAC,gBAAgB,IAAI,MAAM;IAIpC;;;;;;OAMG;aACa,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAEzG;;;;;;;;OAQG;aACa,gBAAgB,CAC9B,MAAM,EAAE,MAAM,CAAC,SAAS,EACxB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,sBAAsB,CAAC;IAElC;;;;;;;;;OASG;aACa,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GAAG,MAAM,EAC3B,QAAQ,EAAE,MAAM,GAAG,MAAM,GACxB,OAAO,CAAC,sBAAsB,CAAC;IAElC;;;;OAIG;aACa,cAAc,IAAI,OAAO,CAAC,0BAA0B,CAAC;CACtE"}

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

@@ -0,0 +1,3 @@
+export { default as ProductionClient } from "./productionClient";
+export { default as MockedClient } from "./mockedClient";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/apiClient/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/types/apiClient/mockedClient.d.ts

@@ -0,0 +1,25 @@
+import { ethers } from "ethers";
+import AbstractApiClient from "./abstractClient";
+import { AcrossBridgeStatisticsType, BridgeLimitsReturnType, CoingeckoDataReturnType, EndpointResultMappingType, SuggestedFeeReturnType } from "./types";
+/**
+ * MockedApiClient is a mocked implementation of the AbstractApiClient.
+ * @class
+ * @extends AbstractApiClient
+ * @note This implementation does not make API calls to RESTful services. Instead, it returns mocked data.
+ */
+export default class MockedApiClient extends AbstractApiClient {
+    /**
+     * Mocked data to return in lieu of the default return values.
+     */
+    private readonly mockedData;
+    /**
+     * Creates a constructor for the MockedApiClient.
+     * @param mockedData The mocked data to return in lieu of the default return values
+     */
+    constructor(mockedData?: Partial<EndpointResultMappingType>);
+    getCoinGeckoData(_l1Token: string, _baseCurrency: string): Promise<CoingeckoDataReturnType>;
+    getSuggestedFees(_amount: ethers.BigNumber, _originToken: string, _toChainid: number, _fromChainid: number): Promise<SuggestedFeeReturnType>;
+    getBridgeLimits(_token: string, _fromChainId: string | number, _toChainId: string | number): Promise<BridgeLimitsReturnType>;
+    getAcrossStats(): Promise<AcrossBridgeStatisticsType>;
+}
+//# sourceMappingURL=mockedClient.d.ts.map

package/dist/types/apiClient/mockedClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockedClient.d.ts","sourceRoot":"","sources":["../../../src/apiClient/mockedClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,iBAAiB,MAAM,kBAAkB,CAAC;AACjD,OAAO,EACL,0BAA0B,EAC1B,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,sBAAsB,EACvB,MAAM,SAAS,CAAC;AAEjB;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,iBAAiB;IAC5D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqC;IAEhE;;;OAGG;gBACgB,UAAU,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC;IAK3D,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAO3F,gBAAgB,CACrB,OAAO,EAAE,MAAM,CAAC,SAAS,EACzB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,sBAAsB,CAAC;IAqB3B,eAAe,CACpB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,GAAG,MAAM,EAC7B,UAAU,EAAE,MAAM,GAAG,MAAM,GAC1B,OAAO,CAAC,sBAAsB,CAAC;IAU3B,cAAc,IAAI,OAAO,CAAC,0BAA0B,CAAC;CAS7D"}

package/dist/types/apiClient/productionClient.d.ts

@@ -0,0 +1,17 @@
+import { ethers } from "ethers";
+import AbstractApiClient from "./abstractClient";
+import { CoingeckoDataReturnType, SuggestedFeeReturnType, BridgeLimitsReturnType, AcrossBridgeStatisticsType } from "./types";
+/**
+ * An implementation of AbstractApiClient that uses the production API.
+ * @class
+ * @extends AbstractApiClient
+ * @note This implementation makes API calls to RESTful services.
+ */
+export default class ProductionApiClient extends AbstractApiClient {
+    constructor(serverlessApiUrl: string, scraperApiUrl: string);
+    getCoinGeckoData(l1Token: string, baseCurrency: string): Promise<CoingeckoDataReturnType>;
+    getSuggestedFees(amount: ethers.BigNumber, originToken: string, toChainid: number, fromChainid: number): Promise<SuggestedFeeReturnType>;
+    getBridgeLimits(token: string, fromChainId: string | number, toChainId: string | number): Promise<BridgeLimitsReturnType>;
+    getAcrossStats(): Promise<AcrossBridgeStatisticsType>;
+}
+//# sourceMappingURL=productionClient.d.ts.map

package/dist/types/apiClient/productionClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"productionClient.d.ts","sourceRoot":"","sources":["../../../src/apiClient/productionClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,iBAAiB,MAAM,kBAAkB,CAAC;AACjD,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,sBAAsB,EACtB,0BAA0B,EAC3B,MAAM,SAAS,CAAC;AAEjB;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,iBAAiB;gBAC7C,gBAAgB,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IAIrD,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAczF,gBAAgB,CAC3B,MAAM,EAAE,MAAM,CAAC,SAAS,EACxB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,sBAAsB,CAAC;IA2CrB,eAAe,CAC1B,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,GAAG,MAAM,EAC5B,SAAS,EAAE,MAAM,GAAG,MAAM,GACzB,OAAO,CAAC,sBAAsB,CAAC;IAMrB,cAAc,IAAI,OAAO,CAAC,0BAA0B,CAAC;CAInE"}

package/dist/types/apiClient/types.d.ts

@@ -0,0 +1,45 @@
+import { ethers } from "ethers";
+export type CoingeckoDataReturnType = {
+    price: ethers.BigNumber;
+};
+export type Fee = {
+    total: ethers.BigNumber;
+    pct: ethers.BigNumber;
+};
+export type SuggestedFeeReturnType = {
+    relayerFee: Fee;
+    relayerGasFee: Fee;
+    relayerCapitalFee: Fee;
+    isAmountTooLow: boolean;
+    quoteTimestamp: ethers.BigNumber;
+    quoteBlock: ethers.BigNumber;
+};
+export type BridgeLimitsReturnType = {
+    minDeposit: ethers.BigNumber;
+    maxDeposit: ethers.BigNumber;
+    maxDepositInstant: ethers.BigNumber;
+    maxDepositShortDelay: ethers.BigNumber;
+};
+export type SpecificRewardType = {
+    eligible: boolean;
+    completed: boolean;
+    amount: string;
+};
+export type TotalRewardType = {
+    welcomeTravellerRewards: SpecificRewardType;
+    earlyUserRewards: SpecificRewardType;
+    liquidityProviderRewards: SpecificRewardType;
+    communityRewards?: SpecificRewardType;
+};
+export type AcrossBridgeStatisticsType = {
+    totalDeposits: number;
+    avgFillTime: number;
+    totalVolumeUsd: number;
+};
+export type EndpointResultMappingType = {
+    CoinGeckoData: CoingeckoDataReturnType;
+    SuggestedFees: SuggestedFeeReturnType;
+    BridgeLimits: BridgeLimitsReturnType;
+    AcrossStats: AcrossBridgeStatisticsType;
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apiClient/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,MAAM,MAAM,uBAAuB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAA;CAAE,CAAC;AAElE,MAAM,MAAM,GAAG,GAAG;IAChB,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,GAAG,CAAC;IAChB,aAAa,EAAE,GAAG,CAAC;IACnB,iBAAiB,EAAE,GAAG,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC;IAC7B,iBAAiB,EAAE,MAAM,CAAC,SAAS,CAAC;IACpC,oBAAoB,EAAE,MAAM,CAAC,SAAS,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,uBAAuB,EAAE,kBAAkB,CAAC;IAC5C,gBAAgB,EAAE,kBAAkB,CAAC;IACrC,wBAAwB,EAAE,kBAAkB,CAAC;IAC7C,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,uBAAuB,CAAC;IACvC,aAAa,EAAE,sBAAsB,CAAC;IACtC,YAAY,EAAE,sBAAsB,CAAC;IACrC,WAAW,EAAE,0BAA0B,CAAC;CACzC,CAAC"}

package/dist/types/caching/Arweave/ArweaveClient.d.ts

@@ -0,0 +1,62 @@
+import { JWKInterface } from "arweave/node/lib/wallet";
+import { ethers } from "ethers";
+import { Struct } from "superstruct";
+import winston from "winston";
+export declare class ArweaveClient {
+    private arweaveJWT;
+    private logger;
+    private client;
+    private gatewayUrl;
+    constructor(arweaveJWT: JWKInterface, logger: winston.Logger, gatewayURL?: string, protocol?: string, port?: number);
+    /**
+     * Stores an arbitrary record in the Arweave network. The record is stored as a JSON string and uses
+     * JSON.stringify to convert the record to a string. The record has all of its big numbers converted
+     * to strings for convenience.
+     * @param value The value to store
+     * @param topicTag An optional topic tag to add to the transaction
+     * @returns The transaction ID of the stored value
+     * @
+     */
+    set(value: Record<string, unknown>, topicTag?: string | undefined): Promise<string | undefined>;
+    /**
+     * Retrieves a record from the Arweave network. The record is expected to be a JSON string and is
+     * parsed using JSON.parse. All numeric strings are converted to big numbers for convenience.
+     * @param transactionID The transaction ID of the record to retrieve
+     * @param structValidator An optional struct validator to validate the retrieved value. If the value does not match the struct, null is returned.
+     * @returns The record if it exists, otherwise null
+     */
+    get<T>(transactionID: string, validator: Struct<T>): Promise<T | null>;
+    /**
+     * Retrieves a list of records from the Arweave network that have a specific tag.
+     * The records are expected to be a JSON string and are pre-filtered by the Across
+     * protocol tag, the content-type tag, and this client's address. Furthermore, the
+     * records are expected to be an array of the given type and will be discarded if
+     * they do not match the given validator.
+     * @param tag The tag to filter all the transactions by
+     * @param validator The validator to validate the retrieved values
+     * @param originQueryAddress An optional flag to override the originating address for the query. By default,
+     *                           the address of the RL Arweave storage wallet is used.
+     * @returns The records if they exist, otherwise an empty array
+     */
+    getByTopic<T>(tag: string, validator: Struct<T>, originQueryAddress?: string): Promise<{
+        data: T;
+        hash: string;
+    }[]>;
+    /**
+     * Retrieves the metadata of a transaction
+     * @param transactionID The transaction ID of the record to retrieve
+     * @returns The metadata of the transaction if it exists, otherwise null
+     */
+    getMetadata(transactionID: string): Promise<Record<string, string> | null>;
+    /**
+     * Returns the address of the signer of the JWT
+     * @returns The address of the signer in this client
+     */
+    getAddress(): Promise<string>;
+    /**
+     * The balance of the signer
+     * @returns The balance of the signer in winston units
+     */
+    getBalance(): Promise<ethers.BigNumber>;
+}
+//# sourceMappingURL=ArweaveClient.d.ts.map

package/dist/types/caching/Arweave/ArweaveClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArweaveClient.d.ts","sourceRoot":"","sources":["../../../../src/caching/Arweave/ArweaveClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,MAAM,EAAU,MAAM,aAAa,CAAC;AAC7C,OAAO,OAAO,MAAM,SAAS,CAAC;AAI9B,qBAAa,aAAa;IAKtB,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,MAAM;IALhB,OAAO,CAAC,MAAM,CAAU;IACxB,OAAO,CAAC,UAAU,CAAS;gBAGjB,UAAU,EAAE,YAAY,EACxB,MAAM,EAAE,OAAO,CAAC,MAAM,EAC9B,UAAU,SAAgB,EAC1B,QAAQ,SAAU,EAClB,IAAI,SAAM;IAiBZ;;;;;;;;OAQG;IACG,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAwCrG;;;;;;OAMG;IACG,GAAG,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAgC5E;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,CAAC,EAChB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,EACpB,kBAAkB,SAAkC,GACnD,OAAO,CAAC;QAAE,IAAI,EAAE,CAAC,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAkDvC;;;;OAIG;IACG,WAAW,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAkBhF;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7B;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC;CAa9C"}

package/dist/types/caching/Arweave/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ArweaveClient";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/caching/Arweave/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/dist/types/caching/IPFS/PinataIPFSClient.d.ts

@@ -0,0 +1,38 @@
+import { CachingMechanismInterface } from "../../interfaces";
+import { Struct } from "superstruct";
+import winston from "winston";
+/**
+ * A client for interacting with the IPFS. This is a wrapper around the IPFS API.
+ * This client also is a part of the caching mechanism interface.
+ * @see https://docs.ipfs.io/reference/http/api/
+ */
+export declare class PinataIPFSClient implements CachingMechanismInterface {
+    /**
+     * The IPFS client instance
+     */
+    private client;
+    /**
+     * Public IPFS gateway URL to retrieve the content from
+     */
+    private publicGatewayURL;
+    /**
+     * An optional logger for logging messages
+     */
+    private logger?;
+    constructor(projectId: string, projectSecret: string, publicGatewayURL: string, logger?: winston.Logger);
+    /**
+     * Calls to a public IPFS gateway to retrieve a value.
+     * @param key The key to retrieve.
+     * @param _structValidator An optional struct validator to validate the retrieved value. If the value does not match the struct, null is returned.
+     * @returns The value if it exists, otherwise null.
+     */
+    get<ObjectType>(key?: string, _structValidator?: Struct<unknown, unknown>): Promise<ObjectType | null>;
+    /**
+     * Stores a value in the IPFS and returns the CID of the value stored.
+     * @param key An optional key to store the value with. This is purely in the metadata of the CID.
+     * @param value The value to store.
+     * @returns The CID of the value stored.
+     */
+    set<T>(key: string, value: T): Promise<string | undefined>;
+}
+//# sourceMappingURL=PinataIPFSClient.d.ts.map

package/dist/types/caching/IPFS/PinataIPFSClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PinataIPFSClient.d.ts","sourceRoot":"","sources":["../../../../src/caching/IPFS/PinataIPFSClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,OAAO,MAAM,SAAS,CAAC;AAI9B;;;;GAIG;AACH,qBAAa,gBAAiB,YAAW,yBAAyB;IAChE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAe;IAE7B;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,CAAiB;gBAEb,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM;IAM9G;;;;;OAKG;IACG,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAkC5G;;;;;OAKG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAW3D"}

package/dist/types/caching/IPFS/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./PinataIPFSClient";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/caching/IPFS/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}

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

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

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

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

package/dist/types/clients/AcrossConfigStoreClient/AcrossConfigStoreClient.d.ts

@@ -0,0 +1,109 @@
+import { across } from "@uma/sdk";
+import { Contract, Event } from "ethers";
+import winston from "winston";
+import { EventSearchConfig, MakeOptional } from "../../utils";
+import { ConfigStoreVersionUpdate, DisabledChainsUpdate, GlobalConfigUpdate, RouteRateModelUpdate, SpokePoolTargetBalance, SpokeTargetBalanceUpdate, UBAConfigUpdates, UBAParsedConfigType } from "../../interfaces";
+import { BaseAbstractClient, UpdateFailureReason } from "../BaseAbstractClient";
+type ConfigStoreUpdateSuccess = {
+    success: true;
+    chainId: number;
+    searchEndBlock: number;
+    events: {
+        updatedTokenConfigEvents: Event[];
+        updatedGlobalConfigEvents: Event[];
+        globalConfigUpdateTimes: number[];
+    };
+};
+type ConfigStoreUpdateFailure = {
+    success: false;
+    reason: UpdateFailureReason;
+};
+export type ConfigStoreUpdate = ConfigStoreUpdateSuccess | ConfigStoreUpdateFailure;
+export declare const DEFAULT_CONFIG_STORE_VERSION = 0;
+export declare enum GLOBAL_CONFIG_STORE_KEYS {
+    MAX_RELAYER_REPAYMENT_LEAF_SIZE = "MAX_RELAYER_REPAYMENT_LEAF_SIZE",
+    MAX_POOL_REBALANCE_LEAF_SIZE = "MAX_POOL_REBALANCE_LEAF_SIZE",
+    VERSION = "VERSION",
+    DISABLED_CHAINS = "DISABLED_CHAINS",
+    CHAIN_ID_INDICES = "CHAIN_ID_INDICES"
+}
+export declare class AcrossConfigStoreClient extends BaseAbstractClient {
+    readonly logger: winston.Logger;
+    readonly configStore: Contract;
+    readonly configStoreVersion: number;
+    cumulativeRateModelUpdates: across.rateModel.RateModelEvent[];
+    ubaConfigUpdates: UBAConfigUpdates[];
+    cumulativeRouteRateModelUpdates: RouteRateModelUpdate[];
+    cumulativeMaxRefundCountUpdates: GlobalConfigUpdate[];
+    cumulativeMaxL1TokenCountUpdates: GlobalConfigUpdate[];
+    chainIdIndicesUpdates: GlobalConfigUpdate<number[]>[];
+    cumulativeSpokeTargetBalanceUpdates: SpokeTargetBalanceUpdate[];
+    cumulativeConfigStoreVersionUpdates: ConfigStoreVersionUpdate[];
+    cumulativeDisabledChainUpdates: DisabledChainsUpdate[];
+    protected rateModelDictionary: across.rateModel.RateModelDictionary;
+    hasLatestConfigStoreVersion: boolean;
+    chainId: number | undefined;
+    constructor(logger: winston.Logger, configStore: Contract, eventSearchConfig: MakeOptional<EventSearchConfig, "toBlock"> | undefined, configStoreVersion: number);
+    getRateModelForBlockNumber(l1Token: string, originChainId: number | string, destinationChainId: number | string, blockNumber?: number | undefined): across.constants.RateModel;
+    getRouteRateModelForBlockNumber(l1Token: string, route: string, blockNumber?: number | undefined): across.constants.RateModel | undefined;
+    /**
+     * Resolve the implied set of chain ID indices based on the chain ID of the ConfigStore.
+     * @param chainId Chain ID of the ConfigStore.
+     * @dev If the resolved chain ID is part of the default set, assume the protocol defaults.
+     *      Otherwise, assume this is a test deployment with a lone chain ID.
+     * @dev The protocol defaults are [1, 10, 137, 288, 42161] (outlined in UMIP-157).
+     * @dev chainId is marked optional to appease tsc. It must always be passed in.
+     */
+    protected implicitChainIdIndices(chainId?: number): number[];
+    /**
+     * Resolves the chain ids that were available to the protocol at a given block range.
+     * @param blockNumber Block number to search for. Defaults to latest block.
+     * @returns List of chain IDs that were available to the protocol at the given block number.
+     * @note This dynamic functionality has been added after the launch of Across.
+     * @note This function will return a default list of chain IDs if the block requested
+     *       existed before the initial inclusion of this dynamic key/value entry. In the
+     *       case that a block number is requested that is before the initial inclusion of
+     *       this key/value entry, the function will return the default list of chain IDs as
+     *       outlined per the UMIP (https://github.com/UMAprotocol/UMIPs/pull/590).
+     */
+    getChainIdIndicesForBlock(blockNumber?: number): number[];
+    getSpokeTargetBalancesForBlock(l1Token: string, chainId: number, blockNumber?: number): SpokePoolTargetBalance;
+    getMaxRefundCountForRelayerRefundLeafForBlock(blockNumber?: number): number;
+    getMaxL1TokenCountForPoolRebalanceLeafForBlock(blockNumber?: number): number;
+    /**
+     * Returns list of chains that have been enabled at least once in the block range.
+     * If a chain was disabled in the block range, it will be included in the list provided it was enabled
+     * at some point in the block range.
+     * @dev If fromBlock == toBlock then defaults to returning enabled chains at fromBlock
+     * @param fromBlock Start block to search inclusive
+     * @param toBlock End block to search inclusive. Defaults to MAX_SAFE_INTEGER, so grabs all disabled chain events
+     * up until `latest`.
+     * @returns List of chain IDs that have been enabled at least once in the block range. Sorted from lowest to highest.
+     */
+    getEnabledChainsInBlockRange(fromBlock: number, toBlock?: number): number[];
+    getEnabledChains(block?: number): number[];
+    getDisabledChainsForBlock(blockNumber?: number): number[];
+    getConfigStoreVersionForTimestamp(timestamp?: number): number;
+    getConfigStoreVersionForBlock(blockNumber?: number): number;
+    hasValidConfigStoreVersionForTimestamp(timestamp?: number): boolean;
+    /**
+     * Resolve the chain ID for the ConfigStore Provider instance.
+     * @dev When the provider is a StatisJsonRpcProvider instance, the getNetwork() is non-blocking.
+     * @returns Chain ID for the ConfigStore deployment.
+     */
+    protected resolveChainId(): Promise<number>;
+    protected _update(): Promise<ConfigStoreUpdate>;
+    update(): Promise<void>;
+    filterDisabledChains(disabledChains: number[]): number[];
+    /**
+     * Retrieves the most recently set UBA config for a given L1 token address before a block number.
+     * @param l1TokenAddress The L1 token address to retrieve the config for
+     * @param blockNumber The block number to retrieve the config for. If not specified, sets block to max integer
+     * meaning that this function will return the latest config.
+     * @returns The UBA config for the given L1 token address and block number, or undefined if no config exists
+     * before blockNumber.
+     */
+    getUBAConfig(l1TokenAddress: string, blockNumber?: number): UBAParsedConfigType | undefined;
+}
+export {};
+//# sourceMappingURL=AcrossConfigStoreClient.d.ts.map

package/dist/types/clients/AcrossConfigStoreClient/AcrossConfigStoreClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcrossConfigStoreClient.d.ts","sourceRoot":"","sources":["../../../../src/clients/AcrossConfigStoreClient/AcrossConfigStoreClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,MAAM,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,EACL,iBAAiB,EACjB,YAAY,EAab,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EACpB,kBAAkB,EAElB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EAExB,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,kBAAkB,EAAyB,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEvG,KAAK,wBAAwB,GAAG;IAC9B,OAAO,EAAE,IAAI,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE;QACN,wBAAwB,EAAE,KAAK,EAAE,CAAC;QAClC,yBAAyB,EAAE,KAAK,EAAE,CAAC;QACnC,uBAAuB,EAAE,MAAM,EAAE,CAAC;KACnC,CAAC;CACH,CAAC;AACF,KAAK,wBAAwB,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAChF,MAAM,MAAM,iBAAiB,GAAG,wBAAwB,GAAG,wBAAwB,CAAC;AAIpF,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAE9C,oBAAY,wBAAwB;IAClC,+BAA+B,oCAAoC;IACnE,4BAA4B,iCAAiC;IAC7D,OAAO,YAAY;IACnB,eAAe,oBAAoB;IACnC,gBAAgB,qBAAqB;CACtC;AAED,qBAAa,uBAAwB,SAAQ,kBAAkB;IAiB3D,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM;IAC/B,QAAQ,CAAC,WAAW,EAAE,QAAQ;IAE9B,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IAnB9B,0BAA0B,EAAE,MAAM,CAAC,SAAS,CAAC,cAAc,EAAE,CAAM;IACnE,gBAAgB,EAAE,gBAAgB,EAAE,CAAM;IAC1C,+BAA+B,EAAE,oBAAoB,EAAE,CAAM;IAC7D,+BAA+B,EAAE,kBAAkB,EAAE,CAAM;IAC3D,gCAAgC,EAAE,kBAAkB,EAAE,CAAM;IAC5D,qBAAqB,EAAE,kBAAkB,CAAC,MAAM,EAAE,CAAC,EAAE,CAAM;IAC3D,mCAAmC,EAAE,wBAAwB,EAAE,CAAM;IACrE,mCAAmC,EAAE,wBAAwB,EAAE,CAAM;IACrE,8BAA8B,EAAE,oBAAoB,EAAE,CAAM;IAEnE,SAAS,CAAC,mBAAmB,EAAE,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC;IAE7D,2BAA2B,UAAS;IACpC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;gBAGxB,MAAM,EAAE,OAAO,CAAC,MAAM,EACtB,WAAW,EAAE,QAAQ,EAC9B,iBAAiB,wDAAoF,EAC5F,kBAAkB,EAAE,MAAM;IAYrC,0BAA0B,CACxB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,GAAG,MAAM,EAC9B,kBAAkB,EAAE,MAAM,GAAG,MAAM,EACnC,WAAW,GAAE,MAAM,GAAG,SAAqB,GAC1C,MAAM,CAAC,SAAS,CAAC,SAAS;IAO7B,+BAA+B,CAC7B,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,WAAW,GAAE,MAAM,GAAG,SAAqB,GAC1C,MAAM,CAAC,SAAS,CAAC,SAAS,GAAG,SAAS;IAUzC;;;;;;;OAOG;IACH,SAAS,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE;IAK5D;;;;;;;;;;OAUG;IACH,yBAAyB,CAAC,WAAW,GAAE,MAAgC,GAAG,MAAM,EAAE;IAWlF,8BAA8B,CAC5B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,WAAW,GAAE,MAAgC,GAC5C,sBAAsB;IASzB,6CAA6C,CAAC,WAAW,GAAE,MAAgC,GAAG,MAAM;IAUpG,8CAA8C,CAAC,WAAW,GAAE,MAAgC,GAAG,MAAM;IAUrG;;;;;;;;;OASG;IACH,4BAA4B,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,SAA0B,GAAG,MAAM,EAAE;IAkC5F,gBAAgB,CAAC,KAAK,SAA0B,GAAG,MAAM,EAAE;IAM3D,yBAAyB,CAAC,WAAW,GAAE,MAAgC,GAAG,MAAM,EAAE;IAOlF,iCAAiC,CAAC,SAAS,GAAE,MAAgC,GAAG,MAAM;IAKtF,6BAA6B,CAAC,WAAW,GAAE,MAAgC,GAAG,MAAM;IAKpF,sCAAsC,CAAC,SAAS,GAAE,MAAgC,GAAG,OAAO;IAK5F;;;;OAIG;cACa,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;cAIjC,OAAO,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAmC/C,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAmM7B,oBAAoB,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAMxD;;;;;;;OAOG;IACI,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,SAA0B,GAAG,mBAAmB,GAAG,SAAS;CAYpH"}

package/dist/types/clients/AcrossConfigStoreClient/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./AcrossConfigStoreClient";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/clients/AcrossConfigStoreClient/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}

package/dist/types/clients/BaseAbstractClient.d.ts

@@ -0,0 +1,52 @@
+import { providers } from "ethers";
+import { CachingMechanismInterface } from "../interfaces";
+import { EventSearchConfig, MakeOptional } from "../utils";
+export declare enum UpdateFailureReason {
+    AlreadyUpdated = 0,
+    BadRequest = 1,
+    RPCError = 2
+}
+export declare function isUpdateFailureReason(x: EventSearchConfig | UpdateFailureReason): x is UpdateFailureReason;
+/**
+ * Base class for all clients to extend.
+ */
+export declare abstract class BaseAbstractClient {
+    readonly eventSearchConfig: MakeOptional<EventSearchConfig, "toBlock">;
+    protected cachingMechanism?: CachingMechanismInterface | undefined;
+    protected _isUpdated: boolean;
+    firstBlockToSearch: number;
+    latestBlockSearched: number;
+    /**
+     * Creates a new client.
+     * @param cachingMechanism The caching mechanism to use for this client. If not provided, the client will not rely on an external cache.
+     */
+    constructor(eventSearchConfig?: MakeOptional<EventSearchConfig, "toBlock">, cachingMechanism?: CachingMechanismInterface | undefined);
+    /**
+     * Indicates whether the client has been updated since it was created.
+     * @returns Whether the client has been updated since it was created.
+     */
+    get isUpdated(): boolean;
+    /**
+     * Sets whether the client has been updated since it was created.
+     * @param value Whether the client has been updated since it was created.
+     * @throws Error if the client has already been updated and the value is false.
+     */
+    set isUpdated(value: boolean);
+    /**
+     * Validates and updates the stored EventSearchConfig in advance of an update() call.
+     * Use isEventSearchConfig() to discriminate the result.
+     * @provider Ethers RPC provider instance.
+     * @returns An EventSearchConfig instance if valid, otherwise an UpdateFailureReason.
+     */
+    updateSearchConfig(provider: providers.Provider): Promise<EventSearchConfig | UpdateFailureReason>;
+    /**
+     * Asserts that the client has been updated.
+     */
+    protected assertUpdated(): void;
+    /**
+     * Determines if the client has an external cache.
+     * @returns Whether the client has an external cache.
+     */
+    protected hasCachingMechanism(): boolean;
+}
+//# sourceMappingURL=BaseAbstractClient.d.ts.map

package/dist/types/clients/BaseAbstractClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseAbstractClient.d.ts","sourceRoot":"","sources":["../../../src/clients/BaseAbstractClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAa,YAAY,EAAE,MAAM,UAAU,CAAC;AAEtE,oBAAY,mBAAmB;IAC7B,cAAc,IAAA;IACd,UAAU,IAAA;IACV,QAAQ,IAAA;CACT;AAED,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,CAAC,IAAI,mBAAmB,CAE1G;AAED;;GAEG;AACH,8BAAsB,kBAAkB;IAUpC,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,iBAAiB,EAAE,SAAS,CAAC;IACtE,SAAS,CAAC,gBAAgB,CAAC;IAV7B,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC;IACvB,kBAAkB,SAAK;IACvB,mBAAmB,SAAK;IAE/B;;;OAGG;gBAEQ,iBAAiB,GAAE,YAAY,CAAC,iBAAiB,EAAE,SAAS,CAAyC,EACpG,gBAAgB,CAAC,uCAA2B;IAKxD;;;OAGG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;;;OAIG;IACH,IAAW,SAAS,CAAC,KAAK,EAAE,OAAO,EAKlC;IAED;;;;;OAKG;IACU,kBAAkB,CAAC,QAAQ,EAAE,SAAS,CAAC,QAAQ,GAAG,OAAO,CAAC,iBAAiB,GAAG,mBAAmB,CAAC;IAkB/G;;OAEG;IACH,SAAS,CAAC,aAAa,IAAI,IAAI;IAM/B;;;OAGG;IACH,SAAS,CAAC,mBAAmB,IAAI,OAAO;CAGzC"}

package/dist/types/clients/HubPoolClient.d.ts

@@ -0,0 +1,135 @@
+import { BigNumber, Contract, Event, EventFilter } from "ethers";
+import winston from "winston";
+import { CachingMechanismInterface, CancelledRootBundle, CrossChainContractsSet, Deposit, DepositWithBlock, DestinationTokenWithBlock, DisputedRootBundle, ExecutedRootBundle, L1Token, LpToken, PendingRootBundle, ProposedRootBundle, RealizedLpFee, TokenRunningBalance } from "../interfaces";
+import { BlockFinder, EventSearchConfig, MakeOptional } from "../utils";
+import { AcrossConfigStoreClient as ConfigStoreClient } from "./AcrossConfigStoreClient/AcrossConfigStoreClient";
+import { BaseAbstractClient, UpdateFailureReason } from "./BaseAbstractClient";
+type HubPoolUpdateSuccess = {
+    success: true;
+    currentTime: number;
+    pendingRootBundleProposal: PendingRootBundle;
+    events: Record<string, Event[]>;
+    searchEndBlock: number;
+};
+type HubPoolUpdateFailure = {
+    success: false;
+    reason: UpdateFailureReason;
+};
+export type HubPoolUpdate = HubPoolUpdateSuccess | HubPoolUpdateFailure;
+type HubPoolEvent = "SetPoolRebalanceRoute" | "L1TokenEnabledForLiquidityProvision" | "ProposeRootBundle" | "RootBundleCanceled" | "RootBundleDisputed" | "RootBundleExecuted" | "CrossChainContractsSet";
+type L1TokensToDestinationTokens = {
+    [l1Token: string]: {
+        [destinationChainId: number]: string;
+    };
+};
+export type LpFeeRequest = Pick<Deposit, "originChainId" | "inputToken" | "inputAmount" | "quoteTimestamp"> & {
+    paymentChainId?: number;
+};
+export declare class HubPoolClient extends BaseAbstractClient {
+    readonly logger: winston.Logger;
+    readonly hubPool: Contract;
+    configStoreClient: ConfigStoreClient;
+    deploymentBlock: number;
+    readonly chainId: number;
+    protected readonly configOverride: {
+        ignoredHubExecutedBundles: number[];
+        ignoredHubProposedBundles: number[];
+        timeToCache?: number;
+    };
+    protected l1TokensToDestinationTokens: L1TokensToDestinationTokens;
+    protected l1Tokens: L1Token[];
+    protected lpTokens: {
+        [token: string]: LpToken;
+    };
+    protected proposedRootBundles: ProposedRootBundle[];
+    protected canceledRootBundles: CancelledRootBundle[];
+    protected disputedRootBundles: DisputedRootBundle[];
+    protected executedRootBundles: ExecutedRootBundle[];
+    protected crossChainContracts: {
+        [l2ChainId: number]: CrossChainContractsSet[];
+    };
+    protected l1TokensToDestinationTokensWithBlock: {
+        [l1Token: string]: {
+            [destinationChainId: number]: DestinationTokenWithBlock[];
+        };
+    };
+    protected pendingRootBundle: PendingRootBundle | undefined;
+    currentTime: number | undefined;
+    readonly blockFinder: BlockFinder;
+    constructor(logger: winston.Logger, hubPool: Contract, configStoreClient: ConfigStoreClient, deploymentBlock?: number, chainId?: number, eventSearchConfig?: MakeOptional<EventSearchConfig, "toBlock">, configOverride?: {
+        ignoredHubExecutedBundles: number[];
+        ignoredHubProposedBundles: number[];
+        timeToCache?: number;
+    }, cachingMechanism?: CachingMechanismInterface);
+    protected hubPoolEventFilters(): Record<HubPoolEvent, EventFilter>;
+    hasPendingProposal(): boolean;
+    getPendingRootBundle(): PendingRootBundle | undefined;
+    getProposedRootBundles(): ProposedRootBundle[];
+    getCancelledRootBundles(): CancelledRootBundle[];
+    getDisputedRootBundles(): DisputedRootBundle[];
+    getExecutedRootBundles(): ExecutedRootBundle[];
+    getSpokePoolForBlock(chain: number, block?: number): string;
+    getSpokePoolActivationBlock(chain: number, spokePool: string): number | undefined;
+    getL2TokenForL1TokenAtBlock(l1Token: string, destinationChainId: number, latestHubBlock?: number): string;
+    getL1TokenForL2TokenAtBlock(l2Token: string, destinationChainId: number, latestHubBlock?: number): string;
+    /**
+     * Returns the L1 token that should be used for an L2 Bridge event. This function is
+     * designed to be used by the caller to associate the L2 token with its mapped L1 token
+     * at the HubPool equivalent block number of the L2 event.
+     * @param deposit Deposit event
+     * @param returns string L1 token counterpart for Deposit
+     */
+    getL1TokenForDeposit(deposit: Pick<DepositWithBlock, "originChainId" | "inputToken" | "quoteBlockNumber">): string;
+    /**
+     * Returns the L2 token that should be used as a counterpart to a deposit event. For example, the caller
+     * might want to know what the refund token will be on l2ChainId for the deposit event.
+     * @param l2ChainId Chain where caller wants to get L2 token counterpart for
+     * @param event Deposit event
+     * @returns string L2 token counterpart on l2ChainId
+     */
+    getL2TokenForDeposit(deposit: Pick<DepositWithBlock, "originChainId" | "destinationChainId" | "inputToken" | "quoteBlockNumber">, l2ChainId?: number): string;
+    l2TokenEnabledForL1Token(l1Token: string, destinationChainId: number): boolean;
+    getBlockNumber(timestamp: number): Promise<number | undefined>;
+    getCurrentPoolUtilization(l1Token: string): Promise<BigNumber>;
+    /**
+     * For a HubPool token at a specific block number, compute the relevant utilization.
+     * @param hubPoolToken HubPool token to query utilization for.
+     * @param blocknumber Block number to query utilization at.
+     * @param amount Amount to query. If set to 0, the closing utilization at blockNumber is returned.
+     * @param amount timestamp Associated quoteTimestamp for query, used for caching evaluation.
+     * @param timeToCache Age at which the response is able to be cached.
+     * @returns HubPool utilization at `blockNumber` after optional `amount` increase in utilization.
+     */
+    protected getUtilization(hubPoolToken: string, blockNumber: number, depositAmount: BigNumber, timestamp: number, timeToCache: number): Promise<BigNumber>;
+    computeRealizedLpFeePct(deposit: LpFeeRequest): Promise<RealizedLpFee>;
+    batchComputeRealizedLpFeePct(deposits: LpFeeRequest[]): Promise<RealizedLpFee[]>;
+    getL1Tokens(): L1Token[];
+    getTokenInfoForL1Token(l1Token: string): L1Token | undefined;
+    getLpTokenInfoForL1Token(l1Token: string): LpToken | undefined;
+    getL1TokenInfoForL2Token(l2Token: string, chainId: number): L1Token | undefined;
+    getTokenInfoForDeposit(deposit: Deposit): L1Token | undefined;
+    getTokenInfo(chainId: number | string, tokenAddress: string): L1Token | undefined;
+    areTokensEquivalent(tokenA: string, chainIdA: number, tokenB: string, chainIdB: number, hubPoolBlock?: number): boolean;
+    getSpokeActivationBlockForChain(chainId: number): number;
+    isRootBundleValid(rootBundle: ProposedRootBundle, latestMainnetBlock: number): boolean;
+    getRootBundleEvalBlockNumberContainingBlock(latestMainnetBlock: number, block: number, chain: number, chainIdListOverride?: number[]): number | undefined;
+    getProposedRootBundlesInBlockRange(startingBlock: number, endingBlock: number): ProposedRootBundle[];
+    getCancelledRootBundlesInBlockRange(startingBlock: number, endingBlock: number): CancelledRootBundle[];
+    getDisputedRootBundlesInBlockRange(startingBlock: number, endingBlock: number): DisputedRootBundle[];
+    getLatestProposedRootBundle(): ProposedRootBundle;
+    getFollowingRootBundle(currentRootBundle: ProposedRootBundle): ProposedRootBundle | undefined;
+    getExecutedLeavesForRootBundle(rootBundle: ProposedRootBundle, latestMainnetBlockToSearch: number): ExecutedRootBundle[];
+    getValidatedRootBundles(latestMainnetBlock?: number): ProposedRootBundle[];
+    getLatestFullyExecutedRootBundle(latestMainnetBlock: number): ProposedRootBundle | undefined;
+    getEarliestFullyExecutedRootBundle(latestMainnetBlock: number, startBlock?: number): ProposedRootBundle | undefined;
+    getNthFullyExecutedRootBundle(n: number, startBlock?: number): ProposedRootBundle | undefined;
+    getLatestBundleEndBlockForChain(chainIdList: number[], latestMainnetBlock: number, chainId: number): number;
+    getNextBundleStartBlockNumber(chainIdList: number[], latestMainnetBlock: number, chainId: number): number;
+    getRunningBalanceBeforeBlockForChain(block: number, chain: number, l1Token: string): TokenRunningBalance;
+    getRunningBalanceForToken(l1Token: string, executedRootBundle: ExecutedRootBundle): TokenRunningBalance;
+    _update(eventNames: HubPoolEvent[]): Promise<HubPoolUpdate>;
+    update(eventsToQuery?: HubPoolEvent[]): Promise<void>;
+    protected getBundleEndBlockForChain(proposeRootBundleEvent: ProposedRootBundle, chainId: number, chainIdList: number[]): number;
+}
+export {};
+//# sourceMappingURL=HubPoolClient.d.ts.map

package/dist/types/clients/HubPoolClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HubPoolClient.d.ts","sourceRoot":"","sources":["../../../src/clients/HubPoolClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEjE,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,EACL,yBAAyB,EACzB,mBAAmB,EACnB,sBAAsB,EACtB,OAAO,EACP,gBAAgB,EAChB,yBAAyB,EACzB,kBAAkB,EAClB,kBAAkB,EAClB,OAAO,EACP,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EAEb,mBAAmB,EACpB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,WAAW,EAGX,iBAAiB,EACjB,YAAY,EAcb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,uBAAuB,IAAI,iBAAiB,EAAE,MAAM,mDAAmD,CAAC;AACjH,OAAO,EAAE,kBAAkB,EAAyB,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEtG,KAAK,oBAAoB,GAAG;IAC1B,OAAO,EAAE,IAAI,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,yBAAyB,EAAE,iBAAiB,CAAC;IAC7C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAChC,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AACF,KAAK,oBAAoB,GAAG;IAC1B,OAAO,EAAE,KAAK,CAAC;IACf,MAAM,EAAE,mBAAmB,CAAC;CAC7B,CAAC;AACF,MAAM,MAAM,aAAa,GAAG,oBAAoB,GAAG,oBAAoB,CAAC;AAExE,KAAK,YAAY,GACb,uBAAuB,GACvB,qCAAqC,GACrC,mBAAmB,GACnB,oBAAoB,GACpB,oBAAoB,GACpB,oBAAoB,GACpB,wBAAwB,CAAC;AAE7B,KAAK,2BAA2B,GAAG;IACjC,CAAC,OAAO,EAAE,MAAM,GAAG;QAAE,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC7D,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,EAAE,eAAe,GAAG,YAAY,GAAG,aAAa,GAAG,gBAAgB,CAAC,GAAG;IAC5G,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,qBAAa,aAAc,SAAQ,kBAAkB;IAmBjD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM;IAC/B,QAAQ,CAAC,OAAO,EAAE,QAAQ;IACnB,iBAAiB,EAAE,iBAAiB;IACpC,eAAe;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM;IAExB,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE;QACjC,yBAAyB,EAAE,MAAM,EAAE,CAAC;QACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;QACpC,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IA3BH,SAAS,CAAC,2BAA2B,EAAE,2BAA2B,CAAM;IACxE,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAM;IACnC,SAAS,CAAC,QAAQ,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAM;IACtD,SAAS,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,CAAM;IACzD,SAAS,CAAC,mBAAmB,EAAE,mBAAmB,EAAE,CAAM;IAC1D,SAAS,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,CAAM;IACzD,SAAS,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,CAAM;IACzD,SAAS,CAAC,mBAAmB,EAAE;QAAE,CAAC,SAAS,EAAE,MAAM,GAAG,sBAAsB,EAAE,CAAA;KAAE,CAAM;IACtF,SAAS,CAAC,oCAAoC,EAAE;QAC9C,CAAC,OAAO,EAAE,MAAM,GAAG;YAAE,CAAC,kBAAkB,EAAE,MAAM,GAAG,yBAAyB,EAAE,CAAA;SAAE,CAAC;KAClF,CAAM;IACP,SAAS,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAEpD,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,SAAgB,WAAW,EAAE,WAAW,CAAC;gBAG9B,MAAM,EAAE,OAAO,CAAC,MAAM,EACtB,OAAO,EAAE,QAAQ,EACnB,iBAAiB,EAAE,iBAAiB,EACpC,eAAe,SAAI,EACjB,OAAO,GAAE,MAAU,EAC5B,iBAAiB,GAAE,YAAY,CAAC,iBAAiB,EAAE,SAAS,CAAyC,EAClF,cAAc,GAAE;QACjC,yBAAyB,EAAE,MAAM,EAAE,CAAC;QACpC,yBAAyB,EAAE,MAAM,EAAE,CAAC;QACpC,WAAW,CAAC,EAAE,MAAM,CAAC;KAItB,EACD,gBAAgB,CAAC,EAAE,yBAAyB;IAU9C,SAAS,CAAC,mBAAmB,IAAI,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC;IAYlE,kBAAkB,IAAI,OAAO;IAI7B,oBAAoB,IAAI,iBAAiB,GAAG,SAAS;IAIrD,sBAAsB,IAAI,kBAAkB,EAAE;IAI9C,uBAAuB,IAAI,mBAAmB,EAAE;IAIhD,sBAAsB,IAAI,kBAAkB,EAAE;IAI9C,sBAAsB,IAAI,kBAAkB,EAAE;IAI9C,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,MAAgC,GAAG,MAAM;IAcpF,2BAA2B,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAUjF,2BAA2B,CACzB,OAAO,EAAE,MAAM,EACf,kBAAkB,EAAE,MAAM,EAC1B,cAAc,SAA0B,GACvC,MAAM;IAqBT,2BAA2B,CACzB,OAAO,EAAE,MAAM,EACf,kBAAkB,EAAE,MAAM,EAC1B,cAAc,SAA0B,GACvC,MAAM;IAoBT;;;;;;OAMG;IACH,oBAAoB,CAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,EAAE,eAAe,GAAG,YAAY,GAAG,kBAAkB,CAAC,GAAG,MAAM;IAOlH;;;;;;OAMG;IACH,oBAAoB,CAClB,OAAO,EAAE,IAAI,CAAC,gBAAgB,EAAE,eAAe,GAAG,oBAAoB,GAAG,YAAY,GAAG,kBAAkB,CAAC,EAC3G,SAAS,SAA6B,GACrC,MAAM;IAMT,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,OAAO;IAI9E,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAKxD,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAKpE;;;;;;;;OAQG;cACa,cAAc,CAC5B,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,SAAS,EACxB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,SAAS,CAAC;IAyCf,uBAAuB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC;IAKtE,4BAA4B,CAAC,QAAQ,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAwHtF,WAAW,IAAI,OAAO,EAAE;IAIxB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI5D,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI9D,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAK/E,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAM7D,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAKjF,mBAAmB,CACjB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,YAAY,SAA2B,GACtC,OAAO;IAkBV,+BAA+B,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAMxD,iBAAiB,CAAC,UAAU,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,GAAG,OAAO;IAWtF,2CAA2C,CACzC,kBAAkB,EAAE,MAAM,EAC1B,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAC7B,MAAM,GAAG,SAAS;IAiCrB,kCAAkC,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,kBAAkB,EAAE;IAMpG,mCAAmC,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,mBAAmB,EAAE;IAMtG,kCAAkC,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,kBAAkB,EAAE;IAMpG,2BAA2B,IAAI,kBAAkB;IAIjD,sBAAsB,CAAC,iBAAiB,EAAE,kBAAkB,GAAG,kBAAkB,GAAG,SAAS;IAY7F,8BAA8B,CAC5B,UAAU,EAAE,kBAAkB,EAC9B,0BAA0B,EAAE,MAAM,GACjC,kBAAkB,EAAE;IAYvB,uBAAuB,CAAC,kBAAkB,GAAE,MAAgC,GAAG,kBAAkB,EAAE;IASnG,gCAAgC,CAAC,kBAAkB,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;IAW5F,kCAAkC,CAAC,kBAAkB,EAAE,MAAM,EAAE,UAAU,SAAI,GAAG,kBAAkB,GAAG,SAAS;IAgB9G,6BAA6B,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS;IAqC7F,+BAA+B,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAe3G,6BAA6B,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAQzG,oCAAoC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,mBAAmB;IAejG,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,kBAAkB,GAAG,mBAAmB;IAcxG,OAAO,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAoE3D,MAAM,CACV,aAAa,GAAE,YAAY,EAA8D,GACxF,OAAO,CAAC,IAAI,CAAC;IA2LhB,SAAS,CAAC,yBAAyB,CACjC,sBAAsB,EAAE,kBAAkB,EAC1C,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EAAE,GACpB,MAAM;CAcV"}