@abtnode/constant 1.15.17 → 1.16.0-beta-b16cb035

package/index.js

@@ -1,9 +1,10 @@
 const NODE_SERVICES = Object.freeze({
-  AUTH_SERVICE: '@abtnode/auth-service',
+  AUTH: 'auth',
+  AUTH_SERVICE: '@abtnode/auth-service', // deprecated
 });
 
 const NODE_SERVICES_PREFIX = Object.freeze({
-  AUTH_SERVICE: `/.service/${NODE_SERVICES.AUTH_SERVICE}`,
+  AUTH_SERVICE: `/.service/${NODE_SERVICES.AUTH_SERVICE}`, // deprecated
 });
 
 const ROLES = Object.freeze({
@@ -13,48 +14,108 @@ const ROLES = Object.freeze({
   GUEST: 'guest',
 });
 
+const SERVER_ROLES = Object.freeze({
+  ...ROLES,
+  CI: 'ci',
+  CERTIFICATE: 'certificate',
+
+  // blocklet user or sdk. must start with 'blocklet-
+  BLOCKLET_OWNER: 'blocklet-owner',
+  BLOCKLET_ADMIN: 'blocklet-admin',
+  BLOCKLET_MEMBER: 'blocklet-member',
+  BLOCKLET_SDK: 'blocklet-sdk',
+
+  // external user
+  EXTERNAL_BLOCKLET_CONTROLLER: 'external-blocklet-controller',
+  EXTERNAL_BLOCKLETS_MANAGER: 'external-blocklets-manager',
+});
+
+const BLOCKLET_ROLES = [
+  SERVER_ROLES.BLOCKLET_OWNER,
+  SERVER_ROLES.BLOCKLET_ADMIN,
+  SERVER_ROLES.BLOCKLET_MEMBER,
+  SERVER_ROLES.BLOCKLET_SDK,
+];
+
+const isBlockletRole = (role) => role && BLOCKLET_ROLES.includes(role);
+
+const AUTH_CERT_TYPE = {
+  USER: 'user',
+  OWNERSHIP_NFT: 'ownership_nft',
+  BLOCKLET_USER: 'blocklet_user',
+  BLOCKLET_CONTROLLER: 'blocklet_controller',
+};
+
 const RBAC_CONFIG = {
   roles: Object.freeze([
     {
-      name: ROLES.OWNER,
+      name: SERVER_ROLES.OWNER,
       title: 'Owner',
       description: 'Has full administrative access to the Blocklet Server',
       passport: true,
     },
     {
-      name: ROLES.ADMIN,
+      name: SERVER_ROLES.ADMIN,
       title: 'Admin',
       description:
         'Has full permissions to manage blocklet and Blocklet Server such as install/remove/start/stop blocklet, manage blocklet URL mapping and certificates, manage blocklet team, manage node integrations and access keys, upgrade node to a new version',
       passport: true,
     },
     {
-      name: ROLES.MEMBER,
+      name: SERVER_ROLES.MEMBER,
       title: 'Member',
       description:
         'Has permissions to manage blocklets, such as install/remove/start/stop blocklet, manage blocklet URL mapping and certificates',
       passport: true,
     },
     {
-      name: ROLES.GUEST,
+      name: SERVER_ROLES.GUEST,
       title: 'Guest',
       description: 'Has all read permissions on Blocklet Server',
       passport: true,
     },
     {
-      name: 'ci',
+      name: SERVER_ROLES.CI,
       title: 'CI',
       description: 'Deploy blocklet to Blocklet Server',
       passport: true,
-      ci: true,
+      noHuman: true,
     },
     {
-      name: 'certificate',
+      name: SERVER_ROLES.CERTIFICATE,
       title: 'Certificate',
       description: 'Manage https certificates for blocklets on the Blocklet Server',
       passport: true,
-      ci: true,
+      noHuman: true,
+    },
+    {
+      name: SERVER_ROLES.BLOCKLET_OWNER,
+      title: 'Blocklet Owner',
+    },
+    {
+      name: SERVER_ROLES.BLOCKLET_ADMIN,
+      title: 'Blocklet Admin',
+    },
+    {
+      name: SERVER_ROLES.BLOCKLET_MEMBER,
+      title: 'Blocklet Member',
+    },
+    {
+      name: SERVER_ROLES.BLOCKLET_SDK,
+      title: 'Blocklet SDK',
+    },
+    {
+      name: SERVER_ROLES.EXTERNAL_BLOCKLET_CONTROLLER,
+      title: 'External Blocklet Controller',
+    },
+    {
+      name: SERVER_ROLES.EXTERNAL_BLOCKLETS_MANAGER,
+      title: 'External Blocklets Manager',
+      description: 'Manage external blocklets in the Blocklet Server',
+      passport: true,
+      noHuman: true,
     },
+    // for backward compatibility
     {
       name: NODE_SERVICES.AUTH_SERVICE,
       title: 'Auth Service',
@@ -95,11 +156,11 @@ const RBAC_CONFIG = {
       description: 'Manage team data(members/roles/permissions) for Blocklet Server and blocklets',
     },
     {
-      name: 'query_blocklet',
-      description: 'View marketplace and installed blocklets, including blocklet runtime configuration and access URLs',
+      name: 'query_blocklets',
+      description: 'View store and installed blocklets, including blocklet runtime configuration, domains and urls',
     },
     {
-      name: 'mutate_blocklet',
+      name: 'mutate_blocklets',
       description: 'Perform state changing actions on blocklets, such as install/upgrade/config/start/stop/remove',
     },
     {
@@ -134,10 +195,19 @@ const RBAC_CONFIG = {
       name: 'mutate_webhook',
       description: 'Manage integrations',
     },
+    // query_blocklet, mutate_blocklet are only for blocklet members
+    {
+      name: 'query_blocklet',
+      description: 'View a blocklet, including blocklet runtime configuration, domains and urls',
+    },
+    {
+      name: 'mutate_blocklet',
+      description: 'Perform state changing actions on a blocklet, such as upgrade/config/start/stop',
+    },
   ]),
   grants: Object.freeze({
-    [ROLES.GUEST]: [
-      'query_blocklet',
+    [SERVER_ROLES.GUEST]: [
+      'query_blocklets',
       'query_router',
       'query_webhook',
       'query_notification',
@@ -146,65 +216,152 @@ const RBAC_CONFIG = {
       'query_node',
       'query_session',
     ],
-    [ROLES.MEMBER]: [ROLES.GUEST, 'mutate_blocklet', 'mutate_router', 'mutate_notification', 'mutate_session'],
-    [ROLES.ADMIN]: [ROLES.MEMBER, 'mutate_team', 'mutate_webhook', 'mutate_accessKey', 'mutate_node'],
-    [ROLES.OWNER]: [ROLES.ADMIN],
-    '@abtnode/auth-service': ['query_team', 'mutate_team'],
-    ci: ['query_blocklet', 'mutate_blocklet'],
-    certificate: ['query_certificate', 'mutate_certificate'],
+    [SERVER_ROLES.MEMBER]: [
+      SERVER_ROLES.GUEST,
+      'mutate_blocklets',
+      'mutate_router',
+      'mutate_notification',
+      'mutate_session',
+    ],
+    [SERVER_ROLES.ADMIN]: [
+      SERVER_ROLES.MEMBER,
+      'mutate_team',
+      'mutate_webhook',
+      'mutate_accessKey',
+      'mutate_node',
+      'mutate_certificate',
+    ],
+    [SERVER_ROLES.OWNER]: [ROLES.ADMIN],
+    [SERVER_ROLES.CI]: ['query_blocklets', 'mutate_blocklets'],
+    [SERVER_ROLES.CERTIFICATE]: ['query_certificate', 'mutate_certificate'],
+
+    // blocklet app or blocklet user
+    [SERVER_ROLES.BLOCKLET_SDK]: ['query_team', 'mutate_team'],
+    [SERVER_ROLES.BLOCKLET_OWNER]: [SERVER_ROLES.BLOCKLET_ADMIN],
+    [SERVER_ROLES.BLOCKLET_ADMIN]: [SERVER_ROLES.BLOCKLET_MEMBER, 'mutate_team', 'mutate_blocklet'],
+    [SERVER_ROLES.BLOCKLET_MEMBER]: ['query_team', 'query_blocklet'],
+
+    // external user
+    [SERVER_ROLES.EXTERNAL_BLOCKLET_CONTROLLER]: ['query_blocklets', 'mutate_blocklets'],
+    [SERVER_ROLES.EXTERNAL_BLOCKLETS_MANAGER]: ['query_blocklets', 'mutate_blocklets'],
   }),
 };
 
 const DAY_IN_MS = 24 * 60 * 60 * 1000;
 
+const EVENTS = {
+  NOTIFICATION_CREATE: 'notification.create',
+  ROUTING_UPDATED: 'routing.updated',
+  NODE_UPDATED: 'node.updated',
+  NODE_MAINTAIN_PROGRESS: 'node.upgrade.progress',
+  NODE_STARTED: 'node.started',
+  NODE_STOPPED: 'node.stopped',
+  NODE_ADDED_OWNER: 'node.addedOwner',
+  NODE_RUNTIME_INFO: 'node.runtimeInfo',
+  BLOCKLETS_RUNTIME_INFO: 'node.blockletsRuntimeInfo',
+  DOMAIN_STATUS: 'domain.status',
+  USER_ADDED: 'user.added',
+  USER_REMOVED: 'user.removed',
+  USER_UPDATED: 'user.updated',
+  CERT_ADDED: 'cert.added',
+  CERT_ISSUED: 'cert.issued',
+  CERT_UPDATED: 'cert.updated',
+  CERT_REMOVED: 'cert.removed',
+  CERT_ERROR: 'cert.error',
+  RELOAD_GATEWAY: 'gateway.reload',
+};
+
+const WHO_CAN_ACCESS = {
+  OWNER: 'owner',
+  INVITED: 'invited',
+  ALL: 'all',
+};
+
+const BLOCKLET_STORE_URL = 'https://store.blocklet.dev';
+const BLOCKLET_STORE_URL_DEV = 'https://dev.store.blocklet.dev';
+const MAIN_CHAIN_ENDPOINT = 'https://main.abtnetwork.io/api/';
+
 module.exports = Object.freeze({
   // Blocklet Server
   NODE_MODES: Object.freeze({
     PRODUCTION: 'production',
     DEBUG: 'debug',
     MAINTENANCE: 'maintenance',
-    IMMUTABLE: 'immutable',
+    SERVERLESS: 'serverless',
   }),
 
   DEFAULT_DESCRIPTION: 'Web Interface to manage your Blocklet Server',
 
-  NODE_UPGRADE_PROGRESS: Object.freeze({
+  NODE_MAINTAIN_PROGRESS: Object.freeze({
     SETUP: 'setup', // backup
     INSTALLING: 'installing',
+    VERIFYING: 'verifying',
     RESTARTING: 'restarting',
     CLEANUP: 'cleanup',
     COMPLETE: 'complete',
     ROLLBACK: 'rollback',
   }),
 
-  NFT_TYPE_NODE_OWNERSHIP: 'NodeOwnershipCredential',
-  BLOCKLET_PURCHASE_NFT_TYPE: 'BlockletPurchaseCredential',
-  NFT_TYPE_SERVICE_OWNERSHIP: 'ServiceOwnershipCredential',
-  SERVICE_PURCHASE_NFT_TYPE: 'ServicePurchaseCredential',
+  VC_TYPE_BLOCKLET_PURCHASE: 'BlockletPurchaseCredential',
+  VC_TYPE_NODE_PASSPORT: 'ABTNodePassport',
+  VC_TYPE_GENERAL_PASSPORT: 'NFTPassport',
+
+  NFT_TYPE_SERVER_OWNERSHIP: 'BlockletServerOwnershipNFT',
+  NFT_TYPE_SERVERLESS: 'BlockletServerServerlessNFT',
 
-  NODE_PACKAGE_NAME: '@abtnode/cli',
-  NODE_COMMAND_NAME: 'abtnode',
+  NODE_PACKAGE_NAME: '@abtnode/cli', // deprecated in 1.6.0
+  NODE_COMMAND_NAME: 'abtnode', // deprecated in 1.6.0
+  NODE_DATA_DIR_NAME: '_abtnode',
+  USER_AVATAR_DIR: '/.assets/avatar',
+  USER_AVATAR_URL_PREFIX: 'bn://avatar',
+  USER_AVATAR_PATH_PREFIX: '/user/avatar',
 
   PROCESS_NAME_DAEMON: 'abt-node-daemon',
   PROCESS_NAME_PROXY: 'abt-node-db-hub',
   PROCESS_NAME_UPDATER: 'abt-node-updater',
   PROCESS_NAME_SERVICE: 'abt-node-service',
+  PROCESS_NAME_ROUTER: 'abt-node-router',
   PROCESS_NAME_LOG_ROTATE: 'abt-node-log-rotate',
   PROCESS_NAME_EVENT_HUB: 'abt-node-event-hub',
 
-  NODE_REGISTER_URL: 'https://install.arcblock.io/', // removed in 1.5.1
+  NODE_REGISTER_URL: 'https://install.arcblock.io/',
   WEB_WALLET_URL: 'https://web.abtwallet.io',
-  BLOCKLET_STORE_URL: 'https://store.blocklet.dev',
-  BLOCKLET_STORE_URL_DEV: 'https://dev.store.blocklet.dev',
+  BLOCKLET_STORE_URL,
+  BLOCKLET_STORE_URL_DEV,
   BLOCKLET_STORE_API_PREFIX: '/api',
+  BLOCKLET_STORE_API_BLOCKLET_PREFIX: '/api/blocklets',
+  BLOCKLET_STORE_META_PATH: '/api/store.json',
+  BLOCKLET_STORE: {
+    name: 'Official Store',
+    description: 'ArcBlock official blocklet registry',
+    url: BLOCKLET_STORE_URL,
+    logoUrl: '/logo.png',
+    maintainer: 'arcblock',
+  },
+  BLOCKLET_STORE_DEV: {
+    name: 'Dev Store',
+    description: 'ArcBlock dev registry that contains demo and example blocklets',
+    url: BLOCKLET_STORE_URL_DEV,
+    maintainer: 'arcblock',
+    logoUrl: '/logo.png',
+  },
 
-  DEFAULT_IP_DNS_DOMAIN_SUFFIX: 'ip.abtnet.io',
-  DEFAULT_DASHBOARD_DOMAIN: '*.ip.abtnet.io',
-  DEFAULT_DASHBOARD_CERT_DOWN_ADDR: 'https://cert.abtnet.io/open/download/certificates/ip_abtnet_io',
+  // application is a container, components have no hierarchy and are tiled in application
+  APP_STRUCT_VERSION: '2',
 
-  CONFIG_FILENAME: 'abtnode.yml',
-  CONFIG_FOLDER_NAME: '.abtnode',
-  EXPORTED_FOLDER_NAME: 'exported_abtnode',
+  DEFAULT_DID_REGISTRY: 'https://registry.abtnet.io',
+  DEFAULT_DID_DOMAIN: 'did.abtnet.io',
+  DEFAULT_IP_DOMAIN: '*.ip.abtnet.io',
+  DEFAULT_IP_DOMAIN_SUFFIX: 'ip.abtnet.io',
+  DEFAULT_WILDCARD_CERT_HOST: 'https://releases.arcblock.io/',
+
+  DEFAULT_CERTIFICATE_EMAIL: 'certs@arcblock.io',
+
+  CONFIG_FILENAME: 'config.yml',
+  CONFIG_FILENAME_OLD: 'abtnode.yml',
+  CONFIG_FOLDER_NAME: '.blocklet-server',
+  CONFIG_FOLDER_NAME_OLD: '.abtnode',
+  EXPORTED_FOLDER_NAME: 'exported_blocklet_server',
 
   StatusCode: Object.freeze({
     ok: 0,
@@ -218,14 +375,20 @@ module.exports = Object.freeze({
   }),
 
   // Service Gateway
-  ROUTER_PROVIDER_NONE: 'none',
+  // eslint-disable-next-line prefer-regex-literals
+  IP: new RegExp('-(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\-(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}'),
   DOMAIN_FOR_IP_SITE: '',
   DOMAIN_FOR_IP_SITE_REGEXP: `~^\\d+.\\d+.\\d+.\\d+$`, // eslint-disable-line
   DOMAIN_FOR_DEFAULT_SITE: '*',
   DOMAIN_FOR_INTERNAL_SITE: '127.0.0.1',
   NAME_FOR_WELLKNOWN_SITE: 'wellknown',
   WELLKNOWN_PATH_PREFIX: '/.well-known',
-  WELLKNOWN_AUTH_PATH_PREFIX: '/.well-known/auth',
+  WELLKNOWN_ACME_CHALLENGE_PREFIX: '/.well-known/acme-challenge',
+  WELLKNOWN_DID_RESOLVER_PREFIX: '/.well-known/did.json',
+  WELLKNOWN_PING_PREFIX: '/.well-known/ping',
+  WELLKNOWN_SERVICE_PATH_PREFIX: '/.well-known/service',
+  WELLKNOWN_BLOCKLET_ADMIN_PATH: '/.well-known/service/admin',
+  WELLKNOWN_BLOCKLET_LOGO_PATH: '/.well-known/service/blocklet/logo',
   SLOT_FOR_IP_DNS_SITE: '888-888-888-888',
 
   DEFAULT_ADMIN_PATH: '/admin',
@@ -234,17 +397,17 @@ module.exports = Object.freeze({
   DEFAULT_HTTPS_PORT: 443,
   MAX_UPLOAD_FILE_SIZE: 500, // unit: MB
   DEFAULT_DAEMON_PORT: 8089,
+  MAX_NGINX_WORKER_CONNECTIONS: 10240,
 
   BLOCKLET_PROXY_PATH_PREFIX: '/.blocklet/proxy',
   BLOCKLET_SITE_GROUP_SUFFIX: '.blocklet-domain-group',
 
   // Time and dates
   DAY_IN_MS,
-  DAEMON_MAX_MEM_LIMIT_IN_MB: 600,
-  PROXY_MAX_MEM_LIMIT_IN_MB: 300,
-  BLOCKLET_MAX_MEM_LIMIT_IN_MB: 300,
-  CERTIFICATE_EXPIRES_OFFSET: 8 * DAY_IN_MS,
-  CERTIFICATE_EXPIRES_WARNING_OFFSET: 7 * DAY_IN_MS,
+  DAEMON_MAX_MEM_LIMIT_IN_MB: 800,
+  PROXY_MAX_MEM_LIMIT_IN_MB: 800,
+  BLOCKLET_MAX_MEM_LIMIT_IN_MB: 800,
+  CERTIFICATE_EXPIRES_OFFSET: 10 * DAY_IN_MS,
   ROUTING_RULE_TYPES: Object.freeze({
     NONE: 'none',
     DAEMON: 'daemon',
@@ -252,15 +415,17 @@ module.exports = Object.freeze({
     BLOCKLET: 'blocklet',
     REDIRECT: 'redirect',
     GENERAL_PROXY: 'general_proxy',
+    DIRECT_RESPONSE: 'direct_response',
   }),
 
   // Team
   ROLES,
+  SERVER_ROLES,
+  BLOCKLET_ROLES,
+  isBlockletRole,
+  AUTH_CERT_TYPE,
   RBAC_CONFIG,
   genPermissionName: (resource, action = 'access') => `${action}_${resource.replace('_', '-')}`, // resource cannot include '_'
-  NFT_TYPE_NODE_PASSPORT: 'ABTNodePassport',
-  NFT_TYPE_GENERAL_PASSPORT: 'NFTPassport',
-  NFT_TYPE_GENERAL_PASSPORT_OLD: 'PassportVerificationCredential', // backward compatible
   PASSPORT_STATUS: {
     VALID: 'valid',
     REVOKED: 'revoked',
@@ -271,4 +436,56 @@ module.exports = Object.freeze({
   NODE_SERVICES_PREFIX,
 
   DISK_ALERT_THRESHOLD_PERCENT: 80,
+
+  // EVENTS
+  EVENTS,
+
+  WHO_CAN_ACCESS,
+  WHO_CAN_ACCESS_PREFIX_ROLES: 'roles:',
+
+  GATEWAY_REQ_LIMIT: Object.freeze({
+    min: 10,
+    max: 100,
+  }),
+
+  // Store
+  STORE_DETAIL_PAGE_PATH_PREFIX: '/blocklets',
+
+  MAX_USER_PAGE_SIZE: 100,
+
+  SERVER_STATUS: {
+    RUNNING: 1,
+    STOPPED: 2,
+    START_FROM_CRASH: 3,
+  },
+
+  LOG_RETAIN_IN_DAYS: 60,
+  EXPIRED_BLOCKLET_DATA_RETENTION_DAYS: 7,
+
+  BLOCKLET_INSTALL_TYPE: {
+    STORE: 'store',
+    URL: 'url',
+    DEV: 'dev',
+    CREATE: 'create',
+    RESTORE: 'restore',
+  },
+
+  // @link https://docs.nginx.com/nginx/admin-guide/content-cache/content-caching/
+  // @link https://www.sheshbabu.com/posts/nginx-caching-proxy/
+  // @link https://www.nginx.com/blog/nginx-caching-guide/
+  ROUTER_CACHE_GROUPS: {
+    blockletProxy: {
+      minSize: '8m',
+      maxSize: '2g',
+      period: '30d',
+    },
+    // TODO: disabled because we can not bust nginx cache effectively for now
+    // blockletJs: {
+    //   minSize: '8m',
+    //   maxSize: '64m',
+    //   period: '5m',
+    // },
+  },
+
+  MAIN_CHAIN_ENDPOINT,
 });

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.15.17",
+  "version": "1.16.0-beta-b16cb035",
   "description": "ABT Node constants",
   "main": "index.js",
   "files": [
@@ -18,7 +18,7 @@
   "author": "polunzh <polunzh@gmail.com> (http://github.com/polunzh)",
   "license": "MIT",
   "devDependencies": {
-    "jest": "^27.3.1"
+    "jest": "^27.5.1"
   },
-  "gitHead": "22715c3ea74d0230f3413162a17f491614b6735a"
+  "gitHead": "138bd91aee5a35b28c2de4e1e924c44932efaf3a"
 }