@abtnode/util 1.8.48 → 1.8.50

package/lib/base32.js

@@ -0,0 +1,14 @@
+const { fromBase58 } = require('@ocap/util');
+const { base32 } = require('multiformats/bases/base32');
+
+const encode = (did) => {
+  if (!did) {
+    return did;
+  }
+
+  const buffer = fromBase58(did);
+
+  return base32.encode(buffer);
+};
+
+module.exports = { encode };

package/lib/did-document.js

@@ -1,28 +1,24 @@
-const get = require('lodash/get');
 const stringify = require('json-stable-stringify');
 const { toBase64, toBase58 } = require('@ocap/util');
 const joinUrl = require('url-join');
 const pRetry = require('p-retry');
 const debug = require('debug')('@abtnode/util:did-document');
 const axios = require('./axios');
+const { encode: encodeBase32 } = require('./base32');
 
-const update = async ({ records, didRegistryUrl, wallet }) => {
+const getDID = (address) => `did:abt:${address}`;
+
+const update = async ({ services, didRegistryUrl, wallet }) => {
   debug('update did document', { didRegistryUrl });
 
-  const did = `did:abt:${wallet.address}`;
+  const did = getDID(wallet.address);
   const time = new Date().toISOString();
 
   const document = {
     '@context': 'https://www.w3.org/ns/did/v1',
     id: did,
     controller: did,
-    service: [
-      {
-        id: `${did}#dns`,
-        type: 'DNSRecords',
-        records,
-      },
-    ],
+    service: services,
     verificationMethod: [
       {
         id: `${did}#key-1`,
@@ -50,30 +46,66 @@ const update = async ({ records, didRegistryUrl, wallet }) => {
 
 const updateWithRetry = async (...args) => pRetry(() => update(...args), { retries: 3 });
 
-const updateDaemon = async ({ ips, wallet, didRegistryUrl, domain }) => {
-  try {
-    const filteredIps = (ips || []).filter(Boolean);
-    if (filteredIps.length === 0) {
-      return {
-        status: 'warn',
-        message: 'No DID Document to update',
-      };
-    }
-
-    const records = filteredIps.map((ip) => {
-      return {
-        type: 'A',
-        rr: wallet.address.toLowerCase(),
-        value: ip,
-        domain,
-      };
-    });
-
-    await updateWithRetry({ records, didRegistryUrl, wallet });
-    return { status: 'success' };
-  } catch (err) {
-    return { status: 'error', message: get(err, 'response.data') || err.message };
+const getServerServices = ({ ips, wallet, domain }) => {
+  const records = ips.map((ip) => ({
+    type: 'A',
+    rr: encodeBase32(wallet.address),
+    value: ip,
+    domain,
+  }));
+
+  const services = [
+    {
+      id: getDID(wallet.address),
+      type: 'DNSRecords',
+      records,
+    },
+  ];
+
+  return services;
+};
+
+const getBlockletServices = ({ blockletAppDid, daemonDidDomain, domain }) => {
+  return [
+    {
+      id: getDID(blockletAppDid),
+      type: 'DNSRecords',
+      records: [
+        {
+          type: 'CNAME',
+          rr: encodeBase32(blockletAppDid),
+          value: daemonDidDomain,
+          domain,
+        },
+      ],
+    },
+  ];
+};
+
+const updateServerDocument = async ({ ips, wallet, didRegistryUrl, domain }) => {
+  const filteredIps = (ips || []).filter(Boolean);
+  if (filteredIps.length === 0) {
+    throw new Error('No DID Document to update');
   }
+
+  const services = getServerServices({ ips: filteredIps, domain, wallet });
+
+  return updateWithRetry({ services, didRegistryUrl, wallet });
+};
+
+const updateBlockletDocument = async ({ wallet, didRegistryUrl, domain, daemonDidDomain, blockletAppDid }) => {
+  const services = getBlockletServices({ blockletAppDid, daemonDidDomain, domain });
+
+  return updateWithRetry({ services, didRegistryUrl, wallet });
 };
 
-module.exports = { updateDaemon };
+const disableDNS = async ({ wallet, didRegistryUrl }) => updateWithRetry({ services: [], didRegistryUrl, wallet });
+
+module.exports = {
+  updateServerDocument,
+  updateBlockletDocument,
+  disableDNS,
+  getDID,
+  getServerServices,
+  getBlockletServices,
+};

package/lib/logo-middleware.js

@@ -0,0 +1,136 @@
+const fs = require('fs');
+const path = require('path');
+const get = require('lodash/get');
+
+const logger = require('@abtnode/logger')('@abtnode/util:logo-middleware');
+
+const ensureBlockletExist = async (req, res, next) => {
+  const { blocklet } = req;
+
+  if (!blocklet || !get(blocklet, 'env.appDir')) {
+    res.sendFallbackLogo();
+    return;
+  }
+
+  next();
+};
+
+const ensureCustomSquareLogo = async (req, res, next) => {
+  const { blocklet, sendOptions } = req;
+
+  const customLogoSquare = get(blocklet, 'environmentObj.BLOCKLET_APP_LOGO_SQUARE');
+
+  if (customLogoSquare) {
+    if (customLogoSquare.startsWith('http')) {
+      res.redirect(customLogoSquare);
+      return;
+    }
+
+    const logoFile = path.join(get(blocklet, 'env.appDir'), customLogoSquare);
+    if (fs.existsSync(logoFile)) {
+      res.sendFile(logoFile, sendOptions);
+      return;
+    }
+  }
+
+  next();
+};
+
+const ensureBundleLogo = async (req, res, next) => {
+  const { blocklet, sendOptions } = req;
+
+  if (blocklet.meta.logo) {
+    const logoFile = path.join(get(blocklet, 'env.appDir'), blocklet.meta.logo);
+
+    if (fs.existsSync(logoFile)) {
+      res.sendFile(logoFile, sendOptions);
+      return;
+    }
+  }
+
+  next();
+};
+
+const fallbackLogo = async (req, res) => {
+  res.sendFallbackLogo();
+};
+
+// eslint-disable-next-line no-unused-vars
+const cacheError = async (err, req, res, next) => {
+  logger.error('failed to send blocklet logo', { url: req.url, error: err });
+  res.sendFallbackLogo();
+};
+
+const ensureDefaultLogo = async (req, res, next) => {
+  const { blocklet, sendOptions } = req;
+
+  if (blocklet && get(blocklet, 'env.dataDir')) {
+    get(blocklet, 'env.dataDir');
+
+    const logoSvgFile = path.join(get(blocklet, 'env.dataDir'), 'logo.svg');
+    if (fs.existsSync(logoSvgFile)) {
+      res.sendFile(logoSvgFile, sendOptions);
+      return;
+    }
+
+    const logoPngFile = path.join(get(blocklet, 'env.dataDir'), 'logo.png');
+    if (fs.existsSync(logoPngFile)) {
+      res.sendFile(logoPngFile, sendOptions);
+      return;
+    }
+  }
+
+  next();
+};
+
+const ensureCustomFavicon = async (req, res, next) => {
+  const { blocklet, sendOptions } = req;
+
+  const customLogoFavicon = get(blocklet, 'environmentObj.BLOCKLET_APP_LOGO_FAVICON');
+  if (customLogoFavicon) {
+    if (customLogoFavicon.startsWith('http')) {
+      res.redirect(customLogoFavicon);
+      return;
+    }
+
+    const logoFile = path.join(get(blocklet, 'env.appDir'), customLogoFavicon);
+    if (fs.existsSync(logoFile)) {
+      res.sendFile(logoFile, sendOptions);
+      return;
+    }
+  }
+
+  next();
+};
+
+const attachSendLogoContext =
+  ({ onSendFallbackLogo, onGetBlocklet }) =>
+  async (req, res, next) => {
+    const sendOptions = { maxAge: '1d' };
+
+    req.sendOptions = sendOptions;
+
+    try {
+      req.blocklet = await onGetBlocklet({ req });
+    } catch (error) {
+      logger.error('failed to get blocklet', { url: req.url, error });
+      req.blocklet = null;
+    }
+
+    res.sendFallbackLogo = () => {
+      onSendFallbackLogo({ res, sendOptions });
+    };
+
+    next();
+  };
+
+module.exports = {
+  attachSendLogoContext,
+  ensureBlockletExist,
+  ensureCustomSquareLogo,
+  ensureBundleLogo,
+  ensureCustomFavicon,
+  ensureDefaultLogo,
+  fallbackLogo,
+  cacheError,
+};

package/lib/security.js

@@ -30,8 +30,16 @@ const formatEnv = (raw, stringifyObject = true) => {
   return value;
 };
 
+// https://github.com/joaquimserafim/base64-url/blob/54d9c9ede66a8724f280cf24fd18c38b9a53915f/index.js#L10
+const escape = (str) => str.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '');
+const encodeEncryptionKey = (key) => escape(Buffer.from(key).toString('base64'));
+const unescape = (str) => (str + '==='.slice((str.length + 3) % 4)).replace(/-/g, '+').replace(/_/g, '/');
+const decodeEncryptionKey = (str) => new Uint8Array(Buffer.from(unescape(str), 'base64'));
+
 module.exports = {
   encrypt,
   decrypt,
   formatEnv,
+  encodeEncryptionKey,
+  decodeEncryptionKey,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.48",
+  "version": "1.8.50",
   "description": "ArcBlock's JavaScript utility",
   "main": "lib/index.js",
   "files": [
@@ -18,13 +18,13 @@
   "author": "polunzh <polunzh@gmail.com> (http://github.com/polunzh)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/constant": "1.8.48",
-    "@abtnode/logger": "1.8.48",
-    "@arcblock/jwt": "^1.18.31",
-    "@blocklet/constant": "1.8.48",
-    "@ocap/mcrypto": "1.18.31",
-    "@ocap/util": "1.18.31",
-    "@ocap/wallet": "1.18.31",
+    "@abtnode/constant": "1.8.50",
+    "@abtnode/logger": "1.8.50",
+    "@arcblock/jwt": "^1.18.32",
+    "@blocklet/constant": "1.8.50",
+    "@ocap/mcrypto": "1.18.32",
+    "@ocap/util": "1.18.32",
+    "@ocap/wallet": "1.18.32",
     "axios": "^0.27.2",
     "axios-mock-adapter": "^1.21.2",
     "axon": "^2.0.3",
@@ -41,6 +41,7 @@
     "is-docker": "^2.2.1",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.21",
+    "multiformats": "9.9.0",
     "p-retry": "4.6.1",
     "parallel-transform": "^1.2.0",
     "public-ip": "^4.0.4",
@@ -63,5 +64,5 @@
     "fs-extra": "^10.1.0",
     "jest": "^27.5.1"
   },
-  "gitHead": "39979d7a059d5f97442ac7d46604391e6656ac8d"
+  "gitHead": "7f3ccb957659a6791b93b6fc4fbcbbd2c42f1efd"
 }