feat: migrate-lookups-file-flow-to-ts

.babelrc

@@ -1,7 +1,29 @@
 {
   "presets": [ 
     [ "@babel/preset-env",
-     { "targets": { "node": 12 } } ],
+      {
+        "targets": {
+          "node": 12
+        }
+      }],
     "@babel/preset-flow"],
+   "overrides": [
+    {
+      "test": ["./src/**/*.ts"],
+      "presets": [
+        "@babel/preset-typescript",
+        [
+          "@babel/preset-env",
+          {
+            "targets": {
+              "node": 12,
+            }
+          }
+        ],
+      ]
+    }
+  ],
   "plugins": ["istanbul"]
-}
+}
+
+

.flowconfig

@@ -3,10 +3,5 @@
 .*/node_modules/.staging/*
 .*/node_modules/npm/*
 
-[include]
-
-[libs]
-
 [options]
-
-[lints]
+module.file_ext=.ts

package.json

@@ -24,12 +24,16 @@
   "devDependencies": {
     "@babel/cli": "^7.6.3",
     "@babel/core": "^7.6.3",
+    "@babel/plugin-transform-typescript": "^7.16.8",
     "@babel/preset-env": "^7.6.3",
     "@babel/preset-flow": "^7.0.0",
+    "@babel/preset-typescript": "^7.16.7",
     "@babel/register": "^7.7.4",
     "@commitlint/cli": "^12.1.1",
     "@commitlint/config-conventional": "^12.1.1",
     "@istanbuljs/nyc-config-babel": "^2.1.1",
+    "@types/node-fetch": "^2.6.1",
+    "@types/sqlite3": "^3.1.8",
     "babel-eslint": "^10.0.3",
     "babel-plugin-istanbul": "^5.2.0",
     "dotenv": "^8.2.0",
@@ -38,15 +42,16 @@
     "husky": "^6.0.0",
     "nock": "^9.1.6",
     "nyc": "^14.1.1",
-    "tape": "^4.6.3"
+    "tape": "^4.6.3",
+    "typescript": "^4.6.2"
   },
   "bin": {
     "blockstack-subdomain-registrar": "lib/index.js"
   },
   "scripts": {
     "start": "npm run build && node lib/index.js",
     "start:regtest": "BSK_SUBDOMAIN_CONFIG=config-develop.json BSK_SUBDOMAIN_REGTEST=true npm run start",
-    "build": "babel src -d lib",
+    "build": "tsc && babel src -d lib",
     "flow": "flow",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
@@ -102,4 +107,4 @@
       "@semantic-release/git"
     ]
   }
-}
+}

src/lookups.ts

@@ -0,0 +1,87 @@
+import {
+  config as bskConfig,
+  validateProofs,
+  resolveZoneFileToProfile,
+} from "blockstack";
+import { validateStacksAddress } from "@stacks/transactions";
+import fetch from "node-fetch";
+import logger from "winston";
+
+export async function isSubdomainRegistered(fullyQualifiedAddress: string) {
+  try {
+    const nameInfoUrl =
+      bskConfig.network.blockstackAPIUrl + "/v1/names/" + fullyQualifiedAddress;
+    const nameInfoRequest = await fetch(nameInfoUrl, {});
+    const { status } = nameInfoRequest;
+    const nameInfo = await nameInfoRequest.json();
+    if (status == 200) {
+      return nameInfo.status === "registered_subdomain";
+    } else {
+      return false;
+    }
+  } catch (err) {
+    if (err.message === "Name not found") {
+      return false;
+    } else if (err.message === "Bad response status: 500") {
+      return false; // currently, the blockstack api returns 500 on subdomain lookup errors.
+    } else {
+      throw err;
+    }
+  }
+}
+
+export function validlySignedUpdate() {
+  throw new Error("Not implemented");
+}
+
+export async function checkProofs(owner: string, zonefile: any) {
+  const profile = await resolveZoneFileToProfile(zonefile, owner);
+  // ts-ignore used below to not modify the code and not add the cheerio module that is in the validate proofs fn type
+  // @ts-ignore
+  const proofs = await validateProofs(profile, owner);
+  return proofs.filter((x) => x.valid);
+}
+
+export async function isRegistrationValid(
+  subdomainName: string,
+  domainName: string,
+  owner: string,
+  sequenceNumber: number,
+  checkCore: boolean
+) {
+  // currently, only support *new* subdomains
+  if (sequenceNumber !== 0) {
+    logger.debug(`seqn: ${sequenceNumber} failed validation`);
+    return false;
+  }
+
+  // owner should be a stacks address
+  if (!validateStacksAddress(owner)) {
+    logger.debug(`owner: ${owner} failed validation`);
+    return false;
+  }
+
+  // subdomain name should be a legal name
+  const subdomainRegex = /^[a-z0-9\-_+]{1,37}$/;
+  if (!subdomainRegex.test(subdomainName)) {
+    logger.debug(`subdomainName: ${subdomainName} failed validation`);
+    return false;
+  }
+  if (!checkCore) {
+    return true;
+  }
+
+  // shouldn't already exist
+  try {
+    const isRegistered = await isSubdomainRegistered(
+      `${subdomainName}.${domainName}`
+    );
+    if (isRegistered) {
+      logger.warn(`${subdomainName}.${domainName} already exists`);
+    }
+    return !isRegistered;
+  } catch (e) {
+    logger.error(e);
+    return false;
+  }
+}

src/types/winston.d.ts

@@ -0,0 +1 @@
+declare module "winston";

tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": false,
+    "strict": true,
+    "sourceMap": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": false,
+    "useUnknownInCatchVariables": false,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "outDir": "lib",
+    "noEmit": true,
+    "baseUrl": ".",
+    "allowJs": true
+  },
+  "include": [
+    "src/lookups.ts",
+    "src/types",
+  ],
+  "exclude": [
+    "lib",
+    "node_modules"
+  ]
+}