multi: Add wallet balance tooltip and all known wallet balances to translation map #2357

ukane-philemon · 2023-05-16T17:20:38Z

UI changes:

Edit: IMO, reducing the tooltip width and adding border-radius makes the tooltip look slick.

chappjc · 2023-05-16T18:32:36Z

I wonder if everything with a tooltip really needs the "i" symbol, or we can just give the text a tooltip that appears on mouse hover?

ukane-philemon · 2023-05-16T20:26:08Z

I wonder if everything with a tooltip really needs the "i" symbol

I'd say yes. The i symbol help users notice there is a hidden info easily. I've notice in other applications, the tooltip is displayed on the i icon itself and not on surrounding text so I did that in this PR (this is debatable since it's a matter of making it easy to hover on a small icon vs not pushing it in their face).

client/webserver/site/src/js/locales.ts

client/asset/interface.go

client/webserver/site/src/html/bodybuilder.tmpl

chappjc

Looks pretty good to me. Two small nits though.
Will wait for another review to merge though.

client/webserver/site/src/js/wallets.ts

client/webserver/site/src/js/locales.ts

client/asset/interface.go

- Added `asset.CustomBalance` struct type for custom balances. Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

client/asset/interface.go

client/asset/zec/shielded_test.go

client/webserver/site/src/css/main.scss

client/webserver/site/src/js/locales.ts

client/webserver/site/src/html/wallets.tmpl

client/webserver/site/src/js/wallets.ts

buck54321 · 2023-06-01T13:47:05Z

client/webserver/site/src/js/wallets.ts

+    if (bal.contractlocked > 0) addSubBalance(lockedBal(intl.prep(intl.ID_SWAPPING)), bal.contractlocked, intl.prep(intl.ID_LOCKED_SWAPPING_BAL_MSG))
+    if (bal.bondlocked > 0) addSubBalance(lockedBal(intl.prep(intl.ID_BONDED)), bal.bondlocked, intl.prep(intl.ID_LOCKED_BOND_BAL_MSG))
+    for (const [cat, bal] of sortedBalCats) {


We need to display orderLocked as well. Not sure why we weren't already doing that.

I also think we should reorganize the display so that the locked sub-balances show as subcategories of the locked total, e.g. roughly

But this can be done in a followup.

I also think we should reorganize the display so that the locked sub-balances show as subcategories of the locked total, e.g. roughly

Okay.

We need to display orderLocked as well. Not sure why we weren't already doing that.

Updated in f0b59d0

I also think we should reorganize the display so that the locked sub-balances show as subcategories of the locked total, e.g. roughly

@buck54321, From the comment for these balance fields, It seems they are not included in asset.Balance.Locked and might be misleading to include them as a subcategory of the locked total, or I'm I missing something?

dcrdex/client/core/types.go

Lines 111 to 118 in 4a2ba0f

OrderLocked uint64 `json:"orderlocked"`

// ContractLocked is the total amount of funds locked in unspent (i.e.

// unredeemed / unrefunded) swap contracts. This amount is NOT included in

// the db.Balance.

ContractLocked uint64 `json:"contractlocked"`

// BondLocked is the total amount of funds locked in unspent fidelity bonds.

// This amount is NOT included in the db.Balance.

BondLocked uint64 `json:"bondlocked"`

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

buck54321

Looks and tests well. Just some suggestions for tooltip language.

buck54321 · 2023-06-05T22:23:48Z

client/mm/price_oracle_test.go

@@ -53,7 +53,7 @@ func TestFetchBinanceSpread(t *testing.T) {

 func TestFetchCoinbaseSpread(t *testing.T) {
 	testSpreader(t, fetchCoinbaseSpread, "btc", "usd")
-}x


buck54321 · 2023-06-05T22:30:38Z

client/webserver/site/src/js/locales.ts

+  [ID_IMMATURE_TITLE]: 'Immature',
+  [ID_SWAPPING]: 'Swapping',
+  [ID_BONDED]: 'Bonded',
+  [ID_LOCKED_BAL_MSG]: 'Total funds temporarily locked to cover the costs of your bond maintenance, settling matches, and necessary fees',


~~settling matches, and necessary fees~~ -> live orders and matches

Also can be locked for other reasons though. For Decred, we add value locked in tickets too.

buck54321 · 2023-06-05T22:32:13Z

client/webserver/site/src/js/locales.ts

+  [ID_SWAPPING]: 'Swapping',
+  [ID_BONDED]: 'Bonded',
+  [ID_LOCKED_BAL_MSG]: 'Total funds temporarily locked to cover the costs of your bond maintenance, settling matches, and necessary fees',
+  [ID_IMMATURE_BAL_MSG]: 'Incoming funds awaiting confirmation',


Still a little off. This is really only coinbase and stakebase outputs that require a large number of confirmations by consensus. Redeemed funds never end up here.

Any other specific message in mind?

Good enough for now. I may follow up with a change later.

buck54321 · 2023-06-05T22:34:27Z

client/webserver/site/src/js/locales.ts

+  [ID_LOCKED_SWAPPING_BAL_MSG]: 'Funds currently locked in settling matches',
+  [ID_LOCKED_BOND_BAL_MSG]: 'Funds locked in active bonds',
+  [ID_RESERVES_DEFICIT]: 'Reserves Deficit',
+  [ID_RESERVES_DEFICIT_MSG]: 'Difference between the available balance in your wallet and the amount that has been reserved for specific purposes',


The apparent wallet balance shortcoming to maintain bonding level. If this persists, you may need to add funds to stay fully bonded.

I have updated the message with your suggestion in commit 27d2601. But is Reserves Deficit only for Fidelity Bonds?

client/webserver/site/src/js/locales.ts

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

buck54321

LGTM. Another review would be appreciated. Otherwise, I'll merge in a day or two.

JoeGruffins

Working well on simnet.

chappjc reviewed May 16, 2023

View reviewed changes

chappjc requested changes May 17, 2023

View reviewed changes

client/webserver/site/src/js/wallets.ts Outdated Show resolved Hide resolved

client/webserver/site/src/js/locales.ts Outdated Show resolved Hide resolved

ukane-philemon force-pushed the wall-tooltips branch 2 times, most recently from 5f99e6b to bc9b2e1 Compare May 23, 2023 20:15

chappjc reviewed May 30, 2023

View reviewed changes

client/asset/interface.go Outdated Show resolved Hide resolved

chappjc requested a review from buck54321 May 30, 2023 15:19

ukane-philemon added 8 commits May 31, 2023 16:41

add wallet balance tooltip and all known wallet balances to translation

c2bb003

- Added `asset.CustomBalance` struct type for custom balances. Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

fix zec harness test

2fd7932

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

improve tooltip display

ed1ef40

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

chappjc review changes

5005c12

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

go fmt

ea6212d

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

fix typos

efb7179

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

list custom balance categories as constants

af4dc55

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

add BalanceCategory string type

70c4590

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

ukane-philemon force-pushed the wall-tooltips branch from bc9b2e1 to 70c4590 Compare May 31, 2023 15:48

buck54321 requested changes Jun 1, 2023

View reviewed changes

buck's review changes

f0b59d0

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

buck54321 requested changes Jun 5, 2023

View reviewed changes

buck's review changes

27d2601

Signed-off-by: Philemon Ukane <ukanephilemon@gmail.com>

buck54321 approved these changes Jun 7, 2023

View reviewed changes

JoeGruffins approved these changes Jun 9, 2023

View reviewed changes

buck54321 merged commit 98fea7d into decred:master Jun 9, 2023
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

multi: Add wallet balance tooltip and all known wallet balances to translation map #2357

multi: Add wallet balance tooltip and all known wallet balances to translation map #2357

ukane-philemon commented May 16, 2023 •

edited

chappjc commented May 16, 2023 •

edited

ukane-philemon commented May 16, 2023 •

edited

chappjc left a comment

buck54321 Jun 1, 2023

ukane-philemon Jun 1, 2023 •

edited

ukane-philemon Jun 21, 2023

buck54321 left a comment

buck54321 Jun 5, 2023

ukane-philemon Jun 6, 2023

buck54321 Jun 5, 2023

ukane-philemon Jun 6, 2023

buck54321 Jun 5, 2023

ukane-philemon Jun 6, 2023

buck54321 Jun 7, 2023

buck54321 Jun 5, 2023

ukane-philemon Jun 6, 2023

buck54321 left a comment

JoeGruffins left a comment

	OrderLocked uint64 `json:"orderlocked"`
	// ContractLocked is the total amount of funds locked in unspent (i.e.
	// unredeemed / unrefunded) swap contracts. This amount is NOT included in
	// the db.Balance.
	ContractLocked uint64 `json:"contractlocked"`
	// BondLocked is the total amount of funds locked in unspent fidelity bonds.
	// This amount is NOT included in the db.Balance.
	BondLocked uint64 `json:"bondlocked"`

multi: Add wallet balance tooltip and all known wallet balances to translation map #2357

multi: Add wallet balance tooltip and all known wallet balances to translation map #2357

Conversation

ukane-philemon commented May 16, 2023 • edited

chappjc commented May 16, 2023 • edited

ukane-philemon commented May 16, 2023 • edited

chappjc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ukane-philemon Jun 1, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

buck54321 left a 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

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

buck54321 left a comment

Choose a reason for hiding this comment

JoeGruffins left a comment

Choose a reason for hiding this comment

ukane-philemon commented May 16, 2023 •

edited

chappjc commented May 16, 2023 •

edited

ukane-philemon commented May 16, 2023 •

edited

ukane-philemon Jun 1, 2023 •

edited