Skip to content

docs(cometbft): update ABCI links #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
melekes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(cometbft): update ABCI links #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-applysnapshotchunk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ because no suitable peers are available), it will reject the snapshot and try
a different one via `OfferSnapshot`. The application should be prepared to
reset and accept it or abort as appropriate.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#applysnapshotchunk)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#applysnapshotchunk)
4 changes: 3 additions & 1 deletion cometbft/src/abci/doc/request-beginblock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ Signals the beginning of a new block.
Called prior to any [`DeliverTx`]s. The `header` contains the height,
timestamp, and more -- it exactly matches the CometBFT block header.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#beginblock)
**This is only called by CometBFT prior to version v0.38.0.**

[ABCI documentation](https://docs.cometbft.com/v0.37/spec/abci/abci++_methods#beginblock)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-checktx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ transaction in full, but can instead perform lightweight or statateful
validation (e.g., checking signatures or account balances) instead of more
expensive checks (like running code in a virtual machine).

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#checktx)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#checktx)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-commit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Signals the application that it can write the queued state transitions
from the block to its state.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#commit)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#commit)
4 changes: 3 additions & 1 deletion cometbft/src/abci/doc/request-delivertx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Execute a transaction against the application state.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#delivertx)
**This is only called by CometBFT prior to version v0.38.0.**

[ABCI documentation](https://docs.cometbft.com/v0.37/spec/abci/abci++_methods#delivertx)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-echo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Echoes a string to test an ABCI implementation.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#echo)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#echo)
4 changes: 3 additions & 1 deletion cometbft/src/abci/doc/request-endblock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@ Signals the end of a block.

Called after all transactions, and prior to each `Commit`.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#endblock)
**This is only called by CometBFT prior to version v0.38.0.**

[ABCI documentation](https://docs.cometbft.com/v0.37/spec/abci/abci++_methods#endblock)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-extendvote.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.38.x/spec/abci/abci++_methods.md#extendvote)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#extendvote)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-finalizeblock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.38.x/spec/abci/abci++_methods.md#finalizeblock)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#finalizeblock)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-flush.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Indicates that any pending requests should be completed and their responses flushed.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#flush)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#flush)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Requests information about the application state.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#info)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#info)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-initchain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Called on genesis to initialize chain state.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#initchain)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#initchain)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-listsnapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Asks the application for a list of snapshots.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#listsnapshots)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#listsnapshots)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-loadsnapshotchunk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Used during state sync to retrieve snapshot chunks from peers.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#loadsnapshotchunk)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#loadsnapshotchunk)
4 changes: 2 additions & 2 deletions cometbft/src/abci/doc/request-offersnapshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ at the end of snapshot restoration.

See also the `Snapshot` data type and the [ABCI state sync documentation][ssd].

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#offersnapshot)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#offersnapshot)

[ssd]: https://docs.cometbft.com/v1/spec/abci/apps.html#state-sync
[ssd]: https://docs.cometbft.com/v1.0/explanation/core/state-sync
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-prepareproposal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#prepareproposal)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#prepareproposal)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-processproposal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#processproposal)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#processproposal)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Queries for data from the application at current or past height.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#query)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#query)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/request-verifyvoteextension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.38.x/spec/abci/abci++_methods.md#verifyvoteextension)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#verifyvoteextension)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-applysnapshotchunk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ The application can choose to refetch chunks and/or ban P2P peers as
appropriate. CometBFT will not do this unless instructed by the
application.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#applysnapshotchunk)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#applysnapshotchunk)
4 changes: 3 additions & 1 deletion cometbft/src/abci/doc/response-beginblock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Returns events that occurred when beginning a new block.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#beginblock)
**This is only called by CometBFT prior to version v0.38.0.**

[ABCI documentation](https://docs.cometbft.com/v0.37/spec/abci/abci++_methods#beginblock)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-checktx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Returns the result of checking a transaction for mempool inclusion.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#checktx)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#checktx)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-commit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Returns the result of persisting the application state.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#commit)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#commit)
4 changes: 3 additions & 1 deletion cometbft/src/abci/doc/response-delivertx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Returns events that occurred while executing a transaction against the
application state.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#delivertx)
**This is only called by CometBFT prior to version v0.38.0.**

[ABCI documentation](https://docs.cometbft.com/v0.37/spec/abci/abci++_methods#delivertx)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-echo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Echoes a string to test an ABCI implementation.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#echo)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#echo)
4 changes: 3 additions & 1 deletion cometbft/src/abci/doc/response-endblock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Returns validator updates that occur after the end of a block.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#endblock)
**This is only called by CometBFT prior to version v0.38.0.**

[ABCI documentation](https://docs.cometbft.com/v0.37/spec/abci/abci++_methods#endblock)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-extendvote.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.38.x/spec/abci/abci++_methods.md#extendvote)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#extendvote)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-finalizeblock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.38.x/spec/abci/abci++_methods.md#finalizeblock)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#finalizeblock)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-flush.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Indicates that all pending requests have been completed with their responses flushed.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#flush)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#flush)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Returns information about the application state.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#info)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#info)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-initchain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Returned on genesis after initializing chain state.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#initchain)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#initchain)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-listsnapshots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Returns a list of local state snapshots.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#listsnapshots)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#listsnapshots)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-loadsnapshotchunk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Returns a snapshot chunk from the application.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#loadsnapshotchunk)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#loadsnapshotchunk)
4 changes: 2 additions & 2 deletions cometbft/src/abci/doc/response-offersnapshot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ Returns the application's response to a snapshot offer.

See also the [`OfferSnapshot`] data type and the [ABCI state sync documentation][ssd].

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#offersnapshot)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#offersnapshot)

[ssd]: https://docs.cometbft.com/v1/spec/abci/apps.html#state-sync
[ssd]: https://docs.cometbft.com/v1.0/explanation/core/state-sync
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-prepareproposal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#prepareproposal)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#prepareproposal)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-processproposal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.37.x/spec/abci/abci++_methods.md#processproposal)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#processproposal)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-query.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Returns data queried from the application.

[ABCI documentation](https://docs.cometbft.com/v1/spec/abci/abci.html#query)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#query)
2 changes: 1 addition & 1 deletion cometbft/src/abci/doc/response-verifyvoteextension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[ABCI documentation](https://github.com/cometbft/cometbft/blob/v0.38.x/spec/abci/abci++_methods.md#verifyvoteextension)
[ABCI documentation](https://docs.cometbft.com/v1.0/spec/abci/abci++_methods#verifyvoteextension)
Loading