From cc1f054632d304a57d50e33b017d5bc4ccae9679 Mon Sep 17 00:00:00 2001 From: Roy Crihfield Date: Tue, 30 Aug 2022 09:48:12 -0500 Subject: [PATCH] Improve logging on failure --- pkg/validator.go | 7 ++++--- pkg/validator_test.go | 14 ++++++++++++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/pkg/validator.go b/pkg/validator.go index 6a793f5..63b282b 100644 --- a/pkg/validator.go +++ b/pkg/validator.go @@ -166,7 +166,7 @@ func (v *Validator) Close() error { return nil } -// Traverses each iterator in a separate goroutine. +// Traverses one iterator fully // If storage = true, also traverse storage tries for each leaf. func (v *Validator) iterate(it trie.NodeIterator, storage bool) error { // Iterate through entire state trie. it.Next() will return false when we have @@ -193,18 +193,19 @@ func (v *Validator) iterate(it trie.NodeIterator, storage bool) error { addrHash := common.BytesToHash(it.LeafKey()) _, err := v.stateDatabase.ContractCode(addrHash, common.BytesToHash(account.CodeHash)) if err != nil { - return fmt.Errorf("code %x: %v", account.CodeHash, err) + return fmt.Errorf("code %x: %w (path %x)", account.CodeHash, err, nodeiter.HexToKeyBytes(it.Path())) } } for dataIt.Next(true) { } if dataIt.Error() != nil { - return dataIt.Error() + return fmt.Errorf("data iterator error (path %x): %w", nodeiter.HexToKeyBytes(dataIt.Path()), dataIt.Error()) } } return it.Error() } +// Traverses each iterator in a separate goroutine, dumping to a recovery file on failure. Handles signals func iterateTracked(tree state.Trie, recoveryFile string, iterCount uint, fn func(trie.NodeIterator) error) error { ctx, cancelCtx := context.WithCancel(context.Background()) tracker := tracker.New(recoveryFile, iterCount) diff --git a/pkg/validator_test.go b/pkg/validator_test.go index d48e950..da7cc24 100644 --- a/pkg/validator_test.go +++ b/pkg/validator_test.go @@ -68,6 +68,7 @@ var ( mockCode = []byte{1, 2, 3, 4, 5} codeHash = crypto.Keccak256Hash(mockCode) + codePath = common.Hex2Bytes("6114658a74d9cc9f7acf2c5cd696c3494d7c344d78bfec3add0d91ec4e8d1c45") contractAccount, _ = rlp.EncodeToBytes(&types.StateAccount{ Nonce: 1, Balance: big.NewInt(0), @@ -190,6 +191,9 @@ var ( storageBranchRootNode, slot1StorageLeafNode, } + + missingStateNodePath = common.Hex2Bytes("0e") + missingStorageNodePath = common.Hex2Bytes("02") ) var ( @@ -236,19 +240,25 @@ var _ = Describe("PG-IPFS Validator", func() { err = v.ValidateTrie(stateRoot) Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("missing trie node")) + pathSubStr := fmt.Sprintf("path %x", missingStateNodePath) + Expect(err.Error()).To(ContainSubstring(pathSubStr)) }) It("Returns an error if the storage trie is missing node(s)", func() { loadTrie(append(trieStateNodes, mockCode), missingNodeStorageNodes) err = v.ValidateTrie(stateRoot) Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("missing trie node")) + pathSubStr := fmt.Sprintf("path %x", missingStorageNodePath) + Expect(err.Error()).To(ContainSubstring(pathSubStr)) }) It("Returns an error if contract code is missing", func() { loadTrie(trieStateNodes, trieStorageNodes) err = v.ValidateTrie(stateRoot) Expect(err).To(HaveOccurred()) - subStr := fmt.Sprintf("code %s: not found", codeHash.Hex()[2:]) - Expect(err.Error()).To(ContainSubstring(subStr)) + codeSubStr := fmt.Sprintf("code %s: not found", codeHash.Hex()[2:]) + Expect(err.Error()).To(ContainSubstring(codeSubStr)) + pathSubStr := fmt.Sprintf("path %x", codePath) + Expect(err.Error()).To(ContainSubstring(pathSubStr)) }) It("Returns no error if the entire state (state trie and storage tries) can be validated", func() { loadTrie(append(trieStateNodes, mockCode), trieStorageNodes)