From 54eb6d79d4fd9f22098bbed1c48751ee4a4621a0 Mon Sep 17 00:00:00 2001
From: Cayle Sharrock <CjS77@users.noreply.github.com>
Date: Thu, 3 Oct 2024 07:27:22 +0100
Subject: [PATCH] feat: update payment_id display (#6597)

Description
---

Update `PaymentId` `Display` implementation

Motivation 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:
* 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

How Has This Been Tested?
---
A single test for displaying each `PaymentId` type is also included.

<!-- Checklist -->
<!-- 1. Is the title of your PR in the form that would make nice release
notes? The title, excluding the conventional commit
tag, will be included exactly as is in the CHANGELOG, so please think
about it carefully. -->


Breaking Changes
---

- [x] None
- [ ] Requires data directory on base node to be deleted
- [ ] Requires hard fork
- [ ] Other - Please specify

<!-- Does this include a breaking change? If so, include this line as a
footer -->
<!-- BREAKING CHANGE: Description what the user should do, e.g. delete a
database, resync the chain -->
---
 .../transaction_components/encrypted_data.rs  | 42 ++++++++++++++++---
 1 file changed, 36 insertions(+), 6 deletions(-)

diff --git a/base_layer/core/src/transactions/transaction_components/encrypted_data.rs b/base_layer/core/src/transactions/transaction_components/encrypted_data.rs
index 4630da74c8..070d2c45aa 100644
--- a/base_layer/core/src/transactions/transaction_components/encrypted_data.rs
+++ b/base_layer/core/src/transactions/transaction_components/encrypted_data.rs
@@ -183,12 +183,12 @@ impl PaymentId {
 impl Display for PaymentId {
     fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
         match self {
-            PaymentId::Empty => write!(f, "N/A"),
-            PaymentId::U64(v) => write!(f, "{}", v),
-            PaymentId::U256(v) => write!(f, "{}", v),
-            PaymentId::Address(v) => write!(f, "{}", v.to_emoji_string()),
-            PaymentId::Open(v) => write!(f, "byte vector: {}", v.to_hex()),
-            PaymentId::AddressAndData(v, d) => write!(f, "From {} with data: {:?}", v.to_emoji_string(), d),
+            PaymentId::Empty => write!(f, "None"),
+            PaymentId::U64(v) => write!(f, "u64({v})"),
+            PaymentId::U256(v) => write!(f, "u256({v})"),
+            PaymentId::Address(v) => write!(f, "address({})", v.to_base58()),
+            PaymentId::Open(v) => write!(f, "data({})", v.to_hex()),
+            PaymentId::AddressAndData(v, d) => write!(f, "address_and_data({},{})", v.to_base58(), d.to_hex()),
         }
     }
 }
@@ -523,4 +523,34 @@ mod test {
             }
         }
     }
+
+    #[test]
+    fn payment_id_display() {
+        assert_eq!(PaymentId::Empty.to_string(), "None");
+        assert_eq!(PaymentId::U64(1235678).to_string(), "u64(1235678)");
+        assert_eq!(
+            PaymentId::U256(
+                U256::from_dec_str("465465489789785458694894263185648978947864164681631").expect("Should not fail")
+            )
+            .to_string(),
+            "u256(465465489789785458694894263185648978947864164681631)"
+        );
+        assert_eq!(
+            PaymentId::Address(TariAddress::from_base58("f3S7XTiyKQauZpDUjdR8NbcQ33MYJigiWiS44ccZCxwAAjk").unwrap())
+                .to_string(),
+            "address(f3S7XTiyKQauZpDUjdR8NbcQ33MYJigiWiS44ccZCxwAAjk)"
+        );
+        assert_eq!(
+            PaymentId::Open(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]).to_string(),
+            "data(0102030405060708090a)"
+        );
+        assert_eq!(
+            PaymentId::AddressAndData(
+                TariAddress::from_base58("f3S7XTiyKQauZpDUjdR8NbcQ33MYJigiWiS44ccZCxwAAjk").unwrap(),
+                vec![0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x57, 0x6f, 0x72, 0x6c, 0x64]
+            )
+            .to_string(),
+            "address_and_data(f3S7XTiyKQauZpDUjdR8NbcQ33MYJigiWiS44ccZCxwAAjk,48656c6c6f20576f726c64)"
+        );
+    }
 }