Skip to content

Commit 7ac523f

Browse files
Merge branch 'main' into 250218-custom-superchain-erc20
2 parents a95eddb + 01555aa commit 7ac523f

37 files changed

+723
-234
lines changed

.circleci/config.yml

+12-48
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
version: 2.1
22
orbs:
3-
utils: ethereum-optimism/circleci-utils@0.0.7
3+
utils: ethereum-optimism/circleci-utils@1.0.13
44

55
executors:
66
node20:
@@ -64,6 +64,7 @@ jobs:
6464
- run:
6565
name: Run breadcrumb check
6666
command: pnpm check-breadcrumbs
67+
6768
lint:
6869
description: Lint Markdown files
6970
executor: ubuntu
@@ -75,39 +76,14 @@ jobs:
7576
command: pnpm lint
7677

7778
links:
78-
executor: rust
79+
description: Check broken links in documentation
80+
executor: ubuntu
7981
steps:
80-
- checkout:
81-
path: docs
82-
- run:
83-
name: Checkout lycheeverse/lychee
84-
command: |
85-
git clone https://github.com/lycheeverse/lychee.git lychee
86-
87-
- restore_cache:
88-
keys:
89-
- v1-rust-cache-{{ checksum "lychee/Cargo.lock" }}
90-
- v1-rust-cache-
91-
92-
- run:
93-
name: Build Lychee
94-
command: |
95-
cd lychee
96-
cargo build --release
97-
98-
- save_cache:
99-
key: v1-rust-cache-{{ checksum "lychee/Cargo.lock" }}
100-
paths:
101-
- ~/.cargo/registry
102-
- ~/.cargo/git
103-
- lychee/target
104-
82+
- checkout
83+
- setup-node
10584
- run:
106-
name: Run Lychee link checker
107-
command: |
108-
export PATH=$PATH:$HOME/project/lychee/target/release
109-
cd docs
110-
lychee --config ./lychee.toml --quiet "./pages"
85+
name: Run link checker
86+
command: pnpm link-checker
11187

11288
developer-metrics:
11389
description: Monthly Metrics Report
@@ -117,10 +93,6 @@ jobs:
11793
type: string
11894
default: $CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME
11995
steps:
120-
- utils/get-github-access-token:
121-
private-key-str: GITHUB_APP_KEY
122-
app-id: GITHUB_APP_ID
123-
repo: << parameters.repo >>
12496
- run:
12597
name: Get Dates for Last Month
12698
command: |
@@ -133,21 +105,13 @@ jobs:
133105
134106
# Export the last_month variable for subsequent steps
135107
echo "export LAST_MONTH=${first_day}..${last_day}" >> $BASH_ENV
136-
- utils/generate-issue-metrics-file:
108+
- utils/create-github-issue-from-search:
137109
SEARCH_QUERY: 'repo:ethereum-optimism/docs is:issue closed:${LAST_MONTH} -reason:\"not planned\" -label:monthly-report'
138-
file-path: "./closed_issue_metrics.md"
139-
- utils/create-github-issue-from-file:
140-
repo: << parameters.repo >>
141-
file-path: "./closed_issue_metrics.md"
142110
issue-title: "${LAST_MONTH} metrics report for closed issues"
143111
issue-labels: "monthly-report"
144112
assignees: "sbvegan"
145-
- utils/generate-issue-metrics-file:
146-
SEARCH_QUERY: "repo:ethereum-optimism/docs is:pr created:${LAST_MONTH}"
147-
file-path: "./pr_issue_metrics.md"
148-
- utils/create-github-issue-from-file:
149-
repo: << parameters.repo >>
150-
file-path: "./pr_issue_metrics.md"
113+
- utils/create-github-issue-from-search:
114+
SEARCH_QUERY: 'repo:ethereum-optimism/docs is:pr created:${LAST_MONTH}'
151115
issue-title: "${LAST_MONTH} metrics report for opened prs"
152116
issue-labels: "monthly-report"
153117
assignees: "sbvegan"
@@ -171,4 +135,4 @@ workflows:
171135
equal: [build_monthly, <<pipeline.schedule.name>>]
172136
jobs:
173137
- developer-metrics:
174-
context: circleci-repo-docs
138+
context: circleci-repo-docs

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
"version": "0.0.1",
44
"description": "Optimism Docs",
55
"scripts": {
6-
"lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint && pnpm check-breadcrumbs && pnpm check-redirects",
6+
"lint": "eslint . --ext mdx --max-warnings 0 && pnpm spellcheck:lint && pnpm check-redirects && pnpm link-checker",
77
"fix": "eslint . --ext mdx --fix && pnpm spellcheck:fix && pnpm breadcrumbs && pnpm fix-redirects",
88
"spellcheck:lint": "cspell lint \"**/*.mdx\"",
99
"spellcheck:fix": "cspell --words-only --unique \"**/*.mdx\" | sort --ignore-case | uniq > words.txt",
10-
"linkcheck": "lychee --config ./lychee.toml --quiet \"./pages\"",
1110
"breadcrumbs": "npx ts-node --skip-project utils/create-breadcrumbs.ts",
1211
"check-redirects": "npx ts-node --skip-project utils/redirects.ts",
12+
"link-checker": "npx ts-node --skip-project utils/link-checker.ts",
1313
"fix-redirects": "npx ts-node --skip-project utils/fix-redirects.ts",
1414
"check-breadcrumbs": "npx ts-node --skip-project utils/breadcrumbs.ts",
1515
"index:docs": "npx ts-node --skip-project utils/algolia-indexer.ts",

pages/app-developers/tools/build/faucets.mdx

+13-13
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ The Superchain Faucet is a great place to start if you're looking for testnet ET
2929

3030
## Additional faucets
3131

32-
| Faucet Name | Supported Networks |
33-
|--------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
34-
| [Alchemy Faucet](https://sepoliafaucet.com) | Sepolia |
35-
| [Infura Faucet](https://www.infura.io/faucet/sepolia) | Sepolia |
36-
| [QuickNode Faucet](https://faucet.quicknode.com/optimism/) | Sepolia, OP Sepolia |
37-
| [Farcaster Frame Faucet by LearnWeb3](https://warpcast.com/haardikkk/0x28f4237d) | Sepolia, OP Sepolia |
38-
| [LearnWeb3 Web App Faucet](https://learnweb3.io/faucets) | Sepolia, OP Sepolia |
39-
| [Native USDC Faucet](https://faucet.circle.com/) | Sepolia, OP Sepolia |
40-
| [ETHGlobal Testnet Faucet](https://ethglobal.com/faucet) | Sepolia, OP Sepolia, Base Sepolia, Zora Sepolia, Holesky |
41-
| [Ethereum Ecosystem Faucets](https://www.ethereum-ecosystem.com/faucets) | Sepolia, OP Sepolia, Base Sepolia |
42-
| [thirdweb Sepolia Faucet](https://thirdweb.com/sepolia?utm_source=opdocs\&utm_medium=docs) | Sepolia |
43-
| [thirdweb OP Sepolia Faucet](https://thirdweb.com/op-sepolia-testnet?utm_source=opdocs\&utm_medium=docs) | OP Sepolia |
44-
| [Tenderly Unlimited Faucet](https://docs.tenderly.co/virtual-testnets/unlimited-faucet?mtm_campaign=ext-docs&mtm_kwd=optimism) | OP Sepolia, OP Mainnet, and [85+ other networks](https://docs.tenderly.co/supported-networks?mtm_campaign=ext-docs&mtm_kwd=optimism) |
32+
| Faucet Name | Supported Networks |
33+
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
34+
| [Alchemy Faucet](https://sepoliafaucet.com) | Sepolia |
35+
| [Infura Faucet](https://www.infura.io/faucet/sepolia) | Sepolia |
36+
| [QuickNode Faucet](https://faucet.quicknode.com/optimism/) | Sepolia, OP Sepolia |
37+
| [Farcaster Frame Faucet by LearnWeb3](https://warpcast.com/haardikkk/0x28f4237d) | Sepolia, OP Sepolia |
38+
| [LearnWeb3 Web App Faucet](https://learnweb3.io/faucets) | Sepolia, OP Sepolia |
39+
| [Native USDC Faucet](https://faucet.circle.com/) | Sepolia, OP Sepolia |
40+
| [ETHGlobal Testnet Faucet](https://ethglobal.com/faucet) | Sepolia, OP Sepolia, Base Sepolia, Zora Sepolia, Holesky |
41+
| [Ethereum Ecosystem Faucets](https://www.ethereum-ecosystem.com/faucets) | Sepolia, OP Sepolia, Base Sepolia |
42+
| [thirdweb Sepolia Faucet](https://thirdweb.com/sepolia?utm_source=opdocs\&utm_medium=docs) | Sepolia |
43+
| [thirdweb OP Sepolia Faucet](https://thirdweb.com/op-sepolia-testnet?utm_source=opdocs\&utm_medium=docs) | OP Sepolia |
44+
| [Tenderly Unlimited Faucet](https://docs.tenderly.co/virtual-testnets/unlimited-faucet?mtm_campaign=ext-docs\&mtm_kwd=optimism) | OP Sepolia, OP Mainnet, and [85+ other networks](https://docs.tenderly.co/supported-networks?mtm_campaign=ext-docs\&mtm_kwd=optimism) |
4545

4646
## Bridge from Sepolia
4747

pages/app-developers/tools/supersim.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ This diagram illustrates how developers interact with Supersim through the CLI,
5656

5757
## Next steps
5858

59+
* Build a [revolutionary app](/app-developers/get-started) that uses multiple blockchains within the Superchain
60+
* Deploy a [SuperchainERC20](/stack/interop/tutorials/deploy-superchain-erc20) to the Superchain
61+
* View more [interop tutorials](/stack/interop/tutorials)
5962
* Check out the collection of [Supersim docs](/app-developers/tutorials/supersim) for tutorials and specific use cases.
6063
* Questions about Interop? Check out our collection of [interop guides](/stack/interop) or check out this [Superchain interop design video walk-thru](https://www.youtube.com/watch?v=FKc5RgjtGes).
6164
* For more info about how Superchain interoperability works under the hood, [check out the specs](https://specs.optimism.io/interop/overview.html).

pages/app-developers/transactions/parameters.mdx

+15-17
Original file line numberDiff line numberDiff line change
@@ -28,29 +28,27 @@ Note that, like Ethereum, the base fee is not explicitly defined within a transa
2828
Instead, the maximum base fee is determined as the difference between the `maxFeePerGas` and the `maxPriorityFeePerGas` fields of any given transaction.
2929

3030
<Steps>
31+
{<h3>Retrieve the latest block</h3>}
3132

32-
{<h3>Retrieve the latest block</h3>}
33+
Using the JSON-RPC API or your favorite Ethereum library, retrieve the latest block on OP Mainnet.
3334

34-
Using the JSON-RPC API or your favorite Ethereum library, retrieve the latest block on OP Mainnet.
35+
{<h3>Retrieve the base fee and gas used</h3>}
3536

36-
{<h3>Retrieve the base fee and gas used</h3>}
37+
From the block, retrieve the `baseFeePerGas` and `gasUsed` fields.
3738

38-
From the block, retrieve the `baseFeePerGas` and `gasUsed` fields.
39+
{<h3>Predict the next base fee</h3>}
3940

40-
{<h3>Predict the next base fee</h3>}
41+
OP Mainnet adjusts the base fee based on the amount of gas used in the previous block.
42+
If the previous block used more than 5m gas (of the 30m gas limit), then the base fee will increase by up to 10%.
43+
If the previous block used less than 5m gas, then the base fee will decrease by up to 10%.
44+
Refer to the [OP Mainnet EIP-1559 Parameters](/stack/differences#eip-1559-parameters) section for more details.
4145

42-
OP Mainnet adjusts the base fee based on the amount of gas used in the previous block.
43-
If the previous block used more than 5m gas (of the 30m gas limit), then the base fee will increase by up to 10%.
44-
If the previous block used less than 5m gas, then the base fee will decrease by up to 10%.
45-
Refer to the [OP Mainnet EIP-1559 Parameters](/stack/differences#eip-1559-parameters) section for more details.
46-
47-
{<h3>Select a base fee per gas</h3>}
48-
49-
Using the current base fee per gas and the amount of gas used in the previous block, you can predict the next base fee per gas.
50-
If you are highly sensitive to the base fee, you may want to select a base fee per gas that is either 10% higher or 10% lower than the previous base fee.
51-
However, you may run the risk that your transaction will not be included in a block quickly.
52-
If you are less sensitive to the base fee, you may wish to simply use a large multiple of the previous base fee (e.g. 2x).
46+
{<h3>Select a base fee per gas</h3>}
5347

48+
Using the current base fee per gas and the amount of gas used in the previous block, you can predict the next base fee per gas.
49+
If you are highly sensitive to the base fee, you may want to select a base fee per gas that is either 10% higher or 10% lower than the previous base fee.
50+
However, you may run the risk that your transaction will not be included in a block quickly.
51+
If you are less sensitive to the base fee, you may wish to simply use a large multiple of the previous base fee (e.g. 2x).
5452
</Steps>
5553

5654
## Selecting the priority fee
@@ -63,4 +61,4 @@ Many Ethereum libraries will provide a function to call this JSON-RPC method.
6361
You can also use the [`eth_feeHistory`](https://docs.alchemy.com/reference/eth-feehistory) JSON-RPC method to retrieve historical priority fee data.
6462
You can then use this data to predict a reasonable priority fee for your transaction.
6563

66-
Alternatively, you can rely on Tenderly's [`tenderly_gasPrice`](https://docs.tenderly.co/node/rpc-reference/optimism-mainnet/tenderly_gasPrice?mtm_campaign=ext-docs&mtm_kwd=optimism) to get real-time gas predictions with 3 levels of likelihood for transaction inclusion.
64+
Alternatively, you can rely on Tenderly's [`tenderly_gasPrice`](https://docs.tenderly.co/node/rpc-reference/optimism-mainnet/tenderly_gasPrice?mtm_campaign=ext-docs\&mtm_kwd=optimism) to get real-time gas predictions with 3 levels of likelihood for transaction inclusion.

pages/app-developers/tutorials/supersim/chain-env/included-contracts.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Callout, Steps } from 'nextra/components'
88

99
# Included contracts
1010

11-
The `supersim` chain environment includes contracts already deployed to help replicate the Superchain environment. See [OP Chain A](op-chain-a) for contract address examples for a L2 system.
11+
The `supersim` chain environment includes contracts already deployed to help replicate the Superchain environment. See [OP Chain A](./chain-a) for contract address examples for a L2 system.
1212

1313
## OP Stack system contracts (L1)
1414

pages/connect/contribute/style-guide.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ Developers trust that we will lead them to sites or pages related to their readi
292292

293293
* Use anchor links, whenever possible, to guide users to a specific page and location in the technical documentation. This reduces cognitive load and improves overall usability.
294294

295-
* To link to an anchor, such as an H3 tag within a page, you need to append it to the page name preceded by `#`, like this **example**: `[any descriptive text](/chain/getting-started/overview#test-your-application)`.
295+
* To link to an anchor, such as an H3 tag within a page, you need to append it to the page name preceded by `#`, like this **example**: `[any descriptive text](/stack/interop/tutorials/deploy-superchain-erc20)`.
296296

297297
### Linking across pages
298298

pages/notices/holocene-changes.mdx

-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ If you experience difficulty at any stage of this process, please reach out to [
1818

1919
The Holocene upgrade for the Soneium Minato (Sepolia) will be activated at **Fri Dec 20 at 09:00:00 UTC** (`1734685200`).
2020

21-
The Holocene upgrade for the Soneium Minato (Sepolia) will be activated at **Fri Dec 20 at 09:00:00 UTC** (`1734685200`).
22-
2321
The Holocene upgrade for the Mainnet Superchain is scheduled for **Thu 9 Jan 2025 18:00:01 UTC**, [governance approval](https://vote.optimism.io/proposals/20127877429053636874064552098716749508236019236440427814457915785398876262515).
2422

2523
The Holocene upgrade for the Soneium Mainnet will be activated at **Mon Feb 03 at 09:00:00 UTC** (`1738573200`).

0 commit comments

Comments
 (0)