trac-msb 0.2.11 → 0.2.12

package/.github/workflows/acceptance-tests.yml

@@ -0,0 +1,38 @@
+name: MSB-Acceptance-Tests
+
+on:
+  workflow_dispatch:
+  workflow_run:
+    workflows: ["MSB-Unit-Tests"]
+    types:
+      - completed
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  integration-tests:
+    name: Acceptance Tests
+    runs-on: [self-hosted, Linux, X64]
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    strategy:
+      matrix:
+        node-version: [ lts/* ]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install bare
+        run: npm i -g bare
+
+      - name: Run Integration Tests
+        run: npm run test:acceptance

package/.github/workflows/lint-pr-title.yml

@@ -0,0 +1,26 @@
+name: Lint PR title
+
+on:
+  pull_request_target:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  main:
+    name: Validate PR title convention
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    steps:
+      - uses: amannn/action-semantic-pull-request@v6.1.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # Allow optional scopes like feat(ui): ...
+          # By default scopes are allowed (no restriction) and are optional.
+          requireScope: false
+
+          # Optional: require a non-empty subject after ": "
+          subjectPattern: ^.+$
+          subjectPatternError: |
+            The pull request title must have a non-empty subject after ": ".
+            Example: "feat: add new command"

package/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish trac-msb to npm on release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout release tag
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: npm ci
+
+      # unit tests are temporarily disabled because they lost stability on GH runners.
+      #- name: Run unit tests
+      #  run: npm run test:unit:all
+
+      - name: Publish to npm
+        run: npm publish --access public

package/.github/workflows/unit-tests.yml

@@ -0,0 +1,34 @@
+name: MSB-Unit-Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    runs-on: [self-hosted, Linux, X64]
+
+    strategy:
+      matrix:
+        node-version: [lts/*]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Install bare
+        run: npm i -g bare
+      - name: Run all tests
+        run: npm run test:unit:all

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "trac-msb",
   "main": "msb.mjs",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "pear": {
     "name": "trac-msb",
     "type": "terminal"
@@ -18,9 +18,9 @@
     "test:integration": "brittle-node -t 1200000 tests/integration/integration.test.js",
     "test:unit:node": "brittle-node -t 60000 tests/unit/unit.test.js",
     "test:unit:bare": "brittle-bare -t 60000 tests/unit/unit.test.js",
-    "test:unit:pear": "BRITTLE='-t 60000' brittle-pear tests/unit/unit.test.js",
     "test:unit:all": "(npm run test:unit:node && npm run test:unit:bare) || exit 1",
-    "test:unit:node:cov": "brittle-node -c -t 60000 tests/unit/unit.test.js"
+    "test:unit:node:cov": "brittle-node -c -t 60000 tests/unit/unit.test.js",
+    "test:unit:bare:cov": "brittle-bare -c -t 60000  tests/unit/unit.test.js"
   },
   "dependencies": {
     "autobase": "7.20.1",
@@ -35,7 +35,6 @@
     "compact-encoding": "2.18.0",
     "corestore": "7.5.0",
     "crypto": "npm:bare-node-crypto",
-    "denque": "^2.1.0",
     "fastest-validator": "1.19.0",
     "http": "npm:bare-node-http",
     "hyperbee": "2.26.5",
@@ -44,25 +43,21 @@
     "hyperdht": "6.27.0",
     "hyperswarm": "4.14.2",
     "lodash": "^4.17.23",
-    "p-queue": "^9.1.0",
-    "protobufjs": "^7.5.4",
     "protocol-buffers-encodings": "1.2.0",
     "protomux": "3.10.1",
     "protomux-wakeup": "2.4.0",
     "readline": "npm:bare-node-readline",
     "ready-resource": "1.1.2",
-    "trac-wallet": "1.0.2",
+    "trac-wallet": "1.0.3",
     "tty": "npm:bare-node-tty",
     "uuid": "^13.0.0"
   },
   "devDependencies": {
-    "bare-module": "^6.1.3",
     "bare-os": "^3.6.1",
     "bip39-mnemonic": "^2.4.0",
-    "brittle": "^3.19.1",
+    "brittle": "^3.17.1",
     "esmock": "^2.7.2",
     "jest": "^30.1.3",
-    "protobufjs-cli": "^1.2.0",
     "protocol-buffers": "^4.2.0",
     "sinon": "^21.0.0",
     "supertest": "^7.1.4",

package/proto/network.proto

@@ -0,0 +1,74 @@
+syntax = "proto3";
+
+package network.v1;
+
+enum MessageType {
+    MESSAGE_TYPE_UNSPECIFIED = 0;
+    MESSAGE_TYPE_VALIDATOR_CONNECTION_REQUEST = 1;
+    MESSAGE_TYPE_VALIDATOR_CONNECTION_RESPONSE = 2;
+    MESSAGE_TYPE_LIVENESS_REQUEST = 3;
+    MESSAGE_TYPE_LIVENESS_RESPONSE = 4;
+    MESSAGE_TYPE_BROADCAST_TRANSACTION_REQUEST = 5;
+    MESSAGE_TYPE_BROADCAST_TRANSACTION_RESPONSE = 6;
+}
+
+enum ResultCode {
+    RESULT_CODE_UNSPECIFIED = 0;
+    RESULT_CODE_OK = 1;
+    RESULT_CODE_INVALID_PAYLOAD = 2;
+    RESULT_CODE_UNSUPPORTED_VERSION = 3;
+    RESULT_CODE_RATE_LIMITED = 4;
+    RESULT_CODE_TIMEOUT = 5;
+    RESULT_CODE_SIGNATURE_INVALID = 6;
+}
+
+message ValidatorConnectionRequest {
+    string issuer_address = 1;
+    bytes nonce = 2;
+    bytes signature = 3;
+}
+
+message ValidatorConnectionResponse {
+    string issuer_address = 1;
+    bytes nonce = 2;
+    bytes signature = 3;
+    ResultCode result = 4;
+}
+
+message LivenessRequest {
+    bytes nonce = 1;
+    bytes signature = 2;
+}
+
+message LivenessResponse {
+    bytes nonce = 1;
+    bytes signature = 2;
+    ResultCode result = 3;
+}
+
+message BroadcastTransactionRequest {
+    bytes data = 1; // binary encoded payload
+    bytes nonce = 2;
+    bytes signature = 3;
+}
+
+message BroadcastTransactionResponse {
+    bytes nonce = 1;
+    bytes signature = 2;
+    ResultCode result = 3;
+}
+
+message MessageHeader {
+    MessageType type = 1;
+    string id = 2;
+    uint64 timestamp = 3;
+    oneof field {
+        ValidatorConnectionRequest            validator_connection_request  = 4;
+        ValidatorConnectionResponse           validator_connection_response  = 5;
+        LivenessRequest                       liveness_request = 6;
+        LivenessResponse                      liveness_response = 7;
+        BroadcastTransactionRequest           broadcast_transaction_request = 8;
+        BroadcastTransactionResponse          broadcast_transaction_response = 9;
+    }
+    repeated string capabilities = 10;
+}

package/rpc/rpc_services.js

@@ -6,23 +6,10 @@ import {
 } from "../src/utils/normalizers.js";
 import { get_confirmed_tx_info, get_unconfirmed_tx_info } from "../src/utils/cli.js";
 import { OperationType } from "../src/utils/constants.js";
-import { sleep } from "../src/utils/helpers.js";
 import b4a from "b4a";
+import PartialTransaction from "../src/core/network/protocols/shared/validators/PartialTransaction.js";
+import PartialTransfer from "../src/core/network/protocols/shared/validators/PartialTransfer.js";
 import { ValidationError, BroadcastError, NotFoundError } from "./utils/helpers.js";
-import PartialTransactionValidator from "../src/core/network/protocols/shared/validators/PartialTransactionValidator.js";
-import PartialTransferValidator from "../src/core/network/protocols/shared/validators/PartialTransferValidator.js";
-
-// This was added because V1 is not waiting for signed/unsigned state. So to include reverse compatibility
-// we need to slow down v1 to legacy case.
-const waitForUnconfirmedTx = async (state, txHash, config) => {
-    const startedAt = Date.now();
-    while ((Date.now() - startedAt) < config.messageValidatorResponseTimeout) {
-        const payload = await state.get(txHash);
-        if (payload) return true;
-        await sleep(100);
-    }
-    return false;
-};
 
 export async function getBalance(msbInstance, address, confirmed) {
     const state = msbInstance.state;
@@ -67,8 +54,8 @@ export async function broadcastTransaction(msbInstance, config, payload) {
     let isValid = false;
     let hash;
 
-    const partialTransferValidator = new PartialTransferValidator(msbInstance.state, null , config);
-    const partialTransactionValidator = new PartialTransactionValidator(msbInstance.state, null , config);
+    const partialTransferValidator = new PartialTransfer(msbInstance.state, null, config);
+    const partialTransactionValidator = new PartialTransaction(msbInstance.state, null, config);
 
     if (payload.type === OperationType.TRANSFER) {
         normalizedPayload = normalizeTransferOperation(payload, config);
@@ -90,11 +77,6 @@ export async function broadcastTransaction(msbInstance, config, payload) {
         throw new BroadcastError("Failed to broadcast transaction after multiple attempts.");
     }
 
-    const isConfirmed = await waitForUnconfirmedTx(msbInstance.state, hash, config);
-    if (!isConfirmed) {
-        throw new BroadcastError("Failed to broadcast transaction after multiple attempts.");
-    }
-
     const signedLength = msbInstance.state.getSignedLength();
     const unsignedLength = msbInstance.state.getUnsignedLength();
 

package/scripts/generate-protobufs.js

@@ -2,10 +2,10 @@ import fs from 'fs';
 import path from 'path';
 
 import { fileURLToPath } from 'url';
-import { execFileSync } from 'child_process';
+import { execSync } from 'child_process';
 
 function generateCJSFromProto(inputPath, outputPath) {
-    execFileSync('protocol-buffers', [inputPath, '-o', outputPath]);
+    execSync(`protocol-buffers "${inputPath}" -o "${outputPath}"`);
     console.log(`${outputPath} has been generated.`);
 }
 
@@ -17,51 +17,26 @@ function transformToUseB4a(outputPath) {
     console.log(`${outputPath} has been modified to use b4a.`);
 }
 
-function generatePbjsModule(pbjsPath, protoRootPath, entryPath, outputPath) {
-    execFileSync(pbjsPath, [
-        '-t', 'static-module',
-        '-w', 'commonjs',
-        '--keep-case',
-        '-p', protoRootPath,
-        '-o', outputPath,
-        entryPath
-    ]);
-    console.log(`${outputPath} has been generated.`);
-}
-
-function transformPbjsForBare(outputPath) {
-    let content = fs.readFileSync(outputPath, 'utf-8');
-    const shim = `if (typeof globalThis !== 'undefined' && typeof globalThis.self === 'undefined') {\n  globalThis.self = globalThis;\n}\n`;
-    const strictDirective = '"use strict";';
-
-    if (content.includes(strictDirective)) {
-        content = content.replace(strictDirective, `${strictDirective}\n${shim}`);
-    } else {
-        content = `${strictDirective}\n${shim}${content}`;
-    }
-
-    fs.writeFileSync(outputPath, content, 'utf-8');
-    console.log(`${outputPath} has been modified for bare-compatible protobufjs runtime.`);
-}
 
 function main() {
     const directoryName = path.dirname(fileURLToPath(import.meta.url));
 
     const inputDir = path.join(directoryName, '../proto');
     const outputDir = path.join(directoryName, '../src/utils/protobuf');
-    const pbjsPath = path.join(directoryName, '../node_modules/.bin/pbjs');
-    const applyInputPath = path.join(inputDir, 'applyOperations.proto');
-    const applyOutputPath = path.join(outputDir, 'applyOperations.cjs');
-    const networkEntryPath = path.join(inputDir, 'network/v1/network_message.proto');
-    const generatedNetworkOutputPath = path.join(outputDir, 'networkV1.generated.cjs');
 
     fs.mkdirSync(outputDir, { recursive: true });
 
-    generateCJSFromProto(applyInputPath, applyOutputPath);
-    transformToUseB4a(applyOutputPath);
+    const files = fs.readdirSync(inputDir).filter(f => f.endsWith('.proto'));
 
-    generatePbjsModule(pbjsPath, inputDir, networkEntryPath, generatedNetworkOutputPath);
-    transformPbjsForBare(generatedNetworkOutputPath);
+    for (const file of files) {
+        const name = path.basename(file, '.proto');
+        const inputPath = path.join(inputDir, file);
+        const outputPath = path.join(outputDir, `${name}.cjs`);
+
+        generateCJSFromProto(inputPath, outputPath);
+        transformToUseB4a(outputPath);
+    }
 }
 
 main();
+

package/src/config/config.js

@@ -129,6 +129,11 @@ export class Config {
         return this.#config.processIntervalMs
     }
 
+    get maxPartialTxPayloadByteSize() {
+        if (this.#isOverriden('maxPartialTxPayloadByteSize')) return this.#options.maxPartialTxPayloadByteSize
+        return this.#config.maxPartialTxPayloadByteSize
+    }
+
     get transactionPoolSize() {
         if (this.#isOverriden('transactionPoolSize')) return this.#options.transactionPoolSize
         return this.#config.transactionPoolSize
@@ -189,31 +194,6 @@ export class Config {
         if (this.#isOverriden('rateLimitMaxTransactionsPerSecond')) return this.#options.rateLimitMaxTransactionsPerSecond
         return this.#config.rateLimitMaxTransactionsPerSecond
     }
-    
-    get pendingRequestTimeout() {
-        return this.#config.pendingRequestTimeout
-    }
-
-    get txCommitTimeout() {
-        return this.#config.txCommitTimeout
-    }
-
-    get txPoolSize() {
-        return this.#config.txPoolSize
-    }
-
-    get validatorHealthCheckInterval() {
-        if (this.#isOverriden('validatorHealthCheckInterval')) return this.#options.validatorHealthCheckInterval
-        return this.#config.validatorHealthCheckInterval
-    }
-
-    get maxPendingRequestsInPendingRequestsService() {
-        return this.#config.maxPendingRequestsInPendingRequestsService
-    }
-
-    get debug() {
-        return this.#config.debug
-    }
 
     // Most of these properties are boolean
     #isOverriden(prop) {
@@ -227,5 +207,4 @@ export class Config {
             );
         }
     }
-
 }

package/src/config/env.js

@@ -1,16 +1,16 @@
 import { TRAC_NETWORK_MSB_MAINNET_PREFIX, TRAC_NETWORK_MSB_TESTNET1_PREFIX } from 'trac-wallet/constants.js';
-import { TRAC_NETWORK_TESTNET_ID, TRAC_NETWORK_MAINNET_ID } from 'trac-crypto-api/constants.js';
 import { Config } from './config.js';
+import { TRAC_NETWORK_TESTNET_ID, TRAC_NETWORK_MAINNET_ID } from 'trac-crypto-api/constants.js';
 
 export const ENV = {
     MAINNET: 'mainnet',
     DEVELOPMENT: 'development',
     TESTNET1: 'testnet1'
 }
+// TODO: CREATE TEST ENV CONFIG SIMILAR TO MAINNET AND USE IT IN TESTS.
 
 const configData = {
     [ENV.TESTNET1]: {
-        debug: false,
         addressLength: 67,
         addressPrefix: TRAC_NETWORK_MSB_TESTNET1_PREFIX,
         addressPrefixLength: TRAC_NETWORK_MSB_TESTNET1_PREFIX.length,
@@ -25,9 +25,9 @@ const configData = {
         enableTxApplyLogs: true,
         enableValidatorObserver: true,
         enableWallet: true,
-        maxValidators: 50,
-        maxRetries: 3,
-        messageThreshold: 3,
+        maxValidators: 6,
+        maxRetries: 1,
+        messageThreshold: 1000,
         messageValidatorRetryDelay: 1000, //How long to wait before retrying (ms) MESSAGE_VALIDATOR_RETRY_DELAY_MS
         messageValidatorResponseTimeout: 3 * 3 * 1000, //Overall timeout for sending a message (ms). This is 3 * maxRetries * messageValidatorRetryDelay;
         host: 'localhost',
@@ -39,20 +39,15 @@ const configData = {
         maxClientConnections: Infinity, // Connectivity constants
         maxWritersForAdminIndexerConnection: 10, // Connectivity constants
         processIntervalMs: 50, // Pool constants
+        maxPartialTxPayloadByteSize: 3072, // Operation handler constants
         transactionPoolSize: 1000, // Operation handler constants
         rateLimitCleanupIntervalMs: 120_000, // Rate limiting constants
         rateLimitConnectionTimeoutMs: 60_000, // Rate limiting constants
         rateLimitMaxTransactionsPerSecond: 50, // Rate limiting constants
-        maxPendingRequestsInPendingRequestsService: 50_000, // Maximum number of pending requests in PendingRequestService (This value should not exceed 256MB)
-        pendingRequestTimeout: 3000, // constant after which time the transaction will be considered invalid
-        txCommitTimeout: 2200,
-        txPoolSize: 1000, // size of transaction pool
-        validatorHealthCheckInterval: 5 * 60 * 1000, // How often to check validator health (ms)
-        storesDirectory: 'stores/',
+        storesDirectory : 'stores/',
         storeName: 'testnet',
     },
     [ENV.MAINNET]: {
-        debug: false,
         addressLength: 63,
         addressPrefix: TRAC_NETWORK_MSB_MAINNET_PREFIX,
         addressPrefixLength: TRAC_NETWORK_MSB_MAINNET_PREFIX.length,
@@ -81,20 +76,15 @@ const configData = {
         maxClientConnections: Infinity, // Connectivity constants
         maxWritersForAdminIndexerConnection: 10, // Connectivity constants
         processIntervalMs: 50, // Pool constants
+        maxPartialTxPayloadByteSize: 3072, // Operation handler constants
         transactionPoolSize: 1000, // Operation handler constants
         rateLimitCleanupIntervalMs: 120_000, // Rate limiting constants
         rateLimitConnectionTimeoutMs: 60_000, // Rate limiting constants
         rateLimitMaxTransactionsPerSecond: 50, // Rate limiting constants
-        maxPendingRequestsInPendingRequestsService: 50_000, // Maximum number of pending requests in PendingRequestService (This value should not exceed 256MB)
-        pendingRequestTimeout: 3000, // constant after which time the transaction will be considered invalid
-        txCommitTimeout: 2200,
-        txPoolSize: 1000, // size of transaction pool
-        validatorHealthCheckInterval: 5 * 60 * 1000, // How often to check validator health (ms)
         storesDirectory: 'stores/',
         storeName: 'mainnet',
     },
     [ENV.DEVELOPMENT]: {
-        debug: true,
         addressLength: 63,
         addressPrefix: TRAC_NETWORK_MSB_MAINNET_PREFIX,
         addressPrefixLength: TRAC_NETWORK_MSB_MAINNET_PREFIX.length,
@@ -110,7 +100,7 @@ const configData = {
         enableValidatorObserver: true,
         enableWallet: true,
         maxValidators: 6,
-        maxRetries: 3,
+        maxRetries: 0,
         messageThreshold: 1000,
         messageValidatorRetryDelay: 1000, //How long to wait before retrying (ms) MESSAGE_VALIDATOR_RETRY_DELAY_MS
         messageValidatorResponseTimeout: 3 * 3 * 1000, //Overall timeout for sending a message (ms). This is 3 * maxRetries * messageValidatorRetryDelay;
@@ -123,16 +113,12 @@ const configData = {
         maxClientConnections: Infinity, // Connectivity constants
         maxWritersForAdminIndexerConnection: 10, // Connectivity constants
         processIntervalMs: 50, // Pool constants
+        maxPartialTxPayloadByteSize: 3072, // Operation handler constants
         transactionPoolSize: 1000, // Operation handler constants
         rateLimitCleanupIntervalMs: 120_000, // Rate limiting constants
         rateLimitConnectionTimeoutMs: 60_000, // Rate limiting constants
         rateLimitMaxTransactionsPerSecond: 50, // Rate limiting constants
-        maxPendingRequestsInPendingRequestsService: 50_000, // Maximum number of pending requests in PendingRequestService (This value should not exceed 256MB)
-        pendingRequestTimeout: 3000, // constant after which time the transaction will be considered invalid
-        txCommitTimeout: 2200,
-        txPoolSize: 1000, // size of transaction pool
-        validatorHealthCheckInterval: 5 * 60 * 1000, // How often to check validator health (ms)
-        storesDirectory: 'stores/',
+        storesDirectory : 'stores/',
         storeName: 'development',
     }
 }