@across-protocol/sdk 3.0.0

package/package.json

@@ -0,0 +1,144 @@
+{
+  "name": "@across-protocol/sdk",
+  "author": "UMA Team",
+  "version": "3.0.0",
+  "license": "AGPL-3.0",
+  "homepage": "https://docs.across.to/reference/sdk",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=16.18.0"
+  },
+  "scripts": {
+    "start": "nodemon -e ts,tsx,json,js,jsx --watch ./src --ignore ./dist --exec 'yarn build'",
+    "build": "yarn run clean && yarn run build:cjs & yarn run build:esm & yarn run build:types; wait",
+    "build:cjs": "tsc --project tsconfig.build.json --module commonjs --outDir ./dist/cjs --removeComments --verbatimModuleSyntax false && echo > ./dist/cjs/package.json '{\"type\":\"commonjs\"}' && yarn copy-abi:cjs",
+    "build:esm": "tsc --project tsconfig.build.json --module es2015 --outDir ./dist/esm && echo > ./dist/esm/package.json '{\"type\":\"module\",\"sideEffects\":false}' && yarn copy-abi:esm",
+    "build:types": "tsc --project tsconfig.build.json --module esnext --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap",
+    "copy-abi:cjs": "DIR=cjs yarn copy-abi",
+    "copy-abi:esm": "DIR=esm yarn copy-abi",
+    "copy-abi": "abi=utils/abi/contracts; dstdir=\"./dist/${DIR}/${abi}\"; mkdir -p \"${dstdir}\"; cp ./src/${abi}/*.json \"${dstdir}\"",
+    "test": "hardhat test",
+    "test:watch": "hardhat watch test",
+    "test:run:arweave": "npx -y arlocal",
+    "lint": "eslint --fix src test e2e && yarn prettier --write \"src/**/*.ts\" \"test/**/*.ts\" \"e2e/**/*.ts\"",
+    "lint-check": "eslint src test e2e && yarn prettier --check \"src/**/*.ts\" \"test/**/*.ts\" \"e2e/**/*.ts\"",
+    "prepare": "yarn build && husky install",
+    "size": "size-limit",
+    "analyze": "size-limit --why",
+    "clean": "rm -rf ./dist",
+    "bump-version:major": "yarn version --major --no-git-tag-version --no-commit-hooks && git commit -m 'chore: bump version' ./package.json --no-verify",
+    "bump-version:minor": "yarn version --minor --no-git-tag-version --no-commit-hooks && git commit -m 'chore: bump version' ./package.json --no-verify",
+    "bump-version:patch": "yarn version --patch --no-git-tag-version --no-commit-hooks && git commit -m 'chore: bump version' ./package.json --no-verify"
+  },
+  "lint-staged": {
+    "*.ts": "yarn lint"
+  },
+  "peerDependencies": {},
+  "sideEffects": false,
+  "size-limit": [
+    {
+      "path": "dist/sdk.cjs.production.min.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "dist/sdk.esm.js",
+      "limit": "10 KB"
+    }
+  ],
+  "devDependencies": {
+    "@defi-wonderland/smock": "^2.3.5",
+    "@eth-optimism/contracts": "^0.5.37",
+    "@nomiclabs/hardhat-ethers": "^2.2.1",
+    "@nomiclabs/hardhat-etherscan": "^3.1.7",
+    "@nomiclabs/hardhat-waffle": "^2.0.3",
+    "@openzeppelin/hardhat-upgrades": "^1.28.0",
+    "@size-limit/preset-small-lib": "^7.0.8",
+    "@typechain/ethers-v5": "^11.1.1",
+    "@typechain/hardhat": "^6.1.6",
+    "@types/chai": "^4.3.6",
+    "@types/dotenv": "^8.2.0",
+    "@types/lodash": "^4.14.199",
+    "@types/lodash.get": "^4.4.7",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "arlocal": "^1.1.65",
+    "chai": "^4.3.8",
+    "chai-exclude": "^2.1.0",
+    "dotenv": "^16.0.0",
+    "eslint": "^8.49.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-chai-expect": "^3.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-mocha": "^10.2.0",
+    "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "ethereum-waffle": "^4.0.10",
+    "hardhat": "^2.17.4",
+    "hardhat-deploy": "^0.11.2",
+    "hardhat-gas-reporter": "^1.0.8",
+    "hardhat-watcher": "^2.5.0",
+    "husky": "^8.0.0",
+    "lint-staged": "^12.4.1",
+    "nodemon": "^3.0.1",
+    "prettier": "^3.0.3",
+    "sinon": "^16.0.0",
+    "size-limit": "^7.0.8",
+    "solidity-coverage": "^0.8.5",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.1",
+    "typechain": "^8.3.1",
+    "typescript": "5",
+    "winston": "^3.10.0",
+    "winston-transport": "^4.5.0"
+  },
+  "dependencies": {
+    "@across-protocol/across-token": "^1.0.0",
+    "@across-protocol/constants": "^3.0.0",
+    "@across-protocol/contracts": "^3.0.0",
+    "@eth-optimism/sdk": "^3.3.1",
+    "@pinata/sdk": "^2.1.0",
+    "@types/mocha": "^10.0.1",
+    "@uma/sdk": "^0.34.1",
+    "arweave": "^1.14.4",
+    "axios": "^0.27.2",
+    "big-number": "^2.0.0",
+    "decimal.js": "^10.3.1",
+    "ethers": "^5.7.2",
+    "lodash.get": "^4.4.2",
+    "superstruct": "^0.15.4",
+    "tslib": "^2.6.2"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.com/",
+    "access": "public"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node"
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "typings": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./dist/cjs/*": {
+      "require": "./dist/cjs/*.js",
+      "import": "./dist/esm/*.js"
+    },
+    "./dist/esm/*": {
+      "require": "./dist/cjs/*.js",
+      "import": "./dist/esm/*.js"
+    }
+  }
+}

package/src/apiClient/abstractClient.ts

@@ -0,0 +1,95 @@
+import { ethers } from "ethers";
+import {
+  CoingeckoDataReturnType,
+  SuggestedFeeReturnType,
+  BridgeLimitsReturnType,
+  AcrossBridgeStatisticsType,
+} from "./types";
+
+/**
+ * AbstractApiClient is an abstract class that defines the interface for the API client.
+ */
+export default abstract class AbstractApiClient {
+  /**
+   * serverlessApiUrl is the URL of the serverless API.
+   */
+  private readonly serverlessApiUrl: string;
+  /**
+   * scraperApiUrl is the URL of the scraper API.
+   */
+  private readonly scraperApiUrl: string;
+
+  /**
+   * Creates a new instance of AbstractApiClient.
+   * @param serverlessApiUrl The URL of the serverless API.
+   * @param scraperApiUrl The URL of the scraper API.
+   */
+  protected constructor(serverlessApiUrl: string, scraperApiUrl: string) {
+    this.serverlessApiUrl = serverlessApiUrl;
+    this.scraperApiUrl = scraperApiUrl;
+  }
+
+  /**
+   * Returns the URL of the serverless API.
+   * @returns The URL of the serverless API.
+   */
+  protected getServerlessApiUrl(): string {
+    return this.serverlessApiUrl;
+  }
+
+  /**
+   * Returns the URL of the scraper API.
+   * @returns The URL of the scraper API.
+   */
+  protected getScraperApiUrl(): string {
+    return this.scraperApiUrl;
+  }
+
+  /**
+   * Returns the coingecko data for the given token.
+   * @param l1Token The token to get the coingecko data for.
+   * @param baseCurrency The base currency to get the coingecko data for.
+   * @returns The coingecko data.
+   * @throws Throws an error if the API call fails.
+   */
+  public abstract getCoinGeckoData(l1Token: string, baseCurrency: string): Promise<CoingeckoDataReturnType>;
+
+  /**
+   * Returns the suggested fees for the given token and amount to transfer to the given chain in a bridge transfer.
+   * @param amount The amount to transfer.
+   * @param originToken The token to transfer.
+   * @param toChainid The chain to transfer to
+   * @param fromChainid The chain to transfer from
+   * @returns The suggested fees.
+   * @throws Throws an error if the API call fails.
+   */
+  public abstract getSuggestedFees(
+    amount: ethers.BigNumber,
+    originToken: string,
+    toChainid: number,
+    fromChainid: number
+  ): Promise<SuggestedFeeReturnType>;
+
+  /**
+   * Returns the bridge limits for the given token and chain on Across.
+   * @class
+   * @abstract
+   * @param token The token to get the bridge limits for.
+   * @param fromChainId The chain that the transfer will originate from.
+   * @param toChainId The chain that the transfer will be bridged to.
+   * @returns The bridge limits.
+   * @throws Throws an error if the API call fails.
+   */
+  public abstract getBridgeLimits(
+    token: string,
+    fromnumber: string | number,
+    tonumber: string | number
+  ): Promise<BridgeLimitsReturnType>;
+
+  /**
+   * Returns the Across bridge statistics. These are a set of statistics that are used to capture the current state of the bridge.
+   * @returns The Across bridge statistics.
+   * @throws Throws an error if the API call fails.
+   */
+  public abstract getAcrossStats(): Promise<AcrossBridgeStatisticsType>;
+}

package/src/apiClient/index.ts

@@ -0,0 +1,2 @@
+export { default as ProductionClient } from "./productionClient";
+export { default as MockedClient } from "./mockedClient";

package/src/apiClient/mockedClient.ts

@@ -0,0 +1,90 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { ethers } from "ethers";
+import { deepCopy } from "ethers/lib/utils";
+import AbstractApiClient from "./abstractClient";
+import {
+  AcrossBridgeStatisticsType,
+  BridgeLimitsReturnType,
+  CoingeckoDataReturnType,
+  EndpointResultMappingType,
+  SuggestedFeeReturnType,
+} from "./types";
+
+/**
+ * MockedApiClient is a mocked implementation of the AbstractApiClient.
+ * @class
+ * @extends AbstractApiClient
+ * @note This implementation does not make API calls to RESTful services. Instead, it returns mocked data.
+ */
+export default class MockedApiClient extends AbstractApiClient {
+  /**
+   * Mocked data to return in lieu of the default return values.
+   */
+  private readonly mockedData: Partial<EndpointResultMappingType>;
+
+  /**
+   * Creates a constructor for the MockedApiClient.
+   * @param mockedData The mocked data to return in lieu of the default return values
+   */
+  public constructor(mockedData?: Partial<EndpointResultMappingType>) {
+    super("", "");
+    this.mockedData = deepCopy(mockedData ?? {});
+  }
+
+  public getCoinGeckoData(_l1Token: string, _baseCurrency: string): Promise<CoingeckoDataReturnType> {
+    return Promise.resolve(
+      this.mockedData.CoinGeckoData ?? {
+        price: ethers.utils.parseEther(String("0.1")),
+      }
+    );
+  }
+  public getSuggestedFees(
+    _amount: ethers.BigNumber,
+    _originToken: string,
+    _toChainid: number,
+    _fromChainid: number
+  ): Promise<SuggestedFeeReturnType> {
+    return Promise.resolve(
+      this.mockedData.SuggestedFees ?? {
+        relayerFee: {
+          pct: ethers.constants.One,
+          total: ethers.constants.One,
+        },
+        relayerCapitalFee: {
+          pct: ethers.constants.One,
+          total: ethers.constants.One,
+        },
+        relayerGasFee: {
+          pct: ethers.constants.One,
+          total: ethers.constants.One,
+        },
+        isAmountTooLow: false,
+        quoteBlock: ethers.constants.One,
+        quoteTimestamp: ethers.constants.One,
+      }
+    );
+  }
+  public getBridgeLimits(
+    _token: string,
+    _fromChainId: string | number,
+    _toChainId: string | number
+  ): Promise<BridgeLimitsReturnType> {
+    return Promise.resolve(
+      this.mockedData.BridgeLimits ?? {
+        minDeposit: ethers.BigNumber.from("317845960607070"),
+        maxDeposit: ethers.BigNumber.from("1625976243310274613043"),
+        maxDepositInstant: ethers.BigNumber.from("148518401181482545509"),
+        maxDepositShortDelay: ethers.BigNumber.from("1625976243310274613043"),
+      }
+    );
+  }
+  public getAcrossStats(): Promise<AcrossBridgeStatisticsType> {
+    return Promise.resolve(
+      this.mockedData.AcrossStats ?? {
+        totalDeposits: 200,
+        avgFillTime: 200,
+        totalVolumeUsd: 100000,
+      }
+    );
+  }
+}

package/src/apiClient/productionClient.ts

@@ -0,0 +1,98 @@
+import axios from "axios";
+import { ethers } from "ethers";
+import AbstractApiClient from "./abstractClient";
+import {
+  CoingeckoDataReturnType,
+  SuggestedFeeReturnType,
+  BridgeLimitsReturnType,
+  AcrossBridgeStatisticsType,
+} from "./types";
+
+/**
+ * An implementation of AbstractApiClient that uses the production API.
+ * @class
+ * @extends AbstractApiClient
+ * @note This implementation makes API calls to RESTful services.
+ */
+export default class ProductionApiClient extends AbstractApiClient {
+  public constructor(serverlessApiUrl: string, scraperApiUrl: string) {
+    super(serverlessApiUrl, scraperApiUrl);
+  }
+
+  public async getCoinGeckoData(l1Token: string, baseCurrency: string): Promise<CoingeckoDataReturnType> {
+    const response = await axios.get(`${this.getServerlessApiUrl()}/api/coingecko`, {
+      params: {
+        l1Token,
+        baseCurrency,
+      },
+    });
+    const result = response.data;
+    const price =
+      baseCurrency === "usd" ? ethers.utils.parseEther(String(result.price)) : ethers.BigNumber.from(result.price);
+    return {
+      price,
+    };
+  }
+  public async getSuggestedFees(
+    amount: ethers.BigNumber,
+    originToken: string,
+    toChainid: number,
+    fromChainid: number
+  ): Promise<SuggestedFeeReturnType> {
+    const response = await axios.get(`${this.getServerlessApiUrl()}/api/suggested-fees`, {
+      params: {
+        token: originToken,
+        destinationChainId: toChainid,
+        originChainId: fromChainid,
+        amount: amount.toString(),
+        skipAmountLimit: true,
+      },
+    });
+    const result = response.data;
+    const relayFeePct = ethers.BigNumber.from(result["relayFeePct"]);
+    const relayFeeTotal = ethers.BigNumber.from(result["relayFeeTotal"]);
+
+    const capitalFeePct = ethers.BigNumber.from(result["capitalFeePct"]);
+    const capitalFeeTotal = ethers.BigNumber.from(result["capitalFeeTotal"]);
+
+    const relayGasFeePct = ethers.BigNumber.from(result["relayGasFeePct"]);
+    const relayGasFeeTotal = ethers.BigNumber.from(result["relayGasFeeTotal"]);
+
+    const isAmountTooLow = result["isAmountTooLow"];
+
+    const quoteTimestamp = ethers.BigNumber.from(result["timestamp"]);
+    const quoteBlock = ethers.BigNumber.from(result["quoteBlock"]);
+
+    return {
+      relayerFee: {
+        pct: relayFeePct,
+        total: relayFeeTotal,
+      },
+      relayerCapitalFee: {
+        pct: capitalFeePct,
+        total: capitalFeeTotal,
+      },
+      relayerGasFee: {
+        pct: relayGasFeePct,
+        total: relayGasFeeTotal,
+      },
+      isAmountTooLow,
+      quoteTimestamp,
+      quoteBlock,
+    };
+  }
+  public async getBridgeLimits(
+    token: string,
+    fromChainId: string | number,
+    toChainId: string | number
+  ): Promise<BridgeLimitsReturnType> {
+    const { data } = await axios.get<BridgeLimitsReturnType>(
+      `${this.getServerlessApiUrl()}/api/limits?token=${token}&originChainId=${fromChainId}&destinationChainId=${toChainId}`
+    );
+    return data;
+  }
+  public async getAcrossStats(): Promise<AcrossBridgeStatisticsType> {
+    const axiosResponse = await axios.get<AcrossBridgeStatisticsType>(`${this.getScraperApiUrl()}/deposits/stats`);
+    return axiosResponse.data;
+  }
+}

package/src/apiClient/types.ts

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