Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

internal/ethapi: quantity-encode storage keys in eth_getProof response #27309

Merged
merged 9 commits into from
Jun 21, 2023
Merged

internal/ethapi: quantity-encode storage keys in eth_getProof response #27309

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2c8ec4d
fix: quantity-encode storage keys in eth_getProof responses
prestwich May 19, 2023
e3a3ad6
lint: run golangci-lint run --fix
prestwich May 19, 2023
34b93db
test: adjust getProof test to use quantity storage keys
prestwich May 21, 2023
17fa4b5
ethclient/gethclient: more testing for getproof
holiman May 22, 2023
3bec74a
Merge branch 'master' into prestwich/1186-quantity
holiman May 31, 2023
7d37b16
internal/ethapi: go format
holiman May 31, 2023
dd7158e
internal/ethapi: apply suggestion for hash-sized storage keys
fjl Jun 20, 2023
9c5b1f0
ethclient/gethclient: update test
fjl Jun 20, 2023
b4fafd3
internal/ethapi: justify
fjl Jun 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion ethclient/gethclient/gethclient_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@ import (
"bytes"
"context"
"encoding/json"
"fmt"
"math/big"
"testing"

"github.com/ethereum/go-ethereum"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/common/hexutil"
"github.com/ethereum/go-ethereum/consensus/ethash"
"github.com/ethereum/go-ethereum/core"
"github.com/ethereum/go-ethereum/core/types"
Expand Down Expand Up @@ -230,9 +232,26 @@ func testGetProof(t *testing.T, client *rpc.Client) {
if !bytes.Equal(slotValue, proof.Value.Bytes()) {
t.Fatalf("invalid storage proof value, want: %v, got: %v", slotValue, proof.Value.Bytes())
}
if proof.Key != testSlot.String() {
if proof.Key != hexutil.EncodeBig(testSlot.Big()) {
t.Fatalf("invalid storage proof key, want: %v, got: %v", testSlot.String(), proof.Key)
}
{
// Tests with non-canon input
if result, err = ec.GetProof(context.Background(), testAddr, []string{"0x0deadbeef"}, nil); err != nil {
t.Fatal(err)
}
p, _ := new(big.Int).SetString(testSlot.String(), 0)
if have, want := result.StorageProof[0].Key, fmt.Sprintf("%#x", p); want != have {
t.Fatalf("invalid storage proof key, want: %v, have: %v", want, have)
}
if result, err = ec.GetProof(context.Background(), testAddr, []string{"0x000deadbeef"}, nil); err != nil {
t.Fatal(err)
}
p, _ = new(big.Int).SetString(testSlot.String(), 0)
if have, want := result.StorageProof[0].Key, fmt.Sprintf("%#x", p); want != have {
t.Fatalf("invalid storage proof key, want: %v, have: %v", want, have)
}
}
}

func testGCStats(t *testing.T, client *rpc.Client) {
Expand Down
7 changes: 4 additions & 3 deletions internal/ethapi/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,7 +650,7 @@ type AccountResult struct {
}

type StorageResult struct {
Key string `json:"key"`
Key *hexutil.Big `json:"key"`
Value *hexutil.Big `json:"value"`
Proof []string `json:"proof"`
}
Expand Down Expand Up @@ -680,6 +680,7 @@ func (s *BlockChainAPI) GetProof(ctx context.Context, address common.Address, st
// create the proof for the storageKeys
for i, hexKey := range storageKeys {
key, err := decodeHash(hexKey)
keyInt := (*hexutil.Big)(new(big.Int).SetBytes(key[:]))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit unorthodox to do this operation, involving key, before checking/handling the err. It's safe, in this instance, but not "The Way" :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my go is far from idiomatic

if err != nil {
return nil, err
}
Expand All @@ -688,9 +689,9 @@ func (s *BlockChainAPI) GetProof(ctx context.Context, address common.Address, st
if storageError != nil {
return nil, storageError
}
storageProof[i] = StorageResult{hexKey, (*hexutil.Big)(state.GetState(address, key).Big()), toHexSlice(proof)}
storageProof[i] = StorageResult{keyInt, (*hexutil.Big)(state.GetState(address, key).Big()), toHexSlice(proof)}
} else {
storageProof[i] = StorageResult{hexKey, &hexutil.Big{}, []string{}}
storageProof[i] = StorageResult{keyInt, &hexutil.Big{}, []string{}}
}
}

Expand Down