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.

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

check potential error before Commit #484

Merged
merged 1 commit into from
Mar 11, 2024
Merged

check potential error before Commit #484

merged 1 commit into from
Mar 11, 2024

Conversation

wanwiset25
Copy link
Collaborator

@wanwiset25 wanwiset25 commented Mar 9, 2024

Proposed changes

The StateDB type utilizes a dbErr to track database errors. It is employed by both the consensus core and the VM which are not designed to manage such errors directly.

Errors encountered during database operations are recorded in dbErr using the SetError function. During a Commit, functions like deleteStateObject, updateStateObject, and getStateObject are called based on the current state of stateObject to manage trie node data for deletion, update, or retrieval. If a data node is missing, dbErr is set accordingly.

To avoid committing erroneous state, check the dbErr before performing Commit action.

This issue is raised by the auditing team
ref: https://github.com/ethereum/go-ethereum/pull/21039/files

Types of changes

What types of changes does your code introduce to XDC network?
Put an in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)
  • Regular KTLO or any of the maintaince work. e.g code style
  • CICD Improvement

Impacted Components

Which part of the codebase this PR will touch base on,

Put an in the boxes that apply

  • Consensus
  • Account
  • Network
  • Geth
  • Smart Contract
  • External components
  • Not sure (Please specify below)

Checklist

Put an in the boxes once you have confirmed below actions (or provide reasons on not doing so) that

  • This PR has sufficient test coverage (unit/integration test) OR I have provided reason in the PR description for not having test coverage
  • Provide an end-to-end test plan in the PR description on how to manually test it on the devnet/testnet.
  • Tested the backwards compatibility.
  • Tested with XDC nodes running this version co-exist with those running the previous version.
  • Relevant documentation has been updated as part of this PR
  • N/A

@@ -649,6 +649,10 @@ func (s *StateDB) clearJournalAndRefund() {

// Commit writes the state to the underlying in-memory trie database.
func (s *StateDB) Commit(deleteEmptyObjects bool) (root common.Hash, err error) {
if s.dbErr != nil {
return common.Hash{}, fmt.Errorf("commit aborted due to earlier error: %v", s.dbErr)
}
Copy link
Collaborator

@gzliudan gzliudan Mar 9, 2024

Choose a reason for hiding this comment

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

dbErr does not mean a real error, eg:

func (self *StateDB) GetCodeSize(addr common.Address) int {
	stateObject := self.getStateObject(addr)
	if stateObject == nil {
		return 0
	}
	if stateObject.code != nil {
		return len(stateObject.code)
	}
	size, err := self.db.ContractCodeSize(stateObject.addrHash, common.BytesToHash(stateObject.CodeHash()))
	if err != nil {
		self.setError(err)
	}
	return size
}

The function GetCodeSize set dbErr when the account does not exist, but the return value size 0 is right.

Copy link
Collaborator Author

@wanwiset25 wanwiset25 Mar 9, 2024

Choose a reason for hiding this comment

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

Would account not existing not be an error? I don't know the repo deep enough about this.

In go-ethereum GetCodeSize is handled the same way. Using setError instead of the usual return nil, err pattern.

func (s *StateDB) GetCodeSize(addr common.Address) int {
	stateObject := s.getStateObject(addr)
	if stateObject != nil {
		return stateObject.CodeSize()
	}
	return 0
}
func (s *stateObject) CodeSize() int {
	if s.code != nil {
		return len(s.code)
	}
	if bytes.Equal(s.CodeHash(), types.EmptyCodeHash.Bytes()) {
		return 0
	}
	size, err := s.db.db.ContractCodeSize(s.address, common.BytesToHash(s.CodeHash()))
	if err != nil {
		s.db.setError(fmt.Errorf("can't load code size %x: %v", s.CodeHash(), err))
	}
	return size
}

@wanwiset25 wanwiset25 merged commit 0114eca into dev-upgrade Mar 11, 2024
16 checks passed
wanwiset25 added a commit that referenced this pull request Mar 13, 2024
wanwiset25 added a commit that referenced this pull request Mar 13, 2024
@wanwiset25 wanwiset25 deleted the XCF-06 branch March 20, 2024 09:24
@wanwiset25 wanwiset25 mentioned this pull request May 2, 2024
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants