Commit ba3de8ea authored by Mark Tyneway's avatar Mark Tyneway Committed by GitHub

Merge pull request #1958 from ethereum-optimism/sc/oe-optimism

fix: replace OE with Optimism
parents dddc160f b3efb8b7
---
'@eth-optimism/gas-oracle': patch
'@eth-optimism/contracts': patch
'@eth-optimism/data-transport-layer': patch
---
String update to change the system name from OE to Optimism
...@@ -98,7 +98,7 @@ Use the above commands to recompile the packages. ...@@ -98,7 +98,7 @@ Use the above commands to recompile the packages.
### Building the rest of the system ### Building the rest of the system
If you want to run an Optimistic Ethereum node OR **if you want to run the integration tests**, you'll need to build the rest of the system. If you want to run an Optimism node OR **if you want to run the integration tests**, you'll need to build the rest of the system.
```bash ```bash
cd ops cd ops
......
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
## TL;DR ## TL;DR
This is the primary place where [Optimism](https://optimism.io) works on stuff related to [Optimistic Ethereum](https://optimistic.etherscan.io/). This is where [Optimism](https://optimism.io) gets built.
## Documentation ## Documentation
...@@ -31,16 +31,16 @@ Then check out our list of [good first issues](https://github.com/ethereum-optim ...@@ -31,16 +31,16 @@ Then check out our list of [good first issues](https://github.com/ethereum-optim
<pre> <pre>
root root
├── <a href="./packages">packages</a> ├── <a href="./packages">packages</a>
│ ├── <a href="./packages/contracts">contracts</a>: L1 and L2 smart contracts for Optimistic Ethereum │ ├── <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 Optimistic Ethereum easier │ ├── <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/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 Optimistic Ethereum-related L1 data │ ├── <a href="./packages/data-transport-layer">data-transport-layer</a>: Service for indexing Optimism-related L1 data
│ ├── <a href="./packages/batch-submitter">batch-submitter</a>: Service for submitting batches of transactions and results to L1 │ ├── <a href="./packages/batch-submitter">batch-submitter</a>: Service for submitting batches of transactions and results to L1
│ ├── <a href="./packages/message-relayer">message-relayer</a>: Tool for automatically relaying L1<>L2 messages in development │ ├── <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="./packages/replica-healthcheck">replica-healthcheck</a>: Service for monitoring the health of a replica node
├── <a href="./l2geth">l2geth</a>: Optimistic Ethereum client software, a fork of <a href="https://github.com/ethereum/go-ethereum/tree/v1.9.10">geth v1.9.10</a> ├── <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="./integration-tests">integration-tests</a>: Various integration tests for an Optimistic Ethereum network ├── <a href="./integration-tests">integration-tests</a>: Various integration tests for the Optimism network
└── <a href="./ops">ops</a>: Tools for running Optimistic Ethereum nodes and networks └── <a href="./ops">ops</a>: Tools for running Optimism nodes and networks
</pre> </pre>
## Branching Model and Releases ## Branching Model and Releases
...@@ -64,7 +64,7 @@ Please read the linked post if you're planning to make frequent PRs into this re ...@@ -64,7 +64,7 @@ Please read the linked post if you're planning to make frequent PRs into this re
The `master` branch contains the code for our latest "stable" releases. The `master` branch contains the code for our latest "stable" releases.
Updates from `master` always come from the `develop` branch. Updates from `master` always come from the `develop` branch.
We only ever update the `master` branch when we intend to deploy code within the `develop` to the Optimistic Ethereum mainnet. We only ever update the `master` branch when we intend to deploy code within the `develop` to the Optimism mainnet.
Our update process takes the form of a PR merging the `develop` branch into the `master` branch. Our update process takes the form of a PR merging the `develop` branch into the `master` branch.
### The `develop` branch ### The `develop` branch
......
...@@ -40,7 +40,7 @@ options. ...@@ -40,7 +40,7 @@ options.
``` ```
NAME: NAME:
gas-oracle - Remotely Control the Optimistic Ethereum Gas Price gas-oracle - Remotely Control the Optimism Gas Price
USAGE: USAGE:
gas-oracle [global options] command [command options] [arguments...] gas-oracle [global options] command [command options] [arguments...]
...@@ -49,7 +49,7 @@ VERSION: ...@@ -49,7 +49,7 @@ VERSION:
0.0.0-1.10.4-stable 0.0.0-1.10.4-stable
DESCRIPTION: DESCRIPTION:
Configure with a private key and an Optimistic Ethereum HTTP endpoint to send transactions that update the L2 gas price. Configure with a private key and an Optimism HTTP endpoint to send transactions that update the L2 gas price.
COMMANDS: COMMANDS:
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
......
...@@ -26,8 +26,8 @@ func main() { ...@@ -26,8 +26,8 @@ func main() {
app.Version = GitVersion + "-" + params.VersionWithCommit(GitCommit, GitDate) app.Version = GitVersion + "-" + params.VersionWithCommit(GitCommit, GitDate)
app.Name = "gas-oracle" app.Name = "gas-oracle"
app.Usage = "Remotely Control the Optimistic Ethereum Gas Price" app.Usage = "Remotely Control the Optimism Gas Price"
app.Description = "Configure with a private key and an Optimistic Ethereum HTTP endpoint " + app.Description = "Configure with a private key and an Optimism HTTP endpoint " +
"to send transactions that update the L2 gas price." "to send transactions that update the L2 gas price."
// Configure the logging // Configure the logging
......
# op_exporter # op_exporter
A prometheus exporter to collect information from an Optimistic Ethereum node and serve metrics for collection A prometheus exporter to collect information from an Optimism node and serve metrics for collection
## Usage ## Usage
......
...@@ -282,7 +282,7 @@ describe('Basic RPC tests', () => { ...@@ -282,7 +282,7 @@ describe('Basic RPC tests', () => {
expect(receipt.status).to.eq(0) expect(receipt.status).to.eq(0)
}) })
// Optimistic Ethereum special fields on the receipt // Optimism special fields on the receipt
it('includes L1 gas price and L1 gas used', async () => { it('includes L1 gas price and L1 gas used', async () => {
const tx = await env.l2Wallet.populateTransaction({ const tx = await env.l2Wallet.populateTransaction({
to: env.l2Wallet.address, to: env.l2Wallet.address,
......
[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=contracts)](https://codecov.io/gh/ethereum-optimism/optimism) [![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=contracts)](https://codecov.io/gh/ethereum-optimism/optimism)
# Optimistic Ethereum Smart Contracts # Optimism Smart Contracts
`@eth-optimism/contracts` contains the various Solidity smart contracts used within the Optimistic Ethereum system. `@eth-optimism/contracts` contains the various Solidity smart contracts used within the Optimism system.
Some of these contracts are deployed on Ethereum ("Layer 1"), while others are meant to be deployed to Optimistic Ethereum ("Layer 2"). Some of these contracts are deployed on Ethereum ("Layer 1"), while others are meant to be deployed to Optimism ("Layer 2").
Within each contract file you'll find a comment that lists: Within each contract file you'll find a comment that lists:
1. The compiler with which a contract is intended to be compiled, `solc` or `optimistic-solc`. 1. The compiler with which a contract is intended to be compiled, `solc` or `optimistic-solc`.
......
# Optimistic Ethereum Deployments # Optimism Deployments
- [Optimistic Ethereum (mainnet)](./mainnet#readme) - [Optimism (mainnet)](./mainnet#readme)
- [Optimistic Kovan (public testnet)](./kovan#readme) - [Optimism Kovan (public testnet)](./kovan#readme)
- [Optimistic Goerli (internal devnet)](./goerli#readme) - [Optimism Goerli (internal devnet)](./goerli#readme)
# Optimistic Goerli (internal devnet) # Optimism Goerli (internal devnet)
## Notice ## Notice
Optimistic Goerli is an internal Optimism development network. You're probably looking for [Optimistic Kovan](../kovan#readme), the public Optimistic Ethereum testnet. Optimism Goerli is an internal Optimism development network. You're probably looking for [Optimism Kovan](../kovan#readme), the public Optimism testnet.
## Network Info ## Network Info
- **Chain ID**: 420 - **Chain ID**: 420
## Layer 1 Contracts ## Layer 1 Contracts
......
# Optimistic Kovan (public testnet) # Optimism Kovan (public testnet)
## Network Info ## Network Info
- **Chain ID**: 69 - **Chain ID**: 69
- **Public RPC**: https://kovan.optimism.io - **Public RPC**: https://kovan.optimism.io
......
# Optimistic Ethereum (mainnet) # Optimism (mainnet)
## Network Info ## Network Info
- **Chain ID**: 10 - **Chain ID**: 10
- **Public RPC**: https://mainnet.optimism.io - **Public RPC**: https://mainnet.optimism.io
......
{ {
"name": "@eth-optimism/contracts", "name": "@eth-optimism/contracts",
"version": "0.5.7", "version": "0.5.7",
"description": "[Optimism] L1 and L2 smart contracts for Optimistic Ethereum", "description": "[Optimism] L1 and L2 smart contracts for Optimism",
"main": "dist/index", "main": "dist/index",
"types": "dist/index", "types": "dist/index",
"files": [ "files": [
......
...@@ -16,7 +16,7 @@ interface DeploymentInfo { ...@@ -16,7 +16,7 @@ interface DeploymentInfo {
const PUBLIC_DEPLOYMENTS: DeploymentInfo[] = [ const PUBLIC_DEPLOYMENTS: DeploymentInfo[] = [
{ {
folder: 'mainnet', folder: 'mainnet',
name: 'Optimistic Ethereum (mainnet)', name: 'Optimism (mainnet)',
chainid: 10, chainid: 10,
rpc: 'https://mainnet.optimism.io', rpc: 'https://mainnet.optimism.io',
l1Explorer: 'https://etherscan.io', l1Explorer: 'https://etherscan.io',
...@@ -24,7 +24,7 @@ const PUBLIC_DEPLOYMENTS: DeploymentInfo[] = [ ...@@ -24,7 +24,7 @@ const PUBLIC_DEPLOYMENTS: DeploymentInfo[] = [
}, },
{ {
folder: 'kovan', folder: 'kovan',
name: 'Optimistic Kovan (public testnet)', name: 'Optimism Kovan (public testnet)',
chainid: 69, chainid: 69,
rpc: 'https://kovan.optimism.io', rpc: 'https://kovan.optimism.io',
l1Explorer: 'https://kovan.etherscan.io', l1Explorer: 'https://kovan.etherscan.io',
...@@ -32,9 +32,9 @@ const PUBLIC_DEPLOYMENTS: DeploymentInfo[] = [ ...@@ -32,9 +32,9 @@ const PUBLIC_DEPLOYMENTS: DeploymentInfo[] = [
}, },
{ {
folder: 'goerli', folder: 'goerli',
name: 'Optimistic Goerli (internal devnet)', name: 'Optimism Goerli (internal devnet)',
chainid: 420, chainid: 420,
notice: `Optimistic Goerli is an internal Optimism development network. You're probably looking for [Optimistic Kovan](../kovan#readme), the public Optimistic Ethereum testnet.`, notice: `Optimism Goerli is an internal Optimism development network. You're probably looking for [Optimism Kovan](../kovan#readme), the public Optimism testnet.`,
l1Explorer: 'https://goerli.etherscan.io', l1Explorer: 'https://goerli.etherscan.io',
}, },
] ]
...@@ -221,7 +221,7 @@ const main = async () => { ...@@ -221,7 +221,7 @@ const main = async () => {
} }
let primary = `` let primary = ``
primary = addline(primary, `# Optimistic Ethereum Deployments`) primary = addline(primary, `# Optimism Deployments`)
for (const deployment of PUBLIC_DEPLOYMENTS) { for (const deployment of PUBLIC_DEPLOYMENTS) {
primary = addline( primary = addline(
primary, primary,
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
## What is this? ## What is this?
The Optimistic Ethereum Data Transport Layer is a long-running software service (written in TypeScript) designed to reliably index Optimistic Ethereum transaction data from Layer 1 (Ethereum). Specifically, this service indexes: The Optimism Data Transport Layer is a long-running software service (written in TypeScript) designed to reliably index Optimism transaction data from Layer 1 (Ethereum). Specifically, this service indexes:
* Transactions that have been enqueued for submission to the CanonicalTransactionChain via [`CanonicalTransactionChain.enqueue`]. * Transactions that have been enqueued for submission to the CanonicalTransactionChain via [`CanonicalTransactionChain.enqueue`].
* Transactions that have been included in the CanonicalTransactionChain via [`CanonicalTransactionChain.appendQueueBatch`] or [`CanonicalTransactionChain.appendSequencerBatch`]. * Transactions that have been included in the CanonicalTransactionChain via [`CanonicalTransactionChain.appendQueueBatch`] or [`CanonicalTransactionChain.appendSequencerBatch`].
......
...@@ -121,7 +121,7 @@ export class L2IngestionService extends BaseService<L2IngestionServiceOptions> { ...@@ -121,7 +121,7 @@ export class L2IngestionService extends BaseService<L2IngestionServiceOptions> {
} }
this.logger.info( this.logger.info(
'Synchronizing unconfirmed transactions from Layer 2 (Optimistic Ethereum)', 'Synchronizing unconfirmed transactions from Layer 2 (Optimism)',
{ {
fromBlock: highestSyncedL2BlockNumber, fromBlock: highestSyncedL2BlockNumber,
toBlock: targetL2Block, toBlock: targetL2Block,
......
...@@ -68,7 +68,7 @@ describe('EOAs', () => { ...@@ -68,7 +68,7 @@ describe('EOAs', () => {
// eslint-disable-next-line // eslint-disable-next-line
before(function() { before(function() {
if (env.surgeryDataSources.configs.l2NetworkName === 'kovan') { if (env.surgeryDataSources.configs.l2NetworkName === 'kovan') {
console.log('1inch deployer does not exist on optimistic kovan') console.log('1inch deployer does not exist on Optimism Kovan')
this.skip() this.skip()
} }
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
# @eth-optimism/sdk # @eth-optimism/sdk
The `@eth-optimism/sdk` package provides a set of tools for interacting with Optimistic Ethereum. The `@eth-optimism/sdk` package provides a set of tools for interacting with Optimism.
## NOTICE ## NOTICE
......
{ {
"name": "@eth-optimism/sdk", "name": "@eth-optimism/sdk",
"version": "0.0.3", "version": "0.0.3",
"description": "[Optimism] Tools for working with Optimistic Ethereum", "description": "[Optimism] Tools for working with Optimism",
"main": "dist/index", "main": "dist/index",
"types": "dist/index", "types": "dist/index",
"files": [ "files": [
......
...@@ -34,7 +34,7 @@ export interface OEL2Contracts { ...@@ -34,7 +34,7 @@ export interface OEL2Contracts {
} }
/** /**
* Represents Optimistic Ethereum contracts, assumed to be connected to their appropriate * Represents Optimism contracts, assumed to be connected to their appropriate
* providers and addresses. * providers and addresses.
*/ */
export interface OEContracts { export interface OEContracts {
......
...@@ -4,7 +4,7 @@ import { CoreCrossChainMessage } from '../interfaces' ...@@ -4,7 +4,7 @@ import { CoreCrossChainMessage } from '../interfaces'
/** /**
* Returns the canonical encoding of a cross chain message. This encoding is used in various * Returns the canonical encoding of a cross chain message. This encoding is used in various
* locations within the Optimistic Ethereum smart contracts. * locations within the Optimism smart contracts.
* *
* @param message Cross chain message to encode. * @param message Cross chain message to encode.
* @returns Canonical encoding of the message. * @returns Canonical encoding of the message.
...@@ -20,7 +20,7 @@ export const encodeCrossChainMessage = ( ...@@ -20,7 +20,7 @@ export const encodeCrossChainMessage = (
/** /**
* Returns the canonical hash of a cross chain message. This hash is used in various locations * Returns the canonical hash of a cross chain message. This hash is used in various locations
* within the Optimistic Ethereum smart contracts and is the keccak256 hash of the result of * within the Optimism smart contracts and is the keccak256 hash of the result of
* encodeCrossChainMessage. * encodeCrossChainMessage.
* *
* @param message Cross chain message to hash. * @param message Cross chain message to hash.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment