Warp stapling block context #823

aaronbuchwald · 2023-08-29T18:10:33Z

Why this should be merged

This PR addresses #735 and #734

How this works

This PR creates a predicate results type to encode the per-transaction predicate results into the block header. This is intended to remove the possibility that predicate verification may fail and require dropping the transaction from the mempool/block, which creates a potential DoS vector as per: https://ethresear.ch/t/dos-vectors-in-account-abstraction-aa-or-validation-generalization-a-case-study-in-geth/7937.

Additionally, this PR adds a BlockHashPayload to allow signing a block hash instead of the existing point-to-point AddressedPayload.

To handle the BlockHashPayload this PR adds a new function getVerifiedWarpBlockHash to read the verified block hash and return it to the caller.

How this was tested

Adds new contract execution tests for the block hash payload function
Adds new predicate test for combinations of verifying successful/failed warp messages within a single transaction
Improve vm warp unit test (add testing of traceBlock)
TODO: add unit predicate results serialization tests

How is this documented

TODO: update Warp README

…dicates with gomocks

…ed result

Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org> Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com>

aaronbuchwald · 2023-08-29T18:41:58Z

accounts/abi/bind/precompilebind/precompile_module_template.go

@@ -59,7 +59,7 @@ func (*configurator) MakeConfig() precompileconfig.Config {
 // This function is called by the EVM once per precompile contract activation.
 // You can use this function to set up your precompile contract's initial state,
 // by using the [cfg] config and [state] stateDB.
-func (*configurator) Configure(chainConfig precompileconfig.ChainConfig, cfg precompileconfig.Config, state contract.StateDB, blockContext contract.BlockContext) error {
+func (*configurator) Configure(chainConfig precompileconfig.ChainConfig, cfg precompileconfig.Config, state contract.StateDB, blockContext contract.ConfigurationBlockContext) error {


Can be broken into a separate preparation PR if preferred

aaronbuchwald · 2023-08-29T18:44:16Z

core/predicate_check.go

+	}
+
+	for address, predicates := range predicateArguments {
+		predicate := rules.Predicates[address]


nit: add comment noting that if predicateArguments was populated with this address, then the predicate must be present in rules.Predicates

core/evm.go

ceyonur · 2023-08-30T14:12:04Z

core/predicate_check.go

-			return fmt.Errorf("predicate %s failed verification for tx %s: %w", address, tx.Hash(), err)
-		}
+
+		predicateArguments[address] = append(predicateArguments[address], predicateutils.HashSliceToBytes(accessTuple.StorageKeys))


why do we append those instead of directly verify each predicate here and set the result bit set here instead of VerifyPredicate? I feel like we can save at least 2 loops here.

This was so that the predicate can take in all of the byte slices for the transaction in one call rather than doing it one at a time and return the bit set as a byte slice.

Alternatively, we could switch back to VerifyPredicate taking in a single value and CheckPredicates assembling the bit set from those results. This would make the code a bit simpler at the cost of constraining the precompile predicates to return a true/false value instead of an arbitrary byte array.

I feel like using a single value for VerifyPredicate could be simpler + cleaner (and costs less loops). It would be easier for 3rd party implementations as well.

Could we make this a follow-on PR to try out the alternative?

This also means that we need to track the indices used by each precompile address to create that bitset, so I'm not sure if it will be cleaner.

Created #844

contracts/contracts/interfaces/IWarpMessenger.sol

ceyonur · 2023-09-07T09:08:02Z

core/state/statedb.go

+func (s *StateDB) GetTxHash() common.Hash {
+	return s.thash
+}
+
 // GetPredicateStorageSlots returns the storage slots associated with a given address, and whether or not


add index to comments

Updated the comment on GetPredicateStorageSlots to include an example and added a comment to GetTxHash

ceyonur · 2023-09-07T09:17:11Z

precompile/results/predicate_results.go

+type TxPredicateResults map[common.Address][]byte
+
+// PredicateResults encodes the precompile predicate results included in a block on a per transaction basis.
+// PredicateResults is not thread-safe.


don't we need this to be thread-safe?

We currently only modify this synchronously in the worker and during block verification. It is only read from the EVM when it is either a unique instance or is being used synchronously in the worker. For the APIs that may re-use a block context, they will only perform read operations on an instance that is never modified.

We could make it thread-safe, but I don't think it's necessary atm. Is there a specific case you're concerned about?

ceyonur · 2023-09-07T09:32:17Z

x/warp/contract.go

+	if !warpIndex.IsInt64() {
+		return nil, false
+	}
+	warpIndexInt := int(warpIndex.Int64())


paranoid 🤖: could someone issue a very big int (MaxInt32<x<MaxInt64) and cause this casting to be not lossless (in 32-bit systems)?

ya I'll update the input type to uint32 so that we don't have to do this at all.

ceyonur · 2023-09-07T09:36:04Z

core/state/statedb.go

+	if !exists {
+		return nil, false
+	}
+	if index >= len(predicates) {


should we check if index is negative (or simply require uint64 indexes here)?

this is related to the comment about lossless conversion between int<>int64 below.

…ersion

* Warp stapling block context (#823) * Add GetPredicateResults to BlockContext * Serve predicate results from blockContext * Allow extra data to extend past DynamicFeeWindow post DUpgrade * Get vm warp unit tests working * Bump ANR to intermediate version to fix incompatibility with AvalancheGo * Add kc to EthKeyChain * Bump avalanchego dep in scripts for CI * Add block hash payload support * Use gomocks for precompileconfig and predicater and re-write CheckPredicates with gomocks * Use gomock for mock accessible state and block context * Fix existing warp contract tests with mock block context * Remove unused mockPredicater impl * x/warp: add contract execution unit tests * Update NewEVMBlockContext * Add AppendExtra to syncervm to fix tests * x/warp: add unit test for multiple predicate results * core: add unit test for CheckPredicates insufficient gas * Update receive warp message test to trace block and assert the expected result * Fix lint * Update warp solidity contracts * Fix block context mocks for bench * Update precompile/precompileconfig/config.go Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org> Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com> * Cleanup * precompile/results: Add predicate results tests + comments * nits * precompile/results: omit tx predicate results if empty * core: add invariant comment to predicate check * Address PR comments * Fix unpackWarpMessage and add unit tests * Rename OriginChainID -> SourceChainID to match ago warp message type * nits * x/warp: set public key in warp predicate unit tests * Update payload format * Clarify IWarpMessenger verified message return types * core/state: improve statedb warp specific comments * Update input param type to uint32 to avoid potential overflow on conversion * Update GetPredicateStorageSlots arg type to uint32 * warp/payload: add README for payload serialization (#835) * Fix merge * x/warp: add unit test for PrimaryNetwork to Subnet predicate verification (#831) * precompilebind: add ChainConfig with DUpgrade enabled to precompile chain config verify template

* update npm package * expand allowlist.configure * add activation func to precompile functions * move chainconfig to precompileconfig * use chainconfig in verification * trim unnecessary changes * add manager role * fix tests * add verify test * nits * add mocks * reviews * fix linter * fix benchmarks * nits * nits * fix alow list bind tests & ensure they're being tested (#841) * simplify can modify check * fix vm tests * Add manager allowlist role merge (#850) * Warp stapling block context (#823) * Add GetPredicateResults to BlockContext * Serve predicate results from blockContext * Allow extra data to extend past DynamicFeeWindow post DUpgrade * Get vm warp unit tests working * Bump ANR to intermediate version to fix incompatibility with AvalancheGo * Add kc to EthKeyChain * Bump avalanchego dep in scripts for CI * Add block hash payload support * Use gomocks for precompileconfig and predicater and re-write CheckPredicates with gomocks * Use gomock for mock accessible state and block context * Fix existing warp contract tests with mock block context * Remove unused mockPredicater impl * x/warp: add contract execution unit tests * Update NewEVMBlockContext * Add AppendExtra to syncervm to fix tests * x/warp: add unit test for multiple predicate results * core: add unit test for CheckPredicates insufficient gas * Update receive warp message test to trace block and assert the expected result * Fix lint * Update warp solidity contracts * Fix block context mocks for bench * Update precompile/precompileconfig/config.go Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org> Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com> * Cleanup * precompile/results: Add predicate results tests + comments * nits * precompile/results: omit tx predicate results if empty * core: add invariant comment to predicate check * Address PR comments * Fix unpackWarpMessage and add unit tests * Rename OriginChainID -> SourceChainID to match ago warp message type * nits * x/warp: set public key in warp predicate unit tests * Update payload format * Clarify IWarpMessenger verified message return types * core/state: improve statedb warp specific comments * Update input param type to uint32 to avoid potential overflow on conversion * Update GetPredicateStorageSlots arg type to uint32 * warp/payload: add README for payload serialization (#835) * Fix merge * x/warp: add unit test for PrimaryNetwork to Subnet predicate verification (#831) * precompilebind: add ChainConfig with DUpgrade enabled to precompile chain config verify template

* Add GetPredicateResults to BlockContext * Serve predicate results from blockContext * Allow extra data to extend past DynamicFeeWindow post DUpgrade * Get vm warp unit tests working * Bump ANR to intermediate version to fix incompatibility with AvalancheGo * Add kc to EthKeyChain * Bump avalanchego dep in scripts for CI * Add block hash payload support * Use gomocks for precompileconfig and predicater and re-write CheckPredicates with gomocks * Use gomock for mock accessible state and block context * Fix existing warp contract tests with mock block context * Remove unused mockPredicater impl * x/warp: add contract execution unit tests * Update NewEVMBlockContext * Add AppendExtra to syncervm to fix tests * x/warp: add unit test for multiple predicate results * core: add unit test for CheckPredicates insufficient gas * Update receive warp message test to trace block and assert the expected result * Fix lint * Update warp solidity contracts * Fix block context mocks for bench * Update precompile/precompileconfig/config.go Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org> Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com> * Cleanup * precompile/results: Add predicate results tests + comments * nits * precompile/results: omit tx predicate results if empty * core: add invariant comment to predicate check * Address PR comments * Fix unpackWarpMessage and add unit tests * Rename OriginChainID -> SourceChainID to match ago warp message type * nits * x/warp: set public key in warp predicate unit tests * Update payload format * Clarify IWarpMessenger verified message return types * core/state: improve statedb warp specific comments * Update input param type to uint32 to avoid potential overflow on conversion * Update GetPredicateStorageSlots arg type to uint32 * warp/payload: add README for payload serialization (#835) * Fix merge

* update npm package * expand allowlist.configure * add activation func to precompile functions * move chainconfig to precompileconfig * use chainconfig in verification * trim unnecessary changes * add manager role * fix tests * add verify test * nits * add mocks * reviews * fix linter * fix benchmarks * nits * nits * fix alow list bind tests & ensure they're being tested (#841) * simplify can modify check * fix vm tests * Add manager allowlist role merge (#850) * Warp stapling block context (#823) * Add GetPredicateResults to BlockContext * Serve predicate results from blockContext * Allow extra data to extend past DynamicFeeWindow post DUpgrade * Get vm warp unit tests working * Bump ANR to intermediate version to fix incompatibility with AvalancheGo * Add kc to EthKeyChain * Bump avalanchego dep in scripts for CI * Add block hash payload support * Use gomocks for precompileconfig and predicater and re-write CheckPredicates with gomocks * Use gomock for mock accessible state and block context * Fix existing warp contract tests with mock block context * Remove unused mockPredicater impl * x/warp: add contract execution unit tests * Update NewEVMBlockContext * Add AppendExtra to syncervm to fix tests * x/warp: add unit test for multiple predicate results * core: add unit test for CheckPredicates insufficient gas * Update receive warp message test to trace block and assert the expected result * Fix lint * Update warp solidity contracts * Fix block context mocks for bench * Update precompile/precompileconfig/config.go Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org> Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com> * Cleanup * precompile/results: Add predicate results tests + comments * nits * precompile/results: omit tx predicate results if empty * core: add invariant comment to predicate check * Address PR comments * Fix unpackWarpMessage and add unit tests * Rename OriginChainID -> SourceChainID to match ago warp message type * nits * x/warp: set public key in warp predicate unit tests * Update payload format * Clarify IWarpMessenger verified message return types * core/state: improve statedb warp specific comments * Update input param type to uint32 to avoid potential overflow on conversion * Update GetPredicateStorageSlots arg type to uint32 * warp/payload: add README for payload serialization (#835) * Fix merge * x/warp: add unit test for PrimaryNetwork to Subnet predicate verification (#831) * precompilebind: add ChainConfig with DUpgrade enabled to precompile chain config verify template

aaronbuchwald and others added 24 commits August 20, 2023 14:47

Add GetPredicateResults to BlockContext

058cfdb

Serve predicate results from blockContext

554700c

Allow extra data to extend past DynamicFeeWindow post DUpgrade

3bad5df

Get vm warp unit tests working

9fce19d

Bump ANR to intermediate version to fix incompatibility with AvalancheGo

a593416

Add kc to EthKeyChain

ea17883

Bump avalanchego dep in scripts for CI

1a8ffa1

Add block hash payload support

5c43941

Use gomocks for precompileconfig and predicater and re-write CheckPre…

c526fe1

…dicates with gomocks

Use gomock for mock accessible state and block context

966a8f8

Fix existing warp contract tests with mock block context

d648a97

Remove unused mockPredicater impl

799416f

x/warp: add contract execution unit tests

d45b605

Update NewEVMBlockContext

e6d9d2d

Add AppendExtra to syncervm to fix tests

da51c5b

x/warp: add unit test for multiple predicate results

b7635fd

core: add unit test for CheckPredicates insufficient gas

a306f1e

Update receive warp message test to trace block and assert the expect…

2e935d6

…ed result

Fix lint

994bde5

Update warp solidity contracts

666425a

Fix block context mocks for bench

9131c96

Update precompile/precompileconfig/config.go

dcdd5ae

Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org> Signed-off-by: aaronbuchwald <aaron.buchwald56@gmail.com>

Merge branch 'master' into warp-results-block-stapling

52eb5f1

Cleanup

5cf7b30

aaronbuchwald requested review from anusha-ctrl, ceyonur and darioush as code owners August 29, 2023 18:10

precompile/results: Add predicate results tests + comments

ca98c98

aaronbuchwald commented Aug 29, 2023

View reviewed changes

Merge branch 'master' into warp-stapling-block-context

d3f905f

ceyonur reviewed Aug 30, 2023

View reviewed changes

aaronbuchwald added 2 commits August 30, 2023 15:59

nits

5f2d3c3

x/warp: set public key in warp predicate unit tests

caffa74

darioush mentioned this pull request Aug 31, 2023

Add support for DoCall for AWM #833

Open

Update payload format

27e0ca9

aaronbuchwald requested review from darioush and ceyonur September 1, 2023 14:50

This was referenced Sep 1, 2023

Update Teleporter and contracts with warp changes ava-labs/teleporter#19

Closed

Update relayer to support warp changes ava-labs/awm-relayer#24

Closed

ceyonur mentioned this pull request Sep 6, 2023

Take single predicate in VerifyPredicates #844

Closed

darioush approved these changes Sep 7, 2023

View reviewed changes

ceyonur reviewed Sep 7, 2023

View reviewed changes

minghinmatthewlam mentioned this pull request Sep 8, 2023

Publish WarpBlockHash messages ava-labs/awm-relayer#32

Open

aaronbuchwald added 5 commits September 11, 2023 15:34

Clarify IWarpMessenger verified message return types

c230bf1

core/state: improve statedb warp specific comments

f380b52

Update input param type to uint32 to avoid potential overflow on conv…

e20b025

…ersion

Update GetPredicateStorageSlots arg type to uint32

14576da

warp/payload: add README for payload serialization (#835)

3d51d36

ceyonur approved these changes Sep 12, 2023

View reviewed changes

aaronbuchwald added 2 commits September 12, 2023 12:19

Merge branch 'master' into warp-stapling-block-context

2e5c922

Fix merge

0be3e47

aaronbuchwald merged commit 077e8ca into master Sep 12, 2023
8 checks passed

aaronbuchwald deleted the warp-stapling-block-context branch September 12, 2023 17:10

This was referenced Sep 13, 2023

Avalanche Warp Signing Block Hashes #734

Closed

Add Warp Verification Results to Block instead of using Predicate #735

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Warp stapling block context #823

Warp stapling block context #823

aaronbuchwald commented Aug 29, 2023

aaronbuchwald Aug 29, 2023

aaronbuchwald Aug 29, 2023

ceyonur Aug 30, 2023

aaronbuchwald Aug 30, 2023

ceyonur Sep 5, 2023

aaronbuchwald Sep 6, 2023

ceyonur Sep 6, 2023

ceyonur Sep 7, 2023

aaronbuchwald Sep 12, 2023 •

edited

Loading

ceyonur Sep 7, 2023

aaronbuchwald Sep 11, 2023 •

edited

Loading

ceyonur Sep 7, 2023

aaronbuchwald Sep 11, 2023

ceyonur Sep 7, 2023

Warp stapling block context #823

Warp stapling block context #823

Conversation

aaronbuchwald commented Aug 29, 2023

Why this should be merged

How this works

How this was tested

How is this documented

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

aaronbuchwald Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaronbuchwald Sep 11, 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

aaronbuchwald Sep 12, 2023 •

edited

Loading

aaronbuchwald Sep 11, 2023 •

edited

Loading