enable transient storage feature #4204

millken · 2024-03-25T06:31:24Z

Description

EVM upgrade to v1.13.12
enable transient storage feature
add tests

Type of change

Please delete options that are not relevant.

[] Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
[] Code refactor or improvement
Breaking change (fix or feature that would cause a new or changed behavior of existing functionality)
[] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

make test
[] fullsync
[] Other test (please specify)

Test Configuration:

Firmware version:
Hardware:
Toolchain:
SDK:

Checklist:

[] My code follows the style guidelines of this project
[] I have performed a self-review of my code
[] I have commented my code, particularly in hard-to-understand areas
[] I have made corresponding changes to the documentation
[] My changes generate no new warnings
[] I have added tests that prove my fix is effective or that my feature works
[] New and existing unit tests pass locally with my changes
[] Any dependent changes have been merged and published in downstream modules

millken · 2024-03-26T08:50:30Z

action/protocol/execution/evm/evm.go

@@ -446,6 +448,8 @@ func getChainConfig(g genesis.Blockchain, height uint64, id uint32, getBlockTime
 	}
 	sumatraTimestamp := (uint64)(sumatraTime.Unix())
 	chainConfig.ShanghaiTime = &sumatraTimestamp
+	//todo: enable Cancun
+	chainConfig.CancunTime = &sumatraTimestamp


Need Hardfork cancun time, enable it for test here

use ToBeEnabledHeight

millken · 2024-03-26T08:52:52Z

action/protocol/execution/evm/evmstatedbadapter.go

+
+// Selfdestruct6780 implements EIP-6780
+func (stateDB *StateDBAdapter) Selfdestruct6780(evmAddr common.Address) {
+	//Todo: implement EIP-6780


implemented another PR

millken · 2024-03-26T08:55:48Z

action/protocol/execution/testdata-shanghai/self-destruct.json

        "expectedStatus": 1,
        "hasReturnValue": true,
-        "rawReturnValue": "",
+        "rawReturnValue": "0000000000000000000000000000000000000000000000000000000000000014",


"selfdestruct" has been deprecated. Note that, starting from the Cancun hard fork, the underlying opcode no longer deletes the code and data associated with an account and only transfers its Ether to the beneficiary

this is test for Shanghai EVM, your change should not break the test

sonarcloud · 2024-03-26T09:08:22Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
1.8% Duplication on New Code

See analysis details on SonarCloud

millken · 2024-03-26T09:11:52Z

Makefile

@@ -11,7 +11,7 @@ GOVET=$(GOCMD) vet
 GOBUILD=$(GOCMD) build
 GOINSTALL=$(GOCMD) install
 GOCLEAN=$(GOCMD) clean
-GOTEST=$(GOCMD) test
+GOTEST=GOARCH=amd64 CGO_ENABLED=1 $(GOCMD) test


fix gomonkey error in mac m1

can we fix the test instead of here? this would limit the testing env to amd64 only

codecov · 2024-03-26T09:28:08Z

Codecov Report

Attention: Patch coverage is 73.13433% with 18 lines in your changes are missing coverage. Please review.

Project coverage is 76.78%. Comparing base (e1f0636) to head (06c7dce).
Report is 214 commits behind head on master.

Files	Patch %	Lines
action/protocol/execution/evm/evmstatedbadapter.go	78.94%	10 Missing and 2 partials ⚠️
action/protocol/execution/evm/evm.go	44.44%	5 Missing ⚠️
action/protocol/poll/nativestaking.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4204      +/-   ##
==========================================
+ Coverage   75.38%   76.78%   +1.40%     
==========================================
  Files         303      340      +37     
  Lines       25923    29280    +3357     
==========================================
+ Hits        19541    22483    +2942     
- Misses       5360     5691     +331     
- Partials     1022     1106      +84

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

dustinxie · 2024-03-26T16:03:48Z

.github/workflows/ci.yaml

@@ -25,7 +25,7 @@ jobs:
      - name: Set up Go
        uses: actions/setup-go@v3
        with:
-          go-version: 1.19.12
+          go-version: 1.21.4


is this a must? if we want to upgrade go version, should do in another PR

Yes, go-ethereum has been upgraded to go1.21, we must upgrade too

dustinxie · 2024-03-26T16:38:20Z

action/protocol/execution/evm/evm.go

@@ -225,10 +226,11 @@ func securityDeposit(ps *Params, stateDB vm.StateDB, gasLimit uint64) error {
 		return action.ErrGasLimit
 	}
 	gasConsumed := new(big.Int).Mul(new(big.Int).SetUint64(ps.gas), ps.txCtx.GasPrice)
-	if stateDB.GetBalance(ps.txCtx.Origin).Cmp(gasConsumed) < 0 {
+	gasConsumedUint256 := uint256.NewInt(gasConsumed.Uint64())


gasConsumed := uint256.MustFromBig(new(big.Int).Mul(new(big.Int).SetUint64(ps.gas), ps.txCtx.GasPrice)) as above L203
Uint64() may overflow right?

dustinxie · 2024-03-26T18:23:50Z

action/protocol/execution/evm/evmstatedbadapter.go

+		accessListSnapshot   map[int]*accessList
+		// Transient storage
+		transientStorage           transientStorage
+		transientStorageSnapshot   map[int]transientStorage


this PR has lots of change, and focus on making interface work with Cancun.
let's enable transient storage in another PR

dustinxie · 2024-03-26T18:26:29Z

action/protocol/execution/evm/evmstatedbadapter.go

@@ -234,8 +240,8 @@ func (stateDB *StateDBAdapter) CreateAccount(evmAddr common.Address) {
 }

 // SubBalance subtracts balance from account
-func (stateDB *StateDBAdapter) SubBalance(evmAddr common.Address, amount *big.Int) {
-	if amount.Cmp(big.NewInt(int64(0))) == 0 {
+func (stateDB *StateDBAdapter) SubBalance(evmAddr common.Address, amount *uint256.Int) {


SubBalance(evmAddr common.Address, a256 *uint256.Int) { amount := a256.ToBig()

then no need to change inside the func

dustinxie · 2024-03-26T18:26:46Z

action/protocol/execution/evm/evmstatedbadapter.go

@@ -263,9 +269,9 @@ func (stateDB *StateDBAdapter) SubBalance(evmAddr common.Address, amount *big.In
 }

 // AddBalance adds balance to account
-func (stateDB *StateDBAdapter) AddBalance(evmAddr common.Address, amount *big.Int) {
+func (stateDB *StateDBAdapter) AddBalance(evmAddr common.Address, amount *uint256.Int) {


same as above

dustinxie · 2024-03-26T18:35:09Z

action/protocol/execution/evm/evmstatedbadapter.go

 	}
 	// clears the account balance
-	actBalance := new(big.Int).Set(s.Balance)
+	actBalance := new(uint256.Int).SetBytes(s.Balance.Bytes())


we don't need to change this?

dustinxie · 2024-03-26T18:35:28Z

action/protocol/execution/evm/evmstatedbadapter.go

@@ -447,13 +453,13 @@ func (stateDB *StateDBAdapter) Suicide(evmAddr common.Address) bool {
 		// before calling Suicide, EVM will transfer the contract's balance to beneficiary
 		// need to create a transaction log on successful suicide
 		if stateDB.lastAddBalanceAmount.Cmp(actBalance) == 0 {
-			if stateDB.lastAddBalanceAmount.Cmp(big.NewInt(0)) > 0 {
+			if stateDB.lastAddBalanceAmount.Cmp(common.U2560) > 0 {


no need to change?

dustinxie · 2024-03-26T18:35:38Z

action/protocol/execution/evm/evmstatedbadapter.go

 				from, _ := address.FromBytes(evmAddr[:])
 				stateDB.addTransactionLogs(&action.TransactionLog{
 					Type:      iotextypes.TransactionLogType_IN_CONTRACT_TRANSFER,
 					Sender:    from.String(),
 					Recipient: stateDB.lastAddBalanceAddr,
-					Amount:    stateDB.lastAddBalanceAmount,
+					Amount:    stateDB.lastAddBalanceAmount.ToBig(),


no need to change?

dustinxie · 2024-03-26T18:35:55Z

action/protocol/execution/evm/evmstatedbadapter.go

 	addrHash := hash.BytesToHash160(evmAddr.Bytes())
 	_, ok := stateDB.suicided[addrHash]
 	return ok
 }

 // SetTransientState sets transient storage for a given account
 func (stateDB *StateDBAdapter) SetTransientState(addr common.Address, key, value common.Hash) {
-	log.S().Panic("SetTransientState not implemented")
+	prev := stateDB.GetTransientState(addr, key)


let's do in next PR

dustinxie · 2024-03-26T18:36:35Z

action/protocol/execution/evm/evmstatedbadapter.go

@@ -522,6 +543,8 @@ func (stateDB *StateDBAdapter) Prepare(rules params.Rules, sender, coinbase comm
 	if !rules.IsBerlin {
 		return
 	}
+	// Clear out any leftover from previous executions


dustinxie · 2024-03-26T18:36:43Z

action/protocol/execution/evm/evmstatedbadapter.go

@@ -539,6 +562,9 @@ func (stateDB *StateDBAdapter) Prepare(rules params.Rules, sender, coinbase comm
 	if rules.IsShanghai { // EIP-3651: warm coinbase
 		stateDB.AddAddressToAccessList(coinbase)
 	}
+	// Reset transient storage at the beginning of transaction execution


dustinxie · 2024-03-26T18:37:08Z

action/protocol/execution/evm/evmstatedbadapter.go

+				break
+			}
+		}
+	}


dustinxie · 2024-03-26T18:40:04Z

action/protocol/execution/evm/evmstatedbadapter_test.go

@@ -933,3 +933,45 @@ func TestSortMap(t *testing.T) {
 		require.True(testFunc(t, sm))
 	})
 }
+
+func TestStateDBTransientStorage(t *testing.T) {


dustinxie · 2024-03-26T18:41:59Z

blockindex/contractstaking/indexer_test.go

@@ -986,8 +986,8 @@ func TestContractStakingIndexerVotes(t *testing.T) {
 		d2Bts, err := indexer.BucketsByCandidate(delegate2, height)
 		r.NoError(err)
 		r.Len(d2Bts, 2)
-		slices.SortFunc(d2Bts, func(i, j *staking.VoteBucket) bool {
-			return i.Index < j.Index
+		slices.SortFunc(d2Bts, func(i, j *staking.VoteBucket) int {


why need to change these?

dustinxie · 2024-03-26T18:42:15Z

e2etest/contract_staking_test.go

@@ -2140,8 +2140,8 @@ func stake(lsdABI abi.ABI, bc blockchain.Blockchain, sf factory.Factory, dao blo
 	r.EqualValues(iotextypes.ReceiptStatus_Success, receipts[0].Status)
 	buckets, err := indexer.Buckets(blk.Height())
 	r.NoError(err)
-	slices.SortFunc(buckets, func(i, j *contractstaking.Bucket) bool {
-		return i.Index < j.Index
+	slices.SortFunc(buckets, func(i, j *contractstaking.Bucket) int {


why need to change these?

dustinxie · 2024-03-26T22:40:48Z

action/protocol/execution/evm/evm_test.go

@@ -347,8 +347,8 @@ func TestConstantinople(t *testing.T) {
 		require.Equal(isSumatra, chainRules.IsShanghai)

 		// Cancun, Prague not yet enabled
-		require.False(evmChainConfig.IsCancun(evm.Context.Time))
-		require.False(evmChainConfig.IsPrague(evm.Context.Time))
+		require.False(evmChainConfig.IsCancun(big.NewInt(0), evm.Context.Time))


what is the first input?

millken requested review from CoderZhi, dustinxie, Liuhaai, envestcc and a team as code owners March 25, 2024 06:31

millken marked this pull request as draft March 25, 2024 09:18

millken marked this pull request as ready for review March 25, 2024 12:49

millken marked this pull request as draft March 25, 2024 12:52

millken added 5 commits March 26, 2024 16:14

rebase master

d32d6a4

save work before mockgen

993af7e

fix revert snapshot

b3f9886

fix revert snapshot

cc47be6

add eip1153 tests in cancun EVM

967ef81

millken force-pushed the issue4177 branch from fc78b2f to 967ef81 Compare March 26, 2024 08:46

code rebase master and fix conflict

cb6d08c

millken commented Mar 26, 2024

View reviewed changes

update golang version to go1.21.4

06c7dce

millken commented Mar 26, 2024

View reviewed changes

dustinxie reviewed Mar 26, 2024

View reviewed changes

action/protocol/execution/evm/evmstatedbadapter.go

break

}

}

}

Copy link

Member

dustinxie Mar 26, 2024

Choose a reason for hiding this comment

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

in next PR

dustinxie reviewed Mar 26, 2024

View reviewed changes

millken closed this Mar 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

enable transient storage feature #4204

enable transient storage feature #4204

millken commented Mar 25, 2024

millken Mar 26, 2024 •

edited

Loading

dustinxie Mar 26, 2024

millken Mar 26, 2024

millken Mar 26, 2024

dustinxie Mar 26, 2024

sonarcloud bot commented Mar 26, 2024

millken Mar 26, 2024

dustinxie Mar 26, 2024

codecov bot commented Mar 26, 2024

dustinxie Mar 26, 2024

millken Mar 27, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

dustinxie Mar 26, 2024

enable transient storage feature #4204

enable transient storage feature #4204

Conversation

millken commented Mar 25, 2024

Description

Type of change

How Has This Been Tested?

Checklist:

millken Mar 26, 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

sonarcloud bot commented Mar 26, 2024

Quality Gate passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Mar 26, 2024

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

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

millken Mar 26, 2024 •

edited

Loading