feat: update payment_id display #6597
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
The main current use case for `PaymentId::to_string()`, besides logging, is passing the payment ID to the notification script. The current implentation makes it awkward to deal with: * spaces in the formatting (bad for command line arguments) * The payment id type is not self describing. * emojis are awkward to deal with on some terminals and OSs * A slash may have to be escaped on some OSs (for empty => N/A) This update addresses these issues, while still maintaining clear readibility in logs: * Change `N/A` to None and eliminate any edge cases that may creep in when dealing with a slash * Other formats are `<type>(<data>,...)` e.g. `u64(1235678)` or `address_and_data(f3S7XTiyKQauZpDUjdR8NbcQ33MYJigiWiS44ccZCxwAAjk,48656c6c6f20576f726c64)` * No spaces A single test for displaying each `PaymentId` type is also included.
Test Results (CI) 3 files 129 suites 36m 17s ⏱️ Results for commit f5a5de6. ♻️ This comment has been updated with latest results. |
ghpbot-tari-project
added
P-acks_required
SWvheerden
approved these changes
Oct 2, 2024
Test Results (Integration tests) 2 files 11 suites 15m 40s ⏱️ For more details on these failures, see this check. Results for commit f5a5de6. ♻️ This comment has been updated with latest results. |
ghpbot-tari-project
removed
the
P-reviews_required
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Update
PaymentIdDisplayimplementationMotivation and Context
The main current use case for
PaymentId::to_string(), besides logging, is passing the payment ID to the notification script.The current implentation makes it awkward to deal with:
This update addresses these issues, while still maintaining clear readibility in logs:
N/Ato None and eliminate any edge cases that may creep in when dealing with a slash<type>(<data>,...)e.g.u64(1235678)oraddress_and_data(f3S7XTiyKQauZpDUjdR8NbcQ33MYJigiWiS44ccZCxwAAjk,48656c6c6f20576f726c64)How Has This Been Tested?
A single test for displaying each
PaymentIdtype is also included.Breaking Changes