@across-protocol/sdk 4.2.16-alpha.5 → 4.2.16

package/src/interfaces/HubPool.ts

@@ -1,4 +1,4 @@
-import { Address, BigNumber, EvmAddress } from "../utils";
+import { BigNumber } from "../utils";
 import { SortableEvent } from "./Common";
 
 export interface PoolRebalanceLeaf {
@@ -8,7 +8,7 @@ export interface PoolRebalanceLeaf {
   netSendAmounts: BigNumber[];
   runningBalances: BigNumber[];
   leafId: number;
-  l1Tokens: EvmAddress[];
+  l1Tokens: string[];
 }
 
 export interface RelayerRefundLeaf {
@@ -16,8 +16,8 @@ export interface RelayerRefundLeaf {
   chainId: number;
   refundAmounts: BigNumber[];
   leafId: number;
-  l2TokenAddress: Address;
-  refundAddresses: Address[];
+  l2TokenAddress: string;
+  refundAddresses: string[];
 }
 
 export interface ProposedRootBundle extends SortableEvent {
@@ -27,7 +27,7 @@ export interface ProposedRootBundle extends SortableEvent {
   poolRebalanceRoot: string;
   relayerRefundRoot: string;
   slowRelayRoot: string;
-  proposer: EvmAddress;
+  proposer: string;
 }
 
 export type RealizedLpFee = {
@@ -55,7 +55,7 @@ export interface ExecutedRootBundle extends SortableEvent {
   netSendAmounts: BigNumber[];
   runningBalances: BigNumber[];
   leafId: number;
-  l1Tokens: EvmAddress[];
+  l1Tokens: string[];
   proof: string[];
 }
 
@@ -76,14 +76,8 @@ export interface RelayerRefundLeafWithGroup extends RelayerRefundLeaf {
   groupIndex: number;
 }
 
-export interface L1TokenInfo {
-  address: EvmAddress;
-  symbol: string;
-  decimals: number;
-}
-
-export interface TokenInfo {
-  address: Address;
+export interface L1Token {
+  address: string;
   symbol: string;
   decimals: number;
 }
@@ -93,30 +87,27 @@ export interface LpToken {
   liquidReserves: BigNumber;
 }
 
-// TODO: I think I don't change string -> Address in the Events. I change right after the event is read
 export interface CrossChainContractsSet extends SortableEvent {
   l2ChainId: number;
-  spokePool: Address;
+  spokePool: string;
 }
 
-// TODO: I think I don't change string -> Address in the Events. I change right after the event is read
 export interface DestinationTokenWithBlock extends SortableEvent {
-  l2Token: Address;
-  l1Token: EvmAddress;
+  l2Token: string;
+  l1Token: string;
 }
 
-// TODO: I think I don't change string -> Address in the Events. I change right after the event is read
 export interface SetPoolRebalanceRoot extends SortableEvent {
   destinationChainId: number;
-  l1Token: EvmAddress;
-  destinationToken: Address;
+  l1Token: string;
+  destinationToken: string;
 }
 
 export interface PendingRootBundle {
   poolRebalanceRoot: string;
   relayerRefundRoot: string;
   slowRelayRoot: string;
-  proposer: EvmAddress;
+  proposer: string;
   unclaimedPoolRebalanceLeafCount: number;
   challengePeriodEndTimestamp: number;
   bundleEvaluationBlockNumbers: number[];

package/src/interfaces/SpokePool.ts

@@ -1,20 +1,20 @@
 import { SortableEvent } from "./Common";
 import { SpokePoolClient } from "../clients";
-import { BigNumber, Address, EvmAddress } from "../utils";
+import { BigNumber } from "../utils";
 import { RelayerRefundLeaf } from "./HubPool";
 
 export interface RelayData {
   originChainId: number;
-  depositor: Address;
-  recipient: Address;
+  depositor: string;
+  recipient: string;
   depositId: BigNumber;
-  inputToken: Address;
+  inputToken: string;
   inputAmount: BigNumber;
-  outputToken: Address;
+  outputToken: string;
   outputAmount: BigNumber;
   message: string;
   fillDeadline: number;
-  exclusiveRelayer: Address;
+  exclusiveRelayer: string;
   exclusivityDeadline: number;
 }
 
@@ -23,7 +23,7 @@ export interface Deposit extends RelayData {
   destinationChainId: number;
   quoteTimestamp: number;
   speedUpSignature?: string;
-  updatedRecipient?: Address;
+  updatedRecipient?: string;
   updatedOutputAmount?: BigNumber;
   updatedMessage?: string;
   fromLiteChain: boolean;
@@ -51,7 +51,7 @@ export enum FillType {
 }
 
 export interface RelayExecutionEventInfo {
-  updatedRecipient: Address;
+  updatedRecipient: string;
   updatedOutputAmount: BigNumber;
   updatedMessage?: string;
   updatedMessageHash: string;
@@ -61,7 +61,7 @@ export interface RelayExecutionEventInfo {
 export interface Fill extends Omit<RelayData, "message"> {
   messageHash: string;
   destinationChainId: number;
-  relayer: Address;
+  relayer: string;
   repaymentChainId: number;
   relayExecutionInfo: RelayExecutionEventInfo;
 }
@@ -72,18 +72,18 @@ export interface FillWithTime extends Fill, SortableEvent {
 }
 
 export interface EnabledDepositRoute {
-  originToken: Address;
+  originToken: string;
   destinationChainId: number;
   enabled: boolean;
 }
 
 export interface EnabledDepositRouteWithBlock extends EnabledDepositRoute, SortableEvent {}
 export interface SpeedUp {
-  depositor: EvmAddress;
+  depositor: string;
   depositorSignature: string;
   depositId: BigNumber;
   originChainId: number;
-  updatedRecipient: Address;
+  updatedRecipient: string;
   updatedOutputAmount: BigNumber;
   updatedMessage: string;
 }
@@ -130,7 +130,7 @@ export interface TokensBridged extends SortableEvent {
   amountToReturn: BigNumber;
   chainId: number;
   leafId: number;
-  l2TokenAddress: Address;
+  l2TokenAddress: string;
 }
 
 export interface ClaimedRelayerRefundWithBlock extends SortableEvent {

package/src/relayFeeCalculator/chain-queries/baseQuery.ts

@@ -9,15 +9,12 @@ import { SpokePool, SpokePool__factory } from "../../typechain";
 import { populateV3Relay } from "../../arch/evm";
 import {
   BigNumberish,
-  EvmAddress,
   TransactionCostEstimate,
   BigNumber,
   toBNWei,
   bnZero,
   chainIsOPStack,
   fixedPointAdjustment,
-  toAddressType,
-  Address,
 } from "../../utils";
 import assert from "assert";
 import { Logger, QueryInterface, getDefaultSimulatedRelayerAddress } from "../relayFeeCalculator";
@@ -75,7 +72,7 @@ export class QueryBase implements QueryInterface {
    */
   async getGasCosts(
     deposit: Omit<Deposit, "messageHash">,
-    relayer = toAddressType(getDefaultSimulatedRelayerAddress(deposit.destinationChainId), deposit.destinationChainId),
+    relayer = getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
     options: Partial<{
       gasPrice: BigNumberish;
       gasUnits: BigNumberish;
@@ -94,12 +91,7 @@ export class QueryBase implements QueryInterface {
       transport,
     } = options;
 
-    const { recipient, outputToken, exclusiveRelayer } = deposit;
-    assert(recipient.isEVM(), `getGasCosts: recipient not an EVM address (${recipient})`);
-    assert(outputToken.isEVM(), `getGasCosts: outputToken not an EVM address (${outputToken})`);
-    assert(exclusiveRelayer.isEVM(), `getGasCosts: exclusiveRelayer not an EVM address (${exclusiveRelayer})`);
-
-    const tx = await this.getUnsignedTxFromDeposit({ ...deposit, recipient, outputToken, exclusiveRelayer }, relayer);
+    const tx = await this.getUnsignedTxFromDeposit(deposit, relayer);
     const {
       nativeGasCost,
       tokenGasCost,
@@ -129,12 +121,8 @@ export class QueryBase implements QueryInterface {
    * @returns PopulatedTransaction
    */
   getUnsignedTxFromDeposit(
-    deposit: Omit<Deposit, "messageHash"> & {
-      recipient: EvmAddress;
-      outputToken: EvmAddress;
-      exclusiveRelayer: EvmAddress;
-    },
-    relayer = toAddressType(getDefaultSimulatedRelayerAddress(deposit.destinationChainId), deposit.destinationChainId)
+    deposit: Omit<Deposit, "messageHash">,
+    relayer = getDefaultSimulatedRelayerAddress(deposit.destinationChainId)
   ): Promise<PopulatedTransaction> {
     return populateV3Relay(this.spokePool, deposit, relayer);
   }
@@ -147,18 +135,10 @@ export class QueryBase implements QueryInterface {
    */
   async getNativeGasCost(
     deposit: Omit<Deposit, "messageHash">,
-    relayer = toAddressType(getDefaultSimulatedRelayerAddress(deposit.destinationChainId), deposit.destinationChainId)
+    relayer = getDefaultSimulatedRelayerAddress(deposit.destinationChainId)
   ): Promise<BigNumber> {
-    const { recipient, outputToken, exclusiveRelayer } = deposit;
-    assert(recipient.isEVM(), `getNativeGasCost: recipient not an EVM address (${recipient})`);
-    assert(outputToken.isEVM(), `getNativeGasCost: outputToken not an EVM address (${outputToken})`);
-    assert(exclusiveRelayer.isEVM(), `getNativeGasCost: exclusiveRelayer not an EVM address (${exclusiveRelayer})`);
-
-    const unsignedTx = await this.getUnsignedTxFromDeposit(
-      { ...deposit, recipient, outputToken, exclusiveRelayer },
-      relayer
-    );
-    const voidSigner = new VoidSigner(relayer.toEvmAddress(), this.provider);
+    const unsignedTx = await this.getUnsignedTxFromDeposit(deposit, relayer);
+    const voidSigner = new VoidSigner(relayer, this.provider);
     return voidSigner.estimateGas(unsignedTx);
   }
 
@@ -172,7 +152,7 @@ export class QueryBase implements QueryInterface {
    */
   async getOpStackL1DataFee(
     unsignedTx: PopulatedTransaction,
-    relayer = toAddressType(getDefaultSimulatedRelayerAddress(unsignedTx.chainId), CHAIN_IDs.MAINNET),
+    relayer = getDefaultSimulatedRelayerAddress(unsignedTx.chainId),
     options: Partial<{
       opStackL2GasUnits: BigNumberish;
       opStackL1DataFeeMultiplier: BigNumber;
@@ -181,7 +161,7 @@ export class QueryBase implements QueryInterface {
     const { opStackL2GasUnits, opStackL1DataFeeMultiplier = toBNWei("1") } = options || {};
     const { chainId } = await this.provider.getNetwork();
     assert(isOptimismL2Provider(this.provider), `Unexpected provider for chain ID ${chainId}.`);
-    const voidSigner = new VoidSigner(relayer.toEvmAddress(), this.provider);
+    const voidSigner = new VoidSigner(relayer, this.provider);
     const populatedTransaction = await voidSigner.populateTransaction({
       ...unsignedTx,
       gasLimit: opStackL2GasUnits, // prevents additional gas estimation call
@@ -203,7 +183,7 @@ export class QueryBase implements QueryInterface {
    */
   async estimateGas(
     unsignedTx: PopulatedTransaction,
-    senderAddress: Address,
+    senderAddress: string,
     provider: providers.Provider | L2Provider<providers.Provider>,
     options: Partial<{
       gasPrice: BigNumberish;
@@ -224,7 +204,7 @@ export class QueryBase implements QueryInterface {
     } = options || {};
 
     const { chainId } = await provider.getNetwork();
-    const voidSigner = new VoidSigner(senderAddress.toEvmAddress(), provider);
+    const voidSigner = new VoidSigner(senderAddress, provider);
 
     // Estimate the Gas units required to submit this transaction.
     const queries = [

package/src/relayFeeCalculator/chain-queries/svmQuery.ts

@@ -1,4 +1,3 @@
-import assert from "assert";
 import { SvmSpokeClient } from "@across-protocol/contracts";
 import { intToU8Array32 } from "@across-protocol/contracts/dist/src/svm/web3-v1/conversionUtils";
 import { SYSTEM_PROGRAM_ADDRESS } from "@solana-program/system";
@@ -76,7 +75,7 @@ export class SvmQuery implements QueryInterface {
    */
   async getGasCosts(
     deposit: Omit<Deposit, "messageHash">,
-    relayer = toAddressType(getDefaultSimulatedRelayerAddress(deposit.destinationChainId), deposit.destinationChainId),
+    _relayer = getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
     options: Partial<{
       gasPrice: BigNumberish;
       gasUnits: BigNumberish;
@@ -84,12 +83,10 @@ export class SvmQuery implements QueryInterface {
       priorityFeeMultiplier: BigNumber;
     }> = {}
   ): Promise<TransactionCostEstimate> {
-    const { recipient, outputToken, exclusiveRelayer } = deposit;
-    assert(recipient.isSVM(), `getGasCosts: recipient not an SVM address (${recipient})`);
-    assert(outputToken.isSVM(), `getGasCosts: outputToken not an SVM address (${outputToken})`);
-    assert(exclusiveRelayer.isSVM(), `getGasCosts: exclusiveRelayer not an SVM address (${exclusiveRelayer})`);
-
-    const fillRelayTx = await this.getFillRelayTx({ ...deposit, recipient, outputToken, exclusiveRelayer }, relayer);
+    const relayer = _relayer
+      ? toAddressType(_relayer, deposit.destinationChainId).forceSvmAddress()
+      : this.simulatedRelayerAddress;
+    const fillRelayTx = await this.getFillRelayTx(deposit, relayer.toBase58());
 
     const [computeUnitsConsumed, gasPriceEstimate] = await Promise.all([
       toBN(await this.computeUnitEstimator(fillRelayTx)),
@@ -120,15 +117,10 @@ export class SvmQuery implements QueryInterface {
    * @returns Estimated gas cost in compute units
    */
   async getNativeGasCost(
-    deposit: Omit<Deposit, "messageHash">, // @todo Update interface to permit EvmAddress | SvmAddress
-    _relayer = toAddressType(getDefaultSimulatedRelayerAddress(deposit.destinationChainId), deposit.destinationChainId)
+    deposit: Omit<Deposit, "messageHash">,
+    _relayer = getDefaultSimulatedRelayerAddress(deposit.destinationChainId)
   ): Promise<BigNumber> {
-    const { recipient, outputToken, exclusiveRelayer } = deposit;
-    assert(recipient.isSVM(), `getNativeGasCost: recipient not an SVM address (${recipient})`);
-    assert(outputToken.isSVM(), `getNativeGasCost: outputToken not an SVM address (${outputToken})`);
-    assert(exclusiveRelayer.isSVM(), `getNativeGasCost: exclusiveRelayer not an SVM address (${exclusiveRelayer})`);
-
-    const fillRelayTx = await this.getFillRelayTx({ ...deposit, recipient, outputToken, exclusiveRelayer }, _relayer);
+    const fillRelayTx = await this.getFillRelayTx(deposit, _relayer);
     return toBN(await this.computeUnitEstimator(fillRelayTx));
   }
 
@@ -139,51 +131,55 @@ export class SvmQuery implements QueryInterface {
    * @returns FillRelay transaction
    */
   async getFillRelayTx(
-    deposit: Omit<Deposit, "recipent" | "outputToken" | "exclusiveRelayer" | "messageHash"> & {
-      recipient: SvmAddress;
-      outputToken: SvmAddress;
-      exclusiveRelayer: SvmAddress;
-    },
-    relayer = toAddressType(getDefaultSimulatedRelayerAddress(deposit.destinationChainId), deposit.destinationChainId),
+    deposit: Omit<Deposit, "messageHash">,
+    _relayer = getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
     repaymentChainId = deposit.destinationChainId,
-    repaymentAddress = toAddressType(
-      getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
-      deposit.destinationChainId
-    )
+    repaymentAddress = getDefaultSimulatedRelayerAddress(deposit.destinationChainId)
   ) {
-    const { depositor, recipient, inputToken, outputToken, exclusiveRelayer, destinationChainId } = deposit;
+    const toSvmAddress = (address: string, chainId: number) =>
+      toAddress(toAddressType(address, chainId).forceSvmAddress());
 
-    // tsc appeasement...should be unnecessary, but isn't. @todo Identify why.
-    assert(recipient.isSVM(), `getFillRelayTx: recipient not an SVM address (${recipient})`);
-    assert(
-      repaymentAddress.isValidOn(repaymentChainId),
-      `getFillRelayTx: repayment address ${repaymentAddress} not valid on chain ${repaymentChainId})`
-    );
+    const { depositor, recipient, inputToken, outputToken, exclusiveRelayer, originChainId, destinationChainId } =
+      deposit;
 
     const program = toAddress(this.spokePool);
+    const relayer = _relayer
+      ? toAddressType(_relayer, deposit.destinationChainId).forceSvmAddress()
+      : this.simulatedRelayerAddress;
+
     const _relayDataHash = getRelayDataHash(deposit, destinationChainId);
     const relayDataHash = new Uint8Array(Buffer.from(_relayDataHash.slice(2), "hex"));
 
     const [state, delegate] = await Promise.all([
       getStatePda(program),
-      getFillRelayDelegatePda(relayDataHash, BigInt(repaymentChainId), toAddress(repaymentAddress), program),
+      getFillRelayDelegatePda(
+        relayDataHash,
+        BigInt(repaymentChainId),
+        toSvmAddress(repaymentAddress, repaymentChainId),
+        program
+      ),
     ]);
 
-    const mint = toAddress(outputToken);
+    const _mint = toAddressType(outputToken, destinationChainId).forceSvmAddress();
+    const mint = toAddress(_mint);
     const mintInfo = await fetchMint(this.provider, mint);
 
     const [recipientAta, relayerAta, fillStatus, eventAuthority] = await Promise.all([
-      getAssociatedTokenAddress(recipient, outputToken, mintInfo.programAddress),
-      getAssociatedTokenAddress(SvmAddress.from(relayer.toBase58()), outputToken, mintInfo.programAddress),
+      getAssociatedTokenAddress(
+        toAddressType(deposit.recipient, destinationChainId).forceSvmAddress(),
+        _mint,
+        mintInfo.programAddress
+      ),
+      getAssociatedTokenAddress(SvmAddress.from(relayer.toBase58()), _mint, mintInfo.programAddress),
       getFillStatusPda(program, deposit, destinationChainId),
-      getEventAuthority(program),
+      getEventAuthority(),
     ]);
 
     const relayData: SvmSpokeClient.FillRelayInput["relayData"] = {
-      depositor: toAddress(depositor),
-      recipient: toAddress(recipient),
-      exclusiveRelayer: toAddress(exclusiveRelayer),
-      inputToken: toAddress(inputToken),
+      depositor: toSvmAddress(depositor, originChainId),
+      recipient: toSvmAddress(recipient, destinationChainId),
+      exclusiveRelayer: toSvmAddress(exclusiveRelayer, destinationChainId),
+      inputToken: toSvmAddress(inputToken, originChainId),
       outputToken: mint,
       inputAmount: deposit.inputAmount.toBigInt(),
       outputAmount: deposit.outputAmount.toBigInt(),
@@ -211,7 +207,7 @@ export class SvmQuery implements QueryInterface {
       relayHash: relayDataHash,
       relayData,
       repaymentChainId: BigInt(repaymentChainId),
-      repaymentAddress: toAddress(repaymentAddress),
+      repaymentAddress: toSvmAddress(repaymentAddress, repaymentChainId),
     };
     // Pass createRecipientAtaIfNeeded =true to the createFillInstruction function to create the recipient token account
     // if it doesn't exist.

package/src/relayFeeCalculator/relayFeeCalculator.ts

@@ -9,9 +9,12 @@ import { Deposit } from "../interfaces";
 import {
   BigNumber,
   BigNumberish,
+  ConvertDecimals,
   MAX_BIG_INT,
   TransactionCostEstimate,
   bnZero,
+  chainIsSvm,
+  compareAddressesSimple,
   fixedPointAdjustment,
   getTokenInfo,
   isDefined,
@@ -22,18 +25,13 @@ import {
   percent,
   toBN,
   toBNWei,
-  compareAddressesSimple,
-  ConvertDecimals,
-  chainIsSvm,
-  toAddressType,
-  Address,
 } from "../utils";
 
 // This needs to be implemented for every chain and passed into RelayFeeCalculator
 export interface QueryInterface {
   getGasCosts: (
     deposit: Omit<Deposit, "messageHash">,
-    relayer: Address,
+    relayer: string,
     options?: Partial<{
       gasPrice: BigNumberish;
       gasUnits: BigNumberish;
@@ -44,7 +42,7 @@ export interface QueryInterface {
     }>
   ) => Promise<TransactionCostEstimate>;
   getTokenPrice: (tokenSymbol: string) => Promise<number>;
-  getNativeGasCost: (deposit: Omit<Deposit, "messageHash">, relayer: Address) => Promise<BigNumber>;
+  getNativeGasCost: (deposit: Omit<Deposit, "messageHash">, relayer: string) => Promise<BigNumber>;
 }
 
 export const expectedCapitalCostsKeys = ["lowerBound", "upperBound", "cutoff", "decimals"];
@@ -256,10 +254,7 @@ export class RelayFeeCalculator {
     deposit: Deposit,
     outputAmount: BigNumberish,
     simulateZeroFill = false,
-    relayerAddress = toAddressType(
-      getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
-      deposit.destinationChainId
-    ),
+    relayerAddress = getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
     _tokenPrice?: number,
     tokenMapping = TOKEN_SYMBOLS_MAP,
     gasPrice?: BigNumberish,
@@ -276,14 +271,14 @@ export class RelayFeeCalculator {
     // undefined address on destination.
     const destinationChainTokenDetails = Object.values(tokenMapping).find(
       (details) =>
-        compareAddressesSimple(details.addresses[originChainId], inputToken.toNative()) &&
+        compareAddressesSimple(details.addresses[originChainId], inputToken) &&
         isDefined(details.addresses[destinationChainId])
     );
     const outputToken = isZeroAddress(deposit.outputToken)
       ? destinationChainTokenDetails!.addresses[destinationChainId]
-      : deposit.outputToken.toNative();
+      : deposit.outputToken;
     const outputTokenInfo = getTokenInfo(outputToken, destinationChainId, tokenMapping);
-    const inputTokenInfo = getTokenInfo(inputToken.toNative(), originChainId, tokenMapping);
+    const inputTokenInfo = getTokenInfo(inputToken, originChainId, tokenMapping);
     if (!isDefined(outputTokenInfo) || !isDefined(inputTokenInfo)) {
       throw new Error(`Could not find token information for ${inputToken} or ${outputToken}`);
     }
@@ -498,10 +493,7 @@ export class RelayFeeCalculator {
     deposit: Deposit,
     outputAmount?: BigNumberish,
     simulateZeroFill = false,
-    relayerAddress = toAddressType(
-      getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
-      deposit.destinationChainId
-    ),
+    relayerAddress = getDefaultSimulatedRelayerAddress(deposit.destinationChainId),
     _tokenPrice?: number,
     gasPrice?: BigNumberish,
     gasUnits?: BigNumberish,
@@ -513,8 +505,8 @@ export class RelayFeeCalculator {
     const { inputToken, originChainId, outputToken, destinationChainId } = deposit;
     // We can perform a simple lookup with `getTokenInfo` here without resolving the exact token to resolve since we only need to
     // resolve the L1 token symbol and not the L2 token decimals.
-    const inputTokenInfo = getTokenInfo(inputToken.toNative(), originChainId);
-    const outputTokenInfo = getTokenInfo(outputToken.toNative(), destinationChainId);
+    const inputTokenInfo = getTokenInfo(inputToken, originChainId);
+    const outputTokenInfo = getTokenInfo(outputToken, destinationChainId);
     if (!isDefined(inputTokenInfo) || !isDefined(outputTokenInfo)) {
       throw new Error(`Could not find token information for ${inputToken} or ${outputToken}`);
     }