@epoch-protocol/inventory-sdk 1.0.0

package/src/token/erc20-abi.ts

@@ -0,0 +1,222 @@
+export const ERC20_ABI = [
+  {
+    constant: true,
+    inputs: [],
+    name: "name",
+    outputs: [
+      {
+        name: "",
+        type: "string",
+      },
+    ],
+    payable: false,
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    constant: false,
+    inputs: [
+      {
+        name: "_spender",
+        type: "address",
+      },
+      {
+        name: "_value",
+        type: "uint256",
+      },
+    ],
+    name: "approve",
+    outputs: [
+      {
+        name: "",
+        type: "bool",
+      },
+    ],
+    payable: false,
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: "totalSupply",
+    outputs: [
+      {
+        name: "",
+        type: "uint256",
+      },
+    ],
+    payable: false,
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    constant: false,
+    inputs: [
+      {
+        name: "_from",
+        type: "address",
+      },
+      {
+        name: "_to",
+        type: "address",
+      },
+      {
+        name: "_value",
+        type: "uint256",
+      },
+    ],
+    name: "transferFrom",
+    outputs: [
+      {
+        name: "",
+        type: "bool",
+      },
+    ],
+    payable: false,
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: "decimals",
+    outputs: [
+      {
+        name: "",
+        type: "uint8",
+      },
+    ],
+    payable: false,
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    constant: true,
+    inputs: [
+      {
+        name: "_owner",
+        type: "address",
+      },
+    ],
+    name: "balanceOf",
+    outputs: [
+      {
+        name: "balance",
+        type: "uint256",
+      },
+    ],
+    payable: false,
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: "symbol",
+    outputs: [
+      {
+        name: "",
+        type: "string",
+      },
+    ],
+    payable: false,
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    constant: false,
+    inputs: [
+      {
+        name: "_to",
+        type: "address",
+      },
+      {
+        name: "_value",
+        type: "uint256",
+      },
+    ],
+    name: "transfer",
+    outputs: [
+      {
+        name: "",
+        type: "bool",
+      },
+    ],
+    payable: false,
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    constant: true,
+    inputs: [
+      {
+        name: "_owner",
+        type: "address",
+      },
+      {
+        name: "_spender",
+        type: "address",
+      },
+    ],
+    name: "allowance",
+    outputs: [
+      {
+        name: "",
+        type: "uint256",
+      },
+    ],
+    payable: false,
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    payable: true,
+    stateMutability: "payable",
+    type: "fallback",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        name: "owner",
+        type: "address",
+      },
+      {
+        indexed: true,
+        name: "spender",
+        type: "address",
+      },
+      {
+        indexed: false,
+        name: "value",
+        type: "uint256",
+      },
+    ],
+    name: "Approval",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        name: "from",
+        type: "address",
+      },
+      {
+        indexed: true,
+        name: "to",
+        type: "address",
+      },
+      {
+        indexed: false,
+        name: "value",
+        type: "uint256",
+      },
+    ],
+    name: "Transfer",
+    type: "event",
+  },
+];

package/src/token/index.ts

@@ -0,0 +1,126 @@
+import { Contract, JsonRpcProvider, Provider, Wallet } from "ethers";
+import { Token, TokenInfo } from "./models";
+import { ERC20_ABI } from "./erc20-abi";
+import { createSafeTx, getSafeInstance, signSafeTx } from "../safe-ops";
+import { SafeTransaction } from "@safe-global/types-kit";
+import Safe from "@safe-global/protocol-kit";
+
+export const getTokenBalance = async (
+  address: string,
+  token: Token,
+  provider: Provider
+): Promise<TokenInfo> => {
+  if (token.address === "0x0000000000000000000000000000000000000000") {
+    const balance = await provider.getBalance(address);
+    return {
+      balance,
+      token: token,
+      decimals: 18,
+    };
+  } else {
+    console.log("Getting token balance for", token.address);
+    console.log("ChainId", await provider.getNetwork());
+    const tokenContract = new Contract(token.address, ERC20_ABI, provider);
+    console.log("name", await getName(token, provider));
+    console.log("symbol", await getSymbol(token, provider));
+    console.log("decimals", await tokenContract?.decimals?.());
+    console.log("balance function", tokenContract?.balanceOf);
+
+    console.log("balance", await tokenContract?.balanceOf!(address));
+
+    const promises = Promise.all([
+      getName(token, provider),
+      getSymbol(token, provider),
+      tokenContract?.decimals?.(),
+      tokenContract?.balanceOf?.(address),
+    ]);
+    const [name, symbol, decimals, balance] = await promises;
+    return {
+      balance,
+      token,
+      decimals,
+      symbol,
+      name,
+    };
+  }
+};
+
+export const getMultipleTokenBalances = async (
+  tokens: Token[],
+  address: string,
+  provider: Provider
+): Promise<Array<TokenInfo>> => {
+  const promises = tokens.map((token) =>
+    getTokenBalance(address, token, provider)
+  );
+
+  const results = await Promise.all(promises);
+  console.log("results", results);
+  return results;
+};
+
+export const getSignedTransferCalldataForSafe = async (
+  safeInstance: Safe,
+  tokenAddress: string,
+  recipientAddress: string,
+  amount: BigInt
+): Promise<SafeTransaction> => {
+  if (tokenAddress === "0x0000000000000000000000000000000000000000") {
+    let safeTx = await createSafeTx(safeInstance, [
+      {
+        to: recipientAddress,
+        value: amount.toString(),
+        data: "0x",
+        operation: 0,
+      },
+    ]);
+
+    safeTx = await signSafeTx(safeInstance, safeTx);
+    return safeTx;
+  } else {
+    const tokenContract = new Contract(tokenAddress, ERC20_ABI);
+    const encodedFunctionCall = tokenContract.interface.encodeFunctionData(
+      "transfer",
+      [recipientAddress, amount]
+    );
+    console.log("encodedFunctionCall", encodedFunctionCall);
+    let safeTx = await createSafeTx(safeInstance, [
+      {
+        to: tokenAddress,
+        value: "0",
+        data: encodedFunctionCall,
+        operation: 0,
+      },
+    ]);
+
+    safeTx = await signSafeTx(safeInstance, safeTx);
+    console.log("safeTx signed", safeTx);
+    return safeTx;
+  }
+};
+export const getDecimals = async (token: Token, provider: Provider) => {
+  const erc20 = new Contract(token.address, ERC20_ABI, provider);
+  const decimals = await erc20?.decimals?.();
+  if (!decimals) {
+    throw new Error("Decimals not found");
+  }
+  return decimals;
+};
+const getName = async (token: Token, provider: Provider): Promise<string> => {
+  try {
+    const erc20 = new Contract(token.address, ERC20_ABI, provider);
+    const name = await erc20?.name?.();
+    return name;
+  } catch (error) {
+    return "";
+  }
+};
+const getSymbol = async (token: Token, provider: Provider): Promise<string> => {
+  try {
+    const erc20 = new Contract(token.address, ERC20_ABI, provider);
+    const symbol = await erc20?.symbol?.();
+    return symbol;
+  } catch (error) {
+    return "";
+  }
+};

package/src/token/models.ts

@@ -0,0 +1,32 @@
+import {
+  SafeSignature,
+  SafeTransaction,
+  SafeTransactionData,
+} from "@safe-global/types-kit";
+import { DeconstructedSafeSignature } from "../safe-ops/models";
+export interface TokenInfo {
+  token: Token;
+  decimals: number;
+  balance?: BigInt;
+  symbol?: string;
+  name?: string;
+  //with 10**18
+  price?: BigInt;
+  usdValue?: BigInt;
+}
+
+export interface Token {
+  address: string;
+  chainId: number;
+  priceFeed: {
+    priceFeedAddress: string;
+    priceFeedDecimals?: number;
+    priceFeedChainId: number;
+  };
+}
+export interface OptimalTokenWithCalldata {
+  token: TokenInfo;
+  safeTx: SafeTransactionData;
+  safeSignatures: DeconstructedSafeSignature[];
+  treasuryAddress: string;
+}

package/tsconfig.json

@@ -0,0 +1,43 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    // "rootDir": "./src",
+    "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    "types": [],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+  }
+}