feat: save user announcements to local storage and last fetched block #685

marcomariscal · 2024-06-18T23:27:35Z

Description

Updates to fetch and scan only the latest blocks. The latest blocks are those after the initial scan, where each subsequent scan saves the latest fetched block to local storage, allowing for appropriate updating of the scan range:

Initial scan --> fetch/scan blocks 1 to x
Next scan --> fetch/scan blocks x + 1 to latest block (y)
Subsequent scan --> fetch/scan blocks y + 1 to latest block
etc.

Methodology:

User announcements are updated in local storage on each fetch/scan
The latest fetched block is updated in local storage on each fetch/scan
The most recent announcement block data is updated in local storage on each fetch/scan to accurately show if there are no announcements fetched in the current scan
The startBlock for the scan is appropriately updated to the latest fetched block

Other Updates:

Show fetching/scanning latest verbiage above the top right of the AccountReceiveTable, intentionally omitting the large scan indicator at the bottom of the table
Implemented a clear local storage button with auto app refresh

Comments:

There were instances where querying the subgraph potentially hung (using goldsky, so outdated); while this may not be directly affected by this PR, it's worth noting for testing purposes

To Test:

Perform the initial scan using account A
Navigate to a different route/page using account A
Validate: Navigate back to the receive page to confirm:
a) The initial user announcements are present
b) The fetching/scanning sequence is reflected appropriately (it's fetching/scanning only the latest blocks)
Perform a send transaction from a different account to account A, then navigate to the receive view connected with account A; validate as in step 3
Test the clear local storage functionality and ensure the app refreshes correctly

netlify · 2024-06-18T23:27:51Z

✅ Deploy Preview for jolly-shaw-20fe62 ready!

Name	Link
🔨 Latest commit	`b627889`
🔍 Latest deploy log	https://app.netlify.com/sites/jolly-shaw-20fe62/deploys/669020c0f4be990008541698
😎 Deploy Preview	https://deploy-preview-685--jolly-shaw-20fe62.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

jferas

Ran into an interesting UX loose end.. connected my wallet and did scan for received transactions.. had to sign to get them.. did so and got the list displayed.. went back to home and hit the receive tab again.. got the list immediate. Very nice...

Then closed that browser tab.. went back to the app via the deploy preview URL.. went to scan for receives, and got the list I had previously as well as a request to sign. Something might need to be cleared?

marcomariscal · 2024-06-25T20:22:00Z

Ran into an interesting UX loose end.. connected my wallet and did scan for received transactions.. had to sign to get them.. did so and got the list displayed.. went back to home and hit the receive tab again.. got the list immediate. Very nice...

Then closed that browser tab.. went back to the app via the deploy preview URL.. went to scan for receives, and got the list I had previously as well as a request to sign. Something might need to be cleared?

Yee, that's intentional. When the user refreshes the page, they need to sign again to scan because the keys are no longer available in memory. Sensitive data won't be cached to ensure security and privacy.

We've updated the sign-to-scan verbiage slightly for this scenario but welcome any feedback on clearer or less confusing language, and the ux in general.

frontend/src/components/AccountReceiveTable.vue

frontend/src/layouts/BaseLayout.vue

frontend/src/i18n/locales/en-US.json

Co-authored-by: Gary Ghayrat <[email protected]>

frontend/src/i18n/locales/zh-CN.json

Co-authored-by: Gary Ghayrat <[email protected]>

frontend/src/components/AccountReceiveTable.vue

…on mount

* fix: explicitly sort the tokens by addr * fix: use vm.computeCreateAddress * fix: mirror test sender params * fix: use actual owner * fix: add back gnosis * Remove all reference to INFURA_ID (#687) --------- Co-authored-by: John Feras <[email protected]>

…rom the stealthBalances array

frontend/src/components/AccountReceiveTable.vue

github-actions · 2024-07-11T18:27:30Z

Coverage after merging feat/last-fetched-block-usage into master will be

81.12%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
contracts-periphery/src
UmbraBatchSend.sol	100%	100%	100%	100%
UniswapWithdrawHook.sol	81.82%	100%	66.67%	83.33%	14
umbra-js/src
ethers.ts	76.27%	100%	61.11%	100%
types.ts	50%	100%	0%	100%
umbra-js/src/classes
KeyPair.ts	98.65%	96.49%	100%	100%	31–32
RandomNumber.ts	100%	100%	100%	100%
StealthKeyRegistry.ts	100%	100%	100%	100%
TxHistoryProvider.ts	77.55%	76.47%	66.67%	79.31%	11, 11, 19–20, 31, 38, 44, 53, 57, 8
Umbra.ts	75.41%	63.69%	82.93%	82.09%	105, 135–136, 157, 229–231, 315–318, 380, 394, 401–403, 405–406, 409–410, 428, 430, 432, 432, 432, 432–433, 433, 433–435, 450, 450, 450–451, 455, 458, 478, 496–498, 585, 602, 615–616, 626–627, 640, 643–644, 674–675, 751, 755, 755, 755–758, 758, 758, 758, 758, 758, 758–759, 759, 759, 759, 759, 759, 759, 759, 759, 759, 759, 761, 761, 761–762, 765, 765, 765, 765, 765–766, 769, 778, 778, 787, 790, 790, 790–792, 805, 809, 812–813, 819–821, 828, 828, 828–831, 862, 867–868, 868–869
umbra-js/src/typechain
index.ts	70.59%	100%	37.50%	100%
umbra-js/src/typechain/factories
index.ts	100%	100%	100%	100%
umbra-js/src/typechain/factories/@OpenZeppelin
index.ts	100%	100%	100%	100%
umbra-js/src/typechain/factories/@openzeppelin/contracts
index.ts	100%	100%	100%	100%
umbra-js/src/typechain/factories/@openzeppelin/contracts/access
Ownable__factory.ts	50%	100%	0%	66.67%	70, 76
index.ts	50%	100%	0%	100%
umbra-js/src/typechain/factories/@openzeppelin/contracts/token
index.ts	100%	100%	100%	100%
umbra-js/src/typechain/factories/@openzeppelin/contracts/token/ERC20
ERC20__factory.ts	29.03%	0%	12.50%	47.06%	310, 314, 314, 314–315, 317, 326, 326, 326, 333, 333, 333, 336, 339, 345
IERC20__factory.ts	50%	100%	0%	66.67%	201, 204
index.ts	50%	100%	0%	100%
umbra-js/src/typechain/factories/contracts
IUmbraHookReceiver__factory.ts	50%	100%	0%	66.67%	61, 67
MockHook__factory.ts	22.58%	0%	0%	41.18%	107, 111, 111, 111–112, 114, 121, 121, 121, 126, 126, 126, 129, 132, 138, 144
StealthKeyRegistry__factory.ts	22.58%	0%	0%	41.18%	202, 206, 206, 206–207, 209, 216, 216, 216, 221, 221, 221, 224, 227, 233, 239
TestToken__factory.ts	64.52%	66.67%	50%	70.59%	329–330, 348, 351, 354, 360, 366
Umbra__factory.ts	70.97%	66.67%	62.50%	76.47%	495–496, 525, 529, 532, 538
index.ts	50%	100%	0%	100%
umbra-js/src/utils
cns.ts	50%	33.33%	50%	55%	33–36, 40, 40, 40, 40, 40–41, 44–46
constants.ts	100%	100%	100%	100%
ens.ts	36.11%	25%	33.33%	40%	25–27, 35, 56–57, 57, 57–58, 63–64, 66, 70, 70, 70, 70, 70–71, 75–77
utils.ts	76.67%	68.66%	76.92%	82%	109–111, 113–115, 121, 139–140, 169, 190, 246, 253–260, 260, 260, 260, 260, 260, 260–261, 263, 294, 296–297, 306, 306, 306–307, 309, 312, 321–322, 363, 380, 380, 380, 400, 429, 431, 436, 448, 448–449, 454, 456–457, 468–472, 478, 480, 522–523, 523, 523–525, 525, 525, 536, 59–60, 779–780, 792–793, 85, 93, 93
umbra-js/test
testPrivateKeys.ts	100%	100%	100%	100%
utils.ts	100%	100%	100%	100%

garyghayrat · 2024-07-11T19:06:17Z

Thank you @marcomariscal !

…ScopeLift#685) * feat: set the last fetched block as the start block * feat: handle caching user announcements and latest fetched block * feat: show user announcements if there are any * fix: handle watching/loading announcements * fix: parse out lastFetchedBlock and fix user announcement loading logic * chore: log * feat: handle block data caching * feat: show most recent block data if exists * fix: type check * feat: handle user announcements already present and sign language * feat: only show fetching when no user announcements * feat: fetching latest from last fetched block component * feat: fetching latest translation for cn * feat: clear local storage button and functionality * fix: start block handling logic * feat: dedupe user announcements * fix: logic * fix: minimize debugging logs on userAnnouncement changes * feat: handle scanning latest announcements from last fetched block * feat: sort by timestamp explicitly * feat: no loading sequence when there are announcements * fix: need sig lately verbiage * fix: add need sig lately to cn * fix: little more mb * fix: no withdraw verbiage on need-sig-lately * feat: handle need sig * Update frontend/src/i18n/locales/en-US.json Co-authored-by: Gary Ghayrat <[email protected]> * feat: handle sign button instead of needs sig * Update frontend/src/i18n/locales/zh-CN.json Co-authored-by: Gary Ghayrat <[email protected]> * fix: move local storage clear button above lang * fix: spacing more uniform * fix: use computed ref as param, and set setIsInWithdrawFlow to false on mount * feat: sign and withdraw * fix: contract periphery tests (ScopeLift#688) * fix: explicitly sort the tokens by addr * fix: use vm.computeCreateAddress * fix: mirror test sender params * fix: use actual owner * fix: add back gnosis * Remove all reference to INFURA_ID (ScopeLift#687) --------- Co-authored-by: John Feras <[email protected]> * fix: use balanceIndex to ensure that the correct balance is fetched from the stealthBalances array * fix: dedupe by tx hash and receiver instead of just tx hash * fix: include receiver to derive isWithdrawn * fix: img --------- Co-authored-by: Gary Ghayrat <[email protected]> Co-authored-by: John Feras <[email protected]>

marcomariscal added 6 commits June 18, 2024 16:16

feat: set the last fetched block as the start block

6925fc0

feat: handle caching user announcements and latest fetched block

9932c07

feat: show user announcements if there are any

154ff46

fix: handle watching/loading announcements

136c4f3

fix: parse out lastFetchedBlock and fix user announcement loading logic

9ba3115

chore: log

9b49317

marcomariscal added 15 commits June 20, 2024 12:35

feat: handle block data caching

9af424d

feat: show most recent block data if exists

c449a82

fix: type check

22cc126

feat: handle user announcements already present and sign language

be0f63e

feat: only show fetching when no user announcements

cd9e394

feat: fetching latest from last fetched block component

1f9591d

feat: fetching latest translation for cn

6916958

feat: clear local storage button and functionality

8cbf9b0

fix: start block handling logic

5d04a36

feat: dedupe user announcements

def9921

fix: logic

3046be2

fix: minimize debugging logs on userAnnouncement changes

1c43d4d

feat: handle scanning latest announcements from last fetched block

c5ad0bb

feat: sort by timestamp explicitly

5909fb8

feat: no loading sequence when there are announcements

9f0a3f9

marcomariscal marked this pull request as ready for review June 25, 2024 17:59

marcomariscal changed the title ~~feat: cache user announcements and last fetched block~~ feat: save user announcements to local storage and last fetched block Jun 25, 2024

marcomariscal requested review from garyghayrat and jferas and removed request for jferas June 25, 2024 18:33

jferas requested changes Jun 25, 2024

View reviewed changes

fix: need sig lately verbiage

c40d035

fix: little more mb

f39c807

garyghayrat reviewed Jun 27, 2024

View reviewed changes

frontend/src/components/AccountReceiveTable.vue Show resolved Hide resolved

marcomariscal added 2 commits June 28, 2024 12:14

fix: no withdraw verbiage on need-sig-lately

aca5dc5

feat: handle need sig

29f6f6e

marcomariscal requested a review from garyghayrat June 28, 2024 23:38

marcomariscal force-pushed the feat/last-fetched-block-usage branch from 965a4e1 to 29f6f6e Compare July 3, 2024 19:31

garyghayrat reviewed Jul 8, 2024

View reviewed changes

frontend/src/layouts/BaseLayout.vue Outdated Show resolved Hide resolved

garyghayrat reviewed Jul 8, 2024

View reviewed changes

frontend/src/i18n/locales/en-US.json Outdated Show resolved Hide resolved

Update frontend/src/i18n/locales/en-US.json

44c53b3

Co-authored-by: Gary Ghayrat <[email protected]>

garyghayrat reviewed Jul 8, 2024

View reviewed changes

frontend/src/i18n/locales/zh-CN.json Outdated Show resolved Hide resolved

marcomariscal and others added 3 commits July 8, 2024 13:22

feat: handle sign button instead of needs sig

a211d46

Update frontend/src/i18n/locales/zh-CN.json

e39a690

Co-authored-by: Gary Ghayrat <[email protected]>

fix: move local storage clear button above lang

ba09324

marcomariscal requested a review from garyghayrat July 8, 2024 20:26

garyghayrat reviewed Jul 9, 2024

View reviewed changes

frontend/src/components/AccountReceiveTable.vue Show resolved Hide resolved

marcomariscal added 2 commits July 8, 2024 20:13

fix: spacing more uniform

a72ff26

fix: use computed ref as param, and set setIsInWithdrawFlow to false …

d8b730b

…on mount

marcomariscal requested a review from garyghayrat July 9, 2024 03:49

marcomariscal and others added 5 commits July 9, 2024 11:49

feat: sign and withdraw

5d63f2a

fix: use balanceIndex to ensure that the correct balance is fetched f…

af15d8c

…rom the stealthBalances array

fix: dedupe by tx hash and receiver instead of just tx hash

c6d04ed

fix: include receiver to derive isWithdrawn

a6d8952

garyghayrat reviewed Jul 11, 2024

View reviewed changes

frontend/src/components/AccountReceiveTable.vue Outdated Show resolved Hide resolved

fix: img

b627889

garyghayrat approved these changes Jul 11, 2024

View reviewed changes

garyghayrat merged commit a13be3a into master Jul 11, 2024
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: save user announcements to local storage and last fetched block #685

feat: save user announcements to local storage and last fetched block #685

marcomariscal commented Jun 18, 2024 •

edited

Loading

netlify bot commented Jun 18, 2024 •

edited

Loading

jferas left a comment

marcomariscal commented Jun 25, 2024

github-actions bot commented Jul 11, 2024

garyghayrat commented Jul 11, 2024

feat: save user announcements to local storage and last fetched block #685

feat: save user announcements to local storage and last fetched block #685

Conversation

marcomariscal commented Jun 18, 2024 • edited Loading

Description

Methodology:

Other Updates:

Comments:

To Test:

netlify bot commented Jun 18, 2024 • edited Loading

✅ Deploy Preview for jolly-shaw-20fe62 ready!

jferas left a comment

Choose a reason for hiding this comment

marcomariscal commented Jun 25, 2024

github-actions bot commented Jul 11, 2024

garyghayrat commented Jul 11, 2024

marcomariscal commented Jun 18, 2024 •

edited

Loading

netlify bot commented Jun 18, 2024 •

edited

Loading