trac-msb 0.2.26 → 0.3.0-beta.2

package/src/config/config.js

@@ -1,6 +1,7 @@
 import b4a from 'b4a'
 import { isDefined } from '../utils/type.js'
 import _ from 'lodash'
+import { BOOTSTRAP_BYTE_LENGTH, CHANNEL_BYTE_LENGTH } from '../utils/constants.js'
 
 export class Config {
     #options
@@ -59,6 +60,11 @@ export class Config {
         return !!this.#config.enableErrorApplyLogs
     }
 
+    get enableLogTimestamp() {
+        if (this.#isOverriden('enableLogTimestamp')) return !!this.#options.enableLogTimestamp
+        return !!this.#config.enableLogTimestamp
+    }
+
     get enableInteractiveMode() {
         if (this.#isOverriden('enableInteractiveMode')) return this.#options.enableInteractiveMode !== false
         return !!this.#config.enableInteractiveMode
@@ -69,11 +75,6 @@ export class Config {
         return !!this.#config.enableRoleRequester
     }
 
-    get enableValidatorObserver() {
-        if (this.#isOverriden('enableValidatorObserver')) return !!this.#options.enableValidatorObserver
-        return !!this.#config.enableValidatorObserver
-    }
-
     get enableTxApplyLogs() {
         if (this.#isOverriden('enableTxApplyLogs')) return !!this.#options.enableTxApplyLogs
         return !!this.#config.enableTxApplyLogs
@@ -201,6 +202,10 @@ export class Config {
         return this.#config.pendingRequestTimeout
     }
 
+    get indexerPendingRequestTimeout() {
+        return this.#config.indexerPendingRequestTimeout
+    }
+
     get txCommitTimeout() {
         return this.#config.txCommitTimeout
     }
@@ -214,6 +219,26 @@ export class Config {
         return this.#config.validatorHealthCheckInterval
     }
 
+    get epochInterval() {
+        return this.#config.epochInterval
+    }
+
+    get epochBackoffDelay() {
+        return this.#config.epochBackoffDelay
+    }
+
+    get epochSignatureTimeout() {
+        return this.#config.epochSignatureTimeout
+    }
+
+    get epochRemoteProposalTimeout() {
+        return this.#config.epochRemoteProposalTimeout
+    }
+
+    get epochAppendTimeout() {
+        return this.#config.epochAppendTimeout
+    }
+
     get validatorHealthCheckFailureThreshold() {
         if (this.#isOverriden('validatorHealthCheckFailureThreshold')) return this.#options.validatorHealthCheckFailureThreshold
         return this.#config.validatorHealthCheckFailureThreshold
@@ -228,6 +253,10 @@ export class Config {
         return this.#config.maxPendingRequestsInPendingRequestsService
     }
 
+    get maxPendingConnections() {
+        return this.#config.maxPendingConnections
+    }
+
     get debug() {
         return this.#config.debug
     }
@@ -251,6 +280,10 @@ export class Config {
         return this.#config.bootstrapTimeout
     }
 
+    get connectTimeoutMs() {
+        return this.#config.connectTimeoutMs
+    }
+
     get writersShortCacheTTL() {
         if (this.#isOverriden('writersShortCacheTTL')) return this.#options.writersShortCacheTTL
         return this.#config.writersShortCacheTTL
@@ -279,7 +312,7 @@ export class Config {
     }
 
     #normalizeChannel(channel) {
-        return b4a.alloc(32).fill(channel)
+        return b4a.alloc(CHANNEL_BYTE_LENGTH).fill(channel)
     }
 
     #validateStringOverride(field, value) {
@@ -296,7 +329,7 @@ export class Config {
 
     #validateBootstrapOverride(bootstrap) {
         if (b4a.isBuffer(bootstrap)) {
-            if (bootstrap.length !== 32) {
+            if (bootstrap.length !== BOOTSTRAP_BYTE_LENGTH) {
                 throw new Error('MainSettlementBus Config: bootstrap must be a 32-byte hex string or Buffer.');
             }
             return;
@@ -370,4 +403,5 @@ export class Config {
             this.#validateDhtBootstrapOverride(options.dhtBootstrap);
         }
     }
+
 }

package/src/config/env.js

@@ -17,20 +17,22 @@ const configData = {
         addressPrefixLength: TRAC_NETWORK_MSB_TESTNET1_PREFIX.length,
         bech32mHrpLength: TRAC_NETWORK_MSB_TESTNET1_PREFIX.length + 1, // len(addressPrefix + separator)
         bootstrap: 'c184f4ad8e9cf5e911f9415b60e7dcfb30aed73ebd8a402ef68e1b154624f5ef',
-        channel: '1111trac1network1msb1testnet1111',
+        channel: '2222trac2network2msb2testnet2222',
         dhtBootstrap: ['116.202.214.149:10001','157.180.12.214:10001','node1.hyperdht.org:49737','node2.hyperdht.org:49737','node3.hyperdht.org:49737'], // these are used to peer discovery
         derivationPath: address.TESNET_DERIVATION_PATH,
-        enableValidatorObserver: true,
         pollInterval: 500, // Validator observer poll interval
         adminCacheTTL: 10_000, // Admin cache TTL ms
         validatorConnectionAttemptDelay: 5, // Delay between validator connection attempts (ms)
+        connectTimeoutMs: 5_000,
         bootstrapTimeout: 60_000, // time used (ms) to connect to new validators at bootstrap
         writersShortCacheTTL: 10_000, // short TTL during bootstrap
         writersLongCacheTTL: 120_000, // long TTL after bootstrap
         maxValidators: 50,
+        maxPendingConnections: 50,
         maxWritersForAdminIndexerConnection: 10, // Connectivity constants
         disableRateLimit: false,
         enableErrorApplyLogs: true,
+        enableLogTimestamp: false,
         enableInteractiveMode: true,
         enableRoleRequester: false,
         enableTxApplyLogs: true,
@@ -53,11 +55,17 @@ const configData = {
         rateLimitMaxTransactionsPerSecond: 50, // Rate limiting constants
         maxPendingRequestsInPendingRequestsService: 50_000, // Maximum number of pending requests in PendingRequestService (This value should not exceed 256MB)
         pendingRequestTimeout: 10_000, // Deadline for a pending V1 response (ms), including health checks
+        indexerPendingRequestTimeout: 20000, // constant after which time the transaction will be considered invalid
         txCommitTimeout: 5_000, // Wait for local append and publication proof (ms); shorter than the response deadline
         txPoolSize: 1000, // size of transaction pool
         validatorHealthCheckInterval: 5 * 60 * 1000, // How often to check validator health (ms)
         validatorHealthCheckFailureThreshold: 3, // Consecutive failed health checks before a validator is removed
-        confirmationStallTimeout: 120_000, // Force a fast-forward when the confirmed length has not moved for this long while unconfirmed entries wait (ms, 0 = off)
+        confirmationStallTimeout: 120_000, // Force a fast-forward when confirmations stall with unconfirmed entries (ms, 0 = off)
+        epochInterval: 3 * 60 * 1000, // How often to trigger epoch proof proposal (ms)
+        epochBackoffDelay: 30_000, // Delay before retrying epoch coordination after a failed attempt (ms)
+        epochSignatureTimeout: 20_000, // Max time delay an indexer have to sign a proposal
+        epochAppendTimeout: 2_000, // Max time a proposer has to append the new epoch in the log
+        epochRemoteProposalTimeout: 20_000, // Max time to wait for a competing proposal to land before broadcasting our own
         storesDirectory: 'stores/',
         storeName: 'testnet',
     },
@@ -71,17 +79,19 @@ const configData = {
         channel: '0000trac0network0msb0mainnet0000',
         dhtBootstrap: ['116.202.214.149:10001','157.180.12.214:10001','node1.hyperdht.org:49737','node2.hyperdht.org:49737','node3.hyperdht.org:49737'],
         derivationPath: address.MAINNET_DERIVATION_PATH,
-        enableValidatorObserver: true,
         pollInterval: 500, // Validator observer poll interval
         adminCacheTTL: 3_600_000, // Admin cache TTL ms
         validatorConnectionAttemptDelay: 5, // Delay between validator connection attempts (ms)
+        connectTimeoutMs: 5_000,
         bootstrapTimeout: 120_000, // time used (ms) to connect to new validators at bootstrap
         writersShortCacheTTL: 2_000, // short TTL during bootstrap
         writersLongCacheTTL: 120_000, // long TTL after bootstrap
         maxValidators: 50,
+        maxPendingConnections: 50,
         maxWritersForAdminIndexerConnection: 10, // Connectivity constants
         disableRateLimit: false,
         enableErrorApplyLogs: false,
+        enableLogTimestamp: false,
         enableInteractiveMode: true,
         enableRoleRequester: false,
         enableTxApplyLogs: false,
@@ -104,11 +114,17 @@ const configData = {
         rateLimitMaxTransactionsPerSecond: 50, // Rate limiting constants
         maxPendingRequestsInPendingRequestsService: 50_000, // Maximum number of pending requests in PendingRequestService (This value should not exceed 256MB)
         pendingRequestTimeout: 10_000, // Deadline for a pending V1 response (ms), including health checks
+        indexerPendingRequestTimeout: 20000, // constant after which time the transaction will be considered invalid
         txCommitTimeout: 5_000, // Wait for local append and publication proof (ms); shorter than the response deadline
         txPoolSize: 1000, // size of transaction pool
         validatorHealthCheckInterval: 5 * 60 * 1000, // How often to check validator health (ms)
         validatorHealthCheckFailureThreshold: 3, // Consecutive failed health checks before a validator is removed
-        confirmationStallTimeout: 120_000, // Force a fast-forward when the confirmed length has not moved for this long while unconfirmed entries wait (ms, 0 = off)
+        confirmationStallTimeout: 120_000, // Force a fast-forward when confirmations stall with unconfirmed entries (ms, 0 = off)
+        epochInterval: 3 * 60 * 1000, // How often to trigger epoch proof proposal (ms)
+        epochBackoffDelay: 30_000, // Delay before retrying epoch coordination after a failed attempt (ms)
+        epochSignatureTimeout: 20_000, // Max time delay an indexer have to sign a proposal
+        epochAppendTimeout: 2_000, // Max time a proposer has to append the new epoch in the log
+        epochRemoteProposalTimeout: 20_000, // Max time to wait for a competing proposal to land before broadcasting our own
         storesDirectory: 'stores/',
         storeName: 'mainnet',
     },
@@ -118,21 +134,23 @@ const configData = {
         addressPrefix: TRAC_NETWORK_MSB_MAINNET_PREFIX,
         addressPrefixLength: TRAC_NETWORK_MSB_MAINNET_PREFIX.length,
         bech32mHrpLength: TRAC_NETWORK_MSB_MAINNET_PREFIX.length + 1, // len(addressPrefix + separator)
-        bootstrap: '12f7f1668eac2e691e17cbc6a53e509c5cee78cdcac562313091c64e5fd077d6',
-        channel: '12312313123123',
+        bootstrap: 'e81a23d67224e794a7df923843591880c24a4fd4de1795a80108035a7fcdfcbd',
+        channel: '123123131231233',
         dhtBootstrap: ['116.202.214.149:10001','157.180.12.214:10001','node1.hyperdht.org:49737','node2.hyperdht.org:49737','node3.hyperdht.org:49737'],
         derivationPath: address.MAINNET_DERIVATION_PATH,
-        enableValidatorObserver: true,
         pollInterval: 500, // Validator observer poll interval
         adminCacheTTL: 60_000, // Admin cache TTL ms
         validatorConnectionAttemptDelay: 5, // Delay between validator connection attempts (ms)
+        connectTimeoutMs: 5_000,
         bootstrapTimeout: 30_000,  // time used (ms) to connect to new validators at bootstrap
         writersShortCacheTTL: 1_000, // short TTL during bootstrap
         writersLongCacheTTL: 2_000, // long TTL after bootstrap
         maxValidators: 10,
+        maxPendingConnections: 50,
         maxWritersForAdminIndexerConnection: 10, // Connectivity constants
         disableRateLimit: false,
         enableErrorApplyLogs: true,
+        enableLogTimestamp: true,
         enableInteractiveMode: true,
         enableRoleRequester: false,
         enableTxApplyLogs: true,
@@ -155,11 +173,17 @@ const configData = {
         rateLimitMaxTransactionsPerSecond: 50, // Rate limiting constants
         maxPendingRequestsInPendingRequestsService: 50_000, // Maximum number of pending requests in PendingRequestService (This value should not exceed 256MB)
         pendingRequestTimeout: 10_000, // Deadline for a pending V1 response (ms), including health checks
+        indexerPendingRequestTimeout: 20000, // constant after which time the transaction will be considered invalid
         txCommitTimeout: 5_000, // Wait for local append and publication proof (ms); shorter than the response deadline
         txPoolSize: 1000, // size of transaction pool
         validatorHealthCheckInterval: 1_000, // How often to check validator health (ms)
         validatorHealthCheckFailureThreshold: 3, // Consecutive failed health checks before a validator is removed
-        confirmationStallTimeout: 120_000, // Force a fast-forward when the confirmed length has not moved for this long while unconfirmed entries wait (ms, 0 = off)
+        confirmationStallTimeout: 120_000, // Force a fast-forward when confirmations stall with unconfirmed entries (ms, 0 = off)
+        epochInterval: 30 * 1000, // How often to trigger epoch proof proposal (ms)
+        epochBackoffDelay: 30_000, // Delay before retrying epoch coordination after a failed attempt (ms)
+        epochSignatureTimeout: 40_000, // Max time delay an indexer have to sign a proposal
+        epochAppendTimeout: 10_000, // Max time a proposer has to append the new epoch in the log
+        epochRemoteProposalTimeout: 40_000, // Max time to wait for a competing proposal to land before broadcasting our own
         storesDirectory: 'stores/',
         storeName: 'development',
     }

package/src/core/consensus/epochAppenderSelection/EpochAppenderSelectionError.js

@@ -0,0 +1,55 @@
+/** Error codes used when handling election failures and building protocol replies. */
+export const EpochAppenderSelectionErrorCode = Object.freeze({
+    SELECTION_STATE_INVALID: 'SELECTION_STATE_INVALID',
+    RESERVATION_INVALID: 'RESERVATION_INVALID',
+    PUBLICATION_MARKER_INVALID: 'PUBLICATION_MARKER_INVALID',
+    PERSISTENCE_FAILED: 'PERSISTENCE_FAILED',
+    SELECTOR_CLOSED: 'SELECTOR_CLOSED',
+    SELECTOR_UNAVAILABLE: 'SELECTOR_UNAVAILABLE',
+    REQUEST_STALE: 'REQUEST_STALE',
+    REQUEST_CANCELLED: 'REQUEST_CANCELLED',
+    ELECTION_SUPERSEDED: 'ELECTION_SUPERSEDED',
+    ELECTION_BUSY: 'ELECTION_BUSY',
+    ALREADY_WAITING: 'ALREADY_WAITING',
+    PUBLICATION_UNRESOLVED: 'PUBLICATION_UNRESOLVED',
+    REPLIES_INCOMPLETE: 'REPLIES_INCOMPLETE',
+    REPLY_TIMEOUT: 'REPLY_TIMEOUT',
+    CONTEXT_CHANGED: 'CONTEXT_CHANGED',
+    NOT_IN_COHORT: 'NOT_IN_COHORT',
+    UNEXPECTED_PEER: 'UNEXPECTED_PEER',
+    LOGICAL_COUNTER_INVALID: 'LOGICAL_COUNTER_INVALID',
+    LOGICAL_CLOCK_EXHAUSTED: 'LOGICAL_CLOCK_EXHAUSTED',
+    SIGNED_CHECKPOINT_UNAVAILABLE: 'SIGNED_CHECKPOINT_UNAVAILABLE',
+    SIGNED_VIEW_INVALID: 'SIGNED_VIEW_INVALID',
+    EPOCH_NOT_INITIALIZED: 'EPOCH_NOT_INITIALIZED',
+    PARENT_MISSING: 'PARENT_MISSING',
+    MEMBER_IDENTITY_MISSING: 'MEMBER_IDENTITY_MISSING',
+    MEMBERSHIP_INVALID: 'MEMBERSHIP_INVALID',
+    CONFIG_MISSING: 'CONFIG_MISSING',
+});
+
+/**
+ * Describes an appender selection error. Callers use the code to decide what to do next. The message
+ * and details help explain the failure in logs. Protocol handlers convert these errors to protocol
+ * result codes.
+ */
+export class EpochAppenderSelectionError extends Error {
+    /**
+     * @param {string} code One of EpochAppenderSelectionErrorCode.
+     * @param {string} message Message shown in logs. Callers use the code to handle the error.
+     * @param {object} [options] Extra details and the original error.
+     * @param {object} [options.details] Request ID and other details about the failure.
+     * @param {Error} [options.cause] Original error that caused this failure.
+     */
+    constructor(code, message, { details, cause } = {}) {
+        super(message);
+        this.name = this.constructor.name;
+        this.code = code;
+        if (details !== undefined) {
+            this.details = details;
+        }
+        if (cause !== undefined) {
+            this.cause = cause;
+        }
+    }
+}

package/src/core/consensus/epochAppenderSelection/EpochAppenderSelectionOperations.js

@@ -0,0 +1,118 @@
+import { generateUUID } from '../../../utils/helpers.js';
+import { consensusMessageFactory } from '../../../messages/consensus/v1/consensusMessageFactory.js';
+import { EpochAppenderSelectionError, EpochAppenderSelectionErrorCode } from './EpochAppenderSelectionError.js';
+import { loadSelectionState, saveSelectionState } from './epochAppenderSelectionStorage.js';
+
+/**
+ * Provides local storage, signed ledger reads and network requests for the selector. The selector uses
+ * these methods to collect votes. The round handles the epoch append.
+ */
+export class EpochAppenderSelectionOperations {
+    #state;
+    #wallet;
+    #config;
+    #getIndexerConnectionManager;
+    #logger;
+    #pendingRequestService;
+
+    /**
+     * Sets up the services used by the selector. The connection manager is read through a callback
+     * because Network creates it after the selector.
+     *
+     * @param {import('../../state/State.js').default} state Access to signed ledger data and local storage.
+     * @param {object} wallet Wallet used to sign REQUEST messages.
+     * @param {object} config Network and message encoding config.
+     * @param {function(): import('../../network/services/IndexerConnectionManager.js').default} getIndexerConnectionManager Returns the connection manager once it is ready.
+     * @param {object} [logger] Logger for operation errors.
+     * @param {object} [pendingRequestService] Tracks pending requests and cancels them when needed.
+     */
+    constructor(state, wallet, config, getIndexerConnectionManager, logger, pendingRequestService) {
+        this.#state = state;
+        this.#wallet = wallet;
+        this.#config = config;
+        this.#getIndexerConnectionManager = getIndexerConnectionManager;
+        this.#logger = logger;
+        this.#pendingRequestService = pendingRequestService;
+    }
+
+    /**
+     * Loads the election state saved on this node.
+     *
+     * @returns {Promise<import('./epochAppenderSelectionState.js').EpochAppenderSelectionState|null>}
+     */
+    load() {
+        return loadSelectionState(this.#state.base);
+    }
+
+    /**
+     * Saves a copy of the election state on this node.
+     *
+     * @param {import('./epochAppenderSelectionState.js').EpochAppenderSelectionState} selectionState Election state to save locally.
+     * @returns {Promise<void>}
+     */
+    save(selectionState) {
+        return saveSelectionState(this.#state.base, selectionState);
+    }
+
+    /**
+     * Reads the epoch, consensus config and indexers from the same signed checkpoint.
+     *
+     * @returns {Promise<import('./epochAppenderSelectionState.js').EpochAppenderSelectionContext>}
+     */
+    readContext() {
+        return this.#state.getEpochAppenderSelectionContext();
+    }
+
+    /**
+     * Checks whether the signed ledger has processed this append.
+     *
+     * @param {import('./epochAppenderSelectionState.js').EpochAppendPublication} publication Saved writer position and payload hash for this append.
+     * @returns {Promise<import('./epochAppenderSelectionState.js').EpochAppendOutcomeResult>}
+     */
+    readOutcome(publication) {
+        return this.#state.getEpochAppendOutcome(publication);
+    }
+
+    /**
+     * Connects to the current indexers through the existing session manager.
+     *
+     * @returns {Promise<void>}
+     */
+    connect() {
+        return this.#getIndexerConnectionManager().connect();
+    }
+
+    /**
+     * Signs and sends a REQUEST for an appender vote. Registers a callback so the election can cancel
+     * the pending request. If cancellation happens during signing, nothing is sent.
+     *
+     * @param {string} peerPublicKey Target wallet key, encoded as hex.
+     * @param {import('./epochAppenderSelectionState.js').EpochAppendRequest} selectionRequest Request containing the candidate, election term and payload hash.
+     * @param {import('./epochAppenderSelectionState.js').EpochSelectionRequestLifecycle} requestLifecycle Callbacks that check whether the request is active and register cancellation.
+     * @returns {Promise<import('./epochAppenderSelectionState.js').EpochAppendReply|null>} Validated reply, or null after cancellation.
+     */
+    async sendRequest(peerPublicKey, selectionRequest, requestLifecycle) {
+        const requestMessage = await consensusMessageFactory(this.#wallet, this.#config).buildRequest(generateUUID(), selectionRequest);
+        if (!requestLifecycle.isActive()) {
+            return null;
+        }
+        requestLifecycle.onPending(() => {
+            const error = new EpochAppenderSelectionError(
+                EpochAppenderSelectionErrorCode.REQUEST_CANCELLED,
+                'Epoch append request no longer waiting',
+                { details: { requestId: selectionRequest.requestId, sessionId: requestMessage.session_id } }
+            );
+            this.#pendingRequestService?.rejectPendingRequest(requestMessage.session_id, error);
+        });
+        return this.#getIndexerConnectionManager().send(peerPublicKey, requestMessage);
+    }
+
+    /**
+     * Logs an error from a background operation. This does not change the election state.
+     *
+     * @param {Error} error Error from storage, signed context reads or a peer request.
+     */
+    onError(error) {
+        this.#logger?.debug?.(`[EpochAppenderSelector] ${error.message}`);
+    }
+}