@across-protocol/sdk 4.2.16 → 4.3.1

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

@@ -1,5 +1,5 @@
 import { Infer } from "superstruct";
-import { BigNumber } from "../../../utils";
+import { BigNumber, EvmAddress, RawAddress, SvmAddress } from "../../../utils";
 export declare const SortableEventSS: {
     blockNumber: import("superstruct").Struct<number, null>;
     logIndex: import("superstruct").Struct<number, null>;
@@ -17,23 +17,23 @@ export declare const BundleDataSS: import("superstruct").Struct<{
         toLiteChain: boolean;
         messageHash: string;
         quoteTimestamp: number;
-        depositor: string;
-        recipient: string;
-        inputToken: string;
+        depositor: SvmAddress | EvmAddress | RawAddress;
+        recipient: SvmAddress | EvmAddress | RawAddress;
+        inputToken: SvmAddress | EvmAddress | RawAddress;
         inputAmount: BigNumber;
-        outputToken: string;
+        outputToken: SvmAddress | EvmAddress | RawAddress;
         outputAmount: BigNumber;
         message: string;
         fillDeadline: number;
-        exclusiveRelayer: string;
+        exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
         exclusivityDeadline: number;
         blockNumber: number;
         logIndex: number;
         quoteBlockNumber: number;
-        speedUpSignature?: string | undefined;
-        updatedRecipient?: string | undefined;
+        updatedRecipient?: SvmAddress | EvmAddress | RawAddress | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        speedUpSignature?: string | undefined;
         txnIndex?: number | undefined;
         txnRef?: string | undefined;
         transactionHash?: string | undefined;
@@ -48,22 +48,22 @@ export declare const BundleDataSS: import("superstruct").Struct<{
             repaymentChainId: number;
             messageHash: string;
             quoteTimestamp: number;
-            depositor: string;
-            recipient: string;
-            inputToken: string;
+            depositor: SvmAddress | EvmAddress | RawAddress;
+            recipient: SvmAddress | EvmAddress | RawAddress;
+            inputToken: SvmAddress | EvmAddress | RawAddress;
             inputAmount: BigNumber;
-            outputToken: string;
+            outputToken: SvmAddress | EvmAddress | RawAddress;
             outputAmount: BigNumber;
             fillDeadline: number;
-            exclusiveRelayer: string;
+            exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
             exclusivityDeadline: number;
             blockNumber: number;
             logIndex: number;
-            relayer: string;
+            relayer: SvmAddress | EvmAddress | RawAddress;
             lpFeePct: BigNumber;
             relayExecutionInfo: {
                 fillType: number;
-                updatedRecipient: string;
+                updatedRecipient: SvmAddress | EvmAddress | RawAddress;
                 updatedOutputAmount: BigNumber;
                 updatedMessageHash: string;
                 updatedMessage?: string | undefined;
@@ -86,24 +86,24 @@ export declare const BundleDataSS: import("superstruct").Struct<{
         toLiteChain: boolean;
         messageHash: string;
         quoteTimestamp: number;
-        depositor: string;
-        recipient: string;
-        inputToken: string;
+        depositor: SvmAddress | EvmAddress | RawAddress;
+        recipient: SvmAddress | EvmAddress | RawAddress;
+        inputToken: SvmAddress | EvmAddress | RawAddress;
         inputAmount: BigNumber;
-        outputToken: string;
+        outputToken: SvmAddress | EvmAddress | RawAddress;
         outputAmount: BigNumber;
         message: string;
         fillDeadline: number;
-        exclusiveRelayer: string;
+        exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
         exclusivityDeadline: number;
         blockNumber: number;
         logIndex: number;
         quoteBlockNumber: number;
         lpFeePct: BigNumber;
-        speedUpSignature?: string | undefined;
-        updatedRecipient?: string | undefined;
+        updatedRecipient?: SvmAddress | EvmAddress | RawAddress | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        speedUpSignature?: string | undefined;
         txnIndex?: number | undefined;
         txnRef?: string | undefined;
         transactionHash?: string | undefined;
@@ -118,23 +118,23 @@ export declare const BundleDataSS: import("superstruct").Struct<{
         toLiteChain: boolean;
         messageHash: string;
         quoteTimestamp: number;
-        depositor: string;
-        recipient: string;
-        inputToken: string;
+        depositor: SvmAddress | EvmAddress | RawAddress;
+        recipient: SvmAddress | EvmAddress | RawAddress;
+        inputToken: SvmAddress | EvmAddress | RawAddress;
         inputAmount: BigNumber;
-        outputToken: string;
+        outputToken: SvmAddress | EvmAddress | RawAddress;
         outputAmount: BigNumber;
         message: string;
         fillDeadline: number;
-        exclusiveRelayer: string;
+        exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
         exclusivityDeadline: number;
         blockNumber: number;
         logIndex: number;
         quoteBlockNumber: number;
-        speedUpSignature?: string | undefined;
-        updatedRecipient?: string | undefined;
+        updatedRecipient?: SvmAddress | EvmAddress | RawAddress | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        speedUpSignature?: string | undefined;
         txnIndex?: number | undefined;
         txnRef?: string | undefined;
         transactionHash?: string | undefined;
@@ -149,24 +149,24 @@ export declare const BundleDataSS: import("superstruct").Struct<{
         toLiteChain: boolean;
         messageHash: string;
         quoteTimestamp: number;
-        depositor: string;
-        recipient: string;
-        inputToken: string;
+        depositor: SvmAddress | EvmAddress | RawAddress;
+        recipient: SvmAddress | EvmAddress | RawAddress;
+        inputToken: SvmAddress | EvmAddress | RawAddress;
         inputAmount: BigNumber;
-        outputToken: string;
+        outputToken: SvmAddress | EvmAddress | RawAddress;
         outputAmount: BigNumber;
         message: string;
         fillDeadline: number;
-        exclusiveRelayer: string;
+        exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
         exclusivityDeadline: number;
         blockNumber: number;
         logIndex: number;
         quoteBlockNumber: number;
         lpFeePct: BigNumber;
-        speedUpSignature?: string | undefined;
-        updatedRecipient?: string | undefined;
+        updatedRecipient?: SvmAddress | EvmAddress | RawAddress | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        speedUpSignature?: string | undefined;
         txnIndex?: number | undefined;
         txnRef?: string | undefined;
         transactionHash?: string | undefined;
@@ -182,23 +182,23 @@ export declare const BundleDataSS: import("superstruct").Struct<{
         toLiteChain: boolean;
         messageHash: string;
         quoteTimestamp: number;
-        depositor: string;
-        recipient: string;
-        inputToken: string;
+        depositor: SvmAddress | EvmAddress | RawAddress;
+        recipient: SvmAddress | EvmAddress | RawAddress;
+        inputToken: SvmAddress | EvmAddress | RawAddress;
         inputAmount: BigNumber;
-        outputToken: string;
+        outputToken: SvmAddress | EvmAddress | RawAddress;
         outputAmount: BigNumber;
         message: string;
         fillDeadline: number;
-        exclusiveRelayer: string;
+        exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
         exclusivityDeadline: number;
         blockNumber: number;
         logIndex: number;
         quoteBlockNumber: number;
-        speedUpSignature?: string | undefined;
-        updatedRecipient?: string | undefined;
+        updatedRecipient?: SvmAddress | EvmAddress | RawAddress | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        speedUpSignature?: string | undefined;
         txnIndex?: number | undefined;
         txnRef?: string | undefined;
         transactionHash?: string | undefined;
@@ -213,23 +213,23 @@ export declare const BundleDataSS: import("superstruct").Struct<{
         toLiteChain: boolean;
         messageHash: string;
         quoteTimestamp: number;
-        depositor: string;
-        recipient: string;
-        inputToken: string;
+        depositor: SvmAddress | EvmAddress | RawAddress;
+        recipient: SvmAddress | EvmAddress | RawAddress;
+        inputToken: SvmAddress | EvmAddress | RawAddress;
         inputAmount: BigNumber;
-        outputToken: string;
+        outputToken: SvmAddress | EvmAddress | RawAddress;
         outputAmount: BigNumber;
         message: string;
         fillDeadline: number;
-        exclusiveRelayer: string;
+        exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
         exclusivityDeadline: number;
         blockNumber: number;
         logIndex: number;
         quoteBlockNumber: number;
-        speedUpSignature?: string | undefined;
-        updatedRecipient?: string | undefined;
+        updatedRecipient?: SvmAddress | EvmAddress | RawAddress | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        speedUpSignature?: string | undefined;
         txnIndex?: number | undefined;
         txnRef?: string | undefined;
         transactionHash?: string | undefined;
@@ -244,24 +244,24 @@ export declare const BundleDataSS: import("superstruct").Struct<{
         toLiteChain: boolean;
         messageHash: string;
         quoteTimestamp: number;
-        depositor: string;
-        recipient: string;
-        inputToken: string;
+        depositor: SvmAddress | EvmAddress | RawAddress;
+        recipient: SvmAddress | EvmAddress | RawAddress;
+        inputToken: SvmAddress | EvmAddress | RawAddress;
         inputAmount: BigNumber;
-        outputToken: string;
+        outputToken: SvmAddress | EvmAddress | RawAddress;
         outputAmount: BigNumber;
         message: string;
         fillDeadline: number;
-        exclusiveRelayer: string;
+        exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
         exclusivityDeadline: number;
         blockNumber: number;
         logIndex: number;
         quoteBlockNumber: number;
         lpFeePct: BigNumber;
-        speedUpSignature?: string | undefined;
-        updatedRecipient?: string | undefined;
+        updatedRecipient?: SvmAddress | EvmAddress | RawAddress | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        speedUpSignature?: string | undefined;
         txnIndex?: number | undefined;
         txnRef?: string | undefined;
         transactionHash?: string | undefined;
@@ -276,24 +276,24 @@ export declare const BundleDataSS: import("superstruct").Struct<{
         toLiteChain: boolean;
         messageHash: string;
         quoteTimestamp: number;
-        depositor: string;
-        recipient: string;
-        inputToken: string;
+        depositor: SvmAddress | EvmAddress | RawAddress;
+        recipient: SvmAddress | EvmAddress | RawAddress;
+        inputToken: SvmAddress | EvmAddress | RawAddress;
         inputAmount: BigNumber;
-        outputToken: string;
+        outputToken: SvmAddress | EvmAddress | RawAddress;
         outputAmount: BigNumber;
         message: string;
         fillDeadline: number;
-        exclusiveRelayer: string;
+        exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
         exclusivityDeadline: number;
         blockNumber: number;
         logIndex: number;
         quoteBlockNumber: number;
         lpFeePct: BigNumber;
-        speedUpSignature?: string | undefined;
-        updatedRecipient?: string | undefined;
+        updatedRecipient?: SvmAddress | EvmAddress | RawAddress | undefined;
         updatedOutputAmount?: BigNumber | undefined;
         updatedMessage?: string | undefined;
+        speedUpSignature?: string | undefined;
         txnIndex?: number | undefined;
         txnRef?: string | undefined;
         transactionHash?: string | undefined;
@@ -308,22 +308,22 @@ export declare const BundleDataSS: import("superstruct").Struct<{
             repaymentChainId: number;
             messageHash: string;
             quoteTimestamp: number;
-            depositor: string;
-            recipient: string;
-            inputToken: string;
+            depositor: SvmAddress | EvmAddress | RawAddress;
+            recipient: SvmAddress | EvmAddress | RawAddress;
+            inputToken: SvmAddress | EvmAddress | RawAddress;
             inputAmount: BigNumber;
-            outputToken: string;
+            outputToken: SvmAddress | EvmAddress | RawAddress;
             outputAmount: BigNumber;
             fillDeadline: number;
-            exclusiveRelayer: string;
+            exclusiveRelayer: SvmAddress | EvmAddress | RawAddress;
             exclusivityDeadline: number;
             blockNumber: number;
             logIndex: number;
-            relayer: string;
+            relayer: SvmAddress | EvmAddress | RawAddress;
             lpFeePct: BigNumber;
             relayExecutionInfo: {
                 fillType: number;
-                updatedRecipient: string;
+                updatedRecipient: SvmAddress | EvmAddress | RawAddress;
                 updatedOutputAmount: BigNumber;
                 updatedMessageHash: string;
                 updatedMessage?: string | undefined;

package/dist/esm/clients/BundleDataClient/utils/SuperstructUtils.js

@@ -1,7 +1,7 @@
 import { __assign } from "tslib";
 import { object, number, optional, string, array, record, coerce, instance, pattern, boolean, defaulted, union, type, } from "superstruct";
-import { UNDEFINED_MESSAGE_HASH } from "../../../constants";
-import { BigNumber } from "../../../utils";
+import { CHAIN_IDs, UNDEFINED_MESSAGE_HASH } from "../../../constants";
+import { BigNumber, EvmAddress, RawAddress, SvmAddress, toAddressType } from "../../../utils";
 var PositiveIntegerStringSS = pattern(string(), /\d+/);
 var Web3AddressSS = pattern(string(), /^0x[a-fA-F0-9]{40}$/);
 var BigNumberType = coerce(instance(BigNumber), union([string(), number()]), function (value) {
@@ -15,18 +15,28 @@ var BigNumberType = coerce(instance(BigNumber), union([string(), number()]), fun
         return value;
     }
 });
+// Accept any concrete implementation of `Address` (Evm, Svm, or Raw) but avoid using the
+// abstract `Address` class directly to keep TypeScript happy.
+var AddressInstanceSS = union([instance(EvmAddress), instance(SvmAddress), instance(RawAddress)]);
+var AddressType = coerce(AddressInstanceSS, string(), function (value) {
+    // Addresses are posted to arweave in their native format (base16 for EVM, base58 for SVM). The chainId for
+    // for the event data is not directly available, so infer it based on the shape of the address. RawAddress
+    // will be instantiated if the address format does not match the expected family.
+    var chainId = value.startsWith("0x") ? CHAIN_IDs.MAINNET : CHAIN_IDs.SOLANA;
+    return toAddressType(value, chainId);
+});
 var FillTypeSS = number();
 var V3RelayDataSS = {
-    inputToken: string(),
+    inputToken: AddressType,
     inputAmount: BigNumberType,
-    outputToken: string(),
+    outputToken: AddressType,
     outputAmount: BigNumberType,
     fillDeadline: number(),
-    exclusiveRelayer: string(),
+    exclusiveRelayer: AddressType,
     exclusivityDeadline: number(),
     originChainId: number(),
-    depositor: string(),
-    recipient: string(),
+    depositor: AddressType,
+    recipient: AddressType,
     depositId: BigNumberType,
     message: string(),
 };
@@ -46,7 +56,7 @@ var V3DepositSS = {
     quoteTimestamp: number(),
     relayerFeePct: optional(BigNumberType),
     speedUpSignature: optional(string()),
-    updatedRecipient: optional(string()),
+    updatedRecipient: optional(AddressType),
     updatedOutputAmount: optional(BigNumberType),
     updatedMessage: optional(string()),
 };
@@ -56,11 +66,11 @@ var V3DepositWithBlockLpFeeSS = object(__assign(__assign({}, _V3DepositWithBlock
 var V3RelayExecutionEventInfoSS = object({
     updatedOutputAmount: BigNumberType,
     fillType: FillTypeSS,
-    updatedRecipient: string(),
+    updatedRecipient: AddressType,
     updatedMessage: optional(string()),
     updatedMessageHash: defaulted(string(), UNDEFINED_MESSAGE_HASH),
 });
-var V3FillSS = __assign(__assign({}, V3RelayDataSS), { message: optional(string()), messageHash: defaulted(string(), UNDEFINED_MESSAGE_HASH), destinationChainId: number(), relayer: string(), repaymentChainId: number(), relayExecutionInfo: V3RelayExecutionEventInfoSS, quoteTimestamp: number() });
+var V3FillSS = __assign(__assign({}, V3RelayDataSS), { message: optional(string()), messageHash: defaulted(string(), UNDEFINED_MESSAGE_HASH), destinationChainId: number(), relayer: AddressType, repaymentChainId: number(), relayExecutionInfo: V3RelayExecutionEventInfoSS, quoteTimestamp: number() });
 var V3FillWithBlockSS = __assign(__assign({}, SortableEventSS), V3FillSS);
 var BundleFillV3SS = object(__assign(__assign({}, V3FillWithBlockSS), { lpFeePct: BigNumberType }));
 var nestedV3DepositRecordSS = record(PositiveIntegerStringSS, record(Web3AddressSS, array(V3DepositWithBlockSS)));

package/dist/esm/clients/BundleDataClient/utils/SuperstructUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"SuperstructUtils.js","sourceRoot":"","sources":["../../../../../src/clients/BundleDataClient/utils/SuperstructUtils.ts"],"names":[],"mappings":";AAAA,OAAO,EAEL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACN,KAAK,EACL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,OAAO,EACP,OAAO,EACP,SAAS,EACT,KAAK,EACL,IAAI,GACL,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,IAAM,uBAAuB,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC;AACzD,IAAM,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,qBAAqB,CAAC,CAAC;AAE/D,IAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,UAAC,KAAK;IACnF,IAAI;QACF,+CAA+C;QAC/C,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAC9B;IAAC,OAAO,KAAK,EAAE;QACd,oEAAoE;QACpE,uGAAuG;QACvG,OAAO,KAAK,CAAC;KACd;AACH,CAAC,CAAC,CAAC;AAEH,IAAM,UAAU,GAAG,MAAM,EAAE,CAAC;AAE5B,IAAM,aAAa,GAAG;IACpB,UAAU,EAAE,MAAM,EAAE;IACpB,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,MAAM,EAAE;IACrB,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,MAAM,EAAE;IACtB,gBAAgB,EAAE,MAAM,EAAE;IAC1B,mBAAmB,EAAE,MAAM,EAAE;IAC7B,aAAa,EAAE,MAAM,EAAE;IACvB,SAAS,EAAE,MAAM,EAAE;IACnB,SAAS,EAAE,MAAM,EAAE;IACnB,SAAS,EAAE,aAAa;IACxB,OAAO,EAAE,MAAM,EAAE;CAClB,CAAC;AAEF,MAAM,CAAC,IAAM,eAAe,GAAG;IAC7B,WAAW,EAAE,MAAM,EAAE;IACrB,QAAQ,EAAE,MAAM,EAAE;IAElB,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC1B,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAE5B,eAAe,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IACnC,gBAAgB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,IAAM,WAAW,GAAG;IAClB,WAAW,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC;IACxD,aAAa,EAAE,SAAS,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC;IAC1C,WAAW,EAAE,SAAS,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC;IACxC,kBAAkB,EAAE,MAAM,EAAE;IAC5B,cAAc,EAAE,MAAM,EAAE;IACxB,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IACtC,gBAAgB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IACpC,gBAAgB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IACpC,mBAAmB,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC5C,cAAc,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACnC,CAAC;AAEF,IAAM,qBAAqB,gCACzB,gBAAgB,EAAE,MAAM,EAAE,IACvB,WAAW,GACX,eAAe,GACf,aAAa,CACjB,CAAC;AAEF,IAAM,oBAAoB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAC3D,IAAM,yBAAyB,GAAG,MAAM,uBACnC,qBAAqB,KACxB,QAAQ,EAAE,aAAa,IACvB,CAAC;AAEH,IAAM,2BAA2B,GAAG,MAAM,CAAC;IACzC,mBAAmB,EAAE,aAAa;IAClC,QAAQ,EAAE,UAAU;IACpB,gBAAgB,EAAE,MAAM,EAAE;IAC1B,cAAc,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAClC,kBAAkB,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC;CAChE,CAAC,CAAC;AAEH,IAAM,QAAQ,yBACT,aAAa,KAChB,OAAO,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAC3B,WAAW,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,EACxD,kBAAkB,EAAE,MAAM,EAAE,EAC5B,OAAO,EAAE,MAAM,EAAE,EACjB,gBAAgB,EAAE,MAAM,EAAE,EAC1B,kBAAkB,EAAE,2BAA2B,EAC/C,cAAc,EAAE,MAAM,EAAE,GACzB,CAAC;AAEF,IAAM,iBAAiB,yBAClB,eAAe,GACf,QAAQ,CACZ,CAAC;AAEF,IAAM,cAAc,GAAG,MAAM,uBACxB,iBAAiB,KACpB,QAAQ,EAAE,aAAa,IACvB,CAAC;AAEH,IAAM,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,EAAE,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;AACpH,IAAM,mCAAmC,GAAG,MAAM,CAChD,uBAAuB,EACvB,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC,CACxD,CAAC;AAEF,IAAM,qBAAqB,GAAG,MAAM;AAClC,oBAAoB;AACpB,uBAAuB,EACvB,MAAM,CACJ,aAAa,EACb,MAAM,CAAC;IACL,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,aAAa,CAAC;IACxC,iBAAiB,EAAE,aAAa;IAChC,cAAc,EAAE,aAAa;CAC9B,CAAC,CACH,CACF,CAAC;AAEF,MAAM,CAAC,IAAM,YAAY,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,uBAAuB;IACzC,yBAAyB,EAAE,uBAAuB;IAClD,qBAAqB,EAAE,mCAAmC;IAC1D,iBAAiB,EAAE,mCAAmC;IACtD,aAAa,EAAE,qBAAqB;CACrC,CAAC,CAAC"}
+{"version":3,"file":"SuperstructUtils.js","sourceRoot":"","sources":["../../../../../src/clients/BundleDataClient/utils/SuperstructUtils.ts"],"names":[],"mappings":";AAAA,OAAO,EAEL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,MAAM,EACN,KAAK,EACL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,OAAO,EACP,OAAO,EACP,SAAS,EACT,KAAK,EACL,IAAI,GACL,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,SAAS,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE9F,IAAM,uBAAuB,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC;AACzD,IAAM,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,qBAAqB,CAAC,CAAC;AAE/D,IAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,UAAC,KAAK;IACnF,IAAI;QACF,+CAA+C;QAC/C,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAC9B;IAAC,OAAO,KAAK,EAAE;QACd,oEAAoE;QACpE,uGAAuG;QACvG,OAAO,KAAK,CAAC;KACd;AACH,CAAC,CAAC,CAAC;AAEH,yFAAyF;AACzF,8DAA8D;AAC9D,IAAM,iBAAiB,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AAEpG,IAAM,WAAW,GAAG,MAAM,CAAC,iBAAiB,EAAE,MAAM,EAAE,EAAE,UAAC,KAAK;IAC5D,2GAA2G;IAC3G,0GAA0G;IAC1G,iFAAiF;IACjF,IAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC;IAC9E,OAAO,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACvC,CAAC,CAAC,CAAC;AAEH,IAAM,UAAU,GAAG,MAAM,EAAE,CAAC;AAE5B,IAAM,aAAa,GAAG;IACpB,UAAU,EAAE,WAAW;IACvB,WAAW,EAAE,aAAa;IAC1B,WAAW,EAAE,WAAW;IACxB,YAAY,EAAE,aAAa;IAC3B,YAAY,EAAE,MAAM,EAAE;IACtB,gBAAgB,EAAE,WAAW;IAC7B,mBAAmB,EAAE,MAAM,EAAE;IAC7B,aAAa,EAAE,MAAM,EAAE;IACvB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,aAAa;IACxB,OAAO,EAAE,MAAM,EAAE;CAClB,CAAC;AAEF,MAAM,CAAC,IAAM,eAAe,GAAG;IAC7B,WAAW,EAAE,MAAM,EAAE;IACrB,QAAQ,EAAE,MAAM,EAAE;IAElB,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC1B,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAE5B,eAAe,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IACnC,gBAAgB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACrC,CAAC;AAEF,IAAM,WAAW,GAAG;IAClB,WAAW,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC;IACxD,aAAa,EAAE,SAAS,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC;IAC1C,WAAW,EAAE,SAAS,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC;IACxC,kBAAkB,EAAE,MAAM,EAAE;IAC5B,cAAc,EAAE,MAAM,EAAE;IACxB,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IACtC,gBAAgB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IACpC,gBAAgB,EAAE,QAAQ,CAAC,WAAW,CAAC;IACvC,mBAAmB,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC5C,cAAc,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;CACnC,CAAC;AAEF,IAAM,qBAAqB,gCACzB,gBAAgB,EAAE,MAAM,EAAE,IACvB,WAAW,GACX,eAAe,GACf,aAAa,CACjB,CAAC;AAEF,IAAM,oBAAoB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAC3D,IAAM,yBAAyB,GAAG,MAAM,uBACnC,qBAAqB,KACxB,QAAQ,EAAE,aAAa,IACvB,CAAC;AAEH,IAAM,2BAA2B,GAAG,MAAM,CAAC;IACzC,mBAAmB,EAAE,aAAa;IAClC,QAAQ,EAAE,UAAU;IACpB,gBAAgB,EAAE,WAAW;IAC7B,cAAc,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IAClC,kBAAkB,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC;CAChE,CAAC,CAAC;AAEH,IAAM,QAAQ,yBACT,aAAa,KAChB,OAAO,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,EAC3B,WAAW,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,EACxD,kBAAkB,EAAE,MAAM,EAAE,EAC5B,OAAO,EAAE,WAAW,EACpB,gBAAgB,EAAE,MAAM,EAAE,EAC1B,kBAAkB,EAAE,2BAA2B,EAC/C,cAAc,EAAE,MAAM,EAAE,GACzB,CAAC;AAEF,IAAM,iBAAiB,yBAClB,eAAe,GACf,QAAQ,CACZ,CAAC;AAEF,IAAM,cAAc,GAAG,MAAM,uBACxB,iBAAiB,KACpB,QAAQ,EAAE,aAAa,IACvB,CAAC;AAEH,IAAM,uBAAuB,GAAG,MAAM,CAAC,uBAAuB,EAAE,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;AACpH,IAAM,mCAAmC,GAAG,MAAM,CAChD,uBAAuB,EACvB,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC,CACxD,CAAC;AAEF,IAAM,qBAAqB,GAAG,MAAM;AAClC,oBAAoB;AACpB,uBAAuB,EACvB,MAAM,CACJ,aAAa,EACb,MAAM,CAAC;IACL,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,aAAa,CAAC;IACxC,iBAAiB,EAAE,aAAa;IAChC,cAAc,EAAE,aAAa;CAC9B,CAAC,CACH,CACF,CAAC;AAEF,MAAM,CAAC,IAAM,YAAY,GAAG,IAAI,CAAC;IAC/B,gBAAgB,EAAE,uBAAuB;IACzC,yBAAyB,EAAE,uBAAuB;IAClD,qBAAqB,EAAE,mCAAmC;IAC1D,iBAAiB,EAAE,mCAAmC;IACtD,aAAa,EAAE,qBAAqB;CACrC,CAAC,CAAC"}

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

@@ -1,8 +1,8 @@
 import { Contract, EventFilter } from "ethers";
 import winston from "winston";
-import { CachingMechanismInterface, CancelledRootBundle, CrossChainContractsSet, Deposit, DepositWithBlock, DestinationTokenWithBlock, DisputedRootBundle, ExecutedRootBundle, L1Token, Log, LpToken, PendingRootBundle, ProposedRootBundle, RealizedLpFee, TokenRunningBalance } from "../interfaces";
+import { CachingMechanismInterface, CancelledRootBundle, CrossChainContractsSet, Deposit, DepositWithBlock, DestinationTokenWithBlock, DisputedRootBundle, ExecutedRootBundle, TokenInfo, Log, LpToken, PendingRootBundle, ProposedRootBundle, RealizedLpFee, TokenRunningBalance, L1TokenInfo } from "../interfaces";
 import { EVMBlockFinder } from "../arch/evm";
-import { BigNumber, EventSearchConfig, MakeOptional } from "../utils";
+import { BigNumber, EventSearchConfig, MakeOptional, EvmAddress, Address } from "../utils";
 import { AcrossConfigStoreClient as ConfigStoreClient } from "./AcrossConfigStoreClient/AcrossConfigStoreClient";
 import { BaseAbstractClient, UpdateFailureReason } from "./BaseAbstractClient";
 type HubPoolUpdateSuccess = {
@@ -38,7 +38,7 @@ export declare class HubPoolClient extends BaseAbstractClient {
         timeToCache?: number;
     };
     protected l1TokensToDestinationTokens: L1TokensToDestinationTokens;
-    protected l1Tokens: L1Token[];
+    protected l1Tokens: L1TokenInfo[];
     protected lpTokens: {
         [token: string]: LpToken;
     };
@@ -69,21 +69,21 @@ export declare class HubPoolClient extends BaseAbstractClient {
     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;
-    protected getL1TokenForDeposit(deposit: Pick<DepositWithBlock, "originChainId" | "inputToken" | "quoteBlockNumber">): string;
-    l2TokenEnabledForL1Token(l1Token: string, destinationChainId: number): boolean;
-    l2TokenEnabledForL1TokenAtBlock(l1Token: string, destinationChainId: number, hubBlockNumber: number): boolean;
-    l2TokenHasPoolRebalanceRoute(l2Token: string, l2ChainId: number, hubPoolBlock?: number): boolean;
+    getSpokePoolForBlock(chain: number, block?: number): Address;
+    getSpokePoolActivationBlock(chain: number, spokePool: Address): number | undefined;
+    getL2TokenForL1TokenAtBlock(l1Token: EvmAddress, destinationChainId: number, latestHubBlock?: number): Address;
+    getL1TokenForL2TokenAtBlock(l2Token: Address, destinationChainId: number, latestHubBlock?: number): EvmAddress;
+    protected getL1TokenForDeposit(deposit: Pick<DepositWithBlock, "originChainId" | "inputToken" | "quoteBlockNumber">): EvmAddress;
+    l2TokenEnabledForL1Token(l1Token: EvmAddress, destinationChainId: number): boolean;
+    l2TokenEnabledForL1TokenAtBlock(l1Token: EvmAddress, destinationChainId: number, hubBlockNumber: number): boolean;
+    l2TokenHasPoolRebalanceRoute(l2Token: Address, l2ChainId: number, hubPoolBlock?: number): boolean;
     /**
      * @dev If tokenAddress + chain do not exist in TOKEN_SYMBOLS_MAP then this will throw.
      * @param tokenAddress Token address on `chain`
-     * @param chain Chain where the `tokenAddress` exists in TOKEN_SYMBOLS_MAP.
+     * @param chainId Chain where the `tokenAddress` exists in TOKEN_SYMBOLS_MAP.
      * @returns Token info for the given token address on the L2 chain including symbol and decimal.
      */
-    getTokenInfoForAddress(tokenAddress: string, chain: number): L1Token;
+    getTokenInfoForAddress(tokenAddress: string, chainId: number): TokenInfo;
     /**
      * Resolve a given timestamp to a block number on the HubPool chain.
      * @param timestamp A single timestamp to be resolved to a block number on the HubPool chain.
@@ -100,7 +100,7 @@ export declare class HubPoolClient extends BaseAbstractClient {
     getBlockNumbers(timestamps: number[]): Promise<{
         [quoteTimestamp: number]: number;
     }>;
-    getCurrentPoolUtilization(l1Token: string): Promise<BigNumber>;
+    getCurrentPoolUtilization(l1Token: EvmAddress): Promise<BigNumber>;
     /**
      * For a HubPool token at a specific block number, compute the relevant utilization.
      * @param hubPoolToken HubPool token to query utilization for.
@@ -110,13 +110,13 @@ export declare class HubPoolClient extends BaseAbstractClient {
      * @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>;
+    protected getUtilization(hubPoolToken: EvmAddress, 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;
-    areTokensEquivalent(tokenA: string, chainIdA: number, tokenB: string, chainIdB: number, hubPoolBlock?: number): boolean;
+    getL1Tokens(): L1TokenInfo[];
+    getTokenInfoForL1Token(l1Token: EvmAddress): L1TokenInfo | undefined;
+    getLpTokenInfoForL1Token(l1Token: EvmAddress): LpToken | undefined;
+    areTokensEquivalent(tokenA: Address, chainIdA: number, tokenB: Address, 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;
@@ -142,9 +142,9 @@ export declare class HubPoolClient extends BaseAbstractClient {
     getNthFullyExecutedRootBundle(n: number, startBlock?: number): ProposedRootBundle | undefined;
     getLatestBundleEndBlockForChain(chainIdList: number[], latestMainnetBlock: number, chainId: number): number;
     getNextBundleStartBlockNumber(chainIdList: number[], latestMainnetBlock: number, chainId: number): number;
-    getLatestExecutedRootBundleContainingL1Token(block: number, chain: number, l1Token: string): ExecutedRootBundle | undefined;
-    getRunningBalanceBeforeBlockForChain(block: number, chain: number, l1Token: string): TokenRunningBalance;
-    getRunningBalanceForToken(l1Token: string, executedRootBundle: ExecutedRootBundle | undefined): TokenRunningBalance;
+    getLatestExecutedRootBundleContainingL1Token(block: number, chain: number, l1Token: EvmAddress): ExecutedRootBundle | undefined;
+    getRunningBalanceBeforeBlockForChain(block: number, chain: number, l1Token: EvmAddress): TokenRunningBalance;
+    getRunningBalanceForToken(l1Token: EvmAddress, executedRootBundle: ExecutedRootBundle | undefined): TokenRunningBalance;
     _update(eventNames: HubPoolEvent[]): Promise<HubPoolUpdate>;
     update(eventsToQuery?: HubPoolEvent[]): Promise<void>;
     protected getBundleEndBlockForChain(proposeRootBundleEvent: ProposedRootBundle, chainId: number, chainIdList: number[]): number;