trac-msb 0.2.9 → 0.2.11

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+info@trac.network.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/README.md

@@ -1,3 +1,11 @@
+[![release](https://img.shields.io/github/v/release/Trac-Systems/main_settlement_bus)](https://github.com/Trac-Systems/main_settlement_bus/releases/latest)
+[![tag](https://img.shields.io/github/v/tag/Trac-Systems/main_settlement_bus?sort=semver)](https://github.com/Trac-Systems/main_settlement_bus/tags)
+[![npm](https://img.shields.io/npm/v/trac-msb)](https://www.npmjs.com/package/trac-msb)
+[![license](https://img.shields.io/github/license/Trac-Systems/main_settlement_bus)](https://github.com/Trac-Systems/main_settlement_bus/blob/main/LICENSE)
+[![node](https://img.shields.io/badge/node-v22.22.0-brightgreen)](https://www.npmjs.com/package/trac-msb)
+[![dependabot](https://img.shields.io/badge/dependabot-enabled-brightgreen)](https://github.com/Trac-Systems/main_settlement_bus/security/dependabot)
+[![MSB-Unit-Tests](https://github.com/Trac-Systems/main_settlement_bus/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/Trac-Systems/main_settlement_bus/actions/workflows/unit-tests.yml)
+[![Acceptance Tests](https://github.com/Trac-Systems/main_settlement_bus/actions/workflows/acceptance-tests.yml/badge.svg?branch=main)](https://github.com/Trac-Systems/main_settlement_bus/actions/workflows/acceptance-tests.yml)
 # Main Settlement Bus (MSB)
 
 A peer-to-peer crypto validator network to verify and append transactions.
@@ -8,7 +16,7 @@ The MSB leverages the [Pear Runtime and Holepunch](https://pears.com/).
 
 ## Prerequisites
 
-Node.js is required to run the application. Before installing Node.js, refer to the official [Node.js documentation](https://nodejs.org) for the latest recommended version and installation instructions. For this project, Node.js v24.11.0 (LTS) and npm 11.6.1 or newer are compatible.
+Node.js is required to run the application. Before installing Node.js, refer to the official [Node.js documentation](https://nodejs.org) for the latest recommended version and installation instructions. For this project, Node.js v22.22.0 (LTS) and npm 11.6.1 or newer are compatible.
 
 The Pear Runtime CLI is required to run the application. Before installing Pear, refer to the official [Pear documentation](https://docs.pears.com/guides/getting-started) for the latest recommended version and installation instructions. For this project, the latest Pear CLI is compatible.
 
@@ -24,7 +32,7 @@ Docker is optional and only needed for running the containerized RPC node. Befor
 ## Install
 
 ```shell
-git clone -b main --single-branch git@github.com:Trac-Systems/main_settlement_bus.git
+git clone -b <tag> --single-branch git@github.com:Trac-Systems/main_settlement_bus.git
 cd main_settlement_bus
 npm install
 ```
@@ -39,11 +47,11 @@ npm install -g bare
 
 - ✅ `npm run test:unit:all` – confirms the codebase builds and runs under both supported runtimes.
 - 📋 `npm run test:acceptance` – optional but recommended before upgrades. This suite spins up in-process nodes and may take a few minutes.
-- 🌐 RPC smoke test – start `MSB_STORE=smoke-store MSB_HOST=127.0.0.1 MSB_PORT=5000 npm run env-prod-rpc` in one terminal, then execute `curl -s http://127.0.0.1:5000/v1/fee` from another terminal to verify `/v1` routes respond. Stop the node with `Ctrl+C` once finished.
+- 🌐 RPC smoke test – start `STORES_DIRECTORY=smoke-store MSB_HOST=127.0.0.1 MSB_PORT=5000 NETWORK=mainnet npm run env-rpc` in one terminal, then execute `curl -s http://127.0.0.1:5000/v1/fee` from another terminal to verify `/v1` routes respond. Stop the node with `Ctrl+C` once finished.
 
 ## Usage
 
-Runtime entry points cover CLI-driven runs (`prod`, `prod-rpc`) and `.env`-aware runs (`env-prod`, `env-prod-rpc`). Each section below lists the accepted configuration inputs.
+Runtime entry points cover CLI-driven runs (`start`, `rpc`) and `.env`-aware runs (`env`, `env-rpc`). Each section below lists the accepted configuration inputs.
 
 ### Interactive regular node
 
@@ -53,29 +61,30 @@ This variant reads configuration from `.env`:
 
 ```
 # .env
-MSB_STORE=<store_name>
+STORES_DIRECTORY=<stores_directory>
+NETWORK=<network>
 ```
 
 then
 
 ```
-npm run env-prod
+npm run env
 ```
 
-The script sources `.env` before invoking program and falls back to `node-store` when `MSB_STORE` is not defined.
+The script sources `.env` before invoking program and falls back to `stores` for `STORES_DIRECTORY` and `mainnet` for `NETWORK` when unset.
 
 #### Inline environment variables
 
 ```sh
-MSB_STORE=<store_name> npm run env-prod
+STORES_DIRECTORY=<stores_directory> NETWORK=testnet npm run env
 ```
 
-This run persists data under `./stores/${MSB_STORE}` (defaults to `node-store`) and is intended for inline or CLI-supplied configuration.
+This run persists data under `${STORES_DIRECTORY}` (defaults to `stores` under the project root), connects to testnet (defaults to `mainnet`) and is intended for inline or CLI-supplied configuration. Each network will have its own store subfolder to avoid collision
 
 #### CLI flags
 
 ```sh
-npm run prod --store=<store_name>
+npm run start -- --stores-directory <stores_directory> --network testnet
 ```
 
 ### RPC-enabled node
@@ -84,29 +93,30 @@ npm run prod --store=<store_name>
 
 ```
 # .env
-MSB_STORE=<store_name>
+STORES_DIRECTORY=<stores_directory>
 MSB_HOST=127.0.0.1
 MSB_PORT=5000
+NETWORK=mainnet
 ```
 
 ```
-npm run env-prod-rpc
+npm run env-rpc
 ```
 
-This entry point sources `.env` automatically and defaults to `rpc-node-store`, `127.0.0.1`, and `5000` when variables are not present.
+This entry point sources `.env` automatically and defaults to `stores`, `127.0.0.1`, `5000`, and `mainnet` when variables are not present. Supported `NETWORK` values are `mainnet`, `development`, `testnet`, and `testnet1`.
 
 #### Inline environment variables
 
 ```sh
-MSB_STORE=<store_name> MSB_HOST=<host> MSB_PORT=<port> npm run env-prod-rpc
+STORES_DIRECTORY=<stores_directory> MSB_HOST=<host> MSB_PORT=<port> NETWORK=<network> npm run env-rpc
 ```
 
-Override any combination of `MSB_STORE`, `MSB_HOST`, or `MSB_PORT`. Data is persisted under `./stores/${MSB_STORE}` (default `rpc-node-store` for this script).
+Override any combination of `STORES_DIRECTORY`, `MSB_HOST`, `MSB_PORT`, or `NETWORK`. Data is persisted under `<stores_directory>/<store_name>` (default `stores/mainnet` for this script).
 
 #### CLI flags
 
 ```sh
-npm run prod-rpc --store=<store_name> --host=<host> --port=<port>
+npm run rpc --host=<host> --port=<port> -- --stores-directory <stores_directory> --network <network>
 ```
 
 ## Docker usage
@@ -117,6 +127,7 @@ You can run the RPC node in a containerized environment using the provided `dock
 - `MSB_HOST`: host interface to bind (defaults to `127.0.0.1` to avoid exposing everything).
 - `MSB_PORT`: port the RPC server listens on **inside** the container (defaults to `5000`).
 - `MSB_PUBLISH_PORT`: host port to expose (defaults to `MSB_PORT`, so set it only when the host port should differ).
+- `NETWORK`: network environment for the RPC process (defaults to `mainnet`). Supported values are `mainnet`, `development`, `testnet`, and `testnet1`.
 
 Leave `MSB_PORT=5000` if you just want to publish the default RPC port and only bump `MSB_PUBLISH_PORT` when the host side must change. Set both to the same value if you want the RPC server itself to listen on another port.
 
@@ -126,6 +137,7 @@ Example (keep container port 5000, expose host port 6000):
 MSB_STORE=rpc-node-store \
 MSB_HOST=127.0.0.1 \
 MSB_PORT=5000 \
+NETWORK=mainnet \
 MSB_PUBLISH_PORT=6000 \
 docker compose up -d msb-rpc
 ```
@@ -154,13 +166,14 @@ Any of the following launch methods can be applied:
    MSB_STORE=rpc-node-store
    MSB_HOST=127.0.0.1
    MSB_PORT=5000
+   NETWORK=mainnet
    MSB_PUBLISH_PORT=1337
    ```
 
 2. **Passing variables inline** – use this method when environment variables should be provided directly in the command line, without modifying the `.env` file:
 
    ```sh
-   MSB_STORE=<store_name> MSB_HOST=<host> MSB_PORT=<container_port> MSB_PUBLISH_PORT=<host_port> docker compose up -d msb-rpc
+   MSB_STORE=<store_name> MSB_HOST=<host> MSB_PORT=<container_port> NETWORK=<network> MSB_PUBLISH_PORT=<host_port> docker compose up -d msb-rpc
    ```
 
    Skip `MSB_PORT` when you just want to keep the container on `5000` and expose a different host port.
@@ -172,6 +185,7 @@ Any of the following launch methods can be applied:
       -e MSB_STORE=<store_name> \
       -e MSB_HOST=<host> \
       -e MSB_PORT=<container_port> \
+      -e NETWORK=<network> \
       -e MSB_PUBLISH_PORT=<host_port> \
       -p <host_address>:<host_port>:<container_port> \
       -v /absolute/path/to/your/store_directory:/msb/stores \
@@ -187,6 +201,7 @@ Any of the following launch methods can be applied:
        -e MSB_STORE=rpc-node-store \
        -e MSB_HOST=127.0.0.1 \
        -e MSB_PORT=5000 \
+       -e NETWORK=mainnet \
        -e MSB_PUBLISH_PORT=6000 \
        -p 127.0.0.1:6000:5000 \
        -v /absolute/path/to/your/store_directory:/msb/stores \
@@ -199,5 +214,5 @@ Stop the service with `docker compose stop msb-rpc`, remove the stack entirely w
 
 ## Troubleshooting
 
-- **Dependency install failures** – confirm you are on Node.js v24.11.0 (LTS) and npm ≥ 11.6.1. If packages still fail to build, clear artifacts (`rm -rf node_modules package-lock.json && npm install`) and rerun `npm run test:unit:all`.
+- **Dependency install failures** – confirm you are on Node.js v22.22.0 (LTS) and npm ≥ 11.6.1. If packages still fail to build, clear artifacts (`rm -rf node_modules package-lock.json && npm install`) and rerun `npm run test:unit:all`.
 - **Unit tests fail only in one runtime** – run the targeted commands (`npm run test:unit:node` or `npm run test:unit:bare`) to isolate regressions, then inspect `tests/unit/unit.test.js` for the failing cases.

package/docker-compose.yml

@@ -9,6 +9,7 @@ services:
       MSB_STORE: ${MSB_STORE:-rpc-node-store}
       MSB_HOST: ${MSB_HOST:-127.0.0.1}
       MSB_PORT: ${MSB_PORT:-5000}
+      NETWORK: ${NETWORK:-mainnet}
     volumes:
       - ./stores:/msb/stores
     ports: