[WIP] OP Fault Proof Dispute Game implementation for op-verifier and op-gateway #36

Chomtana · 2024-03-20T08:57:38Z

On March 19, 2024, Optimism initiated a significant upgrade on the Optimism Sepolia network to introduce a fault-proof system. Unfortunately, this upgrade broke the functionality of the op-verifier and op-gateway components of the ENS EVM Gateway. Below is an overview of the upgrade's key points.

The L2OutputOracle is being entirely removed and replaced by the OptimismPortal and DisputeGameFactory. The L2OutputOracle smart contract is currently used by the trusted Proposer role to store L2 state output proposals. Presently, developers use these outputs to prove that their withdrawals actually happened on L2. But with fault proofs, developers will have to change how their client software proves withdrawals in the first step of the two-step withdrawal process.

Reference: https://docs.optimism.io/builders/notices/fp-changes#overview-of-changes

You can see proof on Etherscan that L2OutputOracle has ceased on Optimism Sepolia: https://sepolia.etherscan.io/address/0x90E9c4f8a994a250F6aEfd61CAFb4F2e895D458F

Despite the lack of documentation on upgrading from L2OutputOracle to DisputeGameFactory, we have reverse-engineered the Optimism code and implemented the necessary upgrades to the op-verifier and op-gateway in this pull request. Here is a summary of the changes introduced:

L2OutputOracle	DisputeGameFactory
l2OutputIndex	disputeGameIndex
getL2Output(...)	gameAtIndex(...)
outputRoot	gameProxy.rootClaim().raw()
latestOutputIndex()	gameCount() + findLatestGames(...)
outputProposal.l2BlockNumber	disputeGame.l2BlockNumber()

To facilitate a smooth transition, it's crucial to incorporate an activation point system into the op-verifier smart contract. Moreover, to ensure our gateway remains adaptable to future updates, the op-verifier contract should be designed with an upgradeable pattern. However, it's been observed that the EVM Gateway is intended to be immutable, leading us to forego these enhancements for the EVM Gateway. Should you be interested in exploring the implementation of an activation point or an upgradeable smart contract, please let us know.

We have already applied the upgradeable design pattern to all contracts within our Opti.Domains CCIP Gateway and plan to introduce an activation point to our Opti.Domains CCIP Gateway shortly. This approach will enable us to upgrade without disrupting the user experience.

The source code for Opti.Domains CCIP Gateway is available at: https://github.com/Opti-domains/optidomains-ccip-contracts

The Opti.Domains team is eager to continue contributing to developing and maintaining the Optimism verifier and gateway implementations.

The integration of the fault-proof system is scheduled to merge into the Optimism Mainnet in Q3 2024.

Note: This is a work in progress and is not fully tested.

Add indentation Co-authored-by: Nick Johnson <arachnid@notdot.net>

Arachnid

Thank you again for putting this together!

arb-gateway/README.md

op-gateway/src/OPDisputeGameProofService.ts

Arachnid · 2024-03-26T11:03:50Z

op-verifier/contracts/OPDisputeGameVerifier.sol

+import { StateProof, EVMProofHelper } from "@ensdomains/evm-verifier/contracts/EVMProofHelper.sol";
+import { Types } from "@eth-optimism/contracts-bedrock/src/libraries/Types.sol";
+import { Hashing } from "@eth-optimism/contracts-bedrock/src/libraries/Hashing.sol";
+import "./interfaces/IDisputeGame.sol";


Are these published anywhere under @eth-optimism?

Published on https://www.npmjs.com/package/@eth-optimism/contracts-bedrock

Will change to use @eth-optimism/contracts-bedrock

I'm facing Error HH411: The library src, imported from @eth-optimism/contracts-bedrock/src/dispute/interfaces/IDisputeGame.sol, is not installed. Try installing it using npm. due to they have migrated to use foundry absolute import path.

I have asked at NomicFoundation/hardhat#5049 but no answer yet

op-verifier/contracts/OPDisputeGameVerifier.sol

Arachnid · 2024-04-03T08:42:05Z

Please let me know when this is ready for review again!

Chomtana · 2024-04-04T19:29:50Z

It should be ready to review. However, let's review this sub PR first: #37

Test domain name: disputegame.eth
Name hash: 0x438bfe3fc990665148f8ac1638323ab84054a5c22a1ab61fe63cebc3040129cb
DNS encoded: 0x0b6469737075746567616d650365746800
L1 Resolver: https://sepolia.etherscan.io/address/0x4fAA6228c0EACE916d734F76B56551770176E7D9
Gateway: https://op-gateway-worker.optidomains.workers.dev/{sender}/{data}.json
L2 Resolver: https://sepolia-optimism.etherscan.io/address/0xF079f2A30f3c797f8e6920ad783b74846a9acBf4#readContract
L2 Resolver Factory: https://sepolia-optimism.etherscan.io/address/0x13950e8d21fc50c02036e0152d77df692fc8edfa

crosschain-resolver/contracts/L1Resolver.sol

Arachnid · 2024-04-09T09:03:57Z

op-gateway/src/OPDisputeGameProofService.ts

+        50
+      );
+
+    const timestampNow = Math.floor(Date.now() / 1000);


Instead of relying on the local time, we should probably get the latest blocktime.

Arachnid · 2024-04-09T09:04:41Z

op-gateway/src/OPDisputeGameProofService.ts

+    const games: FindLatestGamesResult[] =
+      await this.disputeGameFactory.findLatestGames(
+        respectedGameType,
+        gameCount - 1,
+        50
+      );
+
+    const timestampNow = Math.floor(Date.now() / 1000);
+    let disputeGameIndex = -1;
+    let disputeGameLocalIndex = -1;
+
+    for (let i = 0; i < games.length; i++) {
+      if (timestampNow - Number(games[i].timestamp) >= this.delay) {
+        disputeGameIndex = Number(games[i].index);
+        disputeGameLocalIndex = i;
+        break;
+      }
+    }
+
+    if (disputeGameIndex == -1) throw new Error('Game Not Found');


This should probably be refactored into a method called something like findDisputeGame.

Arachnid · 2024-04-09T09:05:44Z

op-gateway/src/OPDisputeGameProofService.ts

+      gameType != respectedGameType ||
+      timestamp != games[disputeGameLocalIndex].timestamp
+    ) {
+      throw new Error('Mismatched Game Data');


Can you please define classes for the various errors being thrown here, so callers can identify them?

Arachnid · 2024-04-09T09:08:39Z

op-gateway/src/index.ts

-export type OPGateway = EVMGateway<OPProvableBlock>;
+export type OPGateway = EVMGateway<
+  OPProvableBlock | OPDisputeGameProvableBlock
+>;

 export async function makeOPGateway(


Given that the third argument depends on the type of service - it's either an L2OutputOracle or a DisputeGameFactory, I'm not sure it makes sense to have this distinction here. Two separate functions might be clearer.

Arachnid · 2024-04-09T09:09:22Z

op-gateway/src/server.ts

+    'number of delay to use (in minutes for DisputeGame)',
+    '5'
+  )
+  .option('-t, --type <number>', '0 - L2OutputOracle, 1 - DisputeGame', '1');


version, perhaps? Or better yet accept two different arguments, to supply either the L2OutputOracle or DisputeGameFactory and choose the implementation on that basis.

I'm thinking to have a separate path prefix like /v1 for L2OutputOracle, /v2 for DisputeGameFactory and /vN for future upgrades. This would allow old immutable OPVerifier contract to continue working after the gateway upgrade.

Do OP expect to continue to operate the old contracts on the same network once the new ones are deployed?

We can do it in a simpler way by passing OptimismPortalProxy address instead of either L2OutputOracle or DisputeGameFactory

OptimismPortal can resolve to l2Oracle only on the old contract

OptimismPortal can resolve to disputeGameFactory only on the new contract (Because old method is replaced by spacer_54_0_20)

This make it possible to automatically determine whether OP is using an new or old implementation

Arachnid · 2024-04-09T09:11:00Z

op-verifier/contracts/OPDisputeGameVerifier.sol

+    Types.OutputRootProof outputRootProof;
+}
+
+// https://docs.optimism.io/builders/notices/fp-changes#overview-of-changes


Some context for this comment would be good.

Arachnid · 2024-04-09T09:12:38Z

op-verifier/contracts/OPDisputeGameVerifier.sol

+        }
+
+        if (block.timestamp - gameCreationTime < disputeGameDelay) {
+            revert GameTooEarly(opData.disputeGameIndex);


Perhaps you can include the age and the minimum age in this error?

Chomtana · 2024-04-09T11:02:24Z

Hi @Arachnid following #37 I have made a PR to ccip-read to patch REDACTED case that https://ccip-v2.ens.xyz is sending as a sender. It would be great if we can get this merged and published to the NPM registry so that ENS UI can work with this gateway implementation correctly.

Chomtana · 2024-04-10T17:28:42Z

I have pushed a temporary fix for Cloudflare "The script will never generate a response". It works with the official ENS UI after deploying this fix.

This removes the use of the app global variables. Changing global variable to server will not resolve this issue; we need to completely avoid using global variables.

However, this is not a good fix. We need to think of a more elegant way.

* Add crosschain resolver details * Updated @ensdomains/ens-contracts ensdomains/ens-contracts#feature/crosschain-resolver-with-reverse-registrar to the latest commit * Change slot * Add ReverseRegistrar deployment details * Update reverse registrar deployed addresses * Add Op sepolia reverse registrar deployment info * Added L1Resolver contract deployment details * Remove comment out * Add bun.lockb * Update bun.lockb * Change ens- ontracts to point to l2-deployment branch * Fix failing test * Update bun.lockb * Add L2ReverseRegistrar to deps.sol on crosschain-resolver (was throwing error) * Fix failing test * Remove unused subheader * Redeploy base l1 resolver * Update README.md * Added Base Reverse Resolver contract address * Add Arbitrum Reverse Resolver deployement * Redeploy ArbL1ReverseResolver with correct L2 Resolver Address * Redeploy l2 contracts with official reverse record namespace (cointype.reverse) * Sepolia resolvers with analytics (ensdomains#30) * WIP * Fix errors * Ignore favicon * Update bun.lockb * Fix lint error * Update gateway url * Add console.log * Changed endpoint * Update apiEndpoint * Add sender and calldata to props * Move Tracker to evm-gateway * Revert "Move Tracker to evm-gateway" This reverts commit 5d3ba37. * WIP * Downgrade to 4.20231121.0 * Bump it to the latest * Add type * Replace tracker with @ensdomains/server-analytics * Pass custom apiEndpoint and props * Add GATEWAY_DOMAIN and ENDPOINT_URL * Point to correct branch * Fix CORS problem * Add gateway log tracker to OP * Fix lint error * Update readme * Default reverse resolver (ensdomains#33) * Change ens-contracts to use default-reverse-resolver * Add suport for DefaultReverseResolver * Add hexToAddress to extract address * Add faulback to name function * Add fallback for text * Use imported IDefaultReverseResolver * Update bun.lockb and README * Update comment * Move DefaultReverseResolver * Add DefaultReverseResolver * Update bun.lockb * Add support for resolve on DefaultReverseResolver * Deployed new contracts * Add setdefaultname * Update README.md * Update README.md * Remove console.log * Point to default-reverse-resolver-2 * Reswitch to default-reverse-resolver * Update bun.ockb * Add whitespace * Check if invalid address * Override .text * Fix TypeError: ambiguous function error * Re-point to default-reverse-resolver * Added wait * Update storage location after removing Owner * Added wait on crosschain resolver * Use L2ReverseRevolver and fix broken test * Update ens-contracts branch * Eip 5559 support (ensdomains#34) * Add IResolverSetter * Simplify metadata function * Fix failing tests * Add test for EIP 5559 * Added wait * Rename from IResolverSetter to IAddrSetter * Add resolveDeferral * Store chainId directly * Rename from resolveDeferral to setAddr

Chomtana · 2024-04-11T17:03:37Z

Should I merge this PR: #34 before continuing the development?

Arachnid · 2024-04-12T10:46:31Z

That PR is now merged, so please go ahead.

Can you explain why you think the global variable is causing your issue with REDACTED? This seems to be purely a logging issue and not anything that affects the actual operation of the service.

Chomtana · 2024-04-12T12:14:39Z

As per my temporary fix, I have commented server global variable and rebuilt server instance on each request and it fix the issue.

Also this blog: https://zuplo.com/blog/2022/03/04/the-script-will-never-generate-a-response suggests a similar cause about the use of global variables.

Arachnid · 2024-04-12T12:31:01Z

This is strange, because app/server isn't a promise here, it's a lazily initialized variable. The longer-term solution, however, is likely to be optimizing imports so that we don't hit the startup time limit in the first place.

…ttps://github.com/ensdomains/evmgateway into op-fault-proof

Chomtana · 2024-05-03T03:59:42Z

I'm assuming I should start over from the main branch and incorporate diff...

Arachnid · 2024-05-03T09:22:02Z

Yes please!

Chomtana · 2024-05-21T17:46:15Z

@Arachnid I have updated the implementation in #45

makoto and others added 30 commits October 20, 2023 17:49

Make testResolver work

0971ed6

Update bun.lockb

383f29a

Add coinType

88dc259

Make text record work

8a58674

Add hardhat-storage-layout

8cb5256

Use the real Resolver contracts

641e15b

Add contenthash

914c66e

Add comment

9a1a74d

Update README

9a386ea

Change the license to ENS labs

db89d14

Remove console.log

805b218

Add an explanation

757d787

typo

93ef4b7

Remove L1Verifier.sol

b3141e5

Remove L1Verifier.sol

80292c4

Rename test

0a227de

Add hardhat-deploy

7f086ce

Add deployment script

749ccd0

Remove deployment addresses

6c9f241

Merge branch 'crosschain-resolver' into crosschain-resolver-deployment

4871812

Apply suggestions from code review

50d48b6

Add indentation Co-authored-by: Nick Johnson <arachnid@notdot.net>

Add immutable and constants

84dd082

Remove getStatic

40be600

Fix the wrong constants

415392b

Merge branch 'main' into crosschain-resolver

7987695

Update bun.lockb

507bfb4

Remove contracts-bedrock

0ee53c8

Update bun.lockb

574297d

Add bun

3e49356

Remove package-lock.json

98adc6e

Arachnid requested changes Mar 26, 2024

View reviewed changes

upnodedev and others added 4 commits March 30, 2024 23:50

fix installation and build error

2970ab7

add findLatestGames abi

a61ad78

implement dispute game resolution with findLatestGames

093a4d3

Implement game challenged check

dede9d1

Chomtana added 6 commits April 3, 2024 19:48

OP Dispute Game verifier deployment and test

d0fa379

cleanup

45b8c45

deploy cloudflare worker

f12c91e

deploy cross chain resolver

fabb68c

fix typo proving

f30d431

Add delay check to op verifier

d381541

Chomtana marked this pull request as ready for review April 6, 2024 08:37

Arachnid requested changes Apr 9, 2024

View reviewed changes

Temporary fix for cloudflare "The script will never generate a response"

985da03

Chomtana force-pushed the op-fault-proof branch from 97522cf to 985da03 Compare April 10, 2024 17:22

Chomtana mentioned this pull request Apr 10, 2024

Handle REDACTED sender address smartcontractkit/ccip-read#33

Closed

Merge branch 'feature/crosschain-resolver-with-reverse-registrar' of h…

673099a

…ttps://github.com/ensdomains/evmgateway into op-fault-proof

Chomtana mentioned this pull request May 21, 2024

Optimism Dispute Game Support #45

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] OP Fault Proof Dispute Game implementation for op-verifier and op-gateway #36

[WIP] OP Fault Proof Dispute Game implementation for op-verifier and op-gateway #36

Chomtana commented Mar 20, 2024 •

edited

Arachnid left a comment

Arachnid Mar 26, 2024

Chomtana Mar 27, 2024

Chomtana Apr 4, 2024

Arachnid commented Apr 3, 2024

Chomtana commented Apr 4, 2024

Arachnid Apr 9, 2024

Arachnid Apr 9, 2024

Arachnid Apr 9, 2024

Arachnid Apr 9, 2024

Arachnid Apr 9, 2024

Chomtana Apr 10, 2024

Arachnid Apr 12, 2024

Chomtana May 8, 2024

Arachnid Apr 9, 2024

Arachnid Apr 9, 2024

Chomtana commented Apr 9, 2024

Chomtana commented Apr 10, 2024

Chomtana commented Apr 11, 2024

Arachnid commented Apr 12, 2024

Chomtana commented Apr 12, 2024

Arachnid commented Apr 12, 2024

Chomtana commented May 3, 2024

Arachnid commented May 3, 2024

Chomtana commented May 21, 2024

[WIP] OP Fault Proof Dispute Game implementation for op-verifier and op-gateway #36

Are you sure you want to change the base?

[WIP] OP Fault Proof Dispute Game implementation for op-verifier and op-gateway #36

Conversation

Chomtana commented Mar 20, 2024 • edited

Arachnid left a 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

Arachnid commented Apr 3, 2024

Chomtana commented Apr 4, 2024

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

Chomtana commented Apr 9, 2024

Chomtana commented Apr 10, 2024

Chomtana commented Apr 11, 2024

Arachnid commented Apr 12, 2024

Chomtana commented Apr 12, 2024

Arachnid commented Apr 12, 2024

Chomtana commented May 3, 2024

Arachnid commented May 3, 2024

Chomtana commented May 21, 2024

Chomtana commented Mar 20, 2024 •

edited