docs: OpenAPI 3.0 spec for RustChain Node API (Bounty #502)#592
Closed
sososonia-cyber wants to merge 6 commits intoScottcjn:mainfrom
Closed
docs: OpenAPI 3.0 spec for RustChain Node API (Bounty #502)#592sososonia-cyber wants to merge 6 commits intoScottcjn:mainfrom
sososonia-cyber wants to merge 6 commits intoScottcjn:mainfrom
Conversation
added 6 commits
March 6, 2026 09:12
- Added pip-installable Python SDK - Supports all node API endpoints: health, miners, balance, epoch, eligibility, attestation, transfer - Async support with aiohttp - Type hints throughout - SSL verification toggle (handles self-signed certs) - Retry logic with exponential backoff - CLI tool included Closes Scottcjn#36
- Command-line wallet management tool - create: Generate new wallet with Ed25519 keys - list: List all stored wallets - balance: Check wallet balance via API - import: Import from mnemonic phrase - export: Export wallet info - Uses rustchain_sdk for API calls Closes Scottcjn#39
- RustChain node metrics exporter for Prometheus - Metrics: node health, miners, epoch info, miner details - Supports Grafana integration - Run as standalone Python script or Docker Closes Scottcjn#504
- Document all public API endpoints - Includes health, epoch, miners, lottery, wallet, attestation - Ready for Swagger UI integration - Helps developers build tools on RustChain Closes Scottcjn#502
github-actions
bot
added
documentation
Contributor
Author
|
Wallet for bounty reward: RTCa95d28a468dd4ba76367483d338b13bcb20499bd |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add OpenAPI 3.0 specification for RustChain Node API.
This PR adds comprehensive API documentation in OpenAPI format covering:
Bounty
This PR addresses issue #502 - OpenAPI Docs (30 RTC)