Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion client/config/config.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

const NodeVersion NODE_VERSION = 532;
// the community release (4.2.532-community.N); also announced to peers in host_data bits 32-47
const uint8_t MINOR_NODE_VERSION = 17;
const uint8_t MINOR_NODE_VERSION = 18;

const std::string BLOCK_NAME_PARAMS = "params";
const std::string BLOCK_NAME_HOST_INPUT = "host_input";
Expand Down
7 changes: 7 additions & 0 deletions docs/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,20 @@ lines under the new release.

## Not released yet

Nothing yet.

## community.18 — 2026-11-09

Release 18 makes a first start easier and gives a full node a better default. It adds a short quick-start guide (Docker and native Linux, Windows and macOS). A new full node now uses rocksdb, in the guided set-up and in Docker; pruned nodes stay on lmdb and existing installs keep their database. Docker takes its CPU and memory limits from `CREDITS_CPUS` and `CREDITS_MEMORY`. The guide explains how to use an existing node key, and `--decryptkey` (in Docker, `decrypt-key`) turns a password-protected key file into a plain one. The log gains more stage-3 diagnostics (`stage3 timestamp`, `stage3 network block`), written only when a check fails.

| PR | Change |
|---|---|
| #172 | docs: `docs/quick-start.md`, a short quick-start guide (Docker and native Linux, Windows and macOS; pruned on lmdb or full on rocksdb from the snapshot, snapshot serving on; requirements, ports, first checks, the wallet, upgrading with the database kept, common problems), linked from the top of the README |
| #173 | packaging: a new full node defaults to rocksdb (it starts from a snapshot) in Docker and in the guided set-up (setup.sh, setup.ps1); pruned stays on lmdb; existing installs keep their backend (the database in `db/`, the `db_backend` of `config.ini`, berkeleydb for a full `[storage]` without one; the entrypoint also detects the database of a data folder whose `config.ini` was removed); `docker-compose.yml` takes its limits from `CREDITS_CPUS` (1.5) and `CREDITS_MEMORY` (4g) in `.env` (a full node: 4 and 8g); texts aligned: a full node on rocksdb about 250 to 300 GB, backfill about 2 to 3 days, glibc 2.38 for `linux-x64` (2.31 for `-glibc2.31`) in the README, the image `ghcr.io/creditscommunity/credits-node`, the `config.pruned.ini` comment on the snapshot start; quick-start, storage.md and the Docker README updated; ci: setup-test and the Docker entrypoint test check the rocksdb default and that a full berkeleydb install is kept |
| #174 | docs: quick-start: using an existing node key, plain or encrypted, in Docker or native (a section with copy-paste steps; an encrypted key converted once to plain with the node's own `--dumpkeys`, for Docker and systemd) |
| #175 | node: `--decryptkey` turns a key file encrypted with a password by the node into the plain key after asking the old password (the encrypted file kept as `NodePrivate.txt.encrypted-<date>`, the public key checked, no configuration, network or database); Docker: `docker compose run --rm node decrypt-key`, and a normal start with an encrypted key stops with that hint instead of waiting for a password; quick-start section 10 uses it instead of the `--dumpkeys` procedure of #174 |
| #176 | solver: stage-3 diagnostics (logging only, failure path): a `stage3 timestamp` line with the last block timestamp, every stage-1 timestamp and its fate (in, outlier, masked, not after last, empty, invalid), N, mean, dispersion and the chosen value; `stage3 inputs` also shows the confirmation mask bits, a hash of the round-confirmation signatures, the real-trusted mask, version, round cost and bootstrap flag; a `stage3 network block` line prints the block the network stored for a sequence whose stage 3 failed here, with the fields that differ; docs/consensus-diagnostics.md sections 1a and 1b |
| — | release: the version announced to peers (`MINOR_NODE_VERSION`) is 18 |

## community.17 — 2026-11-05

Expand Down
18 changes: 17 additions & 1 deletion docs/FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ consensus with them. This page lists what it adds; each item links the pull requ
The full list of changes is in [CHANGES.md](CHANGES.md), the operational details in
[differences.md](differences.md).

Everything listed here is in release 4.2.532-community.17 or earlier.
Everything listed here is in release 4.2.532-community.18 or earlier.

## Storage

Expand Down Expand Up @@ -145,6 +145,11 @@ Everything listed here is in release 4.2.532-community.17 or earlier.
what the node signed and why a peer's stage failed, at info level only when a check fails; a
healthy node logs none of it. See [consensus-diagnostics.md](consensus-diagnostics.md).
[#167](https://github.com/CreditsCommunity/node/pull/167), [#168](https://github.com/CreditsCommunity/node/pull/168)
- **More stage-3 diagnostics.** A `stage3 timestamp` line shows the last block timestamp, every
stage-1 timestamp and what became of it, and the value chosen; `stage3 inputs` shows more of what
the node signed; a `stage3 network block` line shows the block the network stored when stage 3
failed here, with the fields that differ. Logging only.
[#176](https://github.com/CreditsCommunity/node/pull/176)

## Crash and safety fixes

Expand Down Expand Up @@ -194,6 +199,17 @@ limits in the p2p layer (a fork of the p2p library), and two races in the cache
storage at start; the Docker health check no longer reports a node at the head as unhealthy after
a log rotation.
[#157](https://github.com/CreditsCommunity/node/pull/157), [#160](https://github.com/CreditsCommunity/node/pull/160)
- **Quick-start guide.** `docs/quick-start.md`: Docker and native Linux, Windows and macOS, with
requirements, ports, first checks, upgrading and common problems.
[#172](https://github.com/CreditsCommunity/node/pull/172)
- **RocksDB by default for a new full node**, in the set-up and in Docker; pruned stays on lmdb and
an existing install keeps its database. Docker CPU and memory limits are set with `CREDITS_CPUS`
and `CREDITS_MEMORY`.
[#173](https://github.com/CreditsCommunity/node/pull/173)
- **Using an existing node key**, plain or encrypted, in Docker or native; `--decryptkey` (Docker:
`decrypt-key`) turns an encrypted key file into the plain key after asking the password, keeping
the encrypted file.
[#174](https://github.com/CreditsCommunity/node/pull/174), [#175](https://github.com/CreditsCommunity/node/pull/175)
- **Key file.** `NodePrivate.txt` is written readable by its owner only (mode 0600), and the
encrypted key file is re-encrypted atomically, with clear errors; the format is unchanged.
[#169](https://github.com/CreditsCommunity/node/pull/169), [#170](https://github.com/CreditsCommunity/node/pull/170)
Expand Down
2 changes: 1 addition & 1 deletion docs/differences.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ from the Thrift definitions of the fork
| Field | Value |
|---|---|
| `9: optional i64 networkUuid` | The chain identifier: the first 8 bytes of the hash of block 1, read as a little-endian unsigned 64-bit number (`BlockChain::uuid()`). It is the same on every node of a network, so a client such as a wallet can tell mainnet from a test network. Pruned nodes and nodes started from a snapshot know it too (it is in the checkpoint). Left out while the node does not know it yet (an empty database before block 1). Thrift has no unsigned type: the same 64 bits travel as a signed number, so mainnet, `11024959585341937636`, arrives as `-7421784488367613980`; add 2^64 to a negative value (or mask with `0xFFFFFFFFFFFFFFFF`) to get the unsigned one. |
| `10: optional string communityVersion` | The package version, the first line of the `VERSION` file, for example `4.2.532-community.17`. Without a `VERSION` file it is `4.2.<protocol>.<minor>`. Always set by the community node. |
| `10: optional string communityVersion` | The package version, the first line of the `VERSION` file, for example `4.2.532-community.18`. Without a `VERSION` file it is `4.2.<protocol>.<minor>`. Always set by the community node. |

The official node sets neither field, and clients built from the official definitions ignore them,
so a client can detect a community node by the presence of `communityVersion`. A local clone made
Expand Down
16 changes: 8 additions & 8 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,16 +124,16 @@ caches.

1. Open the [latest release](https://github.com/CreditsCommunity/node/releases/latest) and download
the Linux package and `SHA256SUMS`:
- `credits-node-4.2.532-community.17-linux-x64.tar.gz` for Ubuntu 24.04, Debian 13 and later
- `credits-node-4.2.532-community.18-linux-x64.tar.gz` for Ubuntu 24.04, Debian 13 and later
(glibc 2.38);
- `credits-node-4.2.532-community.17-linux-x64-glibc2.31.tar.gz` for Ubuntu 20.04, Debian 11
- `credits-node-4.2.532-community.18-linux-x64-glibc2.31.tar.gz` for Ubuntu 20.04, Debian 11
and later.

2. Check and extract:

```sh
sha256sum -c --ignore-missing SHA256SUMS # must print "OK"
tar -xzf credits-node-4.2.532-community.17-linux-x64.tar.gz
tar -xzf credits-node-4.2.532-community.18-linux-x64.tar.gz
cd csnode
```

Expand Down Expand Up @@ -209,12 +209,12 @@ The node's own log is in `csnode/log/`.

## 5. Native on Windows

1. Download `credits-node-4.2.532-community.17-windows-x64.zip` and `SHA256SUMS-windows-macos`
1. Download `credits-node-4.2.532-community.18-windows-x64.zip` and `SHA256SUMS-windows-macos`
from the [latest release](https://github.com/CreditsCommunity/node/releases/latest). Check it in
PowerShell and compare with the file:

```powershell
Get-FileHash credits-node-4.2.532-community.17-windows-x64.zip
Get-FileHash credits-node-4.2.532-community.18-windows-x64.zip
```

2. Extract the zip, for example to `C:\credits`. Open the `csnode` folder.
Expand All @@ -234,12 +234,12 @@ The package has no Windows service. Run the node in a console window you keep op

## 6. macOS (Apple Silicon)

Download `credits-node-4.2.532-community.17-macos-arm64.tar.gz`, check it with
Download `credits-node-4.2.532-community.18-macos-arm64.tar.gz`, check it with
`shasum -a 256 -c --ignore-missing SHA256SUMS-windows-macos`, extract it, then clear the
download quarantine once (the binaries are not signed) and follow the Linux steps:

```sh
tar -xzf credits-node-4.2.532-community.17-macos-arm64.tar.gz
tar -xzf credits-node-4.2.532-community.18-macos-arm64.tar.gz
xattr -dr com.apple.quarantine csnode
cd csnode && ./setup.sh
```
Expand All @@ -251,7 +251,7 @@ In the console or the log (`csnode/log/`, or `docker compose logs -f`), look for
1. The banner with the version and your settings:

```
node 4.2.532-community.17 (protocol 532, build ...)
node 4.2.532-community.18 (protocol 532, build ...)
storage: pruned, lmdb snapshots: serve on
```

Expand Down
Loading