@across-protocol/sdk 4.1.63-alpha.1 → 4.1.63-beta.0

package/dist/esm/clients/BundleDataClient/utils/SuperstructUtils.d.ts

@@ -10,61 +10,61 @@ export declare const SortableEventSS: {
 };
 export declare const BundleDataSS: import("superstruct").Struct<{
     bundleDepositsV3: Record<string, Record<string, {
-        blockNumber: number;
-        logIndex: number;
+        depositId: BigNumber;
         message: string;
-        originChainId: number;
-        inputToken: string;
-        inputAmount: BigNumber;
-        quoteTimestamp: number;
         messageHash: string;
         destinationChainId: number;
+        quoteTimestamp: number;
         fromLiteChain: boolean;
         toLiteChain: boolean;
+        originChainId: number;
         depositor: string;
         recipient: string;
-        depositId: BigNumber;
+        inputToken: string;
+        inputAmount: BigNumber;
         outputToken: string;
         outputAmount: BigNumber;
         fillDeadline: number;
         exclusiveRelayer: string;
         exclusivityDeadline: number;
+        blockNumber: number;
+        logIndex: number;
         quoteBlockNumber: number;
-        txnIndex?: number | undefined;
-        txnRef?: string | undefined;
         speedUpSignature?: string | undefined;
         updatedRecipient?: string | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        txnIndex?: number | undefined;
+        txnRef?: string | undefined;
         transactionHash?: string | undefined;
         transactionIndex?: number | undefined;
         relayerFeePct?: BigNumber | undefined;
     }[]>>;
     bundleFillsV3: Record<string, Record<string, {
         fills: {
-            blockNumber: number;
-            logIndex: number;
-            originChainId: number;
-            inputToken: string;
-            inputAmount: BigNumber;
-            quoteTimestamp: number;
+            depositId: BigNumber;
             messageHash: string;
             destinationChainId: number;
+            quoteTimestamp: number;
+            originChainId: number;
             depositor: string;
             recipient: string;
-            depositId: BigNumber;
+            inputToken: string;
+            inputAmount: BigNumber;
             outputToken: string;
             outputAmount: BigNumber;
             fillDeadline: number;
             exclusiveRelayer: string;
             exclusivityDeadline: number;
-            relayer: string;
             repaymentChainId: number;
+            blockNumber: number;
+            logIndex: number;
+            relayer: string;
             lpFeePct: BigNumber;
             relayExecutionInfo: {
+                fillType: number;
                 updatedRecipient: string;
                 updatedOutputAmount: BigNumber;
-                fillType: number;
                 updatedMessageHash: string;
                 updatedMessage?: string | undefined;
             };
@@ -79,252 +79,252 @@ export declare const BundleDataSS: import("superstruct").Struct<{
         totalRefundAmount: BigNumber;
     }>>;
     bundleSlowFillsV3: Record<string, Record<string, {
-        blockNumber: number;
-        logIndex: number;
+        depositId: BigNumber;
         message: string;
-        originChainId: number;
-        inputToken: string;
-        inputAmount: BigNumber;
-        quoteTimestamp: number;
         messageHash: string;
         destinationChainId: number;
+        quoteTimestamp: number;
         fromLiteChain: boolean;
         toLiteChain: boolean;
+        originChainId: number;
         depositor: string;
         recipient: string;
-        depositId: BigNumber;
+        inputToken: string;
+        inputAmount: BigNumber;
         outputToken: string;
         outputAmount: BigNumber;
         fillDeadline: number;
         exclusiveRelayer: string;
         exclusivityDeadline: number;
+        blockNumber: number;
+        logIndex: number;
         quoteBlockNumber: number;
         lpFeePct: BigNumber;
-        txnIndex?: number | undefined;
-        txnRef?: string | undefined;
         speedUpSignature?: string | undefined;
         updatedRecipient?: string | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        txnIndex?: number | undefined;
+        txnRef?: string | undefined;
         transactionHash?: string | undefined;
         transactionIndex?: number | undefined;
         relayerFeePct?: BigNumber | undefined;
     }[]>>;
     expiredDepositsToRefundV3: Record<string, Record<string, {
-        blockNumber: number;
-        logIndex: number;
+        depositId: BigNumber;
         message: string;
-        originChainId: number;
-        inputToken: string;
-        inputAmount: BigNumber;
-        quoteTimestamp: number;
         messageHash: string;
         destinationChainId: number;
+        quoteTimestamp: number;
         fromLiteChain: boolean;
         toLiteChain: boolean;
+        originChainId: number;
         depositor: string;
         recipient: string;
-        depositId: BigNumber;
+        inputToken: string;
+        inputAmount: BigNumber;
         outputToken: string;
         outputAmount: BigNumber;
         fillDeadline: number;
         exclusiveRelayer: string;
         exclusivityDeadline: number;
+        blockNumber: number;
+        logIndex: number;
         quoteBlockNumber: number;
-        txnIndex?: number | undefined;
-        txnRef?: string | undefined;
         speedUpSignature?: string | undefined;
         updatedRecipient?: string | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        txnIndex?: number | undefined;
+        txnRef?: string | undefined;
         transactionHash?: string | undefined;
         transactionIndex?: number | undefined;
         relayerFeePct?: BigNumber | undefined;
     }[]>>;
     unexecutableSlowFills: Record<string, Record<string, {
-        blockNumber: number;
-        logIndex: number;
+        depositId: BigNumber;
         message: string;
-        originChainId: number;
-        inputToken: string;
-        inputAmount: BigNumber;
-        quoteTimestamp: number;
         messageHash: string;
         destinationChainId: number;
+        quoteTimestamp: number;
         fromLiteChain: boolean;
         toLiteChain: boolean;
+        originChainId: number;
         depositor: string;
         recipient: string;
-        depositId: BigNumber;
+        inputToken: string;
+        inputAmount: BigNumber;
         outputToken: string;
         outputAmount: BigNumber;
         fillDeadline: number;
         exclusiveRelayer: string;
         exclusivityDeadline: number;
+        blockNumber: number;
+        logIndex: number;
         quoteBlockNumber: number;
         lpFeePct: BigNumber;
-        txnIndex?: number | undefined;
-        txnRef?: string | undefined;
         speedUpSignature?: string | undefined;
         updatedRecipient?: string | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        txnIndex?: number | undefined;
+        txnRef?: string | undefined;
         transactionHash?: string | undefined;
         transactionIndex?: number | undefined;
         relayerFeePct?: BigNumber | undefined;
     }[]>>;
 }, {
     bundleDepositsV3: import("superstruct").Struct<Record<string, Record<string, {
-        blockNumber: number;
-        logIndex: number;
+        depositId: BigNumber;
         message: string;
-        originChainId: number;
-        inputToken: string;
-        inputAmount: BigNumber;
-        quoteTimestamp: number;
         messageHash: string;
         destinationChainId: number;
+        quoteTimestamp: number;
         fromLiteChain: boolean;
         toLiteChain: boolean;
+        originChainId: number;
         depositor: string;
         recipient: string;
-        depositId: BigNumber;
+        inputToken: string;
+        inputAmount: BigNumber;
         outputToken: string;
         outputAmount: BigNumber;
         fillDeadline: number;
         exclusiveRelayer: string;
         exclusivityDeadline: number;
+        blockNumber: number;
+        logIndex: number;
         quoteBlockNumber: number;
-        txnIndex?: number | undefined;
-        txnRef?: string | undefined;
         speedUpSignature?: string | undefined;
         updatedRecipient?: string | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        txnIndex?: number | undefined;
+        txnRef?: string | undefined;
         transactionHash?: string | undefined;
         transactionIndex?: number | undefined;
         relayerFeePct?: BigNumber | undefined;
     }[]>>, null>;
     expiredDepositsToRefundV3: import("superstruct").Struct<Record<string, Record<string, {
-        blockNumber: number;
-        logIndex: number;
+        depositId: BigNumber;
         message: string;
-        originChainId: number;
-        inputToken: string;
-        inputAmount: BigNumber;
-        quoteTimestamp: number;
         messageHash: string;
         destinationChainId: number;
+        quoteTimestamp: number;
         fromLiteChain: boolean;
         toLiteChain: boolean;
+        originChainId: number;
         depositor: string;
         recipient: string;
-        depositId: BigNumber;
+        inputToken: string;
+        inputAmount: BigNumber;
         outputToken: string;
         outputAmount: BigNumber;
         fillDeadline: number;
         exclusiveRelayer: string;
         exclusivityDeadline: number;
+        blockNumber: number;
+        logIndex: number;
         quoteBlockNumber: number;
-        txnIndex?: number | undefined;
-        txnRef?: string | undefined;
         speedUpSignature?: string | undefined;
         updatedRecipient?: string | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        txnIndex?: number | undefined;
+        txnRef?: string | undefined;
         transactionHash?: string | undefined;
         transactionIndex?: number | undefined;
         relayerFeePct?: BigNumber | undefined;
     }[]>>, null>;
     unexecutableSlowFills: import("superstruct").Struct<Record<string, Record<string, {
-        blockNumber: number;
-        logIndex: number;
+        depositId: BigNumber;
         message: string;
-        originChainId: number;
-        inputToken: string;
-        inputAmount: BigNumber;
-        quoteTimestamp: number;
         messageHash: string;
         destinationChainId: number;
+        quoteTimestamp: number;
         fromLiteChain: boolean;
         toLiteChain: boolean;
+        originChainId: number;
         depositor: string;
         recipient: string;
-        depositId: BigNumber;
+        inputToken: string;
+        inputAmount: BigNumber;
         outputToken: string;
         outputAmount: BigNumber;
         fillDeadline: number;
         exclusiveRelayer: string;
         exclusivityDeadline: number;
+        blockNumber: number;
+        logIndex: number;
         quoteBlockNumber: number;
         lpFeePct: BigNumber;
-        txnIndex?: number | undefined;
-        txnRef?: string | undefined;
         speedUpSignature?: string | undefined;
         updatedRecipient?: string | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        txnIndex?: number | undefined;
+        txnRef?: string | undefined;
         transactionHash?: string | undefined;
         transactionIndex?: number | undefined;
         relayerFeePct?: BigNumber | undefined;
     }[]>>, null>;
     bundleSlowFillsV3: import("superstruct").Struct<Record<string, Record<string, {
-        blockNumber: number;
-        logIndex: number;
+        depositId: BigNumber;
         message: string;
-        originChainId: number;
-        inputToken: string;
-        inputAmount: BigNumber;
-        quoteTimestamp: number;
         messageHash: string;
         destinationChainId: number;
+        quoteTimestamp: number;
         fromLiteChain: boolean;
         toLiteChain: boolean;
+        originChainId: number;
         depositor: string;
         recipient: string;
-        depositId: BigNumber;
+        inputToken: string;
+        inputAmount: BigNumber;
         outputToken: string;
         outputAmount: BigNumber;
         fillDeadline: number;
         exclusiveRelayer: string;
         exclusivityDeadline: number;
+        blockNumber: number;
+        logIndex: number;
         quoteBlockNumber: number;
         lpFeePct: BigNumber;
-        txnIndex?: number | undefined;
-        txnRef?: string | undefined;
         speedUpSignature?: string | undefined;
         updatedRecipient?: string | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        txnIndex?: number | undefined;
+        txnRef?: string | undefined;
         transactionHash?: string | undefined;
         transactionIndex?: number | undefined;
         relayerFeePct?: BigNumber | undefined;
     }[]>>, null>;
     bundleFillsV3: import("superstruct").Struct<Record<string, Record<string, {
         fills: {
-            blockNumber: number;
-            logIndex: number;
-            originChainId: number;
-            inputToken: string;
-            inputAmount: BigNumber;
-            quoteTimestamp: number;
+            depositId: BigNumber;
             messageHash: string;
             destinationChainId: number;
+            quoteTimestamp: number;
+            originChainId: number;
             depositor: string;
             recipient: string;
-            depositId: BigNumber;
+            inputToken: string;
+            inputAmount: BigNumber;
             outputToken: string;
             outputAmount: BigNumber;
             fillDeadline: number;
             exclusiveRelayer: string;
             exclusivityDeadline: number;
-            relayer: string;
             repaymentChainId: number;
+            blockNumber: number;
+            logIndex: number;
+            relayer: string;
             lpFeePct: BigNumber;
             relayExecutionInfo: {
+                fillType: number;
                 updatedRecipient: string;
                 updatedOutputAmount: BigNumber;
-                fillType: number;
                 updatedMessageHash: string;
                 updatedMessage?: string | undefined;
             };

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

@@ -56,7 +56,7 @@ export declare class HubPoolClient extends BaseAbstractClient {
     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?: {
+    constructor(logger: winston.Logger, hubPool: Contract, configStoreClient: ConfigStoreClient, deploymentBlock?: number, chainId?: number, eventSearchConfig?: MakeOptional<EventSearchConfig, "to">, configOverride?: {
         ignoredHubExecutedBundles: number[];
         ignoredHubProposedBundles: number[];
         timeToCache?: number;

package/dist/esm/clients/HubPoolClient.js

@@ -10,7 +10,7 @@ var HubPoolClient = /** @class */ (function (_super) {
     function HubPoolClient(logger, hubPool, configStoreClient, deploymentBlock, chainId, eventSearchConfig, configOverride, cachingMechanism) {
         if (deploymentBlock === void 0) { deploymentBlock = 0; }
         if (chainId === void 0) { chainId = 1; }
-        if (eventSearchConfig === void 0) { eventSearchConfig = { fromBlock: 0, maxBlockLookBack: 0 }; }
+        if (eventSearchConfig === void 0) { eventSearchConfig = { from: 0, maxLookBack: 0 }; }
         if (configOverride === void 0) { configOverride = {
             ignoredHubExecutedBundles: [],
             ignoredHubProposedBundles: [],
@@ -32,8 +32,8 @@ var HubPoolClient = /** @class */ (function (_super) {
         _this.executedRootBundles = [];
         _this.crossChainContracts = {};
         _this.l1TokensToDestinationTokensWithBlock = {};
-        _this.latestBlockSearched = Math.min(deploymentBlock - 1, 0);
-        _this.firstBlockToSearch = eventSearchConfig.fromBlock;
+        _this.latestHeightSearched = Math.min(deploymentBlock - 1, 0);
+        _this.firstHeightToSearch = eventSearchConfig.from;
         var provider = _this.hubPool.provider;
         _this.blockFinder = new BlockFinder(provider);
         return _this;
@@ -145,7 +145,7 @@ var HubPoolClient = /** @class */ (function (_super) {
         return l2Token !== undefined;
     };
     HubPoolClient.prototype.l2TokenHasPoolRebalanceRoute = function (l2Token, l2ChainId, hubPoolBlock) {
-        if (hubPoolBlock === void 0) { hubPoolBlock = this.latestBlockSearched; }
+        if (hubPoolBlock === void 0) { hubPoolBlock = this.latestHeightSearched; }
         return Object.values(this.l1TokensToDestinationTokensWithBlock).some(function (destinationTokenMapping) {
             return Object.entries(destinationTokenMapping).some(function (_a) {
                 var _l2ChainId = _a[0], setPoolRebalanceRouteEvents = _a[1];
@@ -223,7 +223,7 @@ var HubPoolClient = /** @class */ (function (_super) {
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
-                        if (!((_a = this.latestBlockSearched) !== null && _a !== void 0)) return [3 /*break*/, 1];
+                        if (!((_a = this.latestHeightSearched) !== null && _a !== void 0)) return [3 /*break*/, 1];
                         _b = _a;
                         return [3 /*break*/, 3];
                     case 1: return [4 /*yield*/, this.hubPool.provider.getBlockNumber()];
@@ -459,7 +459,7 @@ var HubPoolClient = /** @class */ (function (_super) {
         return this.lpTokens[l1Token];
     };
     HubPoolClient.prototype.areTokensEquivalent = function (tokenA, chainIdA, tokenB, chainIdB, hubPoolBlock) {
-        if (hubPoolBlock === void 0) { hubPoolBlock = this.latestBlockSearched; }
+        if (hubPoolBlock === void 0) { hubPoolBlock = this.latestHeightSearched; }
         if (!this.l2TokenHasPoolRebalanceRoute(tokenA, chainIdA, hubPoolBlock) ||
             !this.l2TokenHasPoolRebalanceRoute(tokenB, chainIdB, hubPoolBlock)) {
             return false;
@@ -609,14 +609,14 @@ var HubPoolClient = /** @class */ (function (_super) {
         if (n === 0) {
             throw new Error("n cannot be 0");
         }
-        if (!this.latestBlockSearched) {
+        if (!this.latestHeightSearched) {
             throw new Error("HubPoolClient::getNthFullyExecutedRootBundle client not updated");
         }
         var bundleToReturn;
         // If n is negative, then return the Nth latest executed bundle, otherwise return the Nth earliest
         // executed bundle.
         if (n < 0) {
-            var nextLatestMainnetBlock = startBlock !== null && startBlock !== void 0 ? startBlock : this.latestBlockSearched;
+            var nextLatestMainnetBlock = startBlock !== null && startBlock !== void 0 ? startBlock : this.latestHeightSearched;
             for (var i = 0; i < Math.abs(n); i++) {
                 bundleToReturn = this.getLatestFullyExecutedRootBundle(nextLatestMainnetBlock);
                 var bundleBlockNumber = bundleToReturn ? bundleToReturn.blockNumber : 0;
@@ -628,11 +628,11 @@ var HubPoolClient = /** @class */ (function (_super) {
         else {
             var nextStartBlock = startBlock !== null && startBlock !== void 0 ? startBlock : 0;
             for (var i = 0; i < n; i++) {
-                bundleToReturn = this.getEarliestFullyExecutedRootBundle(this.latestBlockSearched, nextStartBlock);
+                bundleToReturn = this.getEarliestFullyExecutedRootBundle(this.latestHeightSearched, nextStartBlock);
                 var bundleBlockNumber = bundleToReturn ? bundleToReturn.blockNumber : 0;
                 // Add 1 so that next `getEarliestFullyExecutedRootBundle` call filters out the root bundle we just found
                 // because its block number is < nextStartBlock.
-                nextStartBlock = Math.min(bundleBlockNumber + 1, this.latestBlockSearched);
+                nextStartBlock = Math.min(bundleBlockNumber + 1, this.latestHeightSearched);
             }
         }
         return bundleToReturn;
@@ -701,7 +701,7 @@ var HubPoolClient = /** @class */ (function (_super) {
                             // instantiation. However, certain events generally must be queried back to HubPool genesis.
                             var overrideEvents = ["CrossChainContractsSet", "L1TokenEnabledForLiquidityProvision", "SetPoolRebalanceRoute"];
                             if (overrideEvents.includes(eventName) && !_this.isUpdated) {
-                                _searchConfig.fromBlock = _this.deploymentBlock;
+                                _searchConfig.from = _this.deploymentBlock;
                             }
                             return {
                                 eventName: eventName,
@@ -721,7 +721,7 @@ var HubPoolClient = /** @class */ (function (_super) {
                         hubPool = this.hubPool;
                         multicallFunctions = ["getCurrentTime", "rootBundleProposal"];
                         return [4 /*yield*/, Promise.all(__spreadArray([
-                                hubPool.callStatic.multicall(multicallFunctions.map(function (f) { return hubPool.interface.encodeFunctionData(f); }), { blockTag: searchConfig.toBlock })
+                                hubPool.callStatic.multicall(multicallFunctions.map(function (f) { return hubPool.interface.encodeFunctionData(f); }), { blockTag: searchConfig.to })
                             ], eventSearchConfigs.map(function (config) { return paginatedEventQuery(hubPool, config.filter, config.searchConfig); }), true))];
                     case 2:
                         _a = _c.sent(), multicallOutput = _a[0], events = _a.slice(1);
@@ -738,7 +738,7 @@ var HubPoolClient = /** @class */ (function (_super) {
                                 success: true,
                                 currentTime: currentTime,
                                 pendingRootBundleProposal: pendingRootBundleProposal,
-                                searchEndBlock: searchConfig.toBlock,
+                                searchEndBlock: searchConfig.to,
                                 events: _events,
                             }];
                 }
@@ -933,9 +933,9 @@ var HubPoolClient = /** @class */ (function (_super) {
                             }
                         }
                         this.currentTime = currentTime;
-                        this.latestBlockSearched = searchEndBlock;
-                        this.firstBlockToSearch = update.searchEndBlock + 1; // Next iteration should start off from where this one ended.
-                        this.eventSearchConfig.toBlock = undefined; // Caller can re-set on subsequent updates if necessary.
+                        this.latestHeightSearched = searchEndBlock;
+                        this.firstHeightToSearch = update.searchEndBlock + 1; // Next iteration should start off from where this one ended.
+                        this.eventSearchConfig.to = undefined; // Caller can re-set on subsequent updates if necessary.
                         this.isUpdated = true;
                         this.logger.debug({ at: "HubPoolClient::update", message: "HubPool client updated!", searchEndBlock: searchEndBlock });
                         return [2 /*return*/];