Skip to content

Docs: Document status schedules and delegate API enhancements#37

Merged
al-onyxprotocol merged 4 commits into
devfrom
feat/status-schedules-and-forged-delegates
Jul 16, 2026
Merged

Docs: Document status schedules and delegate API enhancements#37
al-onyxprotocol merged 4 commits into
devfrom
feat/status-schedules-and-forged-delegates

Conversation

@al-onyxprotocol

@al-onyxprotocol al-onyxprotocol commented Jul 16, 2026

Copy link
Copy Markdown
Member

Description

Document the additive Node API fields introduced for consensus/reward schedule discovery, lifetime delegate forged totals, and the corrected next-forger schedule semantics.

  • describe consensusCodeName in GET /api/blocks/getStatus;
  • describe network.consensusCodeName, consensusSchedule, and milestoneSchedule in GET /api/node/status;
  • clarify activation boundaries, effective runtime values, base-unit rewards, and compatibility with older nodes;
  • add the forged decimal string to delegate list and single-delegate examples;
  • clarify that delegate search keeps its existing response shape without forged;
  • document that GET /api/delegates/getNextForgers is a next-block snapshot, including round boundaries, refresh behavior, and limit constraints.

Related issue

Closes #36

How to test

npm run docs:build

The affected Blockchain and Delegates pages were also inspected in the local VitePress preview.

Review follow-up also improves the node status prose and uses the canonical internal WebSocket documentation link.

Checklist

  • Content matches the current Node implementation.
  • Field types, units, and boundary semantics are documented.
  • Existing API fields and examples remain intact.
  • The production documentation build succeeds.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the ADAMANT Node API documentation to cover newly added, additive status-schedule discovery fields and the lifetime delegate forged total, keeping examples and field semantics aligned with current node behavior.

Changes:

  • Document forged (decimal string in base units) for GET /api/delegates and GET /api/delegates/get, and clarify it is not returned by delegate search.
  • Document consensus in GET /api/blocks/getStatus.
  • Extend GET /api/node/status docs with network.consensus, consensusSchedule, and milestoneSchedule semantics and examples, including activation-boundary and compatibility notes.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
api-endpoints/delegates.md Adds forged field documentation and updates delegate list/single-delegate examples; clarifies search response excludes forged.
api-endpoints/blockchain.md Documents consensus in /api/blocks/getStatus and adds schedule/activation semantics plus examples for /api/node/status.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread api-endpoints/blockchain.md Outdated
Comment thread api-endpoints/blockchain.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread api-endpoints/blockchain.md Outdated
@al-onyxprotocol al-onyxprotocol changed the title Docs: Document status schedules and delegate forged amounts Docs: Document status schedules and delegate API enhancements Jul 16, 2026
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.

[Enhancement] Document status schedules and delegate forged amounts

3 participants