Skip to content
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

Jump to bottom

spec: ABCI spec refers to both Evidence and Misbehavior types #1326

Closed
Tracked by #24
cason opened this issue Sep 11, 2023 · 4 comments · Fixed by #2789
Closed
Tracked by #24

spec: ABCI spec refers to both Evidence and Misbehavior types #1326

cason opened this issue Sep 11, 2023 · 4 comments · Fixed by #2789
Assignees
@andynog
Labels
abci Application blockchain interface spec Specification-related
Milestone
2024-Q2

Comments

@cason
Copy link
Contributor

cason commented Sep 11, 2023

References to Evidence type, which is used inside CometBFT but not offered to the ABCI application:

References to Misbehavior type, which is the actual type offered to the ABCI application:

The introduction of this new type has also to be mentioned in the https://docs.cometbft.com/v0.37/spec/abci/abci++_methods#data-types-introduced-or-modified-in-abci, as it was updated in ABCI++, with respect with ABCI.
@cason cason added documentation Improvements or additions to documentation abci Application blockchain interface spec Specification-related labels Sep 11, 2023
@cason cason self-assigned this Sep 11, 2023
@cason cason changed the title docs: ABCI spec refers to both Evidence and Misbehavior types docs: ABCI++ spec refers to both Evidence and Misbehavior types Sep 11, 2023
@cason cason removed their assignment Apr 10, 2024
@cason
Copy link
Contributor Author

cason commented Apr 10, 2024

Could be part of #24.

@sergio-mena
Copy link
Contributor

mentions it has been used in ABCI, probably not true

Actually, it was renamed for v0.37.x, IIRC

@sergio-mena
Copy link
Contributor

On main, currently, the only remaining reference to Evidence is in "Basic Concepts": https://github.com/cometbft/cometbft/blob/53e6127943/spec/abci/abci%2B%2B_basic_concepts.md?plain=1#L366

@cason cason mentioned this issue Apr 10, 2024
Closed
11 tasks
@cason cason changed the title docs: ABCI++ spec refers to both Evidence and Misbehavior types spec: ABCI spec refers to both Evidence and Misbehavior types Apr 10, 2024
@cason cason removed the documentation Improvements or additions to documentation label Apr 10, 2024
@andynog
Copy link
Contributor

andynog commented Apr 10, 2024

mentions it has been used in ABCI, probably not true

Actually, it was renamed for v0.37.x, IIRC

yes, according to the CHANGELOG https://github.com/cometbft/cometbft/blob/main/CHANGELOG.md#v0370

andynog added a commit that referenced this issue Apr 11, 2024
@andynog
changing evidencetype to misbehavior type in ABCI basic concepts (#1326)
0715ac8
andynog added a commit that referenced this issue Apr 11, 2024
@andynog
more changes of evidence to misbehavior across spec (#1326)
35c5186
andynog added a commit that referenced this issue Apr 11, 2024
@andynog
more changes in spec and comment in types (#1326)
40db83d
@andynog andynog mentioned this issue Apr 11, 2024
Merged
4 tasks
@adizere adizere added this to the 2024-Q2 milestone Apr 15, 2024
andynog added a commit that referenced this issue Apr 15, 2024
@andynog
fixes based on PR comments and suggestions (#1326)
4ce8d9c
github-merge-queue bot pushed a commit that referenced this issue Apr 15, 2024
@andynog @melekes @cason
spec: fix the references for misbehavior (#2789)
e7213e9 
close: #1326

- This fixes the wrong reference about misbehavior
- This also changes a couple of comments in Evidence types (OK to revert
this change if it's out of scope)

---

#### PR checklist

- [ ] Tests written/updated
- [ ] Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)
- [X] Updated relevant documentation (`docs/` or `spec/`) and code
comments
- [ ] Title follows the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec

---------

Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>
Co-authored-by: Daniel <daniel.cason@informal.systems>
mergify bot pushed a commit that referenced this issue Apr 15, 2024
@andynog @mergify
spec: fix the references for misbehavior (#2789)
7ff3abd 
close: #1326

- This fixes the wrong reference about misbehavior
- This also changes a couple of comments in Evidence types (OK to revert
this change if it's out of scope)

---

#### PR checklist

- [ ] Tests written/updated
- [ ] Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)
- [X] Updated relevant documentation (`docs/` or `spec/`) and code
comments
- [ ] Title follows the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec

---------

Co-authored-by: Anton Kaliaev <anton.kalyaev@gmail.com>
Co-authored-by: Daniel <daniel.cason@informal.systems>
(cherry picked from commit e7213e9)
@mergify mergify bot mentioned this issue Apr 15, 2024
Merged
4 tasks
melekes pushed a commit that referenced this issue Apr 16, 2024
@mergify @andynog
spec: fix the references for misbehavior (backport #2789) (#2819)
9415dac 
close: #1326

- This fixes the wrong reference about misbehavior
- This also changes a couple of comments in Evidence types (OK to revert
this change if it's out of scope)

---

#### PR checklist

- [ ] Tests written/updated
- [ ] Changelog entry added in `.changelog` (we use
[unclog](https://github.com/informalsystems/unclog) to manage our
changelog)
- [X] Updated relevant documentation (`docs/` or `spec/`) and code
comments
- [ ] Title follows the [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec
<hr>This is an automatic backport of pull request #2789 done by
[Mergify](https://mergify.com).

Co-authored-by: Andy Nogueira <me@andynogueira.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andynog andynog

Labels
abci Application blockchain interface spec Specification-related
Projects
CometBFT
Status: Done
Milestone
2024-Q2
Development

Successfully merging a pull request may close this issue.

spec: fix the references for misbehavior cometbft/cometbft
4 participants
@cason @adizere @sergio-mena @andynog