trac-msb 0.2.13 → 0.2.15

package/proto/network/v1/enums/message_type.proto

@@ -1,16 +0,0 @@
-syntax = "proto3";
-
-package network.v1;
-
-// Warning: Do not change numeric values of existing enum fields.
-// They are part of the public API.
-// New values may be added, but existing values must never be renumbered or reused.
-// Use [deprecated = true] while phasing out a value that still remains in the schema.
-// If a value is removed, reserve its number (and preferably its name).
-enum MessageType {
-  MESSAGE_TYPE_UNSPECIFIED = 0;
-  MESSAGE_TYPE_LIVENESS_REQUEST = 1;
-  MESSAGE_TYPE_LIVENESS_RESPONSE = 2;
-  MESSAGE_TYPE_BROADCAST_TRANSACTION_REQUEST = 3;
-  MESSAGE_TYPE_BROADCAST_TRANSACTION_RESPONSE = 4;
-}

package/proto/network/v1/enums/result_code.proto

@@ -1,84 +0,0 @@
-syntax = "proto3";
-
-package network.v1;
-
-// Warning: Do not change numeric values of existing enum fields.
-// They are part of the public API.
-// New values may be added, but existing values must never be renumbered or reused.
-// Use [deprecated = true] while phasing out a value that still remains in the schema.
-// If a value is removed, reserve its number (and preferably its name).
-
-enum ResultCode {
-  // 0-10: [SCOPE: BASE_TRANSPORT_AND_VALIDATOR_STATUS]
-  // Generic V1 processing outcome before deeper payload/proof-specific validation branches.
-  RESULT_CODE_UNSPECIFIED = 0; // We should create an v1Error for this case, sender disconnects from the validator, add optional information to update the node verion.
-  RESULT_CODE_OK = 1;
-  RESULT_CODE_INVALID_PAYLOAD = 2;
-  RESULT_CODE_RATE_LIMITED = 3;
-  RESULT_CODE_SIGNATURE_INVALID = 4;
-  RESULT_CODE_UNEXPECTED_ERROR = 5;
-  RESULT_CODE_TIMEOUT = 6;
-  RESULT_CODE_NODE_HAS_NO_WRITE_ACCESS = 7;
-  RESULT_CODE_TX_ACCEPTED_PROOF_UNAVAILABLE = 8;
-  RESULT_CODE_NODE_OVERLOADED = 9;
-  RESULT_CODE_TX_ALREADY_PENDING = 10;
-  // 11-44: [SCOPE: SHARED_VALIDATORS_REQUEST_PAYLOAD]
-  // (incoming BROADCAST_TRANSACTION_REQUEST -> partial apply payload validation) - validator disconnects, sender rotates
-  RESULT_CODE_OPERATION_TYPE_UNKNOWN = 11;
-  RESULT_CODE_SCHEMA_VALIDATION_FAILED = 12;
-  RESULT_CODE_REQUESTER_ADDRESS_INVALID = 13;
-  RESULT_CODE_REQUESTER_PUBLIC_KEY_INVALID = 14;
-  RESULT_CODE_TX_HASH_MISMATCH = 15;
-  RESULT_CODE_TX_SIGNATURE_INVALID = 16;
-  RESULT_CODE_TX_EXPIRED = 17;
-  RESULT_CODE_TX_ALREADY_EXISTS = 18;
-  RESULT_CODE_OPERATION_ALREADY_COMPLETED = 19;
-  RESULT_CODE_REQUESTER_NOT_FOUND = 20;
-  RESULT_CODE_INSUFFICIENT_FEE_BALANCE = 21;
-  RESULT_CODE_EXTERNAL_BOOTSTRAP_EQUALS_MSB_BOOTSTRAP = 22;
-  RESULT_CODE_SELF_VALIDATION_FORBIDDEN = 23;
-  RESULT_CODE_ROLE_NODE_ENTRY_NOT_FOUND = 24;
-  RESULT_CODE_ROLE_NODE_ALREADY_WRITER = 25;
-  RESULT_CODE_ROLE_NODE_NOT_WHITELISTED = 26;
-  RESULT_CODE_ROLE_NODE_NOT_WRITER = 27;
-  RESULT_CODE_ROLE_NODE_IS_INDEXER = 28;
-  RESULT_CODE_ROLE_ADMIN_ENTRY_MISSING = 29;
-  RESULT_CODE_ROLE_INVALID_RECOVERY_CASE = 30;
-  RESULT_CODE_ROLE_UNKNOWN_OPERATION = 31;
-  RESULT_CODE_ROLE_INVALID_WRITER_KEY = 32;
-  RESULT_CODE_ROLE_INSUFFICIENT_FEE_BALANCE = 33;
-  RESULT_CODE_MSB_BOOTSTRAP_MISMATCH = 34;
-  RESULT_CODE_EXTERNAL_BOOTSTRAP_NOT_DEPLOYED = 35;
-  RESULT_CODE_EXTERNAL_BOOTSTRAP_TX_MISSING = 36;
-  RESULT_CODE_EXTERNAL_BOOTSTRAP_MISMATCH = 37;
-  RESULT_CODE_BOOTSTRAP_ALREADY_EXISTS = 38;
-  RESULT_CODE_TRANSFER_RECIPIENT_ADDRESS_INVALID = 39;
-  RESULT_CODE_TRANSFER_RECIPIENT_PUBLIC_KEY_INVALID = 40;
-  RESULT_CODE_TRANSFER_AMOUNT_TOO_LARGE = 41;
-  RESULT_CODE_TRANSFER_SENDER_NOT_FOUND = 42;
-  RESULT_CODE_TRANSFER_INSUFFICIENT_BALANCE = 43;
-  RESULT_CODE_TRANSFER_RECIPIENT_BALANCE_OVERFLOW = 44;
-
-  // 45-47: [SCOPE: REQUEST_DISPATCH_TXPOOL_TXCOMMIT_PIPELINE]
-  // (dispatch/enqueue/commit handling on validator)
-  RESULT_CODE_TX_HASH_INVALID_FORMAT = 45;
-  RESULT_CODE_INTERNAL_ENQUEUE_VALIDATION_FAILED = 46;
-  RESULT_CODE_TX_COMMITTED_RECEIPT_MISSING = 47;
-
-  // 48-60: [SCOPE: VALIDATOR_RESPONSE_PROOF_AND_IDENTITY_VALIDATION]
-  // (incoming BROADCAST_TRANSACTION_RESPONSE validation on sender)
-  RESULT_CODE_VALIDATOR_RESPONSE_TX_TYPE_INVALID = 48;
-  RESULT_CODE_VALIDATOR_RESPONSE_TX_TYPE_UNKNOWN = 49;
-  RESULT_CODE_VALIDATOR_RESPONSE_TX_TYPE_UNSUPPORTED = 50;
-  RESULT_CODE_VALIDATOR_RESPONSE_SCHEMA_INVALID = 51;
-  RESULT_CODE_PENDING_REQUEST_MISSING_TX_DATA = 52;
-  RESULT_CODE_PROOF_PAYLOAD_MISMATCH = 53;
-  RESULT_CODE_VALIDATOR_WRITER_KEY_NOT_REGISTERED = 54;
-  RESULT_CODE_VALIDATOR_ADDRESS_MISMATCH = 55;
-  RESULT_CODE_VALIDATOR_NODE_ENTRY_NOT_FOUND = 56;
-  RESULT_CODE_VALIDATOR_NODE_NOT_WRITER = 57;
-  RESULT_CODE_VALIDATOR_WRITER_KEY_MISMATCH = 58;
-  RESULT_CODE_VALIDATOR_TX_OBJECT_INVALID = 59;
-  RESULT_CODE_VALIDATOR_VA_MISSING = 60;
-  RESULT_CODE_TX_INVALID_PAYLOAD = 61;
-}

package/proto/network/v1/messages/broadcast_transaction_request.proto

@@ -1,9 +0,0 @@
-syntax = "proto3";
-
-package network.v1;
-
-message BroadcastTransactionRequest {
-  bytes data = 1;
-  bytes nonce = 2;
-  bytes signature = 3;
-}

package/proto/network/v1/messages/broadcast_transaction_response.proto

@@ -1,13 +0,0 @@
-syntax = "proto3";
-
-package network.v1;
-
-import "network/v1/enums/result_code.proto";
-
-message BroadcastTransactionResponse {
-  bytes nonce = 1;
-  bytes signature = 2;
-  bytes proof = 3;
-  uint64 timestamp = 4;
-  ResultCode result = 5;
-}

package/proto/network/v1/messages/liveness_request.proto

@@ -1,8 +0,0 @@
-syntax = "proto3";
-
-package network.v1;
-
-message LivenessRequest {
-  bytes nonce = 1;
-  bytes signature = 2;
-}

package/proto/network/v1/messages/liveness_response.proto

@@ -1,11 +0,0 @@
-syntax = "proto3";
-
-package network.v1;
-
-import "network/v1/enums/result_code.proto";
-
-message LivenessResponse {
-  bytes nonce = 1;
-  bytes signature = 2;
-  ResultCode result = 3;
-}

package/proto/network/v1/network_message.proto

@@ -1,22 +0,0 @@
-syntax = "proto3";
-
-package network.v1;
-
-import "network/v1/enums/message_type.proto";
-import "network/v1/messages/liveness_request.proto";
-import "network/v1/messages/liveness_response.proto";
-import "network/v1/messages/broadcast_transaction_request.proto";
-import "network/v1/messages/broadcast_transaction_response.proto";
-
-message MessageHeader {
-  MessageType type = 1;
-  string id = 2;
-  uint64 timestamp = 3;
-  oneof field {
-    LivenessRequest                       liveness_request = 4;
-    LivenessResponse                      liveness_response = 5;
-    BroadcastTransactionRequest           broadcast_transaction_request = 6;
-    BroadcastTransactionResponse          broadcast_transaction_response = 7;
-  }
-  repeated string capabilities = 8;
-}

package/src/core/network/protocols/connectionPolicies.js

@@ -1,88 +0,0 @@
-import { ResultCode } from '../../../utils/constants.js';
-
-// TODO: Consider how to behave with ResultCode.UNSPECIFIED
-
-export const SENDER_ACTION = Object.freeze({
-    UNDEFINED: 'UNDEFINED',
-    SUCCESS: 'SUCCESS',
-    ROTATE: 'ROTATE',
-    NO_ROTATE: 'NO_ROTATE',
-});
-
-const SUCCESS_CODES = new Set([
-    ResultCode.OK,
-]);
-
-const ROTATE_CODES = new Set([
-    ResultCode.UNSPECIFIED,
-    ResultCode.INVALID_PAYLOAD,
-    ResultCode.RATE_LIMITED,
-    ResultCode.SIGNATURE_INVALID,
-    ResultCode.UNEXPECTED_ERROR,
-    ResultCode.TIMEOUT,
-    ResultCode.NODE_HAS_NO_WRITE_ACCESS,
-    ResultCode.TX_ACCEPTED_PROOF_UNAVAILABLE,
-    ResultCode.NODE_OVERLOADED,
-    ResultCode.OPERATION_TYPE_UNKNOWN,
-    ResultCode.SCHEMA_VALIDATION_FAILED,
-    ResultCode.REQUESTER_ADDRESS_INVALID,
-    ResultCode.REQUESTER_PUBLIC_KEY_INVALID,
-    ResultCode.TX_HASH_MISMATCH,
-    ResultCode.TX_SIGNATURE_INVALID,
-    ResultCode.TX_EXPIRED,
-    ResultCode.TX_ALREADY_EXISTS,
-    ResultCode.OPERATION_ALREADY_COMPLETED,
-    ResultCode.REQUESTER_NOT_FOUND,
-    ResultCode.INSUFFICIENT_FEE_BALANCE,
-    ResultCode.EXTERNAL_BOOTSTRAP_EQUALS_MSB_BOOTSTRAP,
-    ResultCode.SELF_VALIDATION_FORBIDDEN,
-    ResultCode.ROLE_NODE_ENTRY_NOT_FOUND,
-    ResultCode.ROLE_NODE_ALREADY_WRITER,
-    ResultCode.ROLE_NODE_NOT_WHITELISTED,
-    ResultCode.ROLE_NODE_NOT_WRITER,
-    ResultCode.ROLE_NODE_IS_INDEXER,
-    ResultCode.ROLE_ADMIN_ENTRY_MISSING,
-    ResultCode.ROLE_INVALID_RECOVERY_CASE,
-    ResultCode.ROLE_UNKNOWN_OPERATION,
-    ResultCode.ROLE_INVALID_WRITER_KEY,
-    ResultCode.ROLE_INSUFFICIENT_FEE_BALANCE,
-    ResultCode.MSB_BOOTSTRAP_MISMATCH,
-    ResultCode.EXTERNAL_BOOTSTRAP_NOT_DEPLOYED,
-    ResultCode.EXTERNAL_BOOTSTRAP_TX_MISSING,
-    ResultCode.EXTERNAL_BOOTSTRAP_MISMATCH,
-    ResultCode.BOOTSTRAP_ALREADY_EXISTS,
-    ResultCode.TRANSFER_RECIPIENT_ADDRESS_INVALID,
-    ResultCode.TRANSFER_RECIPIENT_PUBLIC_KEY_INVALID,
-    ResultCode.TRANSFER_AMOUNT_TOO_LARGE,
-    ResultCode.TRANSFER_SENDER_NOT_FOUND,
-    ResultCode.TRANSFER_INSUFFICIENT_BALANCE,
-    ResultCode.TRANSFER_RECIPIENT_BALANCE_OVERFLOW,
-    ResultCode.TX_HASH_INVALID_FORMAT,
-    ResultCode.INTERNAL_ENQUEUE_VALIDATION_FAILED,
-    ResultCode.TX_COMMITTED_RECEIPT_MISSING,
-    ResultCode.VALIDATOR_RESPONSE_TX_TYPE_INVALID,
-    ResultCode.VALIDATOR_RESPONSE_TX_TYPE_UNKNOWN,
-    ResultCode.VALIDATOR_RESPONSE_TX_TYPE_UNSUPPORTED,
-    ResultCode.VALIDATOR_RESPONSE_SCHEMA_INVALID,
-    ResultCode.PENDING_REQUEST_MISSING_TX_DATA,
-    ResultCode.PROOF_PAYLOAD_MISMATCH,
-    ResultCode.VALIDATOR_WRITER_KEY_NOT_REGISTERED,
-    ResultCode.VALIDATOR_ADDRESS_MISMATCH,
-    ResultCode.VALIDATOR_NODE_ENTRY_NOT_FOUND,
-    ResultCode.VALIDATOR_NODE_NOT_WRITER,
-    ResultCode.VALIDATOR_WRITER_KEY_MISMATCH,
-    ResultCode.VALIDATOR_TX_OBJECT_INVALID,
-    ResultCode.VALIDATOR_VA_MISSING,
-    ResultCode.TX_INVALID_PAYLOAD
-]);
-
-const NO_ROTATE_CODES = new Set([
-    ResultCode.TX_ALREADY_PENDING,
-]);
-
-export function resultToValidatorAction(resultCode) {
-    if (SUCCESS_CODES.has(resultCode)) return SENDER_ACTION.SUCCESS;
-    if (ROTATE_CODES.has(resultCode)) return SENDER_ACTION.ROTATE;
-    if (NO_ROTATE_CODES.has(resultCode)) return SENDER_ACTION.NO_ROTATE;
-    return SENDER_ACTION.UNDEFINED;
-}

package/src/core/network/protocols/legacy/handlers/LegacyResponseHandler.js

@@ -1,23 +0,0 @@
-import ValidatorResponse from '../validators/ValidatorResponse.js';
-
-class LegacyResponseHandler {
-    #responseValidator;
-
-    constructor(state, wallet, config) {
-        this.#responseValidator = new ValidatorResponse(state, wallet, config);
-
-    }
-
-    async handle(message, channelString) {
-        await this.#handleValidatorResponse(message, channelString);
-    }
-
-    async #handleValidatorResponse(message, channelString) {
-        const isValid = await this.#responseValidator.validate(message, channelString);
-        if (!isValid) {
-            throw new Error("Validator response verification failed");
-        }
-    }
-}
-
-export default LegacyResponseHandler;

package/src/core/network/protocols/shared/errors/SharedValidatorRejectionError.js

@@ -1,27 +0,0 @@
-import {V1ProtocolError} from '../../v1/V1ProtocolError.js';
-
-/**
- * Shared validator rejection error.
- *
- * Used by shared validators in `src/core/network/protocols/shared/validators/**` so they can
- * reject remote peer input with a stable `resultCode`.
- *
- * Note: this currently extends `V1ProtocolError` so the v1 protocol can consistently treat shared
- * validator rejections as typed protocol errors. Legacy protocol codepaths remain compatible because
- * this is still an `Error` and preserves `.message`.
- *
- * Default `endConnection = true` because shared-validator rejections are typically triggered
- * by invalid/malicious peer payloads and should terminate the peer connection after responding.
- */
-export class SharedValidatorRejectionError extends V1ProtocolError {
-    /**
-     * @param {number} resultCode Stable rejection reason (a `ResultCode` value).
-     * @param {string} message Human-readable error message.
-     * @param {boolean} [endConnection=true] Whether the transport should end the connection after responding.
-     */
-    constructor(resultCode, message, endConnection = true) {
-        super(resultCode, message, endConnection);
-    }
-}
-
-export default SharedValidatorRejectionError;

package/src/core/network/protocols/v1/V1ProtocolError.js

@@ -1,91 +0,0 @@
-import {ResultCode} from '../../../../utils/constants.js';
-
-export function getResultCode(err) {
-    return err instanceof V1ProtocolError ? err.resultCode : ResultCode.UNEXPECTED_ERROR;
-}
-
-export function shouldEndConnection(err) {
-    return err instanceof V1ProtocolError ? Boolean(err.endConnection) : false;
-}
-
-/** 
- * V1 protocol error type.
- *
- * `V1ProtocolError` is the v1 base class used by handlers/validators to attach:
- * - `resultCode`: a stable `ResultCode` enum value for programmatic handling
- * - `endConnection`: a transport hint (close peer connection after responding)
- */
-export class V1ProtocolError extends Error {
-    /**
-     * @param {number} resultCode Stable rejection reason (a `ResultCode` enum value).
-     * @param {string} message Human-readable error message.
-     * @param {boolean} [endConnection=false] Whether the transport should end the connection after responding.
-     */
-    constructor(resultCode, message, endConnection = false) {
-        super(message);
-        this.name = this.constructor.name;
-        this.resultCode = resultCode;
-        this.endConnection = Boolean(endConnection);
-    }
-}
-
-export class V1InvalidPayloadError extends V1ProtocolError {
-    constructor(message = 'Invalid payload', endConnection = false) {
-        super(ResultCode.INVALID_PAYLOAD, message, endConnection);
-    }
-}
-
-export class V1TxInvalidPayloadError extends V1ProtocolError {
-    constructor(message = 'Invalid tx payload', endConnection = false) {
-        super(ResultCode.TX_INVALID_PAYLOAD, message, endConnection);
-    }
-}
-
-export class V1SignatureInvalidError extends V1ProtocolError {
-    constructor(message = 'Signature invalid', endConnection = true) {
-        super(ResultCode.SIGNATURE_INVALID, message, endConnection);
-    }
-}
-
-export class V1RateLimitedError extends V1ProtocolError {
-    constructor(message = 'Rate limited', endConnection = true) {
-        super(ResultCode.RATE_LIMITED, message, endConnection);
-    }
-}
-
-export class V1UnexpectedError extends V1ProtocolError {
-    constructor(message = 'Unexpected error', endConnection = true) {
-        super(ResultCode.UNEXPECTED_ERROR, message, endConnection);
-    }
-}
-
-export class V1TimeoutError extends V1ProtocolError {
-    constructor(message = 'Request timed out', endConnection = false) {
-        super(ResultCode.TIMEOUT, message, endConnection);
-    }
-}
-
-export class V1NodeHasNoWriteAccess extends V1ProtocolError {
-    constructor(message = 'Node has no write access', endConnection = true) {
-        super(ResultCode.NODE_HAS_NO_WRITE_ACCESS, message, endConnection);
-    }
-}
-
-export class V1TxAcceptedProofUnavailable extends V1ProtocolError {
-    constructor(message = 'Transaction accepted but proof is unavailable', endConnection = false, timestamp = 0) {
-        super(ResultCode.TX_ACCEPTED_PROOF_UNAVAILABLE, message, endConnection);
-        this.timestamp = Number.isSafeInteger(timestamp) && timestamp > 0 ? timestamp : 0;
-    }
-}
-
-export class V1NodeOverloadedError extends V1ProtocolError {
-    constructor(message = 'Commit queue is full', endConnection = true) {
-        super(ResultCode.NODE_OVERLOADED, message, endConnection);
-    }
-}
-
-export class V1TxAlreadyPendingError extends V1ProtocolError {
-    constructor(message = 'Transaction is already pending', endConnection = false) {
-        super(ResultCode.TX_ALREADY_PENDING, message, endConnection);
-    }
-}

package/src/core/network/protocols/v1/handlers/V1BaseOperationHandler.js

@@ -1,65 +0,0 @@
-import {publicKeyToAddress} from "../../../../../utils/helpers.js";
-import {V1ProtocolError, V1UnexpectedError} from "../V1ProtocolError.js";
-
-class V1BaseOperationHandler {
-    #rateLimiterService;
-    #pendingRequestService;
-    #config;
-
-    constructor(rateLimiterService, pendingRequestService, config) {
-        this.#rateLimiterService = rateLimiterService;
-        this.#pendingRequestService = pendingRequestService;
-        this.#config = config;
-    }
-
-    get config() {
-        return this.#config;
-    }
-
-    applyRateLimit(connection) {
-        if (!this.#config.disableRateLimit) {
-            this.#rateLimiterService.v1HandleRateLimit(connection);
-        }
-    }
-
-    async resolvePendingResponse(message, connection, validator, extractResultCode) {
-        const pendingRequestServiceEntry = this.#pendingRequestService.getPendingRequest(message.id);
-        if (!pendingRequestServiceEntry) return false;
-
-        this.#pendingRequestService.stopPendingRequestTimeout(message.id);
-        await validator.validate(message, connection, pendingRequestServiceEntry);
-
-        const resultCode = extractResultCode(message);
-        this.#pendingRequestService.resolvePendingRequest(message.id, resultCode);
-        return true;
-    }
-
-    handlePendingResponseError(messageId, connection, error, step) {
-        const protocolError = this.#toProtocolError(error);
-        const rejected = this.#pendingRequestService.rejectPendingRequest(messageId, protocolError);
-        if (!rejected) return;
-        this.displayError(step, connection.remotePublicKey, protocolError);
-    }
-
-    async sendResponseAndMaybeClose(connection, response, endConnection) {
-        connection.protocolSession.sendAndForget(response);
-        if (!endConnection) return;
-
-        await connection.flush();
-        connection.end();
-    }
-
-    displayError(step = "undefined step", senderPublicKey, error) {
-        const errorMessage = error?.message ?? 'Unexpected error';
-        console.error(`${this.constructor.name}: ${step} ${publicKeyToAddress(senderPublicKey, this.#config)}: ${errorMessage}`);
-    }
-
-    #toProtocolError(error) {
-        if (error instanceof V1ProtocolError) {
-            return error;
-        }
-        return new V1UnexpectedError(error?.message ?? 'Unexpected error');
-    }
-}
-
-export default V1BaseOperationHandler;