-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cleanups for production, add standard addresses (#12169)
* Cleanups for production, add standard addresses This PR: - Cleans up the intent file to be more suitable for production deployments - Fixes various bugs encountered while preparing `op-deployer` for use against predeployed OPCM contracts - Adds a new CLI command to bootstrap a new OPCM deployment against an existing set of implementation contracts Note on Solidity changes: - Since the code for custom gas tokens is in the monorepo but isn't included in an official contracts release yet, we had to add interfaces for the pre-CGT contracts to the Solidity codebase. - The `DeployImplementations` script looks at the release identifier to determine whether or not it should use the pre- or post-CGT interfaces. * goimports * lints * fix tests * revert tx manger changes * Update packages/contracts-bedrock/src/L1/interfaces/IL1StandardBridgeV160.sol Co-authored-by: Maurelian <john@oplabs.co> * Update packages/contracts-bedrock/src/L1/interfaces/IL1CrossDomainMessengerV160.sol Co-authored-by: Maurelian <john@oplabs.co> * use new opcm * fix test * semver * semver * bump semver * update manager deployment * natspec * SEMVER --------- Co-authored-by: Maurelian <john@oplabs.co>
- Loading branch information
Showing
28 changed files
with
595 additions
and
185 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| package bootstrap | ||
|
|
||
| import ( | ||
| "context" | ||
| "crypto/ecdsa" | ||
| "crypto/rand" | ||
| "fmt" | ||
| "math/big" | ||
| "strings" | ||
|
|
||
| "github.com/ethereum-optimism/optimism/op-chain-ops/deployer" | ||
| "github.com/ethereum-optimism/optimism/op-chain-ops/deployer/opcm" | ||
| "github.com/ethereum-optimism/optimism/op-chain-ops/deployer/pipeline" | ||
| "github.com/ethereum-optimism/optimism/op-chain-ops/deployer/state" | ||
| "github.com/ethereum-optimism/optimism/op-chain-ops/script" | ||
| opcrypto "github.com/ethereum-optimism/optimism/op-service/crypto" | ||
| "github.com/ethereum-optimism/optimism/op-service/ctxinterrupt" | ||
| "github.com/ethereum-optimism/optimism/op-service/ioutil" | ||
| "github.com/ethereum-optimism/optimism/op-service/jsonutil" | ||
| oplog "github.com/ethereum-optimism/optimism/op-service/log" | ||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/core/types" | ||
| "github.com/ethereum/go-ethereum/crypto" | ||
| "github.com/ethereum/go-ethereum/ethclient" | ||
| "github.com/ethereum/go-ethereum/log" | ||
| "github.com/urfave/cli/v2" | ||
| ) | ||
|
|
||
| type OPCMConfig struct { | ||
| L1RPCUrl string | ||
| PrivateKey string | ||
| Logger log.Logger | ||
| ArtifactsURL *state.ArtifactsURL | ||
| ContractsRelease string | ||
|
|
||
| privateKeyECDSA *ecdsa.PrivateKey | ||
| } | ||
|
|
||
| func (c *OPCMConfig) Check() error { | ||
| if c.L1RPCUrl == "" { | ||
| return fmt.Errorf("l1RPCUrl must be specified") | ||
| } | ||
|
|
||
| if c.PrivateKey == "" { | ||
| return fmt.Errorf("private key must be specified") | ||
| } | ||
|
|
||
| privECDSA, err := crypto.HexToECDSA(strings.TrimPrefix(c.PrivateKey, "0x")) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to parse private key: %w", err) | ||
| } | ||
| c.privateKeyECDSA = privECDSA | ||
|
|
||
| if c.Logger == nil { | ||
| return fmt.Errorf("logger must be specified") | ||
| } | ||
|
|
||
| if c.ArtifactsURL == nil { | ||
| return fmt.Errorf("artifacts URL must be specified") | ||
| } | ||
|
|
||
| if c.ContractsRelease == "" { | ||
| return fmt.Errorf("contracts release must be specified") | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func OPCMCLI(cliCtx *cli.Context) error { | ||
| logCfg := oplog.ReadCLIConfig(cliCtx) | ||
| l := oplog.NewLogger(oplog.AppOut(cliCtx), logCfg) | ||
| oplog.SetGlobalLogHandler(l.Handler()) | ||
|
|
||
| l1RPCUrl := cliCtx.String(deployer.L1RPCURLFlagName) | ||
| privateKey := cliCtx.String(deployer.PrivateKeyFlagName) | ||
| artifactsURLStr := cliCtx.String(ArtifactsURLFlagName) | ||
| artifactsURL := new(state.ArtifactsURL) | ||
| if err := artifactsURL.UnmarshalText([]byte(artifactsURLStr)); err != nil { | ||
| return fmt.Errorf("failed to parse artifacts URL: %w", err) | ||
| } | ||
| contractsRelease := cliCtx.String(ContractsReleaseFlagName) | ||
|
|
||
| ctx := ctxinterrupt.WithCancelOnInterrupt(cliCtx.Context) | ||
|
|
||
| return OPCM(ctx, OPCMConfig{ | ||
| L1RPCUrl: l1RPCUrl, | ||
| PrivateKey: privateKey, | ||
| Logger: l, | ||
| ArtifactsURL: artifactsURL, | ||
| ContractsRelease: contractsRelease, | ||
| }) | ||
| } | ||
|
|
||
| func OPCM(ctx context.Context, cfg OPCMConfig) error { | ||
| if err := cfg.Check(); err != nil { | ||
| return fmt.Errorf("invalid config for OPCM: %w", err) | ||
| } | ||
|
|
||
| lgr := cfg.Logger | ||
| progressor := func(curr, total int64) { | ||
| lgr.Info("artifacts download progress", "current", curr, "total", total) | ||
| } | ||
|
|
||
| artifactsFS, cleanup, err := pipeline.DownloadArtifacts(ctx, cfg.ArtifactsURL, progressor) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to download artifacts: %w", err) | ||
| } | ||
| defer func() { | ||
| if err := cleanup(); err != nil { | ||
| lgr.Warn("failed to clean up artifacts", "err", err) | ||
| } | ||
| }() | ||
|
|
||
| l1Client, err := ethclient.Dial(cfg.L1RPCUrl) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to connect to L1 RPC: %w", err) | ||
| } | ||
|
|
||
| chainID, err := l1Client.ChainID(ctx) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get chain ID: %w", err) | ||
| } | ||
| chainIDU64 := chainID.Uint64() | ||
|
|
||
| superCfg, err := opcm.SuperchainFor(chainIDU64) | ||
| if err != nil { | ||
| return fmt.Errorf("error getting superchain config: %w", err) | ||
| } | ||
| standardVersionsTOML, err := opcm.StandardVersionsFor(chainIDU64) | ||
| if err != nil { | ||
| return fmt.Errorf("error getting standard versions TOML: %w", err) | ||
| } | ||
| opcmProxyOwnerAddr, err := opcm.ManagerOwnerAddrFor(chainIDU64) | ||
| if err != nil { | ||
| return fmt.Errorf("error getting superchain proxy admin: %w", err) | ||
| } | ||
|
|
||
| signer := opcrypto.SignerFnFromBind(opcrypto.PrivateKeySignerFn(cfg.privateKeyECDSA, chainID)) | ||
| chainDeployer := crypto.PubkeyToAddress(cfg.privateKeyECDSA.PublicKey) | ||
|
|
||
| lgr.Info("deploying OPCM", "release", cfg.ContractsRelease) | ||
|
|
||
| var dio opcm.DeployImplementationsOutput | ||
| err = pipeline.CallScriptBroadcast( | ||
| ctx, | ||
| pipeline.CallScriptBroadcastOpts{ | ||
| L1ChainID: chainID, | ||
| Logger: lgr, | ||
| ArtifactsFS: artifactsFS, | ||
| Deployer: chainDeployer, | ||
| Signer: signer, | ||
| Client: l1Client, | ||
| Broadcaster: pipeline.KeyedBroadcaster, | ||
| Handler: func(host *script.Host) error { | ||
| // We need to etch the Superchain addresses so that they have nonzero code | ||
| // and the checks in the OPCM constructor pass. | ||
| superchainConfigAddr := common.Address(*superCfg.Config.SuperchainConfigAddr) | ||
| protocolVersionsAddr := common.Address(*superCfg.Config.ProtocolVersionsAddr) | ||
| addresses := []common.Address{ | ||
| superchainConfigAddr, | ||
| protocolVersionsAddr, | ||
| } | ||
| for _, addr := range addresses { | ||
| host.ImportAccount(addr, types.Account{ | ||
| Code: []byte{0x00}, | ||
| }) | ||
| } | ||
|
|
||
| var salt common.Hash | ||
| _, err = rand.Read(salt[:]) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to generate CREATE2 salt: %w", err) | ||
| } | ||
|
|
||
| dio, err = opcm.DeployImplementations( | ||
| host, | ||
| opcm.DeployImplementationsInput{ | ||
| Salt: salt, | ||
| WithdrawalDelaySeconds: big.NewInt(604800), | ||
| MinProposalSizeBytes: big.NewInt(126000), | ||
| ChallengePeriodSeconds: big.NewInt(86400), | ||
| ProofMaturityDelaySeconds: big.NewInt(604800), | ||
| DisputeGameFinalityDelaySeconds: big.NewInt(302400), | ||
| Release: cfg.ContractsRelease, | ||
| SuperchainConfigProxy: superchainConfigAddr, | ||
| ProtocolVersionsProxy: protocolVersionsAddr, | ||
| OpcmProxyOwner: opcmProxyOwnerAddr, | ||
| StandardVersionsToml: standardVersionsTOML, | ||
| UseInterop: false, | ||
| }, | ||
| ) | ||
| return err | ||
| }, | ||
| }, | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("error deploying implementations: %w", err) | ||
| } | ||
|
|
||
| lgr.Info("deployed implementations") | ||
|
|
||
| if err := jsonutil.WriteJSON(dio, ioutil.ToStdOut()); err != nil { | ||
| return fmt.Errorf("failed to write output: %w", err) | ||
| } | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| package bootstrap | ||
|
|
||
| import ( | ||
| "github.com/ethereum-optimism/optimism/op-chain-ops/deployer" | ||
| "github.com/ethereum-optimism/optimism/op-service/cliapp" | ||
| "github.com/urfave/cli/v2" | ||
| ) | ||
|
|
||
| const ( | ||
| ArtifactsURLFlagName = "artifacts-url" | ||
| ContractsReleaseFlagName = "contracts-release" | ||
| ) | ||
|
|
||
| var ( | ||
| ArtifactsURLFlag = &cli.StringFlag{ | ||
| Name: ArtifactsURLFlagName, | ||
| Usage: "URL to the artifacts directory.", | ||
| EnvVars: deployer.PrefixEnvVar("ARTIFACTS_URL"), | ||
| } | ||
| ContractsReleaseFlag = &cli.StringFlag{ | ||
| Name: ContractsReleaseFlagName, | ||
| Usage: "Release of the contracts to deploy.", | ||
| EnvVars: deployer.PrefixEnvVar("CONTRACTS_RELEASE"), | ||
| } | ||
| ) | ||
|
|
||
| var OPCMFlags = []cli.Flag{ | ||
| deployer.L1RPCURLFlag, | ||
| deployer.PrivateKeyFlag, | ||
| ArtifactsURLFlag, | ||
| ContractsReleaseFlag, | ||
| } | ||
|
|
||
| var Commands = []*cli.Command{ | ||
| { | ||
| Name: "opcm", | ||
| Usage: "Bootstrap an instance of OPCM.", | ||
| Flags: cliapp.ProtectFlags(OPCMFlags), | ||
| Action: OPCMCLI, | ||
| }, | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.