@certik/skynet 0.8.4 → 0.8.8

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.8.8
+
+- Improved `postMessage` in `slack` library to support private channels
+
+## 0.8.7
+
+- Changed polygon node endpoint
+
+## 0.8.6
+
+- Fixed a const.js error
+- Support more options in snowflake.js
+
+## 0.8.5
+
+- Improved cross-OS compatibility of `detectDirectory` function
+
 ## 0.8.4
 
 - Added `every` tool to make it easier to build schedule parameter
@@ -26,7 +43,7 @@
 
 ## 0.7.18
 
-- Added the configurability for getTokenPriceAt function in `token` library 
+- Added the configurability for getTokenPriceAt function in `token` library
 
 ## 0.7.17
 

package/cli.js

@@ -16,22 +16,24 @@ function detectWorkingDirectory() {
   const wd = detectDirectory(process.argv[1], "package.json");
   const skynetd = detectDirectory(process.argv[1], "SkynetAPIDefinitions.yml");
 
-  return wd.slice(skynetd.length + path.sep.length);
+  return wd.slice(skynetd.length + path.sep.length).replace(path.sep, "/");
 }
 
 function detectDirectory(fullBinPath, sentinel = "package.json") {
-  const binaryNameParts = fullBinPath.split(path.sep);
+  let parentFolder = path.dirname(fullBinPath);
 
-  const parentFolders = [];
-
-  for (let i = binaryNameParts.length - 1; i > 1; i--) {
-    parentFolders.push(path.join(path.sep, ...binaryNameParts.slice(0, i)));
-  }
-
-  for (let folder of parentFolders) {
-    if (fs.existsSync(path.join(folder, sentinel))) {
-      return folder;
+  while (parentFolder) {
+    // check if parentFolder length is greater than 0
+    const sentinelPath = path.join(parentFolder, sentinel);
+    if (fs.existsSync(sentinelPath)) {
+      return parentFolder;
+    }
+    const newParentFolder = path.dirname(parentFolder);
+    if (newParentFolder === parentFolder) {
+      // we have reached the root folder
+      break;
     }
+    parentFolder = newParentFolder;
   }
 
   throw new Error("Cannot detect current working directory");
@@ -40,7 +42,7 @@ function detectDirectory(fullBinPath, sentinel = "package.json") {
 function detectBin() {
   const wd = detectDirectory(process.argv[1], "package.json");
 
-  return process.argv[1].slice(wd.length + path.sep.length);
+  return process.argv[1].slice(wd.length + path.sep.length).replace(path.sep, "/");
 }
 
 module.exports = {

package/const.js

@@ -1,4 +1,10 @@
-const { getEtherScanApiKey, getBscScanApiKey, getPolygonScanApiKey, getGetBlockApiKey } = require("./env");
+const {
+  getEtherScanApiKey,
+  getBscScanApiKey,
+  getPolygonScanApiKey,
+  getGetBlockApiKey,
+  getAlchemyApiKey,
+} = require("./env");
 
 const SKYNET_API_PREFIX = "https://api.certik-skynet.com";
 
@@ -42,8 +48,9 @@ const PROTOCOLS = {
     nativeTokenAddress: "polygon:0x0000000000000000000000000000000000000000",
     nativeTokenLogo: `https://token-logo.certik-assets.com/polygon:0x0000000000000000000000000000000000000000.png`,
     nativeTokenCoinGeckoId: "matic-network",
-    endpoint: `https://matic.getblock.io/mainnet/?api_key=${getGetBlockApiKey()}`,
-    archiveEndpoint: `https://matic.getblock.io/mainnet/?api_key=${getGetBlockApiKey()}`,
+    endpoint: `https://polygon-mainnet.g.alchemy.com/v2/${getAlchemyApiKey("POLYGON")}`,
+    backupEndpoint: `https://matic.getblock.io/mainnet/?api_key=${getGetBlockApiKey()}`,
+    archiveEndpoint: `https://polygon-mainnet.g.alchemy.com/v2/${getAlchemyApiKey("POLYGON")}`,
     tokenStandard: "ERC20",
     scanApi: {
       endpoint: "https://api.polygonscan.com/api",
@@ -53,70 +60,6 @@ const PROTOCOLS = {
   },
 };
 
-const DEXES = {
-  pancakeswap: {
-    protocol: "bsc",
-    factory: {
-      addr: "0xbcfccbde45ce874adcb698cc183debcf17952812",
-      topics: ["0x0d3648bd0f6ba80134a33ba9275ac585d9d315f0ad8355cddefde31afa28d0e9"],
-      lbl: "PancakeSwap LP",
-      createdAt: 586851,
-    },
-    router: {
-      addr: "bsc:0x05ff2b0db69458a0750badebc4f9e13add608c7f",
-      createdAt: 586899,
-    },
-  },
-  "pancakeswap-v2": {
-    protocol: "bsc",
-    factory: {
-      addr: "0xca143ce32fe78f1f7019d7d551a6402fc5350c73",
-      topics: ["0x0d3648bd0f6ba80134a33ba9275ac585d9d315f0ad8355cddefde31afa28d0e9"],
-      lbl: "PancakeSwap V2 LP",
-      createdAt: 6809737,
-    },
-    router: {
-      addr: "bsc:0x10ed43c718714eb63d5aa57b78b54704e256024e",
-      createdAt: 6810080,
-    },
-  },
-  uniswap: {
-    protocol: "eth",
-    factory: {
-      addr: "0xc0a47dfe034b400b47bdad5fecda2621de6c4d95",
-      topics: ["0x9d42cb017eb05bd8944ab536a8b35bc68085931dd5f4356489801453923953f9"],
-      lbl: "Uniswap LP",
-      createdAt: 6627917,
-    },
-  },
-  "uniswap-v2": {
-    protocol: "eth",
-    factory: {
-      addr: "0x5c69bee701ef814a2b6a3edd4b1652cb9cc5aa6f",
-      topics: ["0x0d3648bd0f6ba80134a33ba9275ac585d9d315f0ad8355cddefde31afa28d0e9"],
-      lbl: "Uniswap V2 LP",
-      createdAt: 10000835,
-    },
-    router: {
-      addr: "eth:0x7a250d5630b4cf539739df2c5dacb4c659f2488d",
-      createdAt: 10207858,
-    },
-  },
-  sushiswap: {
-    protocol: "eth",
-    factory: {
-      addr: "0xc0aee478e3658e2610c5f7a4a2e1777ce9e4f2ac",
-      topics: ["0x0d3648bd0f6ba80134a33ba9275ac585d9d315f0ad8355cddefde31afa28d0e9"],
-      lbl: "SushiSwap LP",
-      createdAt: 10794229,
-    },
-    router: {
-      addr: "eth:0xd9e1ce17f2641f24ae83637ab66a2cca9c378b9f",
-      createdAt: 10794261,
-    },
-  },
-};
-
 const TIME = {
   BY_MS: {
     SECOND: 1000,
@@ -124,20 +67,19 @@ const TIME = {
     HOUR: 1000 * 60 * 60,
     DAY: 1000 * 60 * 60 * 24,
     WEEK: 1000 * 60 * 60 * 24 * 7,
-    YEAR: 1000 * 60 * 60 * 24 * 365
+    YEAR: 1000 * 60 * 60 * 24 * 365,
   },
   BY_S: {
     MINUTE: 60,
     HOUR: 60 * 60,
     DAY: 60 * 60 * 24,
     WEEK: 60 * 60 * 24 * 7,
-    YEAR: 60 * 60 * 24 * 365
-  }
-}
+    YEAR: 60 * 60 * 24 * 365,
+  },
+};
 
 module.exports = {
   SKYNET_API_PREFIX,
   PROTOCOLS,
-  DEXES,
-  TIME
+  TIME,
 };

package/env.js

@@ -30,6 +30,11 @@ function getGetBlockApiKey() {
   return ensureAndGet("SKYNET_GETBLOCK_API_KEY");
 }
 
+function getAlchemyApiKey(identifier) {
+  // Alchemy API keys are different for each alchemy app
+  return ensureAndGet(`SKYNET_ALCHEMY_API_${identifier.toUpperCase()}_KEY`);
+}
+
 function ensureAndGet(envName, defaultValue) {
   if (Array.isArray(envName)) {
     for (let name of envName) {
@@ -75,4 +80,5 @@ module.exports = {
   getBscScanApiKey,
   getPolygonScanApiKey,
   getGetBlockApiKey,
+  getAlchemyApiKey,
 };

package/indexer.js

@@ -539,7 +539,12 @@ ${getSelectorDesc(selector)}
 
     async function runBuild({ verbose, ...selectorFlags }) {
       const startTime = Date.now();
-      console.log(`[INDEXER] starting build, ${toSelectorString(selectorFlags, ", ")}`);
+
+      if (Object.keys(selectorFlags).length > 0) {
+        console.log(`[INDEXER] starting build, ${toSelectorString(selectorFlags, ", ")}`);
+      } else {
+        console.log(`[INDEXER] starting build`);
+      }
 
       const result = await exponentialRetry(
         async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@certik/skynet",
-  "version": "0.8.4",
+  "version": "0.8.8",
   "description": "Skynet Shared JS library",
   "main": "index.js",
   "author": "CertiK Engineering",

package/scan.js

@@ -1,12 +1,12 @@
-const { exponentialRetry, wait } = require("@certik/skynet/availability");
-const { PROTOCOLS } = require("@certik/skynet/const");
+const { exponentialRetry, wait } = require("./availability");
+const { PROTOCOLS } = require("./const");
 const fetch = require("node-fetch");
 
 const BATCH_SIZE = 10_000; // Max number of transactions fetched from scan api at once
 
-function getScanApiEndpoint(protocol, addr, startBlock = 0, endBlock = null) {
+function getScanApiEndpoint(protocol, addr, startBlock = 0, endBlock = null, offset=BATCH_SIZE) {
   const { endpoint, key } = PROTOCOLS[protocol].scanApi;
-  let url = `${endpoint}?module=account&action=txlist&address=${addr}&apikey=${key}&sort=asc&startblock=${startBlock}&page=1&offset=${BATCH_SIZE}`;
+  let url = `${endpoint}?module=account&action=txlist&address=${addr}&apikey=${key}&sort=asc&startblock=${startBlock}&page=1&offset=${offset}`;
 
   if (endBlock) {
     url += `&endblock=${endBlock}`;
@@ -15,19 +15,25 @@ function getScanApiEndpoint(protocol, addr, startBlock = 0, endBlock = null) {
   return url;
 }
 
-async function fetchTxs(protocol, addr, startBlock, to, verbose) {
-  const url = getScanApiEndpoint(protocol, addr, startBlock, to);
+async function fetchTxs(protocol, addr, since, to, offset) {
+  const url = getScanApiEndpoint(protocol, addr, since, to, offset);
 
+  try {
+    const res = await fetch(url);
+    const scanJSON = await res.json();
+    return scanJSON.result;
+  } catch (err) {
+    console.log(`error fetching txs: ${err}`)
+    return null;
+  }
+}
+
+async function fetchTxsWithRetry(protocol, addr, since, to, offset, verbose) {
   const txs = await exponentialRetry(
-    async () => {
-      const res = await fetch(url);
-      const scanJSON = await res.json();
-      return scanJSON.result;
-    },
+    async () => fetchTxs(protocol, addr, since, to, offset),
     { maxRetry: 6, test: Array.isArray, verbose }
   )
 
-  console.log(`start block=${startBlock}, total items=${txs.length}`);
   return txs;
 }
 
@@ -39,7 +45,8 @@ async function streamTxs(address, since, to, callback, verbose) {
   const [protocol, addr] = address.split(":");
 
   while (hasMorePage) {
-    const txs = await fetchTxs(protocol, addr, startBlock, to, verbose);
+    const txs = await fetchTxs(protocol, addr, startBlock, to, BATCH_SIZE, verbose);
+    console.log(`start block=${since}, total items=${txs.length}`);
 
     // This will only ever happen if the total number of txs is a multiple of our batch size
     if (txs.length === 0) {
@@ -65,4 +72,4 @@ async function streamTxs(address, since, to, callback, verbose) {
   }
 }
 
-module.exports = { streamTxs };
+module.exports = { streamTxs, fetchTxs, fetchTxsWithRetry };

package/slack.js

@@ -21,6 +21,7 @@ async function findConversation(client, name) {
 
   // Call the conversations.list method using the built-in WebClient
   let result = await conversations.list({
+    types: "public_channel,private_channel,mpim,im"
     limit: 1000,
   });
 

package/snowflake.js

@@ -3,15 +3,11 @@ const { promisify } = require("util");
 const { ensureAndGet } = require("./env");
 
 async function getConnection(options) {
-  const { account, username, password, database, schema, warehouse } = options;
-
   const connection = snowflake.createConnection({
-    account: account ?? ensureAndGet("SKYNET_SNOWFLAKE_ACCOUNT"),
-    username: username ?? ensureAndGet("SKYNET_SNOWFLAKE_USERNAME"),
-    password: password ?? ensureAndGet("SKYNET_SNOWFLAKE_PASSWORD"),
-    database,
-    schema,
-    warehouse
+    account: ensureAndGet("SKYNET_SNOWFLAKE_ACCOUNT"),
+    username: ensureAndGet("SKYNET_SNOWFLAKE_USERNAME"),
+    password: ensureAndGet("SKYNET_SNOWFLAKE_PASSWORD"),
+    ...options,
   });
   return await promisify(connection.connect).bind(connection)();
 }
@@ -36,5 +32,5 @@ async function executeSql(options, sql, binds) {
 
 module.exports = {
   getConnection,
-  executeSql
-}
+  executeSql,
+};