Merge remote-tracking branch 'origin/v1.4-dev' into feat/get-node-status-in-sdk

Author: lklimek

CHANGELOG.md

@@ -1,3 +1,54 @@
+## [1.4.0-dev.1](https://github.com/dashpay/platform/compare/v1.3.0...v1.4.0-dev.1) (2024-09-27)
+
+
+### ⚠ BREAKING CHANGES
+
+* **sdk:** change default network to mainnet (#2161)
+* **dashmate:** confirm a node reset (#2160)
+* **platform:** withdrawals polishing and fixes for mainnet (#2166)
+* **platform:** do not switch to oldest quorums in validator set update (#2167)
+
+### Features
+
+* **dashmate:** confirm a node reset ([#2160](https://github.com/dashpay/platform/issues/2160))
+* **platform:** do not switch to oldest quorums in validator set update ([#2167](https://github.com/dashpay/platform/issues/2167))
+* **platform:** get current quorum info  ([#2168](https://github.com/dashpay/platform/issues/2168))
+* **platform:** withdrawals polishing and fixes for mainnet ([#2166](https://github.com/dashpay/platform/issues/2166))
+* **sdk:** change default network to mainnet ([#2161](https://github.com/dashpay/platform/issues/2161))
+
+
+### Bug Fixes
+
+* **dapi:** getStatus cache invalidation ([#2155](https://github.com/dashpay/platform/issues/2155))
+* **dapi:** invalid mainnet seed ports ([#2173](https://github.com/dashpay/platform/issues/2173))
+* **dashmate:** cannot read properties of undefined (reading 'expires') ([#2164](https://github.com/dashpay/platform/issues/2164))
+* **dashmate:** colors[updated] is not a function ([#2157](https://github.com/dashpay/platform/issues/2157))
+* **dashmate:** doctor fails collecting to big logs ([#2158](https://github.com/dashpay/platform/issues/2158))
+* **dashmate:** port marks as closed if ipv6 is not disabled ([#2162](https://github.com/dashpay/platform/issues/2162))
+* **dashmate:** remove confusing short flag name ([#2165](https://github.com/dashpay/platform/issues/2165))
+
+
+### Continuous integration
+
+* build dashmate package on macos14
+  
+
+### Documentation
+
+* **dashmate:** document logging configuration ([#2156](https://github.com/dashpay/platform/issues/2156))
+
+
+### Tests
+
+* **dashmate:** e2e tests failing due to DKG interval check ([#2171](https://github.com/dashpay/platform/issues/2171))
+
+
+### Miscellaneous Chores
+
+* **dashmate:** do not call mint on masternodes ([#2172](https://github.com/dashpay/platform/issues/2172))
+* **platform:** protocol version 4 creation ([#2153](https://github.com/dashpay/platform/issues/2153))
+
+
 ## [1.3.0](https://github.com/dashpay/platform/compare/v1.2.0...v1.3.0) (2024-09-19)
 
 ### Features

packages/dapi/lib/externalApis/tenderdash/BlockchainListener.js

@@ -13,7 +13,12 @@ class BlockchainListener extends EventEmitter {
    */
   constructor(tenderdashWsClient) {
     super();
+
     this.wsClient = tenderdashWsClient;
+
+    this.processLogger = logger.child({
+      process: 'BlockchainListener',
+    });
   }
 
   /**
@@ -30,14 +35,7 @@ class BlockchainListener extends EventEmitter {
    * Subscribe to blocks and transaction results
    */
   start() {
-    const processLogger = logger.child({
-      process: 'BlockchainListener',
-    });
-
-    processLogger.info('Subscribed to state transition results');
-
     // Emit transaction results
-    this.wsClient.subscribe(TX_QUERY);
     this.wsClient.on(TX_QUERY, (message) => {
       const [hashString] = (message.events || []).map((event) => {
         const hashAttribute = event.attributes.find((attribute) => attribute.key === 'hash');
@@ -53,15 +51,31 @@ class BlockchainListener extends EventEmitter {
         return;
       }
 
-      processLogger.trace(`received transaction result for ${hashString}`);
+      this.processLogger.trace(`Received transaction result for ${hashString}`);
 
       this.emit(BlockchainListener.getTransactionEventName(hashString), message);
     });
 
-    // TODO: It's not using
     // Emit blocks and contained transactions
-    // this.wsClient.subscribe(NEW_BLOCK_QUERY);
-    // this.wsClient.on(NEW_BLOCK_QUERY, (message) => this.emit(EVENTS.NEW_BLOCK, message));
+    this.wsClient.on(NEW_BLOCK_QUERY, (message) => {
+      this.processLogger.trace('Received new platform block');
+
+      this.emit(EVENTS.NEW_BLOCK, message);
+    });
+
+    this.wsClient.on('connect', () => {
+      this.#subscribe();
+    });
+
+    if (this.wsClient.isConnected) {
+      this.#subscribe();
+    }
+  }
+
+  #subscribe() {
+    this.wsClient.subscribe(TX_QUERY);
+    this.wsClient.subscribe(NEW_BLOCK_QUERY);
+    this.processLogger.debug('Subscribed to platform blockchain events');
   }
 }
 

packages/dapi/lib/grpcServer/handlers/platform/getStatusHandlerFactory.js

@@ -9,6 +9,7 @@ const {
 } = require('@dashevo/dapi-grpc');
 
 const BlockchainListener = require('../../../externalApis/tenderdash/BlockchainListener');
+const logger = require('../../../logger');
 
 /**
  * @param {BlockchainListener} blockchainListener
@@ -17,12 +18,23 @@ const BlockchainListener = require('../../../externalApis/tenderdash/BlockchainL
  * @return {getStatusHandler}
  */
 function getStatusHandlerFactory(blockchainListener, driveClient, tenderdashRpcClient) {
-  // Clean cache when new platform block committed
   let cachedResponse = null;
+  let cleanCacheTimeout = null;
 
-  blockchainListener.on(BlockchainListener.EVENTS.NEW_BLOCK, () => {
+  function cleanCache() {
     cachedResponse = null;
-  });
+
+    // cancel scheduled cache cleanup
+    if (cleanCacheTimeout !== null) {
+      clearTimeout(cleanCacheTimeout);
+      cleanCacheTimeout = null;
+    }
+
+    logger.trace({ endpoint: 'getStatus' }, 'cleanup cache');
+  }
+
+  // Clean cache when new platform block committed
+  blockchainListener.on(BlockchainListener.EVENTS.NEW_BLOCK, cleanCache);
 
   // DAPI Software version
   const packageJsonPath = path.resolve(__dirname, '..', '..', '..', '..', 'package.json');
@@ -210,6 +222,15 @@ function getStatusHandlerFactory(blockchainListener, driveClient, tenderdashRpcC
     cachedResponse = new GetStatusResponse();
     cachedResponse.setV0(v0);
 
+    // Cancel any existing scheduled cache cleanup
+    if (cleanCacheTimeout !== null) {
+      clearTimeout(cleanCacheTimeout);
+      cleanCacheTimeout = null;
+    }
+
+    // Clean cache in 3 minutes
+    cleanCacheTimeout = setTimeout(cleanCache, 3 * 60 * 1000);
+
     return cachedResponse;
   }
 

packages/dapi/test/integration/externalApis/tenderdash/BlockchainListener.spec.js

@@ -15,8 +15,8 @@ describe('BlockchainListener', () => {
     ({ sinon } = this);
     wsClientMock = new EventEmitter();
     wsClientMock.subscribe = sinon.stub();
+
     blockchainListener = new BlockchainListener(wsClientMock);
-    blockchainListener.start();
 
     sinon.spy(blockchainListener, 'on');
     sinon.spy(blockchainListener, 'off');
@@ -84,19 +84,23 @@ describe('BlockchainListener', () => {
   });
 
   describe('#start', () => {
-    it('should subscribe to transaction events from WS client', () => {
-      // TODO: We don't use it for now
-      // expect(wsClientMock.subscribe).to.be.calledTwice();
-      expect(wsClientMock.subscribe).to.be.calledOnce();
+    it('should subscribe to transaction events from WS client if it is connected', () => {
+      wsClientMock.isConnected = true;
+
+      blockchainListener.start();
+
+      expect(wsClientMock.subscribe).to.be.calledTwice();
       expect(wsClientMock.subscribe.firstCall).to.be.calledWithExactly(
         BlockchainListener.TX_QUERY,
       );
-      // expect(wsClientMock.subscribe.secondCall).to.be.calledWithExactly(
-      //   BlockchainListener.NEW_BLOCK_QUERY,
-      // );
+      expect(wsClientMock.subscribe.secondCall).to.be.calledWithExactly(
+        BlockchainListener.NEW_BLOCK_QUERY,
+      );
     });
 
-    it.skip('should emit block when new block is arrived', (done) => {
+    it('should emit block when new block is arrived', (done) => {
+      blockchainListener.start();
+
       blockchainListener.on(BlockchainListener.EVENTS.NEW_BLOCK, (message) => {
         expect(message).to.be.deep.equal(blockMessageMock);
 
@@ -107,6 +111,8 @@ describe('BlockchainListener', () => {
     });
 
     it('should emit transaction when transaction is arrived', (done) => {
+      blockchainListener.start();
+
       const topic = BlockchainListener.getTransactionEventName(transactionHash);
 
       blockchainListener.on(topic, (message) => {

packages/dashmate/src/commands/reset.js

@@ -9,7 +9,7 @@ export default class ResetCommand extends ConfigBaseCommand {
 
   static flags = {
     ...ConfigBaseCommand.flags,
-    hard: Flags.boolean({ char: 'h', description: 'reset config as well as services and data', default: false }),
+    hard: Flags.boolean({ description: 'reset config as well as services and data', default: false }),
     force: Flags.boolean({ char: 'f', description: 'skip running services check', default: false }),
     platform: Flags.boolean({ char: 'p', description: 'reset platform services and data only', default: false }),
     verbose: Flags.boolean({ char: 'v', description: 'use verbose mode for output', default: false }),

packages/dashmate/src/commands/wallet/mint.js

@@ -51,6 +51,10 @@ Mint given amount of tDash to a new or specified address
       throw new Error('Only local network supports generation of dash');
     }
 
+    if (config.get('core.masternode.enable')) {
+      throw new Error('A masternode doesn\'t support generation of dash');
+    }
+
     const tasks = new Listr(
       [
         {

packages/dashmate/src/config/configJsonSchema.js

@@ -404,28 +404,40 @@ export default {
             filePath: {
               type: ['null', 'string'],
               minLength: 1,
+              description: 'Write logs only to stdout if null. Provide an absolute file path on'
+                + ' the host machine to also write to a log file there. Use a log file if logs must be'
+                + ' retained since stdout logs are stored inside the docker container'
+                + ' and removed if the container is removed.',
             },
             debug: {
               type: 'object',
               properties: {
                 enabled: {
                   type: 'boolean',
+                  description: 'Enable debug logging. Equivalent to setting "debug=1" in the Core configuration file)',
                 },
                 ips: {
                   type: 'boolean',
+                  description: 'Include IP addresses in debug output',
                 },
                 sourceLocations: {
                   type: 'boolean',
+                  description: 'Prepend debug output with name of the originating source'
+                    + ' location (source file, line number and function name)',
                 },
                 threadNames: {
                   type: 'boolean',
+                  description: 'Prepend debug output with name of the originating thread (only'
+                    + ' available on platforms supporting thread_local)',
                 },
                 timeMicros: {
                   type: 'boolean',
+                  description: 'Add microsecond precision to debug timestamps',
                 },
                 includeOnly: {
                   type: 'array',
                   uniqueItems: true,
+                  description: 'Log all categories if empty. Otherwise, log only the specified categories.',
                   items: {
                     type: 'string',
                     enum: ['net', 'tor', 'mempool', 'http', 'bench', 'zmq', 'walletdb', 'rpc', 'estimatefee',
@@ -437,6 +449,7 @@ export default {
                 },
                 exclude: {
                   type: 'array',
+                  description: 'Exclude debugging information for one or more categories.',
                   uniqueItems: true,
                   items: {
                     type: 'string',
@@ -654,10 +667,12 @@ export default {
               properties: {
                 level: {
                   type: 'string',
+                  description: 'Log level for gateway container logs',
                   enum: ['trace', 'debug', 'info', 'warn', 'error', 'critical', 'off'],
                 },
                 accessLogs: {
                   type: 'array',
+                  description: 'Envoy access logs',
                   items: {
                     oneOf: [
                       {
@@ -667,7 +682,8 @@ export default {
                             type: 'string',
                             minLength: 1,
                             enum: ['stdout', 'stderr'],
-                            description: 'Access log type: stdout, stderr or file',
+                            description: 'stdout, stderr or file (absolute file path on host'
+                              + ' machine)',
                           },
                           format: {
                             type: 'string',
@@ -693,7 +709,9 @@ export default {
                               additionalProperties: {
                                 type: 'string',
                               },
-                              description: 'JSON fields and values. If null, default template is used.',
+                              description: 'JSON fields and values. If null, default template is'
+                                + ' used. More info:'
+                                + ' https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#format-dictionaries',
                             },
                           },
                           required: ['template'],
@@ -703,7 +721,9 @@ export default {
                           properties: {
                             template: {
                               type: ['null', 'string'],
-                              description: 'Template string. If null, default template is used.',
+                              description: 'Template string. If null, default template is used.'
+                                + ' More info:'
+                                + ' https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#format-strings',
                             },
                           },
                           required: ['template'],
@@ -827,6 +847,7 @@ export default {
                 },
                 logs: {
                   type: 'object',
+                  description: 'Define Drive logs',
                   propertyNames: {
                     type: 'string',
                     minLength: 1,
@@ -847,10 +868,13 @@ export default {
                       },
                       format: {
                         type: 'string',
+                        description: 'Log format:'
+                          + ' https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/format/index.html',
                         enum: ['full', 'compact', 'pretty', 'json'],
                       },
                       color: {
                         type: ['boolean', 'null'],
+                        description: 'Whether or not to use colorful output; defaults to autodetect',
                       },
                     },
                     required: ['destination', 'level', 'format', 'color'],
@@ -1115,17 +1139,21 @@ export default {
                     level: {
                       type: 'string',
                       enum: ['trace', 'debug', 'info', 'warn', 'error'],
+                      description: 'Log verbosity level',
                     },
                     format: {
                       type: 'string',
                       enum: ['plain', 'json'],
+                      description: 'Log format: text or json',
                     },
                     path: {
                       type: ['string', 'null'],
                       minLength: 1,
+                      description: 'Write to stdout only if null or to stdout and specified log'
+                        + ' file (absolute file path on host machine)',
                     },
                   },
-                  required: ['level', 'format'],
+                  required: ['level', 'format', 'path'],
                   additionalProperties: false,
                 },
                 rpc: {

packages/dashmate/src/doctor/analyse/analyseConfigFactory.js

@@ -134,6 +134,10 @@ and revoke the previous certificate in the ZeroSSL dashboard`,
                 description: chalk`ZeroSSL certificate is not valid.`,
                 solution: chalk`Please run {bold.cyanBright dashmate ssl zerossl obtain} to get a new one.`,
               },
+              [ERRORS.ZERO_SSL_API_ERROR]: {
+                description: ssl?.data?.error?.message,
+                solution: chalk`Please contact ZeroSSL support if needed.`,
+              },
             }[ssl.error] ?? {};
 
             if (description) {