feat(earn): Add EarnHome screen #5656

finnian0826 · 2024-07-18T22:14:30Z

Description

Move over necessary multi-pool earn stuff from earnV2. Two pools shown for testing purposes but the PR only includes the single Aave pool currently supported.

Will add analytics and hook stuff up in follow-up PRs

Test plan

all.mp4

Open pools	My pools	Bottom sheet

Related issues

Part of ACT-1260

Backwards compatibility

Yes

Network scalability

If a new NetworkId and/or Network are added in the future, the changes in this PR will:

Continue to work without code changes, OR trigger a compilation error (guaranteeing we find it when a new network is added)

codecov · 2024-07-18T22:37:43Z

Codecov Report

Attention: Patch coverage is 94.39252% with 12 lines in your changes missing coverage. Please review.

Project coverage is 86.83%. Comparing base (40c144e) to head (a68a852).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5656      +/-   ##
==========================================
+ Coverage   86.78%   86.83%   +0.04%     
==========================================
  Files         774      780       +6     
  Lines       31862    32075     +213     
  Branches     5525     5257     -268     
==========================================
+ Hits        27653    27853     +200     
- Misses       3975     4173     +198     
+ Partials      234       49     -185

Files	Coverage Δ
src/components/FilterChipsCarousel.tsx	`100.00% <100.00%> (ø)`
src/earn/EarnTabBar.tsx	`100.00% <100.00%> (ø)`
src/earn/PoolCard.tsx	`100.00% <100.00%> (ø)`
src/earn/PoolList.tsx	`100.00% <100.00%> (ø)`
src/earn/types.ts	`100.00% <100.00%> (ø)`
src/navigator/Screens.tsx	`100.00% <100.00%> (ø)`
src/components/TokenBottomSheet.tsx	`94.03% <66.66%> (-0.56%)`	⬇️
src/earn/pools.ts	`75.00% <75.00%> (ø)`
src/earn/EarnHome.tsx	`91.52% <91.52%> (ø)`

... and 77 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 40c144e...a68a852. Read the comment docs.

finnian0826 · 2024-07-19T21:47:01Z

src/dapps/DappsScreen.tsx

@@ -240,8 +240,6 @@ function DappsScreen({ navigation }: Props) {
                <FilterChipsCarousel
                  chips={filterChips}
                  onSelectChip={handleToggleFilterChip}
-                  primaryColor={Colors.successDark}


This defaults to gray/black buttons, Kayla mentioned wanting this standard across the app here

satish-ravi · 2024-07-20T00:06:06Z

src/components/FilterChipsCarousel.tsx

+  primaryColor?: colors
+  primaryBorderColor?: colors
+  primaryTextColor?: colors
+  secondaryColor?: colors
+  secondaryBorderColor?: colors
+  secondaryTextColor?: colors


can we drop these params if there's no usage of customizing? The less options the better. Also, would be nice if the styling change for this component is in a separate PR

moved to #5672

satish-ravi · 2024-07-20T00:09:40Z

src/components/TokenBottomSheet.tsx

@@ -33,6 +34,7 @@ export enum TokenPickerOrigin {
  CashIn = 'CashIn',
  CashOut = 'CashOut',
  Spend = 'Spend',
+  EarnFilter = 'EarnFilter',


Suggested change

EarnFilter = 'EarnFilter',

Earn = 'Earn',

?

satish-ravi · 2024-07-20T00:11:58Z

src/earn/EarnHome.test.tsx

+]
+
+describe('EarnHome', () => {
+  it('renders correctly', () => {


needs tests for changing tabs / filtering

satish-ravi · 2024-07-20T00:13:34Z

src/navigator/Navigator.tsx

@@ -538,6 +539,7 @@ const generalScreens = (Navigator: typeof Stack) => (

 const earnScreens = (Navigator: typeof Stack) => (
  <>
+    <Navigator.Screen name={Screens.EarnHome} component={EarnHome} options={headerWithBackButton} />


use custom header over nav header to avoid the header not greying out when the bottom sheet is open

I'm having some trouble getting a custom header to work with the useScrollAwareHeader to have scrolling work and the title show up on the top. Is there any example of getting these to work together that we have, I'm having trouble finding one. @satish-ravi @MuckT

useScrollAwareHeader is meant to work with nav header and not custom header. We'll likely need a new wrapper for custom headers, which is beyond the scope of this. Let's make an issue

src/earn/PoolCard.tsx

satish-ravi · 2024-07-20T00:20:22Z

src/earn/EarnHome.tsx

+  {
+    poolId: 'aArbUSDCn',
+    networkId: NetworkId['arbitrum-one'],
+    tokens: [`${NetworkId['arbitrum-one']}:0xaf88d065e77c8cc2239327c5edb3a432268e5831`],


For now I think we are going to support pools where this list is going to be the same as the deposit token id. I guess this is needed for more complex pools, @jeanregisser do you see value in keeping this?

It's fine, it'll be part of the position anyway. I'll update this as I start working on the task to connect it to getEarnPositions.

satish-ravi · 2024-07-23T22:51:47Z

src/earn/EarnTabBar.test.tsx

+import { EarnTabType } from 'src/earn/types'
+import Colors from 'src/styles/colors'
+
+describe('AssetTabBar', () => {


satish-ravi · 2024-07-23T22:51:54Z

src/earn/EarnTabBar.test.tsx

+    jest.clearAllMocks()
+  })
+
+  it('renders all items if positions is enabled', () => {


this test name doesn't seem right

updated, had copied over these tests from AssetTabBar and missed updating title

satish-ravi · 2024-07-23T22:53:29Z

src/earn/PoolCard.tsx

+          <View style={styles.buttonContainer}>
+            <Button
+              onPress={() => {
+                navigate(Screens.EarnCollectScreen, { depositTokenId, poolTokenId })


added in 1a14ebd

satish-ravi · 2024-07-23T22:53:35Z

src/earn/PoolCard.tsx

+            />
+            <Button
+              onPress={() => {
+                navigate(Screens.EarnEnterAmount, { tokenId: depositTokenId })


added in 1a14ebd

satish-ravi · 2024-07-23T22:55:20Z

src/earn/EarnHome.test.tsx

+    expect(getByTestId(`PoolCard/${pools[0].poolId}`)).toBeTruthy()
+  })
+
+  it('correctly shows correct networks, tokens under filters', () => {


can we also add tests for changing filters?

This might be difficult with the current hardcoded single pool. There isn't any way to specify for the home screen to show more pools, so the pools being shown wouldn't change at all.

you can mock the pools by moving them to a separate file right?

satish-ravi · 2024-07-23T22:59:50Z

src/components/TokenBottomSheet.tsx

@@ -215,6 +217,9 @@ function TokenBottomSheet({
          if (isNetworkChip(filter)) {
            return filter.filterFn(token, filter.selectedNetworkIds)
          }
+          if (isTokenSelectChip(filter)) {


is this just to make TS happy? the token bottom sheet itself isn't going to have a token filter chip right?

This is just copied over from Jacob's implementation in Troopo, I can remove if not necessary, the token bottom sheet won't have filters I don't think

looks like TS gets mad if this is removed

satish-ravi · 2024-07-23T23:01:47Z

src/navigator/Navigator.tsx

@@ -538,6 +539,7 @@ const generalScreens = (Navigator: typeof Stack) => (

 const earnScreens = (Navigator: typeof Stack) => (
  <>
+    <Navigator.Screen name={Screens.EarnHome} component={EarnHome} options={headerWithBackButton} />


useScrollAwareHeader is meant to work with nav header and not custom header. We'll likely need a new wrapper for custom headers, which is beyond the scope of this. Let's make an issue

finnian0826 · 2024-07-24T16:29:36Z

src/earn/PoolCard.test.tsx

+
+    expect(getByText('earnFlow.poolCard.addToPool')).toBeTruthy()
+    fireEvent.press(getByText('earnFlow.poolCard.addToPool'))
+    expect(navigate).toHaveBeenCalledWith(Screens.EarnEnterAmount, { tokenId: mockArbUsdcTokenId })


Will add check for analytics event in follow-up when analytics added

finnian0826 · 2024-07-24T16:29:57Z

src/earn/PoolCard.tsx

+            />
+            <Button
+              onPress={() => {
+                navigate(Screens.EarnEnterAmount, { tokenId: depositTokenId })


Adding analytics to all button presses in follow up.

src/earn/PoolCard.tsx

Co-authored-by: Satish Ravi <[email protected]>

### Description Fetch and store earn positions. Also add a selector to list them. User and earn positions are fetched and stored together. For each returned earn position: - if the user already holds the earn position, it is ignored (since it's already present as a user position) - if not it's added to the list Next up: use earn positions to drive the earn screen (which was added in #5656) ### Test plan - Updated tests ### Related issues - Fixes RET-1121 ### Backwards compatibility Yes ### Network scalability If a new NetworkId and/or Network are added in the future, the changes in this PR will: - [x] Continue to work without code changes, OR trigger a compilation error (guaranteeing we find it when a new network is added)

finnian0826 added 3 commits July 18, 2024 16:14

feat(earn): Add EarnHome screen

2f31aff

update root state schema

61ff0e3

Merge branch 'main' into finnian0826/act-1257-add-screen

115a96e

finnian0826 added 7 commits July 18, 2024 16:46

more cleanup

6a9dce4

more updates

4857382

more stuff

fe68a8c

fix translation

4ed0ccc

add tests

5e1e444

fix translation string

12af004

Merge branch 'main' into finnian0826/act-1257-add-screen

8ff64b9

finnian0826 marked this pull request as ready for review July 19, 2024 21:16

finnian0826 added 2 commits July 19, 2024 15:17

fix merge

96ce7fd

lint

632b386

finnian0826 commented Jul 19, 2024

View reviewed changes

satish-ravi reviewed Jul 20, 2024

View reviewed changes

finnian0826 added 6 commits July 23, 2024 14:49

feedback pt. 1

c50fb11

feedback pt. 2

54b9a93

Merge branch 'main' into finnian0826/act-1257-add-screen

f9f74ff

fix bottom sheet

05a243a

add tests

84a35cd

clean up

8ddaa28

satish-ravi reviewed Jul 23, 2024

View reviewed changes

finnian0826 added 2 commits July 23, 2024 17:07

small feedback

caeba91

add tests

1a14ebd

finnian0826 commented Jul 24, 2024

View reviewed changes

finnian0826 added 3 commits July 24, 2024 14:03

add test

eb2f27d

clean up test

cafea89

add pools

6b31a17

satish-ravi approved these changes Jul 24, 2024

View reviewed changes

src/earn/PoolCard.tsx Outdated Show resolved Hide resolved

finnian0826 and others added 2 commits July 25, 2024 09:23

Update src/earn/PoolCard.tsx

a713800

Co-authored-by: Satish Ravi <[email protected]>

Merge branch 'main' into finnian0826/act-1257-add-screen

a68a852

finnian0826 enabled auto-merge July 24, 2024 21:23

finnian0826 added this pull request to the merge queue Jul 24, 2024

Merged via the queue into main with commit eee9d34 Jul 24, 2024
16 checks passed

finnian0826 deleted the finnian0826/act-1257-add-screen branch July 24, 2024 22:02

jeanregisser mentioned this pull request Jul 25, 2024

feat(earn): fetch earn positions + selector #5679

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(earn): Add EarnHome screen #5656

feat(earn): Add EarnHome screen #5656

finnian0826 commented Jul 18, 2024 •

edited

Loading

codecov bot commented Jul 18, 2024 •

edited

Loading

finnian0826 Jul 19, 2024

satish-ravi Jul 20, 2024

finnian0826 Jul 23, 2024

satish-ravi Jul 20, 2024

satish-ravi Jul 20, 2024

satish-ravi Jul 20, 2024

finnian0826 Jul 23, 2024 •

edited

Loading

satish-ravi Jul 23, 2024

satish-ravi Jul 20, 2024 •

edited

Loading

jeanregisser Jul 23, 2024

satish-ravi Jul 23, 2024

satish-ravi Jul 23, 2024

finnian0826 Jul 23, 2024

satish-ravi Jul 23, 2024

finnian0826 Jul 24, 2024

satish-ravi Jul 23, 2024

finnian0826 Jul 24, 2024

satish-ravi Jul 23, 2024

finnian0826 Jul 23, 2024

satish-ravi Jul 24, 2024 •

edited

Loading

satish-ravi Jul 23, 2024

finnian0826 Jul 23, 2024

finnian0826 Jul 24, 2024

satish-ravi Jul 23, 2024

finnian0826 Jul 24, 2024

finnian0826 Jul 24, 2024

feat(earn): Add EarnHome screen #5656

feat(earn): Add EarnHome screen #5656

Conversation

finnian0826 commented Jul 18, 2024 • edited Loading

Description

Test plan

Related issues

Backwards compatibility

Network scalability

codecov bot commented Jul 18, 2024 • edited Loading

Codecov Report

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

finnian0826 Jul 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

satish-ravi Jul 20, 2024 • edited Loading

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

Choose a reason for hiding this comment

satish-ravi Jul 24, 2024 • edited Loading

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

finnian0826 commented Jul 18, 2024 •

edited

Loading

codecov bot commented Jul 18, 2024 •

edited

Loading

finnian0826 Jul 23, 2024 •

edited

Loading

satish-ravi Jul 20, 2024 •

edited

Loading

satish-ravi Jul 24, 2024 •

edited

Loading