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

Enhance code readability with detailed comments for find_output.rs #100

Merged
merged 2 commits into from
Dec 9, 2024

Conversation

Gudnessuche
Copy link
Contributor

This adds helpful comments throughout the Rust code, making it easier to understand and maintain. The comments explain the purpose of each function, variable, and constant, as well as provide context for key operations in the code.

This adds helpful comments throughout the Rust code, making it easier to understand and maintain. The comments explain the purpose of each function, variable, and constant, as well as provide context for key operations in the code.
@Gudnessuche
Copy link
Contributor Author

After re-reading the entire thing, noticed that the Receiver object might need to maintain the "silentpayments::utils::Network::Testnet", as opposed to just "Network::Testnet"

No?

@cygnet3
Copy link
Owner

cygnet3 commented Dec 7, 2024

Yep it needs to be a Network type of the crate itself. The silentpayment Network type refers to the network of the address in question (so starting with sp1, tsp1orsprt1. But these do not map 1:1 with the bitcoin::Network. For example, tsp1` is used for both Testnet and Signet.

If you fix that, I'll merge this too!

Corrected network to be "silentpayments::utils::Network::Testnet" so it maps 1:1
@Gudnessuche
Copy link
Contributor Author

Fixed it.
Quick question tho before you merge. I came across this amazing repo of yours when trying to work on bringing SP to BDK. Have you intended working on that, or working on it currently. Cos what you've done with this, is beyond a Proof of Concept in my humble opinion.

@cygnet3
Copy link
Owner

cygnet3 commented Dec 8, 2024

That's a good question, we are currently not working on a BDK integration but that is not out of the question. With the current work being done to add a BIP352 module to libsecp, the future of this library is a little uncertain.

It is likely that this library will either become more of a high-level silent payments library (basically BDK but for silent payments specifically), or we'll put more effort into merging this library with other existing libraries (e.g. BDK, rust-bitcoin).

@Gudnessuche
Copy link
Contributor Author

Awesome, did you get to merge this?

@cygnet3 cygnet3 merged commit e30a89c into cygnet3:master Dec 9, 2024
2 checks passed
@cygnet3
Copy link
Owner

cygnet3 commented Dec 9, 2024

merged it!

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