Skip to content

Commit

Permalink
linting
Browse files Browse the repository at this point in the history
  • Loading branch information
sbvegan committed Sep 26, 2024
1 parent 05234fa commit 2db308b
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 34 deletions.
54 changes: 26 additions & 28 deletions pages/builders/chain-operators/tools/op-deployer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,49 +16,47 @@ This page will teach you what the `op-deployer` tool is and how it works on a hi
The `op-deployer` is a golang wrapper around [OP Contracts Manager](/stack/experimental/opcm). Here's a sample of its usage:

<Steps>
### Initialize chain

### Initalize chain
Initializes a chain intent and state file with the following command:

Initializes a chain intent and state file with the following command:
```bash
todo: confirm the command and any necessary parameters
./op-deployer init
```

```bash
todo: confirm the command and any necessary parameters
./op-deployer init
```
You can then modify the configuration files. Here's an example file with a standard configuration:
You can then modify the configuration files. Here's an example file with a standard configuration:
```yaml
todo: add sample file
```
```yaml
todo: add sample file
```
### Applies chain intent
### Applies chain intent
Use the following command to apply a chain intent to your network:
Use the following command to apply a chain intent to your network:
```bash
todo: confirm the command and any necessary parameters
./op-deployer apply
```
```bash
todo: confirm the command and any necessary parameters
./op-deployer apply
```
### Inspect deployment
### Inspect deployment

Use the following command to inspect the details of your deployment:

```
todo: confirm the command and any necessary parameters
./op-deployer inspect
```
Use the following command to inspect the details of your deployment:
```
todo: confirm the command and any necessary parameters
./op-deployer inspect
```
</Steps>
## Genesis Creation
## Genesis Creation
todo: is this baked into the commands above?
The `op-deployer` will take the smart contract deployment artifacts and to generate the genesis file for your layer two network.
The `op-deployer` will take the smart contract deployment artifacts and to generate the genesis file for your layer two network.
## Next Steps
* For more details checkout the tool and documnetation in the [monorepo](https://github.com/ethereum-optimism/optimism/tree/develop/op-chain-ops/cmd/op-deployer)
* For more details on OP Contracts Manger checkout these [opcm docs](/stack/experimental/opcm).
* For more details checkout the tool and docs in the [monorepo](https://github.com/ethereum-optimism/optimism/tree/develop/op-chain-ops/cmd/op-deployer)
* For more details on OP Contracts Manger checkout these [opcm docs](/stack/experimental/opcm).
12 changes: 6 additions & 6 deletions pages/stack/experimental/opcm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ The interop team needs a way to configure new multi-L2 deployments: The number o

Outside of interop, deployment also seems increasingly complex and opaque, while it does not have to be, due to the same configuration and composability troubles.

## Purpose
## Purpose

OPCM simplifies the L1 contract deployments for new OP Stack chains. It addresses three aspects of deploying the OP Stack's L1 contracts:

1. **Deploy Superchain Contracts.** Superchain contracts are shared between many OP chains, so this occurs only occasionally in production, but is needed for every OP chain deployment in devnet and testnet.
1. **Deploy Shared Implementation Contracts.** This occurs once per contracts release in production, but is needed for every OP chain deployment in devnet and testnet.
1. **Deploy OP Chain Contracts.** This occurs for every OP chain deployment in production, devnet, and testnet.
1. **Deploy Superchain Contracts.** Superchain contracts are shared between many OP chains, so this occurs only occasionally in production, but is needed for every OP chain deployment in devnet and testnet.
2. **Deploy Shared Implementation Contracts.** This occurs once per contracts release in production, but is needed for every OP chain deployment in devnet and testnet.
3. **Deploy OP Chain Contracts.** This occurs for every OP chain deployment in production, devnet, and testnet.

In a future iteration, it also is meant to handle upgrading the smart contracts.

## Learn more

* Checkout the [OPCM specs](https://specs.optimism.io/experimental/op-contracts-manager.html)
* Checkout the [OPCM design document](https://github.com/ethereum-optimism/design-docs/blob/main/protocol/op-contracts-manager-arch.md)
* Checkout the [OPCM specs](https://specs.optimism.io/experimental/op-contracts-manager.html)
* Checkout the [OPCM design document](https://github.com/ethereum-optimism/design-docs/blob/main/protocol/op-contracts-manager-arch.md)
3 changes: 3 additions & 0 deletions words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,8 @@ nosyncserve
Numba
Offchain
offchain
OPCM
opcm
Openfort
oplabs
opnode's
Expand Down Expand Up @@ -340,6 +342,7 @@ syncmode
SYNCTARGET
synctarget
syscalls
Terrafrom
therealbytes
Thirdweb
threadcreate
Expand Down

0 comments on commit 2db308b

Please sign in to comment.