docs(ADR-114): Partly Undo ADR 109 (Reduce Go API Surface) #2897
Conversation
|
Not 100% ADRs need to be backported. Since we're publishing ADRs in https://docs.cometbft.com/v1.0/references/architecture/ I'll go ahead and backport this. |
|
Copying @tac0turtle if you get a chance to peek at this before our chat next Wednesday, that would be great! If not, we'll cover this in our chat, no pb. |
Closes #2896 --- #### PR checklist - [ ] Tests written/updated - [ ] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [ ] Updated relevant documentation (`docs/` or `spec/`) and code comments - [ ] Title follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec (cherry picked from commit 17caea0)
| To summarize, these modules will remain public in v1 and marked as deprecated: | ||
| - `evidence` | ||
| - `consensus` | ||
| - `indexer` |
There was a problem hiding this comment.
why is indexer deprecated? the interface in the package should continue being public otherwise why have an interface? I think the implementations should be private but you should allow people to implement custom indexers, unless this system is being replaced?
There was a problem hiding this comment.
Last year, we decided that, moving forward (starting from v1.x), the data companion (ADR 101) will progressively replace the indexer interface. ADR 101 is a better solution for implementing your own indexer.
…2897) (#2991) Closes #2896 --- #### PR checklist - [ ] Tests written/updated - [ ] Changelog entry added in `.changelog` (we use [unclog](https://github.com/informalsystems/unclog) to manage our changelog) - [ ] 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 #2897 done by [Mergify](https://mergify.com). Co-authored-by: Adi Seredinschi <adizere@gmail.com>
Closes #2896
PR checklist
.changelog(we use unclog to manage our changelog)docs/orspec/) and code comments