This repository has been archived by the owner on Apr 23, 2024. It is now read-only.
sdk/state, sdk/agent: add memos to payments #348
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
acharb
approved these changes
Sep 30, 2021
| return a.PaymentWithMemo(paymentAmount, "") | ||
| } | ||
|
|
||
| // Payment makes a payment of the payment amount to the remote participant using |
There was a problem hiding this comment.
💡 can we remove the dup method comment from Payment() above? Since we're re-explaining what the method does here. The Payment comment above could be something like:
// Payment creates a payment using the PaymentWithmemo method with an empty memo.
func (a *Agent) Payment(paymentAmount int64) error {
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Add a memo field to close agreements that is optional. The memo is a string with unspecified bounds. The memo is not included in the final transaction so its contents does not leak to the public ledger when the channel is closed. Subsequently the signatures for close agreements to do not cover the memo.
Why
Payments should have memos so they can be identifiable on the terms of the participants. Participants may communicate about a payment ahead of sending a payment and the memo will provide a way to annotate or identify the payment in whatever way they require.
Note that this is similar but different to #339. #339 is concerned with uniquely identifying payments with an identifier that the state machine attaches to close agreements. That would not be useful in the situation described above where an identifier must be assigned prior to the payment being made.
This is useful for things like buffered channels, something I'm experimenting with right now for #340.
Close #347