[cli] Add balance formatting for balance and gas commands #16477

stefan-mysten · 2024-03-01T06:29:07Z

Description

This PR improves the formatting of the coin objects for client gas and client balance.

Test Plan

Visual tests + existing tests.

🚀 sui % sui client gas 0x28409ff3622bbe6f08ac6199ac676864097378ca61cb084c8ccd60e2b187c2bd
[warn] Client/Server api version mismatch, client api version : 1.20.0, server api version : 1.19.1
╭────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Showing 11 gas coins and their balances.                                                                   │
├────────────────────────────────────────────────────────────────────┬────────────────────┬──────────────────┤
│ gasCoinId                                                          │ mistBalance (MIST) │ suiBalance (SUI) │
├────────────────────────────────────────────────────────────────────┼────────────────────┼──────────────────┤
│ 0x086c2acfcfe3486f7bdc2776c437e86c514bc57f0bcf45b56c02df5adf262661 │ 467370580          │ 0.46             │
│ 0x0932dd16f91af65277c9a70a984b0ca38650145851b803bd74afcd10a9c8faf4 │ 65053495712        │ 65.05            │
│ 0x1ca885902867d76eea3a658ca0f8ad8dd78677a3d49fe39a639704b6ebcf6402 │ 360226368          │ 0.36             │
│ 0x2d62f203fd1dc550d3aa441b777be9558616689f0d89dc5a77a8504e92411d7c │ 292949372          │ 0.29             │
│ 0x64ab87ecf605263352171f9cd6ef19bf63c771a8919f07cb585c23d4833995aa │ 420680104          │ 0.42             │
│ 0x85ffbe1439d1cc8a2f927410424ac050c61c518130670e9cf12211298938915d │ 443874748          │ 0.44             │
│ 0x956feeb8146c8be86b21adc6a32989a34e3aa33e2f2fe817e73739b8a7578102 │ 292698372          │ 0.29             │
│ 0x9a42ab27f66e887caeaee1a096baf1433ab59a690599f12c1eb83beb1c085407 │ 672390364          │ 0.67             │
│ 0x9af10229657774af1973a50773fbf5a6192dc2d6cd8c4af6778246fa45c9d0fc │ 474064540          │ 0.47             │
│ 0xb29207f2bcd6d737cfb13385e6545f3b676ced7fa8559b774d01d8c9335146fe │ 242133524          │ 0.24             │
│ 0xbfd24877ade8a38c1665ec0be579a6a2ce50cb06a987ed0cf994b5f65e3f8541 │ 290452196          │ 0.29             │
├────────────────────────────────────────────────────────────────────┴────────────────────┴──────────────────┤
│ Showing 11 gas coins and their balances.                                                                   │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

🚀 sui % sui client balance 0x28409ff3622bbe6f08ac6199ac676864097378ca61cb084c8ccd60e2b187c2bd --with-coins
[warn] Client/Server api version mismatch, client api version : 1.20.0, server api version : 1.19.1
╭──────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Balance of coins owned by this address                                                               │
├──────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ ╭─────────────────────────────────────────────────────────────────────────────────────────────────╮  │
│ │ Sui: 11 coins, Balance: 69005151084 (69.00 SUI)                                                 │  │
│ ├─────────────────────────────────────────────────────────────────────────────────────────────────┤  │
│ │ coinId                                                              balance (raw)  balance      │  │
│ ├─────────────────────────────────────────────────────────────────────────────────────────────────┤  │
│ │ 0x086c2acfcfe3486f7bdc2776c437e86c514bc57f0bcf45b56c02df5adf262661  484525540      0.48     SUI │  │
│ │ 0x0932dd16f91af65277c9a70a984b0ca38650145851b803bd74afcd10a9c8faf4  65036962456    65.03    SUI │  │
│ │ 0x1ca885902867d76eea3a658ca0f8ad8dd78677a3d49fe39a639704b6ebcf6402  368036368      0.36     SUI │  │
│ │ 0x2d62f203fd1dc550d3aa441b777be9558616689f0d89dc5a77a8504e92411d7c  292949372      0.29     SUI │  │
│ │ 0x64ab87ecf605263352171f9cd6ef19bf63c771a8919f07cb585c23d4833995aa  418646128      0.41     SUI │  │
│ │ 0x85ffbe1439d1cc8a2f927410424ac050c61c518130670e9cf12211298938915d  450418100      0.45     SUI │  │
│ │ 0x956feeb8146c8be86b21adc6a32989a34e3aa33e2f2fe817e73739b8a7578102  299864424      0.29     SUI │  │
│ │ 0x9a42ab27f66e887caeaee1a096baf1433ab59a690599f12c1eb83beb1c085407  670363684      0.67     SUI │  │
│ │ 0x9af10229657774af1973a50773fbf5a6192dc2d6cd8c4af6778246fa45c9d0fc  472029956      0.47     SUI │  │
│ │ 0xb29207f2bcd6d737cfb13385e6545f3b676ced7fa8559b774d01d8c9335146fe  220902860      0.22     SUI │  │
│ │ 0xbfd24877ade8a38c1665ec0be579a6a2ce50cb06a987ed0cf994b5f65e3f8541  290452196      0.29     SUI │  │
│ ╰─────────────────────────────────────────────────────────────────────────────────────────────────╯  │
│ ╭──────────────────────────────────────────────────────────────────────────────────────────────────╮ │
│ │ USD Coin: 1 coin, Balance: 11001500 (11.00 USDC)                                                 │ │
│ ├──────────────────────────────────────────────────────────────────────────────────────────────────┤ │
│ │ coinId                                                              balance (raw)  balance       │ │
│ ├──────────────────────────────────────────────────────────────────────────────────────────────────┤ │
│ │ 0x035f43b7a4a3859c7ebc0d59fa8bfbd83631a8941f2b80a17d50b095d48fc2e5  11001500       11.00    USDC │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ │
│ ╭──────────────────────────────────────────────────────────────────────────────────────────────────╮ │
│ │ Tether USD: 1 coin, Balance: 0 (0.00 USDT)                                                       │ │
│ ├──────────────────────────────────────────────────────────────────────────────────────────────────┤ │
│ │ coinId                                                              balance (raw)  balance       │ │
│ ├──────────────────────────────────────────────────────────────────────────────────────────────────┤ │
│ │ 0x46239adea94e1d530c1a735eb81c8a37f2312eb90a5faa590f4b3294bc1f6451  0              0.00     USDT │ │
│ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ │
│                                                                                                      │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────╯

🚀 sui % sui client balance 0x28409ff3622bbe6f08ac6199ac676864097378ca61cb084c8ccd60e2b187c2bd
[warn] Client/Server api version mismatch, client api version : 1.20.0, server api version : 1.19.1
╭──────────────────────────────────────────────╮
│ Balance of coins owned by this address       │
├──────────────────────────────────────────────┤
│ ╭──────────────────────────────────────────╮ │
│ │ coin        balance (raw)  balance       │ │
│ ├──────────────────────────────────────────┤ │
│ │ Sui         68981878692    68.98    SUI  │ │
│ │ USD Coin    11001500       11.00    USDC │ │
│ │ Tether USD  0              0.00     USDT │ │
│ ╰──────────────────────────────────────────╯ │
╰──────────────────────────────────────────────╯

If your changes are not user-facing and do not break anything, you can skip the following section. Otherwise, please briefly describe what has changed under the Release Notes section.

Type of Change (Check all that apply)

protocol change
user-visible impact
breaking change for a client SDKs
breaking change for FNs (FN binary must upgrade)
breaking change for validators or node operators (must upgrade binaries)
breaking change for on-chain data layout
necessitate either a data wipe or data migration

Release notes

Improved the way balance is displayed for sui client gas and sui client balance commands.

vercel · 2024-03-01T06:29:12Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
explorer	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 2, 2024 1:20am
sui-core	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 2, 2024 1:20am

amnn

All good with some nits!

amnn · 2024-03-13T14:19:49Z

crates/sui/src/client_commands.rs

@@ -1829,11 +1830,12 @@ impl Display for SuiClientCommandResult {
                }

                let mut builder = TableBuilder::default();
-                builder.set_header(vec!["gasCoinId", "gasBalance"]);
+                builder.set_header(vec!["gasCoinId", "mistBalance (MIST)", "suiBalance (SUI)"]);


This is not really related to this PR, but I don't understand why we use camelCase for table header names? as opposed to "Gas Coin ID", "MIST Balance", "SUI Balance".

The first time I started using json_to_table, I somehow decided that the table headings should match the json keys when using the --json flag. When passing a json object to json_to_table, the headings will be camelCase, so I kept it like that for other commands. We can of course change, not an issue.

Okay, I figured it was something like this, but then the addition of the " (MIST)" and " (SUI)" here kind of go counter to that. I think it would be fine to be more aesthetic in our choice of headings for the pretty tables FWIW!

I agree, I'll go once through all of them and fix it.

amnn · 2024-03-13T14:23:14Z

crates/sui/src/client_commands.rs

@@ -2392,43 +2396,130 @@ fn pretty_print_balance(
    builder: &mut TableBuilder,
    with_coins: bool,
 ) {
+    let format_decmials = 3;


3 is a bit of a maverick choice for a currency isn't it (as opposed to 2)? Is there some precedence for it?

Just the way I implemented it, 3 meant actually 2 :)) Don't ask :D

amnn · 2024-03-13T15:01:24Z

crates/sui/src/client_commands.rs

+    (integer_part, fractional_part)
+}
+
+fn format_balance(value: u128, coin_decimals: u8, format_decimals: usize) -> String {


I think this implementation can be simplified slightly:

fn format_balance(value: u128, coin_decimals: u8, format_decimals: usize, symbol: Option<&str>) -> String { let mut suffix = if let Some(symbol) { format!(" {symbol}") } else { "".to_string() }; let mut coin_decimals = coin_decimals as u32; let billions = 10u128.pow(coin_decimals + 9); let millions = 10u128.pow(coin_decimals + 6); let thousands = 10u128.pow(coin_decimals + 3); let (whole, fractional) = if value > billions { coin_decimals += 9; suffix = format!("B{suffix}"); divide(value, billions) } else if value > millions { coin_decimals += 6; suffix = format!("M{suffix}"); divide(value, millions) } else if value > thousands { coin_decimals += 3; suffix = format!("K{suffix}"); divide(value, thousands) }; let fractional = format!("{fractional:0width$}", width = coin_decimals as usize) .truncate(format_decimals); format!("{whole}.{fractional}{suffix}") }

Thanks. I don't fully follow the code, for example the coin_decimals += 9 / 6 / 3, they don't seem to do anything?

I figured it out! It was missing the first call to divide, before the whole if else branch.

Cannot figure it out how to make it work, in some cases it does not work properly (e.g., thousands). I'll use the other version and add it on my list to see if we can the code nicer.

The high level idea of this implementation is that it treats billions, millions, and thousands as their own "unit", with suffix "B SUI", "M SUI", "K SUI", etc. I think what I missed though was the base case (if the amount was smaller than a thousand).

The addition to coin_decimals is to deal with padding the fractional part with the right number of zeroes.

Here it is with what I think are the necessary fixes:

fn format_balance(value: u128, coin_decimals: u8, format_decimals: usize, symbol: Option<&str>) -> String { let mut suffix = if let Some(symbol) { format!(" {symbol}") } else { "".to_string() }; let mut coin_decimals = coin_decimals as u32; let billions = 10u128.pow(coin_decimals + 9); let millions = 10u128.pow(coin_decimals + 6); let thousands = 10u128.pow(coin_decimals + 3); let units = 10u128.pow(coin_decimals); let (whole, fractional) = if value > billions { coin_decimals += 9; suffix = format!("B{suffix}"); divide(value, billions) } else if value > millions { coin_decimals += 6; suffix = format!("M{suffix}"); divide(value, millions) } else if value > thousands { coin_decimals += 3; suffix = format!("K{suffix}"); divide(value, thousands) } else { divide(value, units) }; let fractional = format!("{fractional:0width$}", width = coin_decimals as usize) .truncate(format_decimals); format!("{whole}.{fractional}{suffix}") }

…#16477) ## Description This PR improves the formatting of the coin objects for `client gas` and `client balance`. ## Test Plan Visual tests + existing tests. ``` 🚀 sui % sui client gas 0x28409ff3622bbe6f08ac6199ac676864097378ca61cb084c8ccd60e2b187c2bd [warn] Client/Server api version mismatch, client api version : 1.20.0, server api version : 1.19.1 ╭────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │ Showing 11 gas coins and their balances. │ ├────────────────────────────────────────────────────────────────────┬────────────────────┬──────────────────┤ │ gasCoinId │ mistBalance (MIST) │ suiBalance (SUI) │ ├────────────────────────────────────────────────────────────────────┼────────────────────┼──────────────────┤ │ 0x086c2acfcfe3486f7bdc2776c437e86c514bc57f0bcf45b56c02df5adf262661 │ 467370580 │ 0.46 │ │ 0x0932dd16f91af65277c9a70a984b0ca38650145851b803bd74afcd10a9c8faf4 │ 65053495712 │ 65.05 │ │ 0x1ca885902867d76eea3a658ca0f8ad8dd78677a3d49fe39a639704b6ebcf6402 │ 360226368 │ 0.36 │ │ 0x2d62f203fd1dc550d3aa441b777be9558616689f0d89dc5a77a8504e92411d7c │ 292949372 │ 0.29 │ │ 0x64ab87ecf605263352171f9cd6ef19bf63c771a8919f07cb585c23d4833995aa │ 420680104 │ 0.42 │ │ 0x85ffbe1439d1cc8a2f927410424ac050c61c518130670e9cf12211298938915d │ 443874748 │ 0.44 │ │ 0x956feeb8146c8be86b21adc6a32989a34e3aa33e2f2fe817e73739b8a7578102 │ 292698372 │ 0.29 │ │ 0x9a42ab27f66e887caeaee1a096baf1433ab59a690599f12c1eb83beb1c085407 │ 672390364 │ 0.67 │ │ 0x9af10229657774af1973a50773fbf5a6192dc2d6cd8c4af6778246fa45c9d0fc │ 474064540 │ 0.47 │ │ 0xb29207f2bcd6d737cfb13385e6545f3b676ced7fa8559b774d01d8c9335146fe │ 242133524 │ 0.24 │ │ 0xbfd24877ade8a38c1665ec0be579a6a2ce50cb06a987ed0cf994b5f65e3f8541 │ 290452196 │ 0.29 │ ├────────────────────────────────────────────────────────────────────┴────────────────────┴──────────────────┤ │ Showing 11 gas coins and their balances. │ ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ 🚀 sui % sui client balance 0x28409ff3622bbe6f08ac6199ac676864097378ca61cb084c8ccd60e2b187c2bd --with-coins [warn] Client/Server api version mismatch, client api version : 1.20.0, server api version : 1.19.1 ╭──────────────────────────────────────────────────────────────────────────────────────────────────────╮ │ Balance of coins owned by this address │ ├──────────────────────────────────────────────────────────────────────────────────────────────────────┤ │ ╭─────────────────────────────────────────────────────────────────────────────────────────────────╮ │ │ │ Sui: 11 coins, Balance: 69005151084 (69.00 SUI) │ │ │ ├─────────────────────────────────────────────────────────────────────────────────────────────────┤ │ │ │ coinId balance (raw) balance │ │ │ ├─────────────────────────────────────────────────────────────────────────────────────────────────┤ │ │ │ 0x086c2acfcfe3486f7bdc2776c437e86c514bc57f0bcf45b56c02df5adf262661 484525540 0.48 SUI │ │ │ │ 0x0932dd16f91af65277c9a70a984b0ca38650145851b803bd74afcd10a9c8faf4 65036962456 65.03 SUI │ │ │ │ 0x1ca885902867d76eea3a658ca0f8ad8dd78677a3d49fe39a639704b6ebcf6402 368036368 0.36 SUI │ │ │ │ 0x2d62f203fd1dc550d3aa441b777be9558616689f0d89dc5a77a8504e92411d7c 292949372 0.29 SUI │ │ │ │ 0x64ab87ecf605263352171f9cd6ef19bf63c771a8919f07cb585c23d4833995aa 418646128 0.41 SUI │ │ │ │ 0x85ffbe1439d1cc8a2f927410424ac050c61c518130670e9cf12211298938915d 450418100 0.45 SUI │ │ │ │ 0x956feeb8146c8be86b21adc6a32989a34e3aa33e2f2fe817e73739b8a7578102 299864424 0.29 SUI │ │ │ │ 0x9a42ab27f66e887caeaee1a096baf1433ab59a690599f12c1eb83beb1c085407 670363684 0.67 SUI │ │ │ │ 0x9af10229657774af1973a50773fbf5a6192dc2d6cd8c4af6778246fa45c9d0fc 472029956 0.47 SUI │ │ │ │ 0xb29207f2bcd6d737cfb13385e6545f3b676ced7fa8559b774d01d8c9335146fe 220902860 0.22 SUI │ │ │ │ 0xbfd24877ade8a38c1665ec0be579a6a2ce50cb06a987ed0cf994b5f65e3f8541 290452196 0.29 SUI │ │ │ ╰─────────────────────────────────────────────────────────────────────────────────────────────────╯ │ │ ╭──────────────────────────────────────────────────────────────────────────────────────────────────╮ │ │ │ USD Coin: 1 coin, Balance: 11001500 (11.00 USDC) │ │ │ ├──────────────────────────────────────────────────────────────────────────────────────────────────┤ │ │ │ coinId balance (raw) balance │ │ │ ├──────────────────────────────────────────────────────────────────────────────────────────────────┤ │ │ │ 0x035f43b7a4a3859c7ebc0d59fa8bfbd83631a8941f2b80a17d50b095d48fc2e5 11001500 11.00 USDC │ │ │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ │ │ ╭──────────────────────────────────────────────────────────────────────────────────────────────────╮ │ │ │ Tether USD: 1 coin, Balance: 0 (0.00 USDT) │ │ │ ├──────────────────────────────────────────────────────────────────────────────────────────────────┤ │ │ │ coinId balance (raw) balance │ │ │ ├──────────────────────────────────────────────────────────────────────────────────────────────────┤ │ │ │ 0x46239adea94e1d530c1a735eb81c8a37f2312eb90a5faa590f4b3294bc1f6451 0 0.00 USDT │ │ │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────╯ │ │ │ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────╯ 🚀 sui % sui client balance 0x28409ff3622bbe6f08ac6199ac676864097378ca61cb084c8ccd60e2b187c2bd [warn] Client/Server api version mismatch, client api version : 1.20.0, server api version : 1.19.1 ╭──────────────────────────────────────────────╮ │ Balance of coins owned by this address │ ├──────────────────────────────────────────────┤ │ ╭──────────────────────────────────────────╮ │ │ │ coin balance (raw) balance │ │ │ ├──────────────────────────────────────────┤ │ │ │ Sui 68981878692 68.98 SUI │ │ │ │ USD Coin 11001500 11.00 USDC │ │ │ │ Tether USD 0 0.00 USDT │ │ │ ╰──────────────────────────────────────────╯ │ ╰──────────────────────────────────────────────╯ ``` --- If your changes are not user-facing and do not break anything, you can skip the following section. Otherwise, please briefly describe what has changed under the Release Notes section. ### Type of Change (Check all that apply) - [ ] protocol change - [x] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes Improved the way balance is displayed for `sui client gas` and `sui client balance` commands.

stefan-mysten requested a review from a team March 1, 2024 06:29

stefan-mysten self-assigned this Mar 1, 2024

vercel bot deployed to Preview – sui-core March 1, 2024 06:30 View deployment

vercel bot deployed to Preview – sui-core March 2, 2024 00:49 View deployment

Add formatting for coins

bd02d77

stefan-mysten force-pushed the fix_cli_balance_display branch from 15cf15d to bd02d77 Compare March 2, 2024 01:19

vercel bot deployed to Preview – explorer March 2, 2024 01:20 View deployment

vercel bot deployed to Preview – sui-core March 2, 2024 01:20 View deployment

amnn approved these changes Mar 13, 2024

View reviewed changes

stefan-mysten merged commit 1b7244a into MystenLabs:main Mar 14, 2024
41 checks passed

stefan-mysten deleted the fix_cli_balance_display branch March 14, 2024 22:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[cli] Add balance formatting for balance and gas commands #16477

[cli] Add balance formatting for balance and gas commands #16477

stefan-mysten commented Mar 1, 2024

vercel bot commented Mar 1, 2024 •

edited

amnn left a comment

amnn Mar 13, 2024

stefan-mysten Mar 14, 2024 •

edited

amnn Mar 15, 2024

stefan-mysten Mar 15, 2024

amnn Mar 13, 2024

stefan-mysten Mar 14, 2024

amnn Mar 13, 2024

stefan-mysten Mar 14, 2024

stefan-mysten Mar 14, 2024 •

edited

stefan-mysten Mar 14, 2024 •

edited

amnn Mar 15, 2024

amnn Mar 15, 2024

[cli] Add balance formatting for balance and gas commands #16477

[cli] Add balance formatting for balance and gas commands #16477

Conversation

stefan-mysten commented Mar 1, 2024

Description

Test Plan

Type of Change (Check all that apply)

Release notes

vercel bot commented Mar 1, 2024 • edited

amnn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stefan-mysten Mar 14, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stefan-mysten Mar 14, 2024 • edited

Choose a reason for hiding this comment

stefan-mysten Mar 14, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Mar 1, 2024 •

edited

stefan-mysten Mar 14, 2024 •

edited

stefan-mysten Mar 14, 2024 •

edited

stefan-mysten Mar 14, 2024 •

edited