Skip to content

Improve ChannelKeys TODOs #567

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

Closed
TheBlueMatt opened this issue Mar 31, 2020 · 5 comments
Closed

Improve ChannelKeys TODOs #567

TheBlueMatt opened this issue Mar 31, 2020 · 5 comments
Milestone

Comments

@TheBlueMatt
Copy link
Collaborator

We currently have TODOs in public documentation, which isn't OK, but also we should replace the with real documentation before the next release.

@TheBlueMatt TheBlueMatt added this to the 0.0.11 milestone Mar 31, 2020
@TheBlueMatt
Copy link
Collaborator Author

Also, we should probably fix up the APIs to be sensible post-559 pre-0.0.11.

@ariard
Copy link

ariard commented Apr 9, 2020

We should make signing function as pure function do avoid any side-effect and return a Result<Signature,Error> to propagate back error to caller.

See #559 (comment) and #562 (comment)

@TheBlueMatt
Copy link
Collaborator Author

The ChannelKeys stuff should never be pure functions - many cases of channel keys require internal state to enforce that we dont eg sign two different local commitment transactions. They should, of course, return Result<>s, though maybe I misunderstood your point.

@valentinewallace
Copy link
Contributor

Should this have been closed by #598?

@TheBlueMatt
Copy link
Collaborator Author

Yep!

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

3 participants