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

Clean up re-exports + pre-release tracking #53

Closed
2 of 3 tasks
ValuedMammal opened this issue Sep 23, 2024 · 6 comments
Closed
2 of 3 tasks

Clean up re-exports + pre-release tracking #53

ValuedMammal opened this issue Sep 23, 2024 · 6 comments

Comments

@ValuedMammal
Copy link
Collaborator

ValuedMammal commented Sep 23, 2024

When discussing plans to publish a release I found a few TODO items

  • Decide which types to re-export
  • We placed the builder module behind a "wallet" feature, so I think also add required-features = ["wallet"] for the wallet example in Cargo.toml
  • Depend on a proper version of kyoto-cbf
@rustaceanrob
Copy link
Collaborator

we need the kyoto re-exports so a Client can be built without the builder module but all of the rust-bitcoin re-exports are probably not necessary

@rustaceanrob
Copy link
Collaborator

let's hold off on release until we chat with Steve oct 3

@rustaceanrob
Copy link
Collaborator

after doing a little reading, i might push back a bit on the first bullet. although it is not necessarily encouraged, since kyoto is very tightly coupled with rust-bitcoin types, it makes sense to re-export them imo. in an effort to never force the user to add kyoto, i think it makes sense to give them the types they will come across, even if re-exports from rust-bitcoin

@ValuedMammal
Copy link
Collaborator Author

Yeah I would agree with that as long as we can justify it as a deliberate choice on behalf of the user

@rustaceanrob
Copy link
Collaborator

would you consider that a doc-level thing? or in the readme?

@ValuedMammal
Copy link
Collaborator Author

I don't think you need to explain it anywhere, just that the effect is what you say, i.e. the user doesn't need to pull in extra deps.

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

No branches or pull requests

2 participants