@across-protocol/sdk 3.2.9 → 3.2.11-beta.1

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

@@ -41,6 +41,15 @@ export declare const resolveContractFromSymbol: (symbol: string, chainId: string
         };
         coingeckoId: string;
     };
+    AZERO: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+        coingeckoId: string;
+    };
     BAL: {
         name: string;
         symbol: string;
@@ -76,13 +85,7 @@ export declare const resolveContractFromSymbol: (symbol: string, chainId: string
             [x: number]: string;
         };
         coingeckoId: string;
-    }; /**
-     * Resolve a token symbol to an L1Token description on a particular chain ID.
-     * @notice Not to be confused with the HubPool's internal view on the supported origin/destination token for a chain.
-     * @param symbol Symbol to query.
-     * @param chainId Chain ID to query on.
-     * @returns Symbol, decimals and contract address on the requested chain.
-     */
+    };
     ETH: {
         name: string;
         symbol: string;
@@ -92,6 +95,15 @@ export declare const resolveContractFromSymbol: (symbol: string, chainId: string
         };
         coingeckoId: string;
     };
+    GHO: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+        coingeckoId: string;
+    };
     LSK: {
         name: string;
         symbol: string;
@@ -184,6 +196,14 @@ export declare const resolveContractFromSymbol: (symbol: string, chainId: string
     };
     USDzC: {
         name: string;
+        /**
+         * Retrieves the ERC20 balance for a given address and token address.
+         * @param address The address to retrieve the balance for.
+         * @param tokenAddress The token address
+         * @param signerOrProvider A valid ethers.js Signer or Provider object.
+         * @param blockTag The block tag to retrieve the balance at.
+         * @returns The balance of the given address for the given token address.
+         */
         symbol: string;
         decimals: number;
         addresses: {
@@ -200,16 +220,17 @@ export declare const resolveContractFromSymbol: (symbol: string, chainId: string
         };
         coingeckoId: string;
     };
+    WAZERO: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+        coingeckoId: string;
+    };
     WBTC: {
         name: string;
-        /**
-         * Retrieves the ERC20 balance for a given address and token address.
-         * @param address The address to retrieve the balance for.
-         * @param tokenAddress The token address
-         * @param signerOrProvider A valid ethers.js Signer or Provider object.
-         * @param blockTag The block tag to retrieve the balance at.
-         * @returns The balance of the given address for the given token address.
-         */
         symbol: string;
         decimals: number;
         addresses: {
@@ -255,6 +276,15 @@ export declare function getTokenInformationFromAddress(address: string, tokenMap
         };
         coingeckoId: string;
     };
+    AZERO: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+        coingeckoId: string;
+    };
     BAL: {
         name: string;
         symbol: string;
@@ -290,13 +320,7 @@ export declare function getTokenInformationFromAddress(address: string, tokenMap
             [x: number]: string;
         };
         coingeckoId: string;
-    }; /**
-     * Resolve a token symbol to an L1Token description on a particular chain ID.
-     * @notice Not to be confused with the HubPool's internal view on the supported origin/destination token for a chain.
-     * @param symbol Symbol to query.
-     * @param chainId Chain ID to query on.
-     * @returns Symbol, decimals and contract address on the requested chain.
-     */
+    };
     ETH: {
         name: string;
         symbol: string;
@@ -306,6 +330,15 @@ export declare function getTokenInformationFromAddress(address: string, tokenMap
         };
         coingeckoId: string;
     };
+    GHO: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+        coingeckoId: string;
+    };
     LSK: {
         name: string;
         symbol: string;
@@ -398,6 +431,14 @@ export declare function getTokenInformationFromAddress(address: string, tokenMap
     };
     USDzC: {
         name: string;
+        /**
+         * Retrieves the ERC20 balance for a given address and token address.
+         * @param address The address to retrieve the balance for.
+         * @param tokenAddress The token address
+         * @param signerOrProvider A valid ethers.js Signer or Provider object.
+         * @param blockTag The block tag to retrieve the balance at.
+         * @returns The balance of the given address for the given token address.
+         */
         symbol: string;
         decimals: number;
         addresses: {
@@ -414,16 +455,17 @@ export declare function getTokenInformationFromAddress(address: string, tokenMap
         };
         coingeckoId: string;
     };
+    WAZERO: {
+        name: string;
+        symbol: string;
+        decimals: number;
+        addresses: {
+            [x: number]: string;
+        };
+        coingeckoId: string;
+    };
     WBTC: {
         name: string;
-        /**
-         * Retrieves the ERC20 balance for a given address and token address.
-         * @param address The address to retrieve the balance for.
-         * @param tokenAddress The token address
-         * @param signerOrProvider A valid ethers.js Signer or Provider object.
-         * @param blockTag The block tag to retrieve the balance at.
-         * @returns The balance of the given address for the given token address.
-         */
         symbol: string;
         decimals: number;
         addresses: {

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

@@ -1 +1 @@
-{"version":3,"file":"TokenUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/TokenUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAY,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAM7C,KAAK,gBAAgB,GAAG,SAAS,CAAC,QAAQ,GAAG,MAAM,CAAC;AAEpD,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAI1G;AAED,eAAO,MAAM,mBAAmB,mBACd,MAAM;;aAMvB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAY7E;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,WAC5B,MAAM,WACL,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA9BjB;;;;;;OAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAqDH;;;;;;;WAOG;;;;;;;;;;;;;;;;;;;;;;;;;;MAlCA,MAAM,GAAG,SAIX,CAAC;AAEF,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAtC5E;;;;;;OAMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAqDH;;;;;;;WAOG;;;;;;;;;;;;;;;;;;;;;;;;;;CA5B6F,GAAG,OAAO,GAAG,SAAS,CAWrH;AAED,wBAAgB,4BAA4B,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAM5E;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,gBAAgB,EAClC,QAAQ,GAAE,QAAmB,GAC5B,OAAO,CAAC,SAAS,CAAC,CAGpB;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAI1D;AAED,wBAAgB,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAc7E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOlF;AAED,wBAAgB,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAa/E"}
+{"version":3,"file":"TokenUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/TokenUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAY,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAM7C,KAAK,gBAAgB,GAAG,SAAS,CAAC,QAAQ,GAAG,MAAM,CAAC;AAEpD,wBAAsB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAI1G;AAED,eAAO,MAAM,mBAAmB,mBACd,MAAM;;aAMvB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAY7E;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,WAC5B,MAAM,WACL,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA6BjB;;;;;;;WAOG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAlCA,MAAM,GAAG,SAIX,CAAC;AAEF,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAqB5E;;;;;;;WAOG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA5B6F,GAAG,OAAO,GAAG,SAAS,CAWrH;AAED,wBAAgB,4BAA4B,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAM5E;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,EACpB,gBAAgB,EAAE,gBAAgB,EAClC,QAAQ,GAAE,QAAmB,GAC5B,OAAO,CAAC,SAAS,CAAC,CAGpB;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAI1D;AAED,wBAAgB,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAc7E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOlF;AAED,wBAAgB,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAa/E"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@across-protocol/sdk",
   "author": "UMA Team",
-  "version": "3.2.9",
+  "version": "3.2.11-beta.1",
   "license": "AGPL-3.0",
   "homepage": "https://docs.across.to/reference/sdk",
   "files": [
@@ -99,8 +99,8 @@
   },
   "dependencies": {
     "@across-protocol/across-token": "^1.0.0",
-    "@across-protocol/constants": "^3.1.16",
-    "@across-protocol/contracts": "^3.0.11",
+    "@across-protocol/constants": "^3.1.18",
+    "@across-protocol/contracts": "^3.0.12-beta.3",
     "@eth-optimism/sdk": "^3.3.1",
     "@ethersproject/bignumber": "^5.7.0",
     "@pinata/sdk": "^2.1.0",

package/src/gasPriceOracle/oracle.ts

@@ -24,6 +24,7 @@ export async function getGasPriceEstimate(
   }
 
   const gasPriceFeeds: { [chainId: number]: GasPriceFeed } = {
+    [CHAIN_IDs.ALEPH_ZERO]: arbitrum.eip1559,
     [CHAIN_IDs.ARBITRUM]: arbitrum.eip1559,
     [CHAIN_IDs.BASE]: ethereum.eip1559,
     [CHAIN_IDs.BOBA]: ethereum.legacy,

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

@@ -0,0 +1,48 @@
+import assert from "assert";
+import { getDeployedAddress } from "../../utils/DeploymentUtils";
+import { DEFAULT_LOGGER, Logger } from "../relayFeeCalculator";
+import { providers } from "ethers";
+import { CHAIN_IDs, DEFAULT_SIMULATED_RELAYER_ADDRESS, TOKEN_SYMBOLS_MAP } from "../../constants";
+import { Coingecko } from "../../coingecko/Coingecko";
+import { isDefined } from "../../utils";
+import { QueryBase } from "./baseQuery";
+
+export class AlephZeroQueries extends QueryBase {
+  constructor(
+    provider: providers.Provider,
+    symbolMapping = TOKEN_SYMBOLS_MAP,
+    spokePoolAddress = getDeployedAddress("SpokePool", CHAIN_IDs.ALEPH_ZERO),
+    simulatedRelayerAddress = DEFAULT_SIMULATED_RELAYER_ADDRESS,
+    coingeckoProApiKey?: string,
+    logger: Logger = DEFAULT_LOGGER,
+    gasMarkup = 0
+  ) {
+    assert(isDefined(spokePoolAddress));
+    super(
+      provider,
+      symbolMapping,
+      spokePoolAddress,
+      simulatedRelayerAddress,
+      gasMarkup,
+      logger,
+      coingeckoProApiKey,
+      undefined,
+      "usd"
+    );
+  }
+
+  override async getTokenPrice(tokenSymbol: string): Promise<number> {
+    if (!this.symbolMapping[tokenSymbol]) throw new Error(`${tokenSymbol} does not exist in mapping`);
+    const coingeckoInstance = Coingecko.get(this.logger, this.coingeckoProApiKey);
+    const [, tokenPrice] = await coingeckoInstance.getCurrentPriceByContract(
+      this.symbolMapping[tokenSymbol].addresses[CHAIN_IDs.MAINNET],
+      "usd"
+    );
+
+    const [, alephZeroPrice] = await coingeckoInstance.getCurrentPriceByContract(
+      this.symbolMapping["AZERO"].addresses[CHAIN_IDs.MAINNET],
+      "usd"
+    );
+    return Number((tokenPrice / alephZeroPrice).toFixed(this.symbolMapping["AZERO"].decimals));
+  }
+}

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

@@ -4,10 +4,11 @@ import { getDeployedAddress } from "@across-protocol/contracts";
 import { asL2Provider } from "@eth-optimism/sdk";
 import { providers } from "ethers";
 import { DEFAULT_SIMULATED_RELAYER_ADDRESS } from "../../constants";
-import { chainIsMatic, chainIsOPStack, isDefined } from "../../utils";
+import { chainIsAlephZero, chainIsMatic, chainIsOPStack, isDefined } from "../../utils";
 import { QueryBase } from "./baseQuery";
 import { PolygonQueries } from "./polygon";
 import { DEFAULT_LOGGER, Logger } from "../relayFeeCalculator";
+import { AlephZeroQueries } from "./alephZero";
 
 /**
  * Some chains have a fixed gas price that is applied to the gas estimates. We should override
@@ -31,7 +32,6 @@ export class QueryBase__factory {
   ): QueryBase {
     assert(isDefined(spokePoolAddress));
 
-    // Currently the only chain that has a custom query class is Polygon
     if (chainIsMatic(chainId)) {
       return new PolygonQueries(
         provider,
@@ -43,6 +43,19 @@ export class QueryBase__factory {
         gasMarkup
       );
     }
+
+    if (chainIsAlephZero(chainId)) {
+      return new AlephZeroQueries(
+        provider,
+        symbolMapping,
+        spokePoolAddress,
+        simulatedRelayerAddress,
+        coingeckoProApiKey,
+        logger,
+        gasMarkup
+      );
+    }
+
     // For OPStack chains, we need to wrap the provider in an L2Provider
     provider = chainIsOPStack(chainId) ? asL2Provider(provider) : provider;
 

package/src/utils/NetworkUtils.ts

@@ -57,7 +57,16 @@ export function chainIsMatic(chainId: number): boolean {
  * @returns True if chainId is an OP stack, otherwise false.
  */
 export function chainIsOPStack(chainId: number): boolean {
-  return PUBLIC_NETWORKS[chainId]?.family === ChainFamily.OP_STACK ?? false;
+  return PUBLIC_NETWORKS[chainId]?.family === ChainFamily.OP_STACK;
+}
+
+/**
+ * Determines whether a chain ID is an Arbitrum Orbit implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is an Orbit chain, otherwise false.
+ */
+export function chainIsOrbit(chainId: number): boolean {
+  return PUBLIC_NETWORKS[chainId]?.family === ChainFamily.ORBIT;
 }
 
 /**
@@ -69,6 +78,15 @@ export function chainIsArbitrum(chainId: number): boolean {
   return [CHAIN_IDs.ARBITRUM, CHAIN_IDs.ARBITRUM_SEPOLIA].includes(chainId);
 }
 
+/**
+ * Determines whether a chain ID is an Aleph0 implementation
+ * @param chainId Chain ID to evaluate
+ * @returns True if chainId is an Aleph0 chain, otherwise false.
+ */
+export function chainIsAlephZero(chainId: number): boolean {
+  return [CHAIN_IDs.ALEPH_ZERO].includes(chainId);
+}
+
 /**
  * Determines whether a chain ID is a Linea implementation.
  * @param chainId Chain ID to evaluate.