-
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.
op-deployer: add 'inspect superchain-registry' subcommand (#12736)
* op-deployer: add 'inspect superchain-registry' subcommand * op-deployer: generate artifacts at runtime of superchain-registry cmd * op-deployer: add missing err handler * op-deployer: add Printf to prompt user to populate .env vals * op-deployer: reformat addresses to superchain.AddressList
- Loading branch information
1 parent
72c11da
commit caf63ce
Showing
5 changed files
with
250 additions
and
24 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
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
173 changes: 173 additions & 0 deletions
173
op-deployer/pkg/deployer/inspect/superchain_registry.go
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,173 @@ | ||
| package inspect | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/pipeline" | ||
| "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/standard" | ||
| "github.com/ethereum-optimism/optimism/op-deployer/pkg/deployer/state" | ||
| "github.com/ethereum-optimism/optimism/op-service/ioutil" | ||
| "github.com/ethereum-optimism/optimism/op-service/jsonutil" | ||
| "github.com/ethereum/go-ethereum/common" | ||
|
|
||
| "github.com/ethereum-optimism/superchain-registry/superchain" | ||
|
|
||
| "github.com/urfave/cli/v2" | ||
| ) | ||
|
|
||
| func SuperchainRegistryCLI(cliCtx *cli.Context) error { | ||
| cfg, err := readConfig(cliCtx) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| globalIntent, err := pipeline.ReadIntent(cfg.Workdir) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to read intent: %w", err) | ||
| } | ||
|
|
||
| envVars := map[string]string{} | ||
| envVars["SCR_CHAIN_NAME"] = "" | ||
| envVars["SCR_CHAIN_SHORT_NAME"] = "" | ||
| envVars["SCR_PUBLIC_RPC"] = "" | ||
| envVars["SCR_SEQUENCER_RPC"] = "" | ||
| envVars["SCR_EXPLORER"] = "" | ||
| envVars["SCR_STANDARD_CHAIN_CANDIDATE"] = "false" | ||
|
|
||
| creationCommit, err := standard.CommitForDeployTag(globalIntent.L2ContractsLocator.Tag) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get commit for deploy tag: %w", err) | ||
| } | ||
| envVars["SCR_GENESIS_CREATION_COMMIT"] = creationCommit | ||
|
|
||
| l1ChainName, err := standard.ChainNameFor(globalIntent.L1ChainID) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to get l1 chain name: %w", err) | ||
| } | ||
| envVars["SCR_SUPERCHAIN_TARGET"] = l1ChainName | ||
|
|
||
| globalState, err := pipeline.ReadState(cfg.Workdir) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to read state: %w", err) | ||
| } | ||
|
|
||
| genesis, rollup, err := GenesisAndRollup(globalState, cfg.ChainID) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to generate genesis and rollup: %w", err) | ||
| } | ||
| genesisFilepath := filepath.Join(cfg.Workdir, "genesis.json") | ||
| if err := jsonutil.WriteJSON(genesis, ioutil.ToStdOutOrFileOrNoop(genesisFilepath, 0o666)); err != nil { | ||
| return fmt.Errorf("failed to write genesis: %w", err) | ||
| } | ||
| rollupFilepath := filepath.Join(cfg.Workdir, "rollup.json") | ||
| if err := jsonutil.WriteJSON(rollup, ioutil.ToStdOutOrFileOrNoop(rollupFilepath, 0o666)); err != nil { | ||
| return fmt.Errorf("failed to write rollup: %w", err) | ||
| } | ||
|
|
||
| deployConfig, err := DeployConfig(globalState, cfg.ChainID) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to generate deploy config: %w", err) | ||
| } | ||
| deployConfigFilepath := filepath.Join(cfg.Workdir, "deploy-config.json") | ||
| if err := jsonutil.WriteJSON(deployConfig, ioutil.ToStdOutOrFileOrNoop(deployConfigFilepath, 0o666)); err != nil { | ||
| return fmt.Errorf("failed to write rollup: %w", err) | ||
| } | ||
|
|
||
| l1Contracts, err := L1(globalState, cfg.ChainID) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to generate l1 contracts: %w", err) | ||
| } | ||
|
|
||
| addressList, err := createAddressList(l1Contracts, globalState.AppliedIntent, cfg.ChainID) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create address list: %w", err) | ||
| } | ||
|
|
||
| addressListFilepath := filepath.Join(cfg.Workdir, "addresses.json") | ||
| if err := jsonutil.WriteJSON(addressList, ioutil.ToStdOutOrFileOrNoop(addressListFilepath, 0o666)); err != nil { | ||
| return fmt.Errorf("failed to write address list: %w", err) | ||
| } | ||
|
|
||
| envVars["SCR_GENESIS"] = genesisFilepath | ||
| envVars["SCR_ROLLUP_CONFIG"] = rollupFilepath | ||
| envVars["SCR_DEPLOY_CONFIG"] = deployConfigFilepath | ||
| envVars["SCR_DEPLOYMENTS_DIR"] = addressListFilepath | ||
|
|
||
| envFilepath := filepath.Join(cfg.Workdir, "superchain-registry.env") | ||
| err = writeEnvFile(envFilepath, envVars) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to write .env file: %w", err) | ||
| } | ||
|
|
||
| fmt.Printf("---------------------------------------------------\n"+ | ||
| "Please populate any empty values in your .env file\n"+ | ||
| "before creating your pull-request to add this chain\n"+ | ||
| "to the superchain-registry repo.\n\n"+ | ||
| " * %s\n"+ | ||
| "---------------------------------------------------\n", envFilepath, | ||
| ) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func writeEnvFile(filepath string, envVars map[string]string) error { | ||
| file, err := os.Create(filepath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer file.Close() | ||
|
|
||
| for key, value := range envVars { | ||
| _, err := file.WriteString(fmt.Sprintf("%s=\"%s\"\n", key, value)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func createAddressList(l1Contracts *L1Contracts, appliedIntent *state.Intent, chainId common.Hash) (*superchain.AddressList, error) { | ||
| chainIntent, err := appliedIntent.Chain(chainId) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to get applied chain intent: %w", err) | ||
| } | ||
|
|
||
| addressList := superchain.AddressList{ | ||
| // Roles | ||
| Roles: superchain.Roles{ | ||
| Guardian: superchain.Address(appliedIntent.SuperchainRoles.Guardian), | ||
| SystemConfigOwner: superchain.Address(chainIntent.Roles.SystemConfigOwner), | ||
| ProxyAdminOwner: superchain.Address(chainIntent.Roles.L1ProxyAdminOwner), | ||
| Challenger: superchain.Address(chainIntent.Roles.Challenger), | ||
| Proposer: superchain.Address(chainIntent.Roles.Proposer), | ||
| UnsafeBlockSigner: superchain.Address(chainIntent.Roles.UnsafeBlockSigner), | ||
| BatchSubmitter: superchain.Address(chainIntent.Roles.Batcher), | ||
| }, | ||
|
|
||
| // Contracts | ||
| AddressManager: superchain.Address(l1Contracts.OpChainDeployment.AddressManagerAddress), | ||
| L1CrossDomainMessengerProxy: superchain.Address(l1Contracts.OpChainDeployment.L1CrossDomainMessengerProxyAddress), | ||
| L1ERC721BridgeProxy: superchain.Address(l1Contracts.OpChainDeployment.L1ERC721BridgeProxyAddress), | ||
| L1StandardBridgeProxy: superchain.Address(l1Contracts.OpChainDeployment.L1StandardBridgeProxyAddress), | ||
| OptimismMintableERC20FactoryProxy: superchain.Address(l1Contracts.OpChainDeployment.OptimismMintableERC20FactoryProxyAddress), | ||
| OptimismPortalProxy: superchain.Address(l1Contracts.OpChainDeployment.OptimismPortalProxyAddress), | ||
| SystemConfigProxy: superchain.Address(l1Contracts.OpChainDeployment.SystemConfigProxyAddress), | ||
|
|
||
| ProxyAdmin: superchain.Address(l1Contracts.OpChainDeployment.ProxyAdminAddress), | ||
| SuperchainConfig: superchain.Address(l1Contracts.SuperchainDeployment.SuperchainConfigProxyAddress), | ||
|
|
||
| // Fault proof contracts | ||
| AnchorStateRegistryProxy: superchain.Address(l1Contracts.OpChainDeployment.AnchorStateRegistryProxyAddress), | ||
| DelayedWETHProxy: superchain.Address(l1Contracts.OpChainDeployment.L1CrossDomainMessengerProxyAddress), | ||
| DisputeGameFactoryProxy: superchain.Address(l1Contracts.OpChainDeployment.DisputeGameFactoryProxyAddress), | ||
| FaultDisputeGame: superchain.Address(l1Contracts.OpChainDeployment.FaultDisputeGameAddress), | ||
| MIPS: superchain.Address(l1Contracts.ImplementationsDeployment.MipsSingletonAddress), | ||
| PermissionedDisputeGame: superchain.Address(l1Contracts.OpChainDeployment.PermissionedDisputeGameAddress), | ||
| PreimageOracle: superchain.Address(l1Contracts.ImplementationsDeployment.PreimageOracleSingletonAddress), | ||
| } | ||
|
|
||
| return &addressList, 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