@epoch-protocol/inventory-sdk 1.0.0

package/src/chainlink-ops/chainlink-abi.ts

@@ -0,0 +1,283 @@
+export const CHAINLINK_FEED_ABI = [
+  {
+    inputs: [
+      { internalType: "address", name: "_aggregator", type: "address" },
+      { internalType: "address", name: "_accessController", type: "address" },
+    ],
+    stateMutability: "nonpayable",
+    type: "constructor",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "int256",
+        name: "current",
+        type: "int256",
+      },
+      {
+        indexed: true,
+        internalType: "uint256",
+        name: "roundId",
+        type: "uint256",
+      },
+      {
+        indexed: false,
+        internalType: "uint256",
+        name: "updatedAt",
+        type: "uint256",
+      },
+    ],
+    name: "AnswerUpdated",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "uint256",
+        name: "roundId",
+        type: "uint256",
+      },
+      {
+        indexed: true,
+        internalType: "address",
+        name: "startedBy",
+        type: "address",
+      },
+      {
+        indexed: false,
+        internalType: "uint256",
+        name: "startedAt",
+        type: "uint256",
+      },
+    ],
+    name: "NewRound",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "address", name: "from", type: "address" },
+      { indexed: true, internalType: "address", name: "to", type: "address" },
+    ],
+    name: "OwnershipTransferRequested",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "address", name: "from", type: "address" },
+      { indexed: true, internalType: "address", name: "to", type: "address" },
+    ],
+    name: "OwnershipTransferred",
+    type: "event",
+  },
+  {
+    inputs: [],
+    name: "acceptOwnership",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "accessController",
+    outputs: [
+      {
+        internalType: "contract AccessControllerInterface",
+        name: "",
+        type: "address",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "aggregator",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "_aggregator", type: "address" }],
+    name: "confirmAggregator",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "decimals",
+    outputs: [{ internalType: "uint8", name: "", type: "uint8" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "description",
+    outputs: [{ internalType: "string", name: "", type: "string" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "uint256", name: "_roundId", type: "uint256" }],
+    name: "getAnswer",
+    outputs: [{ internalType: "int256", name: "", type: "int256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "uint80", name: "_roundId", type: "uint80" }],
+    name: "getRoundData",
+    outputs: [
+      { internalType: "uint80", name: "roundId", type: "uint80" },
+      { internalType: "int256", name: "answer", type: "int256" },
+      { internalType: "uint256", name: "startedAt", type: "uint256" },
+      { internalType: "uint256", name: "updatedAt", type: "uint256" },
+      { internalType: "uint80", name: "answeredInRound", type: "uint80" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "uint256", name: "_roundId", type: "uint256" }],
+    name: "getTimestamp",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "latestAnswer",
+    outputs: [{ internalType: "int256", name: "", type: "int256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "latestRound",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "latestRoundData",
+    outputs: [
+      { internalType: "uint80", name: "roundId", type: "uint80" },
+      { internalType: "int256", name: "answer", type: "int256" },
+      { internalType: "uint256", name: "startedAt", type: "uint256" },
+      { internalType: "uint256", name: "updatedAt", type: "uint256" },
+      { internalType: "uint80", name: "answeredInRound", type: "uint80" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "latestTimestamp",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "owner",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "uint16", name: "", type: "uint16" }],
+    name: "phaseAggregators",
+    outputs: [
+      {
+        internalType: "contract AggregatorV2V3Interface",
+        name: "",
+        type: "address",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "phaseId",
+    outputs: [{ internalType: "uint16", name: "", type: "uint16" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "_aggregator", type: "address" }],
+    name: "proposeAggregator",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "proposedAggregator",
+    outputs: [
+      {
+        internalType: "contract AggregatorV2V3Interface",
+        name: "",
+        type: "address",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "uint80", name: "_roundId", type: "uint80" }],
+    name: "proposedGetRoundData",
+    outputs: [
+      { internalType: "uint80", name: "roundId", type: "uint80" },
+      { internalType: "int256", name: "answer", type: "int256" },
+      { internalType: "uint256", name: "startedAt", type: "uint256" },
+      { internalType: "uint256", name: "updatedAt", type: "uint256" },
+      { internalType: "uint80", name: "answeredInRound", type: "uint80" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "proposedLatestRoundData",
+    outputs: [
+      { internalType: "uint80", name: "roundId", type: "uint80" },
+      { internalType: "int256", name: "answer", type: "int256" },
+      { internalType: "uint256", name: "startedAt", type: "uint256" },
+      { internalType: "uint256", name: "updatedAt", type: "uint256" },
+      { internalType: "uint80", name: "answeredInRound", type: "uint80" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "_accessController", type: "address" },
+    ],
+    name: "setController",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "_to", type: "address" }],
+    name: "transferOwnership",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "version",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+];

package/src/chainlink-ops/index.ts

@@ -0,0 +1,53 @@
+import { Contract, Provider } from "ethers";
+import { TokenInfo } from "../token/models";
+import { CHAINLINK_FEED_ABI } from "./chainlink-abi";
+
+export const getPrice = async (
+  tokenInfo: TokenInfo,
+  amount: BigInt,
+  provider: Provider
+) => {
+  const priceFeed = new Contract(
+    tokenInfo.token.priceFeed.priceFeedAddress,
+    CHAINLINK_FEED_ABI,
+    provider
+  );
+  console.log("priceFeed: ", tokenInfo.token.priceFeed.priceFeedAddress);
+  console.log("Networ", (await provider.getNetwork()).chainId);
+  const promises = Promise.all([
+    priceFeed?.latestAnswer?.(),
+    priceFeed?.decimals?.(),
+  ]);
+  const [price, decimals] = await promises;
+
+  const differenceInPrecision = BigInt(18) - BigInt(decimals.toString());
+  const extraDecimals = BigInt(BigInt(10) ** BigInt(differenceInPrecision));
+  tokenInfo.price = BigInt(price) * extraDecimals;
+  tokenInfo.token.priceFeed.priceFeedDecimals = decimals;
+  const tokenDecimalsDifference =
+    BigInt(18) - BigInt(tokenInfo.decimals.toString());
+  const tokenDecimalsExtra = BigInt(
+    BigInt(10) ** BigInt(tokenDecimalsDifference)
+  );
+  tokenInfo.usdValue =
+    (BigInt(amount.toString()) *
+      tokenDecimalsExtra *
+      BigInt(tokenInfo.price!.toString())) /
+    BigInt(BigInt(10) ** BigInt(18));
+
+  return tokenInfo;
+};
+
+export const getMultiplePrices = async (
+  tokenInfoAndProviders: { tokenInfo: TokenInfo; provider: Provider }[]
+) => {
+  const promises = tokenInfoAndProviders.map((tokenInfoAndProvider) =>
+    getPrice(
+      tokenInfoAndProvider.tokenInfo,
+      tokenInfoAndProvider.tokenInfo.balance!,
+      tokenInfoAndProvider.provider
+    )
+  );
+  const results = await Promise.all(promises);
+  return results;
+};

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from "./token";
+export * from "./safe-ops";
+export * from "./chainlink-ops";
+export * from "./chainlink-ops/models";
+export * from "./safe-ops/models";
+export * from "./token/erc20-abi";
+export * from "./token/models";

package/src/safe-ops/index.ts

@@ -0,0 +1,98 @@
+import Safe, { EthSafeSignature } from "@safe-global/protocol-kit";
+import {
+  SafeSignature,
+  SafeTransaction,
+  SafeTransactionData,
+} from "@safe-global/types-kit";
+import { DeconstructedSafeSignature, DeconstructedSafeTx } from "./models";
+
+export const createSafeTx = async (
+  safe: Safe,
+  txList: Array<{
+    to: string;
+    value: string;
+    data: string;
+    operation: number;
+  }>
+): Promise<SafeTransaction> => {
+  try {
+    const safeTx = await safe.createTransaction({ transactions: txList });
+    console.log("safeTx", safeTx);
+    return safeTx;
+  } catch (error) {
+    console.log("error", error);
+    throw error;
+  }
+};
+
+export const signSafeTx = async (
+  safe: Safe,
+  safeTx: SafeTransaction
+): Promise<SafeTransaction> => {
+  try {
+    const signedSafeTx = await safe.signTransaction(safeTx);
+    console.log("signedSafeTx", signedSafeTx);
+    return signedSafeTx;
+  } catch (error) {
+    console.log("error", error);
+    throw error;
+  }
+};
+
+export const getSafeInstance = async (
+  safeAddress: string,
+  privateKey: string,
+  rpcUrl: string
+): Promise<Safe> => {
+  const safe = await Safe.init({
+    safeAddress,
+    provider: rpcUrl,
+    signer: privateKey,
+  });
+  return safe;
+};
+
+export const deconstructSafeTx = async (
+  SafeTransaction: SafeTransaction
+): Promise<{
+  safeTxElements: DeconstructedSafeTx;
+  signatures: DeconstructedSafeSignature[];
+}> => {
+  const safeTxElements: DeconstructedSafeTx = SafeTransaction.data;
+  const signatures: DeconstructedSafeSignature[] = [];
+  SafeTransaction.signatures.entries().forEach(([key, signature]) => {
+    signatures.push({
+      signer: key,
+      signature: signature.data,
+      isContractSignature: signature.isContractSignature,
+    });
+  });
+  return {
+    safeTxElements,
+    signatures,
+  };
+};
+
+export const reconstructSafeTx = async (
+  deconstructedSafeTx: DeconstructedSafeTx,
+  deconstructedSafeSignatures: DeconstructedSafeSignature[]
+): Promise<{
+  safeTx: SafeTransactionData;
+  safeSignatures: SafeSignature[];
+}> => {
+  const safeTx: SafeTransactionData = deconstructedSafeTx;
+  const safeSignatures: SafeSignature[] = [];
+  deconstructedSafeSignatures.forEach((deconstructedSafeSignature) => {
+    safeSignatures.push(
+      new EthSafeSignature(
+        deconstructedSafeSignature.signer,
+        deconstructedSafeSignature.signature,
+        deconstructedSafeSignature.isContractSignature
+      )
+    );
+  });
+  return {
+    safeTx,
+    safeSignatures,
+  };
+};

package/src/safe-ops/models.ts

@@ -0,0 +1,23 @@
+import { OperationType, SafeTransaction } from "@safe-global/types-kit";
+
+export type { SafeTransaction };
+export type { SafeSignature } from "@safe-global/types-kit";
+export { EthSafeSignature } from "@safe-global/protocol-kit";
+
+export interface DeconstructedSafeTx {
+  to: string;
+  value: string;
+  data: string;
+  operation: OperationType;
+  safeTxGas: string;
+  baseGas: string;
+  gasPrice: string;
+  gasToken: string;
+  refundReceiver: string;
+  nonce: number;
+}
+export interface DeconstructedSafeSignature {
+  signer: string;
+  signature: string;
+  isContractSignature: boolean;
+}