@certik/skynet 0.8.3 → 0.8.7

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.8.7
+
+- Change polygon node endpoint
+
+## 0.8.6
+
+- Fixed a const.js error
+- support more options in snowflake.js
+
+## 0.8.5
+
+- Improve cross-OS compatibility of `detectDirectory` function
+
+## 0.8.4
+
+- Added `every` tool to make it easier to build schedule parameter
+
 ## 0.8.2 && 0.8.3
 
 - Made check optional for new indexer/producer app
@@ -22,7 +39,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/app.js

@@ -540,4 +540,23 @@ function consumer({ name, selector, consume, check, env = {}, region = "us-east-
 
 const SENSITIVE_VALUE = null;
 
-module.exports = { indexer, modeIndexer, producer, consumer, SENSITIVE_VALUE, ERROR_LEVEL };
+const every = (n = 1) => {
+  if (n === 1) {
+    return {
+      second: "*/1 * * * * * *",
+      minute: "0 * * * * * *",
+      hour: "0 0 * * * * *",
+      day: "0 0 0 * * * *",
+      week: "0 0 0 * * 0 *",
+    };
+  }
+
+  return {
+    seconds: `*/${n} * * * * * *`,
+    minutes: `0 */${n} * * * * *`,
+    hours: `0 0 */${n} * * * *`,
+    days: `0 0 0 */${n} * * *`,
+  };
+};
+
+module.exports = { indexer, modeIndexer, producer, consumer, every, SENSITIVE_VALUE, ERROR_LEVEL };

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/examples/consumer

@@ -8,7 +8,7 @@
 //   $ examples/consumer deploy --protocol eth
 //   $ examples/consumer --help
 
-const { consumer, ERROR_LEVEL } = require("../app");
+const { consumer, every, ERROR_LEVEL } = require("../app");
 
 async function consume({ protocol, messages, verbose }) {
   console.log("consume called with", protocol, messages, verbose);
@@ -39,7 +39,7 @@ const app = consumer({
 
   check: {
     func: check,
-    schedule: "@minutely",
+    schedule: every(1).minute,
     slackChannel: "skynet-notifications-local-dev",
   },
 });

package/examples/indexer

@@ -8,7 +8,7 @@
 //   $ examples/indexer deploy --protocol eth
 //   $ examples/indexer --help
 
-const { indexer, ERROR_LEVEL } = require("../app");
+const { indexer, every, ERROR_LEVEL } = require("../app");
 
 async function build({ protocol, verbose }) {
   console.log("build called with", protocol, verbose);
@@ -40,14 +40,14 @@ const app = indexer({
 
   build: {
     func: build,
-    schedule: "@minutely",
+    schedule: every(1).minute,
     cpu: 600,
     mem: 200,
   },
 
   check: {
     func: check,
-    schedule: "@minutely",
+    schedule: every(2).minutes,
     maxRetry: 0,
     slackChannel: "skynet-notifications-local-dev",
   },

package/examples/mode-indexer

@@ -9,7 +9,7 @@
 //   $ examples/mode-indexer deploy --protocol eth
 //   $ examples/mode-indexer --help
 
-const { modeIndexer, SENSITIVE_VALUE } = require("../app");
+const { modeIndexer, every, SENSITIVE_VALUE } = require("../app");
 
 async function build({ protocol, from, to, verbose }) {
   console.log("build called with", protocol, from, to, verbose);
@@ -48,7 +48,7 @@ const app = modeIndexer({
     batchSize: 5,
     concurrency: 2, // default is 1, no concurrency
 
-    schedule: "@minutely",
+    schedule: every(1).minute,
     cpu: 800,
     mem: 400,
   },
@@ -58,14 +58,14 @@ const app = modeIndexer({
     batchSize: 2,
     concurrency: 2, // default is 1, no concurrency
 
-    schedule: "@hourly",
+    schedule: every(1).hour,
     cpu: 600,
     mem: 200,
   },
 
   check: {
     func: check,
-    schedule: "@minutely",
+    schedule: every(2).minutes,
     slackChannel: "skynet-notifications-local-dev",
   },
 });

package/examples/producer

@@ -8,7 +8,7 @@
 //   $ examples/producer deploy --protocol eth
 //   $ examples/producer --help
 
-const { producer, SENSITIVE_VALUE, ERROR_LEVEL } = require("../app");
+const { producer, every, SENSITIVE_VALUE, ERROR_LEVEL } = require("../app");
 
 async function produce({ protocol, from, to, verbose, send }) {
   console.log("produce called with", protocol, from, to, verbose);
@@ -72,7 +72,7 @@ const app = producer({
 
   check: {
     func: check,
-    schedule: "@minutely",
+    schedule: every(2).minutes,
     slackChannel: "skynet-notifications-local-dev",
   },
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@certik/skynet",
-  "version": "0.8.3",
+  "version": "0.8.7",
   "description": "Skynet Shared JS library",
   "main": "index.js",
   "author": "CertiK Engineering",
@@ -29,4 +29,4 @@
     "sinon": "^11.1.2"
   },
   "license": "MIT"
-}
+}

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,
+};