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.

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

feat: 📝 implement cometstub crate (work-in-progress) #3592

Closed
wants to merge 1 commit into from

Conversation

cratelyn
Copy link
Contributor

@cratelyn cratelyn commented Jan 8, 2024

see:

/!\ ------------------------------------------------------- /!\
/!\ NOTE: this is a rolling work-in-progress.               /!\
/!\ this branch will be force-pushed frequently until it is /!\
/!\ ready for review. proceed accordingly!                  /!\
/!\ ------------------------------------------------------- /!\

this commit introduces a new library, in `crates/test/`. this library
contains a mock implementation of cometbft, for use in cargo integration
tests.

* this does NOT add the `penumbra-mock-cometbft` crate to the list of
  crates included in the rust documentation in
  `deployments/scripts/rust-docs`. the `penumbra-tct-property-test`
  crate was also not included in that list at the time of writing.

/!\ ------------------------------------------------------- /!\
/!\ NOTE: this is a rolling work-in-progress.               /!\
/!\ this branch will be force-pushed frequently until it is /!\
/!\ ready for review. proceed accordingly!                  /!\
/!\ ------------------------------------------------------- /!\
@cratelyn cratelyn self-assigned this Jan 8, 2024
@hdevalence
Copy link
Member

hdevalence commented Jan 9, 2024

Two high-level comments:

  1. we should avoid using the word "mock" to prevent confusion with cometmock, which is a different piece of software
  2. we should have a separate crate, maybe "cometstub"/"tenderstub", that just has the functionality of producing headers (and possibly abci functionality, but no penumbra-specific code) so that this component can be more easily reused in other parts of the ecosystem (eg https://x.com/hdevalence/status/1736860951000031672 )

@cratelyn cratelyn changed the title feat: 📝 implement mock-cometbft crate (work-in-progress) feat: 📝 implement cometstub crate (work-in-progress) Jan 9, 2024
@cratelyn
Copy link
Contributor Author

cratelyn commented Jan 9, 2024

Two high-level comments:

1. we should avoid using the word "mock" to prevent confusion with cometmock, which is a different piece of software

@hdevalence that sounds good to me. before we accrue further review context here, and because github doesn't provide a way to switch the branch associated with a pull request, i am going to close this in favor of #3597 (katie/cometstub).

2. we should have a separate crate, maybe "cometstub"/"tenderstub", that _just_ has the functionality of producing headers (and possibly abci functionality, but no penumbra-specific code) so that this component can be more easily reused in other parts of the ecosystem (eg https://x.com/hdevalence/status/1736860951000031672 )

this also sounds like a great idea to me. if it is alright with you, i will wait until i am a little further along to split things into two crates, hopefully at which point i will have a clearer picture of how these pieces fit together.

that said, a separate library for generating headers sounds like a wise division of responsibilities.

i am happy to continue this conversation forward over in #3597!

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