Skip to content

docs: refresh REST and public testnet guidance - #234

Merged
pgarciagon merged 1 commit into
devfrom
codex/refresh-rest-testnet-docs
Jul 23, 2026
Merged

docs: refresh REST and public testnet guidance#234
pgarciagon merged 1 commit into
devfrom
codex/refresh-rest-testnet-docs

Conversation

@pgarciagon

Copy link
Copy Markdown

Summary

This PR supersedes #230 by applying its still-relevant REST and public-testnet
improvements on top of the current dev branch.

  • document live mainnet and public-testnet REST/JSON-RPC endpoints
  • add a verified transaction-prepare example and clarify that prepare does not
    sign or broadcast
  • update the embedded Swagger server for the Koinos Foundation public testnet
  • replace the retired testnet/faucet guidance in the legacy Developers pages
  • make offline-signing guidance retrieve the resettable testnet chain ID instead
    of copying a fixed value
  • add warnings that historical serialized transactions, nonces, signatures,
    and chain IDs must not be reused
  • update the Common Tasks REST and multisig connection guidance

The cross-chapter Developers/Common Tasks scope is intentional and explicitly
authorized for this #230 replacement. Current Getting Started, Contracts, and
Interacting pages were preserved because they already contain newer executable
examples and current testnet guidance.

Current-source validation

Checked against:

  • koinos/koinos-testnet README and faucet documentation
  • https://api.koinos.io/v1/chain/head_info
  • https://api.koinos.io/v1/transaction/prepare
  • https://api.koinos.io/jsonrpc
  • https://api.koinos.io/swagger
  • https://testnet.koinosfoundation.org/health
  • https://testnet.koinosfoundation.org/v1/chain/head_info
  • https://testnet.koinosfoundation.org/jsonrpc

Verification

  • npm run examples:verify
  • npm run examples:syntax
  • npm run docs:links
  • python3 -m json.tool docs/developers/swagger.json
  • docs-venv/bin/mkdocs build
  • git diff --check
  • browser review of Developers REST, Developers Testnet, Common Tasks REST,
    multisig, and offline-signing pages
  • browser click-through from offline signing to the dynamic chain-ID guidance

@netlify

netlify Bot commented Jul 23, 2026

Copy link
Copy Markdown

Deploy Preview for koinos-documentation ready!

Name Link
🔨 Latest commit 93da8e8
🔍 Latest deploy log https://app.netlify.com/projects/koinos-documentation/deploys/6a629550ffa2f300084e336a
😎 Deploy Preview https://deploy-preview-234--koinos-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@pgarciagon
pgarciagon merged commit 1ad7f58 into dev Jul 23, 2026
5 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.

2 participants