docs: clarify broadcast-transaction is relay-only and link Query API - #55
Merged
Conversation
Expand the Broadcast Transaction OpenAPI docs to state that a successful response only means the transaction was relayed to peers_broadcasted node peers, not that it was added to a tick or executed. Document the common reasons a broadcast transaction is never included (insufficient balance, tick congestion, no quorum, target tick too close, never reached a computor) and how to confirm inclusion/effect via the Qubic Query API, linking the getLastProcessedTick and getTransactionByHash docs instead of inlining method/parameter details. Regenerate qubic.openapi.yaml (also picks up the previously unsynced /health endpoint).
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.
What
Expands the Broadcast Transaction OpenAPI docs to make clear that a successful response only means the transaction was relayed to peers — not that it was added to a tick or executed.
Specifically:
200does not mean the transaction was added to the blockchain; it only confirms relay topeers_broadcastednode peers.