Hands-on Sandbox
Simulate the execution of a national settlement Root Node in your development environment. A complete containerized topology with Docker Compose ready for testing with simulated FIs.
1. Prerequisites
Numo orchestrates heavy services like Kafka, PostgreSQL (multiple instances), and in-memory databases. It requires Docker and Docker Compose V2. 16GB of RAM is recommended on the host machine.
2. Running the Base Stack (Core + Ledger + Stream)
$ git clone https://github.com/inbox-ong/numoCore
$ cd numoCore
$ docker-compose up -d
[+] Running 5/5
✔ Container numocore-zookeeper-1 Started
✔ Container numocore-kafka-1 Started
✔ Container numocore-postgres-1 Started
✔ Container numocore-redis-1 Started
✔ Container numocore-api-1 Started $ docker ps --format "table {{.Names}}\t{{.Ports}}"
$ cd numoCore
$ docker-compose up -d
[+] Running 5/5
✔ Container numocore-zookeeper-1 Started
✔ Container numocore-kafka-1 Started
✔ Container numocore-postgres-1 Started
✔ Container numocore-redis-1 Started
✔ Container numocore-api-1 Started $ docker ps --format "table {{.Names}}\t{{.Ports}}"
3. Operational APIs
With the core running, the settlement API
(`numoCore`) will be available at localhost:8080. You can submit JSON ISO message batches.
$ curl -X POST http://localhost:8080/v1/settle \
-H "Content-Type: application/json" \
-d '{"msg_id":"MSG123","sender":"BANK_A","receiver":"BANK_B","amount":1500.00}'
{"status":"processing", "tx_id":"NX-A91B-2026"}
-H "Content-Type: application/json" \
-d '{"msg_id":"MSG123","sender":"BANK_A","receiver":"BANK_B","amount":1500.00}'
{"status":"processing", "tx_id":"NX-A91B-2026"}
4. Exploring the Interface (Coming Soon)
The `numoAdmin-next` repository contains the administrative graphical interface where you can visualize the bus in practice. Run it in parallel.