contractless/Contractless
contractless
/
Contractless
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Update README.md

This commit is contained in:
contractless 2026-07-12 15:14:50 +00:00
parent 4d559c710a
commit c0aee08f07
1 changed files with 8 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -12,14 +12,11 @@ For protocol design, mining rules, balance handling, orphan correction, and Fair
Recommended node requirements: Recommended node requirements:
- 64-bit Windows or Linux - Dedicated Internet
- Dedicated internet connection - PC / Laptop / Hosted VPS or cloud hosting
- Publicly reachable PC, laptop, VPS, cloud server, or self-hosted server - Minimum 16GB memory 24 - 32 GB recommended
- 16 GB RAM minimum - i5 or higher CPU (or AMD equivalent CPU)
- 24 GB to 32 GB RAM recommended - 64 bit processing OS
- Intel i5 or better, or comparable AMD CPU
- PostgreSQL installed locally or reachable by the node
- Enough disk space for blocks, torrents, balance data, logs, and state files
Contractless uses Falcon signatures and requires 64-bit processing support. Contractless uses Falcon signatures and requires 64-bit processing support.
@ -27,17 +24,12 @@ Contractless uses Falcon signatures and requires 64-bit processing support.
A public Contractless node must be reachable by other peers. A public Contractless node must be reachable by other peers.
- Public IP address - Dedicated Public IP address
- Open RPC port - Open public RPC port
- Router or host firewall port forwarding when behind NAT - Router or host firewall port forwarding when behind NAT
- `PUBLIC_IP` in `settings.ini` set to the reachable public IP - Reliable system time using NTP or another time synchronization service A common default is `pool.ntp.org`.
- `LISTEN_IP` usually set to `0.0.0.0`
- Correct `RPC_PORT` and `TESTNET_RPC_PORT`
- Reliable system time using NTP or another time synchronization service
- One mining node per public IP - One mining node per public IP
Loopback and private addresses are fine for local testing, but public testnet nodes must announce a reachable public IP.
## Download Source ## Download Source
Clone the repository: Clone the repository:
@ -57,8 +49,6 @@ Use the release package that matches your operating system and follow the matchi
## Documentation ## Documentation
The documentation is being reorganized into focused guides. Each guide explains the concept, required setup, common workflows, and relevant CLI tools instead of only listing commands.
| Guide | Description | | Guide | Description |
| --- | --- | | --- | --- |
| [Linux Installation](src/branch/main/docs/LINUX_INSTALLATION.md) | Install, configure, and run a Contractless node on Linux. | | [Linux Installation](src/branch/main/docs/LINUX_INSTALLATION.md) | Install, configure, and run a Contractless node on Linux. |