feat: Add view for get/set ERC20 balances (#39) #50

ditto-eth · 2023-09-06T20:02:08Z

vid: https://twitter.com/dittoproj/status/1699904944898240966?s=20

@jxom said we can add a new issue to embed revm to do this better but my workaround might work for now for most tokens.

This setERCBalance is a bit like fuzzing! By assuming the balanceOf mapping is usually near slot 0, we can iterate through each and randomly check values to set we are setting the right storage slot.

loop through each slot, starting from 0 (maybe stop at some point, I just hardcoded it to 10)
setStorageAt() with a special value (if we used the user value, it might be 0 or a number that a slot might already be so I want to make sure it's weird enough that it's obvious we calculated it right I think?)
check the val of balanceOf == value
if not, guess++ (get the next slot, from 0 to 1, etc)
if yes, profit! (we've found it!, maybe this could be saved in the tokens store locally, or could just hardcode special tokens)

Note: one issue is ERC20 tokens that use special slots (assembly, diamond storage, etc) - this stops checking at slot 10. Those would have to be hardcoded or we could read the source code to find the storage constant, not sure how easy that is?

q:

should erc20 be stored separately from 721/1155? Or put all into one as diff types
copied the abi file since not importing from wagmi

gakonst · 2023-09-08T23:18:56Z

Note: one issue is ERC20 tokens that use special slots (assembly, diamond storage, etc) - this stops checking at slot 10. Those would have to be hardcoded or we could read the source code to find the storage constant, not sure how easy that is?

I think we can merge w/o this, document as a known limitation, and we can add an issue for future usage. Running with the revm in WASM & capturing the storage slots accessed during balanceOf is useful here. I'll see if I can get us a nice library for this, similar to https://github.com/gakonst/pyrevm

…dd comment

ditto-eth · 2023-09-11T17:33:20Z

src/hooks/useErcBalance.ts

+        contract.read.name(),
+        contract.read.symbol(),
+        contract.read.decimals(),
+        contract.read.balanceOf([address]),


maybe for next pr: it's probably better to just leave this as only the balanceOf call, and then add the name/symbol/decimals metadata to the tokens store?

It should attempt to validate that the address is an erc20 (not sure how really), and maybe include if it's 721, which can save the tokenUri if it exists? q is whether we want multiple stores for 20/721/1155 or if it's possible to keep in 1 and just filter it.

Yeah, I'd consider splitting this up into useErc20Balance and useErc20Metadata Hooks, that both use React Query. Two reasons:

Metadata is independent of address, and we can cache that separately (instead of having it as separate cache entries for erc/address pairs).

We can still just use React Query still for useErc20Metadata as syncing it into Zustand probably isn't worth it (syncing RQ with external stores like Zustand is generally not recommended).

Invalidating metadata is useless since it's immutable (https://github.com/paradigmxyz/rivet/pull/50/files#diff-83dac5097fa3ff04758ab51b989502a815d5ef851830cd4f9aee80856305c6f9R59-R61)

Might be worth doing in this PR as it's pretty trivial.

src/utils/abi.ts

jxom · 2023-09-11T23:58:30Z

src/hooks/useErcBalance.ts

+        contract.read.name(),
+        contract.read.symbol(),
+        contract.read.decimals(),
+        contract.read.balanceOf([address]),


Yeah, I'd consider splitting this up into useErc20Balance and useErc20Metadata Hooks, that both use React Query. Two reasons:

Metadata is independent of address, and we can cache that separately (instead of having it as separate cache entries for erc/address pairs).

We can still just use React Query still for useErc20Metadata as syncing it into Zustand probably isn't worth it (syncing RQ with external stores like Zustand is generally not recommended).

Invalidating metadata is useless since it's immutable (https://github.com/paradigmxyz/rivet/pull/50/files#diff-83dac5097fa3ff04758ab51b989502a815d5ef851830cd4f9aee80856305c6f9R59-R61)

Might be worth doing in this PR as it's pretty trivial.

jxom · 2023-09-11T23:59:51Z

src/hooks/useErcBalance.ts

rename to useErc20Balance?

jxom · 2023-09-12T00:00:57Z

src/hooks/useErcBalance.ts

+
+type UseErcBalanceParameters = {
+  address: Address
+  erc: Address


Suggested change

erc: Address

contractAddress: Address

jxom · 2023-09-12T00:01:25Z

src/hooks/useErcBalance.ts

+  erc,
+  address,


Suggested change

erc,

address,

address,

tokenAddress,

jxom · 2023-09-12T00:01:35Z

src/hooks/useErcBalance.ts

+    queryKey: getErcBalanceQueryKey([client.key, { erc, address }]),
+    async queryFn() {
+      const contract = getContract({
+        address: erc,


Suggested change

address: erc,

address: tokenAddress,

jxom · 2023-09-12T01:50:41Z

src/hooks/useSetErcBalance.ts

+            if (slotGuess >= 10n) {
+              throw "couldn't find balancesOf mapping past slot 10"
+            }


Suggested change

if (slotGuess >= 10n) {

throw "couldn't find balancesOf mapping past slot 10"

}

if (slotGuess >= 10n)

throw new BaseError('could not find storage for: `balanceOf`')

jxom · 2023-09-12T01:51:14Z

src/hooks/useSetErcBalance.ts

+          }
+        }
+      } catch (e) {
+        console.error(e)


Do we need this try/catch? Can we remove and let React Query catch the error?

jxom · 2023-09-12T01:51:37Z

src/screens/index.tsx

@@ -251,6 +254,34 @@ function RemoveButton({ onClick }: { onClick: (e: any) => void }) {
  )
 }

+export function DetailButton({ onClick }: { onClick: (e: any) => void }) {


FYI - we have a Button.Symbol now!

jxom · 2023-09-12T01:52:03Z

src/hooks/useSetErcBalance.ts

+type SetErcBalanceParameters = {
+  address: Address
+  erc: Address
+  value: bigint
+}
+
+import { type Address, encodeAbiParameters, keccak256, pad, toHex } from 'viem'
+import { queryClient } from '~/react-query'
+import { useClient } from './useClient'
+import { getErcBalanceQueryKey } from './useErcBalance'


Suggested change

type SetErcBalanceParameters = {

address: Address

erc: Address

value: bigint

}

import { type Address, encodeAbiParameters, keccak256, pad, toHex } from 'viem'

import { queryClient } from '~/react-query'

import { useClient } from './useClient'

import { getErcBalanceQueryKey } from './useErcBalance'

import { type Address, encodeAbiParameters, keccak256, pad, toHex } from 'viem'

import { queryClient } from '~/react-query'

import { useClient } from './useClient'

import { getErcBalanceQueryKey } from './useErcBalance'

type SetErcBalanceParameters = {

address: Address

erc: Address

value: bigint

}

src/utils/abi.ts

jxom · 2023-09-12T02:14:14Z

src/zustand/tokens.ts

+export type TokensState = {
+  tokens: Address[]
+}


We will need to make sure this works across accounts too.

Suggested change

export type TokensState = {

tokens: Address[]

}

export type TokensState = {

tokens: Record<Address, Address[]>

}

…ymbol

ditto-eth force-pushed the 39 branch from fd8ce4e to 3d857c3 Compare September 7, 2023 22:36

ditto-eth changed the title ~~feat: Add view for viewing ERC20 (#39)~~ feat: Add view for get/set ERC20 balances (#39) Sep 7, 2023

ditto-eth force-pushed the 39 branch from 3d857c3 to e83ae35 Compare September 8, 2023 18:18

ditto-eth force-pushed the 39 branch from a327f85 to ed634ec Compare September 9, 2023 15:53

ditto-eth added 8 commits September 11, 2023 16:03

Add Screen for viewing ERC20

2f74fbd

Add ability to set erc balances

e9bbd93

Add ability to set rebasing tokens or tokens that change balanceOf, a…

283b550

…dd comment

Remove multicall, fix need to reload page

7767298

Check valid address, rename

b8e1152

Fix button color

5483996

Handle tokens with decimals other than 18

96bc1be

Fix input if balance changes to 0

16a6122

jxom force-pushed the 39 branch from 12580fc to 16a6122 Compare September 11, 2023 06:04

ditto-eth commented Sep 11, 2023

View reviewed changes

src/utils/abi.ts Outdated Show resolved Hide resolved

jxom reviewed Sep 12, 2023

View reviewed changes

Fix Token page to allow scrolling, allow removing addresses if invalid

150fe31

ditto-eth force-pushed the 39 branch 3 times, most recently from 5877f76 to 3df6bad Compare September 12, 2023 16:15

PR review: rename to erc20, split into balance/metadata, use Button.S…

9eac57c

…ymbol

ditto-eth force-pushed the 39 branch from 3df6bad to 9eac57c Compare September 12, 2023 17:56

ditto-eth and others added 3 commits September 12, 2023 18:04

Use diff token store per account

3c9cabf

refactor: ui polish

c1ea865

lint

6fcb4d2

jxom merged commit a184297 into paradigmxyz:main Sep 13, 2023
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add view for get/set ERC20 balances (#39) #50

feat: Add view for get/set ERC20 balances (#39) #50

ditto-eth commented Sep 6, 2023 •

edited

Loading

gakonst commented Sep 8, 2023 •

edited

Loading

ditto-eth Sep 11, 2023

jxom Sep 11, 2023

jxom Sep 11, 2023

jxom Sep 11, 2023

jxom Sep 12, 2023

jxom Sep 12, 2023

jxom Sep 12, 2023

jxom Sep 12, 2023

jxom Sep 12, 2023

jxom Sep 12, 2023

jxom Sep 12, 2023

jxom Sep 12, 2023 •

edited

Loading

feat: Add view for get/set ERC20 balances (#39) #50

feat: Add view for get/set ERC20 balances (#39) #50

Conversation

ditto-eth commented Sep 6, 2023 • edited Loading

gakonst commented Sep 8, 2023 • 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

jxom Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

ditto-eth commented Sep 6, 2023 •

edited

Loading

gakonst commented Sep 8, 2023 •

edited

Loading

jxom Sep 12, 2023 •

edited

Loading