Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

interop: devnet InteropDeployer script #10777

Closed
wants to merge 18 commits into from
Closed

interop: devnet InteropDeployer script #10777

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
7ae18a7
Interop deployer script
jinmel Jun 8, 2024
c5416d1
refactor InteropDeploy.s.sol
jinmel Jun 10, 2024
b484479
interop deployer script
jinmel Jun 11, 2024
9e5eb84
Merge remote-tracking branch 'origin/develop' into feat/interop_deployer
jinmel Jun 19, 2024
e8a8349
Generates allocs for the interop devnet
jinmel Jun 19, 2024
9ab28ad
Add l2-interop services to docker-compose.yml
jinmel Jun 20, 2024
d7558fd
Add two interop devnet build targets to the Makefile
jinmel Jun 20, 2024
5c99144
L2 interop devnet launch script
jinmel Jun 20, 2024
5845301
lint fix
jinmel Jun 20, 2024
c797189
remove unused import
jinmel Jun 20, 2024
bd8c256
indent fix
jinmel Jun 20, 2024
cd3d17e
add chain id to op-e2e config
jinmel Jun 20, 2024
0562275
fix failing e2e ci/cd
jinmel Jun 20, 2024
87ef9a8
remove devnetL1-interop.json
jinmel Jun 20, 2024
9cc1fc2
revert op-e2e/config/init.go to the original state
jinmel Jun 20, 2024
513ce31
force fault proof and no plasma
jinmel Jun 21, 2024
25344dc
remove unused env var
jinmel Jun 21, 2024
8062943
dedupe docker images build for interop services
jinmel Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,11 @@ devnet-up: pre-devnet
PYTHONPATH=./bedrock-devnet $(PYTHON) ./bedrock-devnet/main.py --monorepo-dir=.
.PHONY: devnet-up

devnet-up-interop: pre-devnet
./ops/scripts/newer-file.sh .devnet/allocs-l1.json ./packages/contracts-bedrock \
|| make devnet-allocs-interop
PYTHONPATH=./bedrock-devnet $(PYTHON) ./bedrock-devnet/main.py --monorepo-dir=. --interop

devnet-test: pre-devnet
PYTHONPATH=./bedrock-devnet $(PYTHON) ./bedrock-devnet/main.py --monorepo-dir=. --test
.PHONY: devnet-test
Expand All @@ -203,6 +208,9 @@ devnet-allocs: pre-devnet
PYTHONPATH=./bedrock-devnet $(PYTHON) ./bedrock-devnet/main.py --monorepo-dir=. --allocs
.PHONY: devnet-allocs

devnet-allocs-interop: pre-devnet
PYTHONPATH=./bedrock-devnet $(PYTHON) ./bedrock-devnet/main.py --monorepo-dir=. --allocs --interop

devnet-logs:
@(cd ./ops-bedrock && docker compose logs -f)
.PHONY: devnet-logs
Expand Down
221 changes: 179 additions & 42 deletions bedrock-devnet/devnet/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
parser.add_argument('--monorepo-dir', help='Directory of the monorepo', default=os.getcwd())
parser.add_argument('--allocs', help='Only create the allocs and exit', type=bool, action=argparse.BooleanOptionalAction)
parser.add_argument('--test', help='Tests the deployment, must already be deployed', type=bool, action=argparse.BooleanOptionalAction)
parser.add_argument('--interop', help='Deploy the interop devnet', type=bool, action=argparse.BooleanOptionalAction)

log = logging.getLogger()

Expand All @@ -33,6 +34,9 @@
DEVNET_PLASMA = os.getenv('DEVNET_PLASMA') == "true"
GENERIC_PLASMA = os.getenv('GENERIC_PLASMA') == "true"

CHAIN_ID = 901
INTEROP_CHAIN_ID = 902

class Bunch:
def __init__(self, **kwds):
self.__dict__.update(kwds)
Expand Down Expand Up @@ -70,30 +74,38 @@ def main():
ops_bedrock_dir = pjoin(monorepo_dir, 'ops-bedrock')
deploy_config_dir = pjoin(contracts_bedrock_dir, 'deploy-config')
devnet_config_path = pjoin(deploy_config_dir, 'devnetL1.json')
interop_devnet_config_path = pjoin(deploy_config_dir, 'devnetL1-interop.json')
devnet_config_template_path = pjoin(deploy_config_dir, 'devnetL1-template.json')
ops_chain_ops = pjoin(monorepo_dir, 'op-chain-ops')
tasks_dir = pjoin(monorepo_dir, 'packages', 'devnet-tasks')

paths = Bunch(
mono_repo_dir=monorepo_dir,
devnet_dir=devnet_dir,
contracts_bedrock_dir=contracts_bedrock_dir,
deployment_dir=deployment_dir,
forge_l1_dump_path=forge_l1_dump_path,
l1_deployments_path=pjoin(deployment_dir, '.deploy'),
deploy_config_dir=deploy_config_dir,
devnet_config_path=devnet_config_path,
devnet_config_template_path=devnet_config_template_path,
op_node_dir=op_node_dir,
ops_bedrock_dir=ops_bedrock_dir,
ops_chain_ops=ops_chain_ops,
tasks_dir=tasks_dir,
genesis_l1_path=pjoin(devnet_dir, 'genesis-l1.json'),
genesis_l2_path=pjoin(devnet_dir, 'genesis-l2.json'),
allocs_l1_path=pjoin(devnet_dir, 'allocs-l1.json'),
addresses_json_path=pjoin(devnet_dir, 'addresses.json'),
sdk_addresses_json_path=pjoin(devnet_dir, 'sdk-addresses.json'),
rollup_config_path=pjoin(devnet_dir, 'rollup.json')
mono_repo_dir=monorepo_dir,
devnet_dir=devnet_dir,
contracts_bedrock_dir=contracts_bedrock_dir,
deployment_dir=deployment_dir,
forge_l1_dump_path=forge_l1_dump_path,
l1_deployments_path=pjoin(deployment_dir, '.deploy'),
deploy_config_dir=deploy_config_dir,
devnet_config_path=devnet_config_path,
devnet_config_template_path=devnet_config_template_path,
op_node_dir=op_node_dir,
ops_bedrock_dir=ops_bedrock_dir,
ops_chain_ops=ops_chain_ops,
tasks_dir=tasks_dir,
genesis_l1_path=pjoin(devnet_dir, 'genesis-l1.json'),
genesis_l2_path=pjoin(devnet_dir, 'genesis-l2.json'),
allocs_l1_path=pjoin(devnet_dir, 'allocs-l1.json'),
addresses_json_path=pjoin(devnet_dir, 'addresses.json'),
sdk_addresses_json_path=pjoin(devnet_dir, 'sdk-addresses.json'),
rollup_config_path=pjoin(devnet_dir, 'rollup.json'),

# interop L2 devnet paths.
interop_l1_deployments_path=pjoin(deployment_dir, '.deploy-interop'),
interop_devnet_config_path=interop_devnet_config_path,
interop_genesis_l2_path=pjoin(devnet_dir, 'genesis-l2-interop.json'),
interop_addresses_json_path=pjoin(devnet_dir, 'addresses-interop.json'),
interop_rollup_config_path=pjoin(devnet_dir, 'rollup-interop.json')
)

if args.test:
Expand All @@ -104,8 +116,14 @@ def main():
os.makedirs(devnet_dir, exist_ok=True)

if args.allocs:
devnet_l1_allocs(paths)
devnet_l2_allocs(paths)
devnet_l1_allocs(paths, interop=args.interop)
devnet_l2_allocs(CHAIN_ID, paths.l1_deployments_path, paths.devnet_config_path,
paths.devnet_dir, paths.contracts_bedrock_dir)
if args.interop:
log.info("Generating interop L2 allocs")
devnet_l2_allocs(INTEROP_CHAIN_ID,
paths.interop_l1_deployments_path, paths.interop_devnet_config_path,
paths.devnet_dir, paths.contracts_bedrock_dir, interop=True)
return

git_commit = subprocess.run(['git', 'rev-parse', 'HEAD'], capture_output=True, text=True).stdout.strip()
Expand All @@ -125,9 +143,9 @@ def main():
})

log.info('Devnet starting')
devnet_deploy(paths)
devnet_deploy(paths, interop=args.interop)

def init_devnet_l1_deploy_config(paths, update_timestamp=False):
def init_devnet_l1_deploy_config(paths, interop=False, update_timestamp=False):
deploy_config = read_json(paths.devnet_config_template_path)
if update_timestamp:
deploy_config['l1GenesisBlockTimestamp'] = '{:#x}'.format(int(time.time()))
Expand All @@ -137,11 +155,36 @@ def init_devnet_l1_deploy_config(paths, update_timestamp=False):
deploy_config['usePlasma'] = True
if GENERIC_PLASMA:
deploy_config['daCommitmentType'] = "GenericCommitment"

# Make another copy of the deploy config with different chain id for the interop devnet.
if interop:
deploy_config['l2ChainID'] = INTEROP_CHAIN_ID
write_json(paths.interop_devnet_config_path, deploy_config)

deploy_config['l2ChainID'] = CHAIN_ID
write_json(paths.devnet_config_path, deploy_config)

def devnet_l1_allocs(paths):
def devnet_l1_allocs(paths, interop=False):
log.info('Generating L1 genesis allocs')
init_devnet_l1_deploy_config(paths)
init_devnet_l1_deploy_config(paths, interop=interop)

if interop:
fqn = 'scripts/deploy/InteropDeploy.s.sol:InteropDeploy'
run_command([
"forge", "script", fqn, "--sig", "runWithStateDump()", "--sender",
"0x90F79bf6EB2c4f870365E785982E1f101E93b906"
], env={
"DEPLOYMENT_OUTFILE": paths.l1_deployments_path,
"DEPLOY_CONFIG_PATH": paths.devnet_config_path,
"INTEROP_DEPLOYMENT_OUTFILE": paths.interop_l1_deployments_path,
"INTEROP_DEPLOY_CONFIG_PATH": paths.interop_devnet_config_path,
"STATE_DUMP_PATH": paths.forge_l1_dump_path,
}, cwd=paths.contracts_bedrock_dir)

shutil.move(src=paths.forge_l1_dump_path, dst=paths.allocs_l1_path)
shutil.copy(src=paths.l1_deployments_path, dst=paths.addresses_json_path)
shutil.copy(src=paths.interop_l1_deployments_path, dst=paths.interop_addresses_json_path)
return

fqn = 'scripts/deploy/Deploy.s.sol:Deploy'
run_command([
Expand All @@ -159,28 +202,33 @@ def devnet_l1_allocs(paths):
shutil.copy(paths.l1_deployments_path, paths.addresses_json_path)


def devnet_l2_allocs(paths):
log.info('Generating L2 genesis allocs, with L1 addresses: '+paths.l1_deployments_path)
def devnet_l2_allocs(chainid, l1_deployments_path, devnet_config_path, devnet_dir, contracts_bedrock_dir, interop=False):
log.info('Generating L2 genesis allocs, with L1 addresses: '+l1_deployments_path)

fqn = 'scripts/L2Genesis.s.sol:L2Genesis'
run_command([
'forge', 'script', fqn, "--sig", "runWithAllUpgrades()"
], env={
'CONTRACT_ADDRESSES_PATH': paths.l1_deployments_path,
'DEPLOY_CONFIG_PATH': paths.devnet_config_path,
}, cwd=paths.contracts_bedrock_dir)
'CONTRACT_ADDRESSES_PATH': l1_deployments_path,
'DEPLOY_CONFIG_PATH': devnet_config_path,
}, cwd=contracts_bedrock_dir)

# For the previous forks, and the latest fork (default, thus empty prefix),
# move the forge-dumps into place as .devnet allocs.
for fork in FORKS:
input_path = pjoin(paths.contracts_bedrock_dir, f"state-dump-901-{fork}.json")
output_path = pjoin(paths.devnet_dir, f'allocs-l2-{fork}.json')
input_path = pjoin(contracts_bedrock_dir, f"state-dump-{chainid}-{fork}.json")
# TODO: Consider using chainid instead of the `-interop` suffix for each chains. For now we keep the
# filename consistent with the current CI/CD pipeline
if interop:
output_path = pjoin(devnet_dir, f'allocs-l2-{fork}-interop.json')
else:
output_path = pjoin(devnet_dir, f'allocs-l2-{fork}.json')
shutil.move(src=input_path, dst=output_path)
log.info("Generated L2 allocs: "+output_path)
log.info("Generated L2 allocs: " + output_path)


# Bring up the devnet where the contracts are deployed to L1
def devnet_deploy(paths):

def deploy_l1(paths):
if os.path.exists(paths.genesis_l1_path):
log.info('L1 genesis already generated.')
else:
Expand Down Expand Up @@ -215,28 +263,40 @@ def devnet_deploy(paths):
wait_up(8545)
wait_for_rpc_server('127.0.0.1:8545')

if os.path.exists(paths.genesis_l2_path):

def generate_l2_genesis(chainid, genesis_l2_path, l1_deployments_path,
devnet_config_path, addresses_json_path, rollup_config_path, paths, interop=False):
if os.path.exists(genesis_l2_path):
log.info('L2 genesis and rollup configs already generated.')
else:
log.info('Generating L2 genesis and rollup configs.')
l2_allocs_path = pjoin(paths.devnet_dir, f'allocs-l2-{FORKS[-1]}.json')
if interop:
l2_allocs_path = pjoin(paths.devnet_dir, f'allocs-l2-{FORKS[-1]}-interop.json')
else:
l2_allocs_path = pjoin(paths.devnet_dir, f'allocs-l2-{FORKS[-1]}.json')
if os.path.exists(l2_allocs_path) == False or DEVNET_L2OO == True:
# Also regenerate if L2OO.
# The L2OO flag may affect the L1 deployments addresses, which may affect the L2 genesis.
devnet_l2_allocs(paths)
devnet_l2_allocs(chainid, l1_deployments_path, devnet_config_path,
paths.devnet_dir, paths.contracts_bedrock_dir, interop=interop)
else:
log.info('Re-using existing L2 allocs.')

run_command([
'go', 'run', 'cmd/main.go', 'genesis', 'l2',
'--l1-rpc', 'http://localhost:8545',
'--deploy-config', paths.devnet_config_path,
'--deploy-config', devnet_config_path,
'--l2-allocs', l2_allocs_path,
'--l1-deployments', paths.addresses_json_path,
'--outfile.l2', paths.genesis_l2_path,
'--outfile.rollup', paths.rollup_config_path
'--l1-deployments', addresses_json_path,
'--outfile.l2', genesis_l2_path,
'--outfile.rollup', rollup_config_path
], cwd=paths.op_node_dir)


def deploy_l2(paths):
generate_l2_genesis(CHAIN_ID,
paths.genesis_l2_path, paths.l1_deployments_path,
paths.devnet_config_path, paths.addresses_json_path, paths.rollup_config_path, paths)
rollup_config = read_json(paths.rollup_config_path)
addresses = read_json(paths.addresses_json_path)

Expand Down Expand Up @@ -300,6 +360,83 @@ def devnet_deploy(paths):
log.info('Bringing up `da-server`, `sentinel`.') # TODO(10141): We don't have public sentinel images yet
run_command(['docker', 'compose', 'up', '-d', 'da-server'], cwd=paths.ops_bedrock_dir, env=docker_env)


def deploy_l2_interop(paths):
generate_l2_genesis(INTEROP_CHAIN_ID,
paths.interop_genesis_l2_path, paths.interop_l1_deployments_path,
paths.interop_devnet_config_path, paths.interop_addresses_json_path,
paths.interop_rollup_config_path, paths, interop=True)
rollup_config = read_json(paths.interop_rollup_config_path)
addresses = read_json(paths.interop_addresses_json_path)

# Start the L2.
log.info('Bringing up L2.')
run_command(['docker', 'compose', 'up', '-d', 'l2-interop'], cwd=paths.ops_bedrock_dir, env={
'PWD': paths.ops_bedrock_dir
})

# Wait for the L2 to be available.
wait_up(10545)
wait_for_rpc_server('127.0.0.1:10545')

# Print out the addresses being used for easier debugging.
l2_output_oracle = addresses['L2OutputOracleProxy']
dispute_game_factory = addresses['DisputeGameFactoryProxy']
batch_inbox_address = rollup_config['batch_inbox_address']
log.info(f'Using L2OutputOracle {l2_output_oracle}')
log.info(f'Using DisputeGameFactory {dispute_game_factory}')
log.info(f'Using batch inbox {batch_inbox_address}')

# Set up the base docker environment.
docker_env = {
'PWD': paths.ops_bedrock_dir,
}

# Selectively set the L2OO_ADDRESS or DGF_ADDRESS if using L2OO.
# Must be done selectively because op-proposer throws if both are set.
if DEVNET_L2OO:
jinmel marked this conversation as resolved.
Show resolved Hide resolved
docker_env['L2OO_ADDRESS_INTEROP'] = l2_output_oracle
else:
docker_env['DGF_ADDRESS_INTEROP'] = dispute_game_factory
docker_env['DG_TYPE'] = '254'
docker_env['PROPOSAL_INTERVAL'] = '10s'

if DEVNET_PLASMA:
docker_env['PLASMA_ENABLED'] = 'true'
else:
docker_env['PLASMA_ENABLED'] = 'false'

if GENERIC_PLASMA:
docker_env['PLASMA_GENERIC_DA'] = 'true'
docker_env['PLASMA_DA_SERVICE'] = 'true'
else:
docker_env['PLASMA_GENERIC_DA'] = 'false'
docker_env['PLASMA_DA_SERVICE'] = 'false'

# Bring up the rest of the services.
log.info('Bringing up `op-node-interop`, `op-proposer-interop` and `op-batcher-interop`.')
run_command(['docker', 'compose', 'up', '-d',
'op-node-interop', 'op-proposer-interop', 'op-batcher-interop'],
cwd=paths.ops_bedrock_dir, env=docker_env)

# Optionally bring up op-challenger.
if not DEVNET_L2OO:
log.info('Bringing up `op-challenger-interop`.')
run_command(['docker', 'compose', 'up', '-d', 'op-challenger-interop'],
cwd=paths.ops_bedrock_dir, env=docker_env)


# Bring up the devnet where the contracts are deployed to L1
def devnet_deploy(paths, interop=False):
log.info("Deploying L1 devnet.")
deploy_l1(paths)

log.info("Deploying L2 devnet.")
deploy_l2(paths)

if interop:
log.info("Deploying L2 interop devnet.")
deploy_l2_interop(paths)
# Fin.
log.info('Devnet ready.')

Expand Down
Loading