Skip to content

chore: replace "server" with "node"/"API" across the repo - #121

Merged
TaprootFreak merged 6 commits into
release/mainnet-hardeningfrom
chore/rename-server-to-node
May 26, 2026
Merged

chore: replace "server" with "node"/"API" across the repo#121
TaprootFreak merged 6 commits into
release/mainnet-hardeningfrom
chore/rename-server-to-node

Conversation

@TaprootFreak

Copy link
Copy Markdown
Contributor

Summary

Final, comprehensive servernode/API rename pass across the whole repo. The repo was previously named zk-coins/server; the term server for our own HTTP service is deprecated. Prior partial passes (#98, #101, #104) only touched docs — this PR covers the remaining residuals in source comments, code identifiers, CI workflows, and SQL migrations.

Naming convention applied:

  • node = our zkCoins HTTP service (default).
  • API = used when the HTTP interface is what's being discussed ("API endpoint", "REST API", "the API returns 400").
  • Bitcoin Core / bitcoind = the Bitcoin daemon (replaces "Bitcoin server").
  • External components (electrs, Esplora, Postgres, sccache, SSH, GitHub Actions context, wiremock::MockServer, axum::serve, StatusCode::INTERNAL_SERVER_ERROR, etc.) are intentionally not renamed.
  • Stable CI contract ZKCOINS_E2E_ALLOW_FEATURE_TRIMMED_SERVER env var keeps its _SERVER suffix; a code comment explains why.

Commits

SHA Scope
a7231a1 docs: root design docs (CONTRIBUTING, README, ROADMAP, SPEC, MIGRATION_RESEARCH, BRIDGE_*, ARKADE, MULTI_ASSET, LIGHTNING)
68028da docs: program-plonky2, script-plonky2, shared
b53ee42 refactor(node): internal bindings (minting_server_accountminting_node_account, server_clonenode_clone, server_guardaccount_node_guard) + comments across node/src and node/tests
8ad972d chore: CI/deploy workflow comments
ce4307c docs: SQL migration comments

Notes

  • ASCII directory tree in CONTRIBUTING.md corrected: server/server.rsnode/router.rs (matches actual layout).
  • Docker volume name in CONTRIBUTING examples updated: zkcoins_server-datazkcoins_node-data.
  • Anchor link in MIGRATION_RESEARCH.md §7.23 heading renamed and all 3 cross-references in ROADMAP.md / SPEC.md updated to match.
  • No functional changes. Pure naming + doc cleanup.

Test plan

  • cargo fmt --all -- --check clean
  • cargo clippy --workspace --all-features --no-deps -- -D warnings clean
  • cargo check --workspace --all-features clean
  • CI passes: Lint & Build, Rust Crypto Tests, Unit Tests, CodeQL, Analyze (rust/actions)

Aligns the prose, ASCII trees, and anchor links across CONTRIBUTING,
README, ROADMAP, SPEC, MIGRATION_RESEARCH, BRIDGE_MVP, BITVM_BRIDGE,
MULTI_ASSET, LIGHTNING_ATOMIC_SWAP, and ARKADE_INTEGRATION with the
post-rename module names (node/src/router.rs, the zkCoins node, etc.).
External components (Bitcoin Core, electrs/Esplora, Postgres) keep
their proper names; bitcoind's server=1 flag and Docker volume
zkcoins_node-data are corrected accordingly.
…r" references

Updates doc-comments, migration notes, and historical planning records
in program-plonky2 (CONTRIBUTING/SESSION_STATE/STEP4_REVIEW/STEP7_PREP
plus the rustdoc on types.rs, merkle helpers, and circuit/main.rs),
script-plonky2 (CONTRIBUTING + lib.rs rustdoc), and the shared
commitment_tests module header to refer to the zkCoins node instead
of the legacy "server" wording. No code logic changes.
Sweeps the remaining "server" prose in node/src/* and node/tests/* to
match the post-rename crate identity. Renames three local Rust
bindings whose names referenced the old crate:

  * minting_server_account -> minting_node_account (runtime.rs)
  * server_clone           -> node_clone           (router_tests.rs)
  * server_guard           -> account_node_guard   (router_tests.rs)

Doc-comments and error/log messages on main.rs, router.rs, runtime.rs,
scanner.rs, db.rs, account_node.rs, the matching test files, and
node/tests/api_remote.rs now refer to "the node" or "the API" as
appropriate. The env-var ZKCOINS_E2E_ALLOW_FEATURE_TRIMMED_SERVER is
kept verbatim because it is a stable CI contract with deploy-dev.yaml.

External names are untouched: StatusCode::INTERNAL_SERVER_ERROR,
wiremock::MockServer + every mock_server/mint_broadcast_mock_server
binding, scanner_ws_tests' spawn_ws_server (Esplora WS mock), and the
bitcoind server=1 documentation example all keep their original
spelling.
Replaces the remaining prose references to the legacy "server" name
in ci.yaml, deploy-dev.yaml, and deploy-prd.yaml — workflow_dispatch
descriptions, deploy-target labels ("deployed DEV/PRD server"),
test-target descriptions ("live-DEV-server verification"), and the
bootstrap-env comment all now refer to "the node" instead.

External names stay untouched: SSH ServerAlive*, github.server_url,
sccache --start-server / --stop-server, and the
ZKCOINS_E2E_ALLOW_FEATURE_TRIMMED_SERVER env-var contract with the
api_remote test macro all keep their original spelling.
@TaprootFreak
TaprootFreak marked this pull request as ready for review May 26, 2026 21:12
@TaprootFreak
TaprootFreak changed the base branch from develop to release/mainnet-hardening May 26, 2026 21:13
…node

Resolve conflict in runtime.rs (boot_log block from release branch kept,
"REST server" → "REST API" rename applied).

Apply server → node rename to merge-introduced files:
- node/migrations/0006_inscription_kind.sql, 0007_request_log.sql, 0008_full_database_trail.sql
- node/src/db.rs (4 doc-comments)
- node/src/router.rs (1 doc-comment)
@TaprootFreak
TaprootFreak merged commit e29a488 into release/mainnet-hardening May 26, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant