WIP: Optimistic ZK Game Contract #11

zobront · 2024-06-04T23:21:55Z

First draft of an Optimistic ZK Contract for the bridge:

Anyone can propose a root without any ZK proof, referencing a past confirmed block to anchor from
Anyone can challenge (in parallel) but once a challenger starts a challenge, only they can continue it
Challengers evenly bisect the range of blocks from the anchor block to the proposed block with their root
The proposer must agree or disagree with the bisections to pinpoint the block of disagreement
Once the block is confirmed, a ZK proof from the challenger settles the game (or it is settled by proposer when challenger runs out of time without a valid proof)
Challengers have up to MAX_GAME_DURATION to complete a challenge (expect 7 days)
Proposers must complete their turns within MAX_PROPOSER_DURATION (expect 3.5 days)

This contract attempts to model a lot of the patterns, types and interfaces of the existing game contracts, which can feel a little clunky in some areas, but works.

This is still a WIP. Sharing here for early feedback.

Note: Pausing work on this contract to focus on implementing the state transition function in the zkVM. After that's done, will come back to it to tackle:

Validate remaining public values going into the SP1 Verifier (blob kzg commitment & l1 block root)
Determine the correct bond amounts (considering ability for proposer to frontrun to steal some bonds)
Test suite (including updating bridge to use new game and validating the full flow with a proof)

packages/contracts-bedrock/src/dispute/OptimisticZKGame.sol

…optimism into zach/optimistic-zk-tests

zobront · 2024-06-06T00:29:44Z

packages/contracts-bedrock/src/dispute/OptimisticZKGame.sol

+        // Validate public values passed to the verifier: The real L1 block root matches the passed l1Root.
+        // @todo verify relevant L1 block root matches _publicValues.l1Root
+
+        // Validate public values passed to the verifier: The real commitment to the blob matches the passed blobKzgCommitment.
+        // @todo access correct kzg commitment to verify against _publicValues.blobKzgCommitment?


After building the STF, come back to finalize these commitments to ensure data is accurate.

zobront · 2024-06-06T00:30:42Z

packages/contracts-bedrock/src/dispute/OptimisticZKGame.sol

+        // Require that the gap between the reference block and the block being proven is less than MAX_BLOCK_GAP.
+        // This is used to avoid attacks where such a large gap is used that the game cannot be completed.
+        if (anchorStateRoot.l2BlockNumber + MAX_BLOCK_GAP < l2BlockNumber()) revert InvalidBlockNumber();


I need to think more about these limits to ensure that up to 7 days later, the necessary data will be available via the EVM to prove against.

* feat: introduce OptimismSuperchainERC20 * fix: contract fixes * feat: add snapshots and semver * test: add supports interface tests * test: add invariant test * feat: add parameters to the RelayERC20 event * fix: typo * fix: from param description * fix: event signature and interface pragma * feat: add initializer * feat: use unstructured storage and OZ v5 * feat: update superchain erc20 interfaces * fix: adapt storage to ERC7201 * test: add initializable OZ v5 test * fix: invariant docs * fix: ERC165 implementation * test: improve superc20 invariant (#11) * fix: gas snapshot --------- Co-authored-by: 0xng <[email protected]> Co-authored-by: Disco <[email protected]>

* chore: configure medusa with basic supERC20 self-bridging (#19) - used --foundry-compile-all to ensure the test contract under `test/properties` is compiled (otherwise it is not compiled and medusa crashes when it can't find it's compiled representation) - set src,test,script to test/properties/medusa to not waste time compiling contracts that are not required for the medusa campaign - used an atomic bridge, which doesnt allow for testing of several of the proposed invariants fix: delete dead code test: give the fuzzer a head start docs: fix properties order test: document & implement assertions 22, 23 and 24 fix: fixes from self-review test: guide the fuzzer a little bit less previously: initial mint, bound on transfer amount: 146625 calls in 200s now: no initial mint, no bound on transfer amount: 176835 calls in 200s it doesn't seem to slow the fuzzer down fix: fixes after lovely feedback by disco docs: merge both documents and categorized properties by their milestone fix: fixes from parti's review fix: feedback from disco fix: feedback from doc refactor: separate state transitions from pure properties docs: update tested properties refactor: move all assertions into properties contract fix: move function without assertions back into handler test: only use assertion mode fix: improve justfile recipie for medusa * feat: halmos symbolic tests (#21) * feat: introduce OptimismSuperchainERC20 * fix: contract fixes * feat: add snapshots and semver * test: add supports interface tests * test: add invariant test * feat: add parameters to the RelayERC20 event * fix: typo * fix: from param description * fix: event signature and interface pragma * feat: add initializer * feat: use unstructured storage and OZ v5 * feat: update superchain erc20 interfaces * fix: adapt storage to ERC7201 * test: add initializable OZ v5 test * fix: invariant docs * fix: ERC165 implementation * test: improve superc20 invariant (#11) * fix: gas snapshot * chore: configure medusa with basic supERC20 self-bridging - used --foundry-compile-all to ensure the test contract under `test/properties` is compiled (otherwise it is not compiled and medusa crashes when it can't find it's compiled representation) - set src,test,script to test/properties/medusa to not waste time compiling contracts that are not required for the medusa campaign - used an atomic bridge, which doesnt allow for testing of several of the proposed invariants * fix: delete dead code * test: give the fuzzer a head start * feat: create suite for sybolic tests with halmos * test: setup and 3 properties with symbolic tests * chore: remove todo comment * docs: fix properties order * test: document & implement assertions 22, 23 and 24 * fix: fixes from self-review * test: guide the fuzzer a little bit less previously: initial mint, bound on transfer amount: 146625 calls in 200s now: no initial mint, no bound on transfer amount: 176835 calls in 200s it doesn't seem to slow the fuzzer down * feat: add property for burn * refactor: remove symbolic address on mint property * refactor: order the tests based on the property id * feat: checkpoint * chore: set xdomain sender on failing test * chore: enhance mocks * Revert "Merge branch 'chore/setup-medusa' into feat/halmos-symbolic-tests" This reverts commit 945d6b6ad265ea5e3790d7ac9c5bf4d6586eb533, reversing changes made to 5dcb3a89252e9e8fa9b54ba9012e714f7cc96395. * refactor: remove symbolic addresses to make all of the test work * chore: remove console logs * feat: add properties file * chore: polish * refactor: enhance test on property 7 using direct try catch (now works) * fix: review comments * refactor: add symbolic addresses on test functions * feat: create halmos toml * chore: polish test contract and mock * chore: update property * refactor: move symbolic folder into properties one * feat: create advanced tests helper contract * refactor: enhance tests using symbolic addresses instead of concrete ones * chore: remove 0 property natspec * feat: add halmos profile and just script * chore: rename symbolic folder to halmos * feat: add halmos commands to justfile * chore: reorder assertions on one test * refactor: complete test property seven * chore: mark properties as completed * chore: add halmos-cheatcodes dependency * chore: rename advancedtest->halmosbase * chore: minimize mocked messenger * chore: delete empty halmos file * chore: revert changes to medusa.json * docs: update changes to PROPERTIES.md from base branch * test: sendERC20 destination fix * chore: natspec fixes --------- Co-authored-by: agusduha <[email protected]> Co-authored-by: 0xng <[email protected]> Co-authored-by: teddy <[email protected]> * test: remaining protocol properties (#26) * test: cross-user fuzzed bridges + actor setup * test: fuzz properties 8 and 9 * test: properties 7 and 25 * fix: implement doc's feedback * test: superc20 tob properties (#27) * chore: add crytic/properties dependency * test: extend protocol properties so it also covers ToB erc20 properties * chore: small linter fixes * docs: update property list * test: handlers for remaining superc20 state transitions * fix: disable ToB properties we are not using and guide the fuzzer a bit more * fix: disable another ToB property not implemented by solady * chore: remove zero-initializations * fix: feedback from disco * chore: separate fuzz campaign tests in guided vs unguided * test: dont revert on successful unguided relay * test: add fuzzed calls to burn and mint * docs: document the separation of fuzz test functions * chore: move the properties file to its own directory * chore: consistently use fuzz_ and property_ + camelcase * chore: fix typo * chore: camelcase for handlers as well * fix: revert change that broke halmos campaign compile :D * test: fuzz non atomic bridging (#31) * test: changed mocked messenger ABI for message sending but kept assertions the same * docs: add new properties 26&27 * test: queue cross-chain messages and test related properties * test: relay random messages from queue and check associated invariants * chore: rename bridge->senderc20 method for consistency with relayerc20 * test: not-yet-deployed supertokens can get funds sent to them * chore: medusa runs forever by default doable since it also handles SIGINTs gracefully * chore: document the reason behind relay zero and send zero inconsistencies * fix: feedback from doc * fix: walk around possible medusa issue I'm getting an 'unknown opcode 0x4e' in ProtocolAtomic constructor when calling the MockL2ToL2CrossDomainMessenger for the first time * test: unguided handler for sendERC20 * fix: feedback from disco * chore: remove halmos testsuite * chore: foundry migration (#40) * chore: track assertion failures this is so foundry's invariant contract can check that an assertion returned false in the handler, while still allowing `fail_on_revert = false` so we can still take full advantage of medusa's fuzzer & coverage reports * fix: explicitly skip duplicate supertoken deployments * chore: remove duplicated PROPERTIES.md file * chore: expose data to foundry's external invariant checker * test: run medusa fuzzing campaign from within foundry * fix: eagerly check for duplicate deployments * fix: feedback from doc * chore: shoehorn medusa campaign into foundry dir structure * chore: remove PROPERTIES.md file * chore: delete medusa config * docs: limited support for subdirectories in test/invariant * chore: rename contracts to be more sneaky about medusa * docs: rewrite invariant docs in a way compliant with autogen scripts * chore: fixes from rebase * fix: cleanup superc20 invariants (#46) * chore: revert modifications from medusa campaign * docs: extra docs on why ForTest contract is required * doc: add list of all supertoken properties * chore: run forge fmt * ci: allow for testfiles to be deleted * fix: run doc autogen script after rebase --------- Co-authored-by: Disco <[email protected]> Co-authored-by: agusduha <[email protected]> Co-authored-by: 0xng <[email protected]>

zobront added 3 commits June 4, 2024 16:14

optimistic zk contract

f423dc5

req statement to revert

b2c6fba

empty test file

10e2068

puma314 reviewed Jun 4, 2024

View reviewed changes

packages/contracts-bedrock/src/dispute/OptimisticZKGame.sol Show resolved Hide resolved

packages/contracts-bedrock/src/dispute/OptimisticZKGame.sol Show resolved Hide resolved

puma314 reviewed Jun 4, 2024

View reviewed changes

packages/contracts-bedrock/src/dispute/OptimisticZKGame.sol Outdated Show resolved Hide resolved

packages/contracts-bedrock/src/dispute/OptimisticZKGame.sol Outdated Show resolved Hide resolved

packages/contracts-bedrock/src/dispute/OptimisticZKGame.sol Outdated Show resolved Hide resolved

zobront added 7 commits June 4, 2024 17:10

fix interface imports

477eb6c

Merge branch 'zach/optimistic-zk' of https://github.com/succinctlabs/…

21be38b

…optimism into zach/optimistic-zk-tests

vkey immutable

6498f07

vkey immutable

541ada1

IBlockDisputeGame interface abstraction

d131cbb

refactor public values

8381ea7

pull general checks out of if blocks

7ed62d1

zobront commented Jun 6, 2024

View reviewed changes

zobront changed the title ~~WIP: Optimistic ZK Contract~~ WIP: Optimistic ZK Game Contract Jun 6, 2024

zobront added 4 commits June 5, 2024 18:06

misc small fixes

2d3f1b8

correct public inputs

c08f1f5

public l2 block num to uint

1d4b1bf

add chain id to public values

edc066b

zobront closed this Jul 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Optimistic ZK Game Contract #11

WIP: Optimistic ZK Game Contract #11

zobront commented Jun 4, 2024 •

edited

Loading

zobront Jun 6, 2024

zobront Jun 6, 2024 •

edited

Loading

WIP: Optimistic ZK Game Contract #11

WIP: Optimistic ZK Game Contract #11

Conversation

zobront commented Jun 4, 2024 • edited Loading

zobront Jun 6, 2024

Choose a reason for hiding this comment

zobront Jun 6, 2024 • edited Loading

Choose a reason for hiding this comment

zobront commented Jun 4, 2024 •

edited

Loading

zobront Jun 6, 2024 •

edited

Loading