Bedrock -> Develop

.circleci/config.yml

@@ -1,5 +1,8 @@
 version: 2.1
 
+orbs:
+  node: circleci/node@5.0.2
+
 executors:
   go-builder:
     docker:
@@ -307,10 +310,159 @@ jobs:
             echo "$DOCKER_PASS" | docker login -u "$DOCKER_USERNAME" --password-stdin
             docker push <<parameters.docker_tags>>
 
+  bedrock-markdown:
+    machine:
+      image: ubuntu-2004:202111-02
+    steps:
+      - checkout
+      - run:
+          name: markdown lint
+          command: |
+            docker run -v `pwd`:/workdir davidanson/markdownlint-cli2:0.4.0 "op-node/README.md" "./specs/**/*.md" "#**/node_modules"
+      - run:
+          name: link lint
+          command: |
+            docker run --init -it -v `pwd`:/input lycheeverse/lychee --verbose --no-progress --exclude-loopback --exclude twitter.com --exclude-mail /input/README.md "/input/specs/**/*.md" "/input/meta/**/*.md" "/input/op-node/**/*.md" || exit 0
+
+  bedrock-solidity:
+    docker:
+      - image: ethereumoptimism/js-builder:0.0.4
+    steps:
+      - checkout
+      - run:
+          name: init submodules
+          command: |
+            git submodule sync --recursive
+            git submodule update --recursive --init
+      - run:
+          name: install
+          command: yarn install
+          working_directory: contracts-bedrock
+      - run:
+          name: lint
+          command: |
+            # remove prettierrc in root of repo since it doesn't work with non-Lerna packages
+            mv ../.eslintrc.js ../.eslintrc.bak
+            yarn lint:check
+            mv ../.eslintrc.bak ../.eslintrc.js
+          working_directory: contracts-bedrock
+      - run:
+          name: slither
+          command: yarn slither || exit 0
+          working_directory: contracts-bedrock
+      - run:
+          name: build forge
+          command: yarn build:forge
+          working_directory: contracts-bedrock
+      - run:
+          name: test forge
+          command: yarn test:forge
+          working_directory: contracts-bedrock
+      - run:
+          name: gas snapshot
+          command: forge snapshot
+          working_directory: contracts-bedrock
+
+
+  bedrock-go-tests:
+    docker:
+      - image: ethereumoptimism/go-builder:latest
+    steps:
+      - checkout
+      - run:
+          name: lint op-node
+          command: |
+            golangci-lint run -E goimports,sqlclosecheck,bodyclose,asciicheck,misspell ./...
+          working_directory: op-node
+      - run:
+          name: lint op-proposer
+          command: |
+            golangci-lint run -E goimports,sqlclosecheck,bodyclose,asciicheck,misspell ./...
+          working_directory: op-proposer
+      - run:
+          name: lint op-batcher
+          command: |
+            golangci-lint run -E goimports,sqlclosecheck,bodyclose,asciicheck,misspell ./...
+          working_directory: op-batcher
+      - run:
+          name: lint op-e2e
+          command: |
+            golangci-lint run -E goimports,sqlclosecheck,bodyclose,asciicheck,misspell ./...
+          working_directory: op-e2e
+      - run:
+          name: prep results dir
+          command: mkdir -p /test-results
+      - run:
+          name: test op-node
+          command: |
+            gotestsum --junitfile /test-results/op-node.xml -- -coverpkg=github.com/ethereum-optimism/optimism/... -coverprofile=coverage.out -covermode=atomic ./...
+          working_directory: op-node
+      - run:
+          name: test op-proposer
+          command: |
+            gotestsum --junitfile /test-results/op-proposer.xml -- -coverpkg=github.com/ethereum-optimism/optimism/... -coverprofile=coverage.out -covermode=atomic ./...
+          working_directory: op-proposer
+      - run:
+          name: test op-batcher
+          command: |
+            gotestsum --junitfile /test-results/op-batcher.xml -- -coverpkg=github.com/ethereum-optimism/optimism/... -coverprofile=coverage.out -covermode=atomic ./...
+          working_directory: op-batcher
+      - run:
+          name: test op-e2e
+          command: |
+            gotestsum --junitfile /test-results/op-e2e.xml -- -coverpkg=github.com/ethereum-optimism/optimism/... -coverprofile=coverage.out -covermode=atomic ./...
+          working_directory: op-e2e
+      - store_test_results:
+          path: /test-results
+
+  fuzz-op-node:
+    docker:
+      - image: ethereumoptimism/go-builder:latest
+    steps:
+      - checkout
+      - run:
+          name: Fuzz
+          command: make fuzz
+          working_directory: op-node
+
+  bedrock-integration-tests:
+    machine:
+      image: ubuntu-2004:202111-02
+      docker_layer_caching: true
+    steps:
+      - checkout
+      - run:
+          name: init submodules
+          command: |
+            git submodule sync --recursive
+            git submodule update --recursive --init
+      - node/install:
+          install-yarn: true
+          node-version: '16.13'
+      - run:
+          name: install Foundry
+          command: |
+            curl -L https://foundry.paradigm.xyz | bash
+            source /home/circleci/.bashrc
+            foundryup
+      - run:
+          name: build typescript
+          command: make build-ts
+      - run:
+          name: start devnet
+          command: make devnet-up
+      - run:
+          name: run itests
+          command: make test-integration
+
 workflows:
   main:
     jobs:
       - yarn-monorepo
+      - bedrock-go-tests
+      - bedrock-solidity
+      - bedrock-markdown
+      - fuzz-op-node
       - go-lint-test-build:
           name: batch-submitter-tests
           binary_name: batch-submitter

.gitignore

@@ -6,6 +6,8 @@ temp
 coverage.json
 *.tsbuildinfo
 
+yarn-error.log
+
 dist
 artifacts
 cache
@@ -19,10 +21,20 @@ packages/contracts/hardhat*
 
 packages/data-transport-layer/db
 
+packages/integration-tests-bedrock/cache
+packages/integration-tests-bedrock/artifacts
+
 # vim
 *.sw*
 
 .env
 .env*
 !.env.example
 *.log
+
+.devnet
+
+# Ignore local fuzzing results
+**/testdata/fuzz/
+
+coverage.out

.gitmodules

@@ -1,3 +1,12 @@
 [submodule "tests"]
 	path = l2geth/tests/testdata
 	url = https://github.com/ethereum/tests
+[submodule "packages/contracts-bedrock/lib/forge-std"]
+	path = contracts-bedrock/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std.git
+[submodule "packages/contracts-bedrock/lib/solmate"]
+	path = contracts-bedrock/lib/solmate
+	url = https://github.com/rari-capital/solmate.git
+[submodule "packages/contracts-bedrock/lib/ds-test"]
+	path = contracts-bedrock/lib/ds-test
+	url = https://github.com/dapphub/ds-test.git

.markdownlint.json

@@ -0,0 +1,12 @@
+{
+  "line_length": {
+    "line_length": 120,
+    "strict": false,
+    "stern": true,
+    "code_blocks": false,
+    "tables": false,
+  },
+  "no-blanks-blockquote": false,
+  "single-title": false,
+  "no-emphasis-as-heading": false,
+}

Makefile

@@ -0,0 +1,76 @@
+COMPOSEFLAGS=-d
+ITESTS_L2_HOST=http://localhost:9545
+
+build: build-go contracts integration-tests
+.PHONY: build
+
+build-go: submodules op-node op-proposer op-batcher
+.PHONY: build-go
+
+build-ts: submodules contracts integration-tests
+.PHONY: build-ts
+
+submodules:
+	# CI will checkout submodules on its own (and fails on these commands)
+	if [ -z "$$GITHUB_ENV" ]; then \
+		git submodule init; \
+		git submodule update; \
+	fi
+.PHONY: submodules
+
+op-node:
+	make -C ./op-node op-node
+.PHONY: op-node
+
+op-batcher:
+	make -C ./op-batcher op-batcher
+.PHONY: op-batcher
+
+op-proposer:
+	make -C ./op-proposer op-proposer
+.PHONY: op-proposer
+
+contracts:
+	cd ./contracts-bedrock && yarn install && yarn build
+.PHONY: contracts
+
+integration-tests:
+	cd ./packages/integration-tests-bedrock && yarn install && yarn build:contracts
+.PHONY: integration-tests
+
+clean:
+	rm -rf ./bin
+.PHONY: clean
+
+devnet-up:
+	@bash ./ops-bedrock/devnet-up.sh
+.PHONY: devnet-up
+
+devnet-down:
+	@(cd ./ops-bedrock && GENESIS_TIMESTAMP=$(shell date +%s) docker-compose stop)
+.PHONY: devnet-down
+
+devnet-clean:
+	rm -rf ./contracts-bedrock/deployments/devnetL1
+	rm -rf ./.devnet
+	cd ./ops-bedrock && docker-compose down
+	docker volume rm ops_l1_data
+	docker volume rm ops_l2_data
+.PHONY: devnet-clean
+
+test-unit:
+	make -C ./op-node test
+	make -C ./op-proposer test
+	make -C ./op-batcher test
+	make -C ./op-e2e test
+	cd ./contracts-bedrock && yarn test
+.PHONY: test-unit
+
+test-integration:
+	bash ./ops-bedrock/test-integration.sh \
+		./contracts-bedrock/deployments/devnetL1
+.PHONY: test-integration
+
+devnet-genesis:
+	bash ./ops-bedrock/devnet-genesis.sh
+.PHONY: devnet-genesis

README.md

@@ -31,21 +31,38 @@ Then check out our list of [good first issues](https://github.com/ethereum-optim
 <pre>
 root
 ├── <a href="./packages">packages</a>
+│   ├── <a href="./packages/common-ts">common-ts</a>: Common tools for building apps in TypeScript
 │   ├── <a href="./packages/contracts">contracts</a>: L1 and L2 smart contracts for Optimism
 │   ├── <a href="./packages/core-utils">core-utils</a>: Low-level utilities that make building Optimism easier
-│   ├── <a href="./packages/common-ts">common-ts</a>: Common tools for building apps in TypeScript
 │   ├── <a href="./packages/data-transport-layer">data-transport-layer</a>: Service for indexing Optimism-related L1 data
-│   ├── <a href="./packages/fault-detector">fault-detector</a>: Service for detecting faulty L2 output proposals
+│   ├── <a href="./packages/fault-detector">fault-detector</a>:
+│   ├── <a href="./packages/integration-tests-bedrock">integration-tests-bedrock</a> (BEDROCK upgrade): Bedrock integration tests.
 │   ├── <a href="./packages/message-relayer">message-relayer</a>: Tool for automatically relaying L1<>L2 messages in development
-│   └── <a href="./packages/replica-healthcheck">replica-healthcheck</a>: Service for monitoring the health of a replica node
-├── <a href="./go">go</a>
-│   ├── <a href="./batch-submitter">batch-submitter</a>: Service for submitting batches of transactions and results to L1
-│   ├── <a href="./bss-core">bss-core</a>: Core batch-submitter logic and utilities
-│   ├── <a href="./gas-oracle">gas-oracle</a>: Service for updating L1 gas prices on L2
-│   └── <a href="./proxyd">proxyd</a>: Configurable RPC request router and proxy
-├── <a href="./l2geth">l2geth</a>: Optimism client software, a fork of <a href="https://github.com/ethereum/go-ethereum/tree/v1.9.10">geth v1.9.10</a>
+│   ├── <a href="./packages/replica-healthcheck">replica-healthcheck</a>: Service for monitoring the health of a replica node
+│   └── <a href="./packages/sdk">sdk</a>: provides a set of tools for interacting with Optimism
+
+~~ Production ~~
+├── <a href="./batch-submitter">batch-submitter</a>: Service for submitting batches of transactions and results to L1
+├── <a href="./bss-core">bss-core</a>: Core batch-submitter logic and utilities
+├── <a href="./gas-oracle">gas-oracle</a>: Service for updating L1 gas prices on L2
+├── <a href="./indexer">indexer</a>: indexes and syncs transactions
+├── <a href="./infra/op-replica">infra/op-replica</a>: Deployment examples and resources for running an Optimism replica
 ├── <a href="./integration-tests">integration-tests</a>: Various integration tests for the Optimism network
-└── <a href="./ops">ops</a>: Tools for running Optimism nodes and networks
+├── <a href="./l2geth">l2geth</a>: Optimism client software, a fork of <a href="https://github.com/ethereum/go-ethereum/tree/v1.9.10">geth v1.9.10</a>  (deprecated for BEDROCK upgrade)
+├── <a href="./l2geth-exporter">l2geth-exporter</a>: A prometheus exporter to collect/serve metrics from an L2 geth node
+├── <a href="./op-exporter">op-exporter</a>: A prometheus exporter to collect/serve metrics from an Optimism node
+├── <a href="./proxyd">proxyd</a>: Configurable RPC request router and proxy
+├── <a href="./technical-documents">technical-documents</a>: audits and post-mortem documents
+├── <a href="./teleportr">teleportr</a>: Bridge for teleporting ETH between L1 and L2 at low cost
+
+~~ BEDROCK upgrade - Not production-ready yet, part of next major upgrade ~~
+├── <a href="./contracts-bedrock">contracts-bedrock</a>: Bedrock smart contracts. To be merged with ./packages/contracts.
+├── <a href="./op-batcher">op-batcher</a>: L2-Batch Submitter, submits bundles of batches to L1
+├── <a href="./op-e2e">op-e2e</a>: End-to-End testing of all bedrock components in Go
+├── <a href="./op-node">op-node</a>: rollup consensus-layer client.
+├── <a href="./op-proposer">op-proposer</a>: L2-Output Submitter, submits proposals to L1
+├── <a href="./ops-bedrock">ops-bedrock</a>: Bedrock devnet work
+└── <a href="./specs">specs</a>: Specs of the rollup starting at the Bedrock upgrade
 </pre>
 
 ## Branching Model and Releases