Skip to content

docs: bounty #1494 first API call walkthrough + signed transfer example#751

Closed
createkr wants to merge 1 commit intoScottcjn:mainfrom
createkr:feat/issue1494-api-transfer-example-v2
Closed

docs: bounty #1494 first API call walkthrough + signed transfer example#751
createkr wants to merge 1 commit intoScottcjn:mainfrom
createkr:feat/issue1494-api-transfer-example-v2

Conversation

@createkr
Copy link
Copy Markdown
Contributor

@createkr createkr commented Mar 9, 2026

Implements #1494 with reproducible API walkthrough and signed transfer dry-run examples. One-bounty scope only.\n\nPayout wallet: RTC1d48d848a5aa5ecf2c5f01aa5fb64837daaf2f35 (split: createkr-wallet).

…ottcjn#1494)

Implement bounty Scottcjn#1494 with comprehensive documentation and verified examples
for developers making their first RustChain API calls and signed transfers.

Deliverables:
- docs/FIRST_API_CALLS.md: Step-by-step API walkthrough (health, epoch, miners, balance)
- docs/SIGNED_TRANSFER_EXAMPLE.md: Complete signed transfer guide with Ed25519 spec
- docs/REPRODUCIBILITY_NOTES.md: Environment setup and validation checklist
- examples/signed_transfer_example.py: Full-featured Python script with CLI
- validate_bounty1494.sh: Automated validation script (7 tests)
- requirements_bounty1494.txt: Python dependencies
- docs/BOUNTY_1494_VALIDATION_REPORT.md: Validation report

Validation:
- All 7 tests pass against live node (rustchain.org v2.2.1-rip200)
- Verified: health, epoch, miners, hall_of_fame, fee_pool, balance endpoints
- Verified: Ed25519 signature generation (64-byte pubkey, 128-char hex signature)
- Verified: Replay protection with millisecond timestamp nonces
- Python 3.12.12 compatibility verified

Usage:
  # Quick API test
  curl -sk https://rustchain.org/health

  # Signed transfer example (dry-run)
  python3 examples/signed_transfer_example.py --generate --to RTC... --amount 1.0 --dry-run

  # Run full validation
  bash validate_bounty1494.sh
@github-actions github-actions bot added documentation Improvements or additions to documentation BCOS-L1 Beacon Certified Open Source tier BCOS-L1 (required for non-doc PRs) size/XL PR: 500+ lines labels Mar 9, 2026
dagangtj pushed a commit to dagangtj/Rustchain that referenced this pull request Mar 9, 2026
…cottcjn#751)

* feat: add standalone testnet faucet service with rate limiting

* chore: add SPDX headers to new faucet files

* feat: add automated SQLite backup verification script

---------

Co-authored-by: chenx20050405 <chenx04050020@gmail.com>
Repository owner deleted a comment from MontaEllis8 Mar 9, 2026
@Scottcjn Scottcjn closed this Mar 9, 2026
@Scottcjn
Copy link
Copy Markdown
Owner

Scottcjn commented Mar 9, 2026

Closing — bounty #1494 already fulfilled by PR #729 (merged). Your other PRs are being reviewed separately. Keep up the great work createkr!

createkr pushed a commit to createkr/Rustchain that referenced this pull request Mar 12, 2026
…miting and validation

Implement production-ready Flask-based faucet service for dispensing test RTC tokens.

Features:
- Configurable rate limiting (IP, wallet, or hybrid methods)
- Wallet address validation with blocklist/allowlist support
- SQLite backend with optional Redis for distributed deployments
- REST API with modern HTML UI
- Health check and Prometheus metrics endpoints
- Mock mode for testing without actual transfers

Files:
- faucet_service/faucet_service.py - Main service (1036 lines)
- faucet_service/faucet_config.yaml - Configuration template
- faucet_service/test_faucet_service.py - Test suite (30 tests)
- faucet_service/README.md - Comprehensive documentation
- faucet_service/requirements.txt - Python dependencies
- faucet_service/IMPLEMENTATION_SUMMARY.md - Implementation details

Testing:
- All 30 tests passing
- Coverage: config, validation, rate limiting, API, integration

Usage:
  cd faucet_service
  pip install -r requirements.txt
  python faucet_service.py

API Endpoints:
  GET  /faucet        - Web UI
  POST /faucet/drip   - Request tokens
  GET  /faucet/status - Statistics
  GET  /health        - Health check
createkr pushed a commit to createkr/Rustchain that referenced this pull request Mar 22, 2026
…cottcjn#751)

* feat: add standalone testnet faucet service with rate limiting

* chore: add SPDX headers to new faucet files

* feat: add automated SQLite backup verification script

---------

Co-authored-by: chenx20050405 <chenx04050020@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BCOS-L1 Beacon Certified Open Source tier BCOS-L1 (required for non-doc PRs) documentation Improvements or additions to documentation size/XL PR: 500+ lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants