Skip to content

Commit 773edc0

Browse files
committed
Merge branch 'mintlify' into actions
2 parents d34f46d + 24dcfc8 commit 773edc0

File tree

62 files changed

+517
-115
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+517
-115
lines changed

.github/ISSUE_TEMPLATE/general_docs_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ labels: 'community-request,documentation'
66

77
---
88

9-
<!-- please fill out the description and acceptance criteria to the best to your ability. While the other sections are optional, it makes resolving the issue much easier. -->
9+
<!-- please fill out the description and acceptance criteria to the best of your ability. While the other sections are optional, it makes resolving the issue much easier. -->
1010

1111
## Description
1212
<!-- Write a clear and concise description of the docs request. For example, is the request related to an existing page or are you suggesting a brand-new docs page? -->

.vale.ini

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Top level styles
2+
StylesPath = .vale/styles
3+
MinAlertLevel = suggestion
4+
IgnoredScopes = code, tt, img, url, a
5+
SkippedScopes = script, style, pre, figure, code
6+
7+
# Vocabularies
8+
Vocab = Optimism
9+
10+
# This is required since Vale doesn't officially support MDX
11+
[formats]
12+
mdx = md
13+
14+
# MDX support
15+
[*.mdx]
16+
BasedOnStyles = Vale
17+
Vale.Terms = NO # Enforces really harsh capitalization rules, keep off
18+
19+
# `import ...`, `export ...`
20+
# `<Component ... />`
21+
# `<Component>...</Component>`
22+
# `{ ... }`
23+
TokenIgnores = (?sm)((?:import|export) .+?$), \
24+
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
25+
(<[A-Z]\w+>.+?<\/[A-Z]\w+>)
26+
27+
# Exclude:
28+
# `<Component \n ... />`
29+
BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
30+
(?sm)^({.+.*})
31+
32+
CommentDelimiters = {/*, */}

words.txt renamed to .vale/styles/config/vocabularies/Optimism/accept.txt

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,3 +450,55 @@ ZKPs
450450
ZKVM
451451
zora
452452
Zora
453+
Ethereum
454+
Mainnet
455+
interop
456+
mempool
457+
onchain
458+
Jito
459+
Timeboost
460+
DEXs
461+
Mips
462+
blockchain
463+
Rollup
464+
monorepo
465+
Config
466+
batcher
467+
GWei
468+
tx
469+
rpc
470+
dev
471+
blockchains
472+
testnet
473+
Testnet
474+
zlib
475+
cpu
476+
goroutine
477+
mutex
478+
wei
479+
deployer
480+
validator
481+
liveness
482+
nat
483+
trie
484+
Geth
485+
validators
486+
Relayer
487+
calldata
488+
sequencer's
489+
attestors
490+
patricia
491+
golang
492+
subtrees
493+
endianness
494+
Endianness
495+
VMs
496+
archiver
497+
CPUs
498+
EOAs
499+
hardcoded
500+
Prysm
501+
Teku
502+
Etherscan
503+
SSDs
504+
HHDs

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Optimism Docs
1+
# Optimism Docs
22

3-
This repo houses the Optimism Docs located at [docs.optimism.io](https://docs.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo.
3+
This repo houses the Optimism Docs located at [docs.optimism.io](https://docs.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo.
44

55
## Local Development
66

@@ -9,4 +9,3 @@ Follow these [mintlify docs](https://www.mintlify.com/docs/installation) to prev
99
## License
1010

1111
This project is licensed under the [MIT License](https://github.com/ethereum-optimism/optimism/blob/develop/LICENSE).
12-

app-developers/guides/bridging/messaging.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ Each message from L2 to L1 requires three transactions:
197197
1. An L2 transaction that *initiates* the transaction, which is priced the same as any other transaction made on OP Mainnet.
198198

199199
2. An L1 transaction that *proves* the transaction.
200-
This transaction can only be submitted after L2 block, including your L2 transaction, is proposed on L1.
200+
This transaction can only be submitted after the L2 block, including your L2 transaction, is proposed on L1.
201201
This transaction is expensive because it includes verifying a [Merkle trie](/connect/resources/glossary#merkle-patricia-trie) inclusion proof on L1.
202202

203203
3. An L1 transaction that *finalizes* the transaction.

app-developers/guides/bridging/standard-bridge.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ After providing a sufficient allowance, the user calls the [`bridgeERC20To`](htt
6868
* `address _to`: Address of the recipient of these tokens, usually the sender's address.
6969
* `uint256 _amount`: Number of tokens to transfer.
7070
* `uint32 _minGasLimit`: Gas to use to complete the transfer on the receiving side.
71-
* `bytes calldata _extraData`: Optional identify extra data.
71+
* `bytes calldata _extraData`: Optional identity extra data.
7272

7373
<Info>
7474
Users can also trigger the [`bridgeERC20`](https://github.com/ethereum-optimism/optimism/blob/2e647210882d961f04055e656590d90ad98c9934/packages/contracts-bedrock/src/universal/StandardBridge.sol#L168-L191) function instead of `bridgeERC20To` to avoid needing to specify the `address _to` parameter.
@@ -154,7 +154,7 @@ Unlike when bridging native tokens, users do not need to provide an approval to
154154
* `address _to`: Address of the recipient of these tokens, usually the sender's address.
155155
* `uint256 _amount`: Number of tokens to transfer.
156156
* `uint32 _minGasLimit`: Gas to use to complete the transfer on the receiving side.
157-
* `bytes calldata _extraData`: Optional identify extra data.
157+
* `bytes calldata _extraData`: Optional identity extra data.
158158

159159
</Step>
160160

app-developers/guides/interoperability/get-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ The SuperchainERC20 Starter Kit allows you to focus on what to deploy, not how t
3030

3131
| Tool | Description |
3232
| ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
33-
| [Superchain Faucet](https://console.optimism.io/faucet?utm_source=op-docs&utm_medium=docs) | One stop shop to grab testnet ETH for any Superchain network. |
33+
| [Superchain Faucet](https://console.optimism.io/faucet?utm_source=op-docs&utm_medium=docs) | One-stop shop to grab testnet ETH for any Superchain network. |
3434
| [Supersim](/interop/tools/supersim) | Local multi-chain testing environment for smart contracts. |
3535
| [Super CLI](https://github.com/ethereum-optimism/super-cli) | Command-line tool for seamless multichain app deployment and testing. |
3636
| [Superchain Relayer](https://github.com/ethereum-optimism/superchain-relayer) | UI for monitoring and managing cross-chain transactions. |
3737
| [Interop Docs](/interop/explainer) | Comprehensive Interop information in the Optimism Docs. |
38-
| [Superchain Dev Console](https://console.optimism.io/?utm_source=op-docs&utm_medium=docs) | Comprensive tool to build, launch, and grow your app on the Superchain. |
38+
| [Superchain Dev Console](https://console.optimism.io/?utm_source=op-docs&utm_medium=docs) | Comprehensive tool to build, launch, and grow your app on the Superchain. |
3939
| [Developer Support GitHub](https://github.com/ethereum-optimism/developers/discussions) | Quick and easy developer support. |
4040

4141
## Handy step-by-step guides

app-developers/tools/data/analytics-tools.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
22
title: Analytics tools
3-
description: Learn about platforms you can use to gather analytics and setup customizations
3+
description: Learn about platforms you can use to gather analytics and set up customizations
44
about OP Mainnet.
55
---
6-
The following guide lists platforms you can use to gather analytics and setup customizations about OP Mainnet.
6+
The following guide lists platforms you can use to gather analytics and set up customizations about OP Mainnet.
77

88
## Blocknative
99

1010
[Blocknative](https://www.blocknative.com/) lets you [decode](http://docs.blocknative.com/ethernow/batch-decoder-api) and [analyze](https://docs.blocknative.com/blocknative-data-archive/blob-archive) OP Stack Batches submitted to the Ethereum L1. You can inspect, analyze, decode, and download the data of any batch – confirmed on-chain or not – via public APIs or visually through the [Ethernow Explorer](http://ethernow.xyz). Below you can find links to the different resources:
1111

12-
* [Batch Decoding API](http://docs.blocknative.com/ethernow/batch-decoder-api): decode OP Stack Batch transactions into its human-readable, JSON format.
12+
* [Batch Decoding API](http://docs.blocknative.com/ethernow/batch-decoder-api): decode OP Stack Batch transactions into their human-readable JSON format.
1313
* [Blob Archive API](https://docs.blocknative.com/blocknative-data-archive/blob-archive): take any versioned hash of an OP Stack Blob and receive the blob data (even beyond the 4096 epoch window of storage).
1414
* [Mempool Archive](https://docs.blocknative.com/blocknative-data-archive/mempool-archive): Analyze any OP Stack transaction that was in the Ethereum mempool to see detection time, time pending, gas, etc.
15-
* [Ethernow explorer](http://ethernow.xyz): Visually see transactions and batches enter the mempool and get organized into blocks. Use this filter to see OP Stack Batches enter the mempool and land on-chain.
15+
* [Ethernow Explorer](http://ethernow.xyz): Visually see transactions and batches enter the mempool and get organized into blocks. Use this filter to see OP Stack Batches enter the mempool and land on-chain.
1616

1717
## Tenderly
1818

1919
[Tenderly](https://tenderly.co/?mtm_campaign=ext-docs&mtm_kwd=optimism) provides comprehensive monitoring and security solutions for OP-powered Chains, allowing you to stay informed and respond proactively to potential issues in real time.
2020

2121
* Configure [Tenderly Alerts](https://docs.tenderly.co/alerts/intro-to-alerts?mtm_campaign=ext-docs&mtm_kwd=optimism) for monitoring wallets and setting up real-time notifications on transactions and contract events. Notifications trigger external webhooks, PagerDuty, or chat apps like Telegram and Slack.
22-
* Rely on [Developer Explorer](https://docs.tenderly.co/developer-explorer?mtm_campaign=ext-docs&mtm_kwd=optimism) to monitor and analyze transaction execution with high level of details.
22+
* Rely on [Developer Explorer](https://docs.tenderly.co/developer-explorer?mtm_campaign=ext-docs&mtm_kwd=optimism) to monitor and analyze transaction execution with a high level of detail.
2323
* Use [Web3 Actions](https://docs.tenderly.co/web3-actions/intro-to-web3-actions?mtm_campaign=ext-docs&mtm_kwd=optimism) to automate predefined responses, improving security and user experience.
2424
* Integrate [Simulation RPC](https://docs.tenderly.co/simulations/single-simulations#simulate-via-rpc?mtm_campaign=ext-docs&mtm_kwd=optimism) to predict transaction outcomes such as the expected asset changes, precise gas usage, and emitted events.
2525

26-
## Dune analytics
26+
## Dune Analytics
2727

2828
[Dune Analytics](https://dune.com) allows anyone to create dashboards that present information about OP Chains (OP Mainnet, Base, and Zora are available). See [Dune Docs](https://dune.com/docs/) for more info.
2929
You can find a list of community created dashboards for OP Chains [here](https://dune.com/browse/dashboards?q=tags%3Aop%2Coptimism%2Csuperchain\&order=trending\&time_range=24h), or [create your own](https://docs.dune.com/#queries) dashboard.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Data and Dashboards
3+
description: Learn about various dashboards and terms to explore various Superchain metrics.
4+
---
5+
6+
The following resources are available to help you explore various Superchain metrics:
7+
8+
* [Data Glossary](/app-developers/tools/data/data-glossary): Definitions, methodology, and calculation notes for key metrics
9+
* [Superchain Health Dashboard](https://docs.google.com/spreadsheets/d/1f-uIW_PzlGQ_XFAmsf9FYiUf0N9l_nePwDVrw0D5MXY/edit?gid=192497306#gid=192497306): High-level metrics across the Superchain
10+
* [Superchain Strategic Focus Dashboard](https://app.hex.tech/61bffa12-d60b-484c-80b9-14265e268538/app/d28726b2-ff11-4f94-8a9f-6bb0a86f4b46/latest): In-depth metrics with chain-level splits and industry benchmarks
11+
* [Optimism Superchain Raw Onchain Data](https://console.cloud.google.com/bigquery/analytics-hub/exchanges/projects/523274563936/locations/us/dataExchanges/optimism_192d403716e/listings/optimism_superchain_raw_onchain_data_192fdc72e35): Raw Blocks, Logs, Transactions, Traces data for chains in the Superchain, updated daily.
12+
* [Optimism Superchain 4337 Account Abstraction Data](https://console.cloud.google.com/bigquery/analytics-hub/exchanges/projects/523274563936/locations/us/dataExchanges/optimism_192d403716e/listings/optimism_superchain_4337_account_abstraction_data_1954d8919e1): Decoded account abstraction UserOps across the Superchain.
Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: Data Glossary
3+
description: This glossary explains various data terms.
4+
---
5+
6+
This glossary is a living document and will be updated over time as new metrics emerge or definitions evolve.
7+
8+
| Metric | What It Measures | Why It Matters |
9+
| ------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------- |
10+
| Real Economic Value (REV) | Fees paid by users to transact (txn fees + out-of-protocol tips) | Captures users' willingness to pay for onchain activity |
11+
| Collective Revenue | ETH earned by the Optimism Collective | Revenue can be directed by governance to support ecosystem growth |
12+
| Total Value Locked (TVL) | Tokens locked in DeFi protocols and other apps | Supply side of the DeFi ecosystem |
13+
| Gas Used per Second | Average compute consumed onchain | Measures throughput and execution load |
14+
| Median Transaction Fee | Typical cost for a user to transact | Lower fees reduce friction and may unlock broader usage |
15+
| Market Share | Superchain's share of activity vs. the broader crypto industry | Tracks relative performance against L2s or the broader market |
16+
17+
## Measure Demand
18+
19+
### Transaction Fees Paid
20+
21+
**Metric:** Real Economic Value (REV)
22+
23+
**Definition:** The total fees paid to execute a transaction onchain. This includes both the traditional gas fees required for inclusion onchain and additional fees paid to transaction execution services (e.g., Jito, Flashbots, Timeboost).
24+
25+
**Calculation:** Gas Fees + Out-of-Protocol Tips (e.g., Jito, Flashbots, Timeboost)
26+
27+
* Out-of-Protocol Tips can be sourced from Defillama's MEV category
28+
29+
**Why it matters:**
30+
31+
* REV is a topline metric that "measures the monetary demand to transact onchain" (Blockworks).
32+
* It's used as a proxy for users' willingness to pay, capturing all transaction fees to better reflect real demand (excludes app-level fees like DEX swap costs).
33+
34+
### Revenue
35+
36+
**Metric:** Estimated Optimism Collective Revenue (Collective Revenue)
37+
38+
**Definition:** The amount of ETH expected to be earned by the Optimism Collective from revenue sharing.
39+
40+
**Calculation:** For each chain, take the greater of (a) 2.5% of Chain Revenue or (b) 15% of Net Onchain Profit. OP Mainnet contributes 100% of Net Onchain Profit.
41+
42+
**Key Components:**
43+
44+
* **Net Onchain Profit:** Chain Revenue - L1 Gas Fees
45+
* **Chain Revenue:** Sum of the L1 Data Fee + L2 Base Fee + L2 Priority Fee + L2 Operator Fee (Also includes any additional fee types added in the future.)
46+
* *L1 Gas Fees:* Total gas fees spent by the chain on L1 in transaction batches (including blob costs) and state output submissions or dispute games.
47+
* **Transaction Batches:** All transactions where the transaction from address is the `batcherHash` address and the transaction to address is the `batchInbox` as defined in the chains' `SystemConfigProxy` contract.
48+
* **State Output Submissions or Dispute Games:** All transactions where the transaction from address is the `Proposer` and the transaction to address is either the `outputOracleProxy` or the `disputeGameFactoryProxy` as defined in the chains' `SystemConfigProxy` contract.
49+
* Each chain's `SystemConfigProxy` contract can be found in the Superchain Registry.
50+
* **Resolving Dispute Games:** All transactions sent to dispute game contracts created by the `disputeGameFactoryProxy`, where the transaction's method id (function call) is either `Resolve`, `ResolveClaim`, or `ClaimCredit`.
51+
52+
**Why it matters:**
53+
54+
* This is what the Optimism Collective earns by operating the Superchain, which can be directed by governance to support ecosystem growth.
55+
* See How (and why) the Superchain drives fees to the Optimism Collective (Optimism blog, Aug 2024)
56+
57+
## Onchain Signals
58+
59+
### Value Onchain
60+
61+
**Metric:** Total Value Locked (TVL)
62+
63+
**Definition:** "Value of all coins held in smart contracts of the protocol" (Defillama).
64+
65+
**Calculation:** The sum of all USD value of assets locked in applications, as reported by DefiLlama.
66+
67+
* TVL can be priced in USD or a crypto asset like ETH, but both are subject to price volatility. USD is often used because it's easier to interpret and consistent across the broader crypto ecosystem.
68+
69+
**Why it Matters:** TVL represents the supply side of onchain economic activity for use in protocols such as Decentralized Exchanges (DEXs) and lending markets. Strong TVL in the right places may enable greater onchain demand.
70+
71+
#### How to Measure Growth: Net TVL Flows
72+
73+
Because TVL is influenced by market fluctuations, it can be misleading when trying to measure true growth or user behavior. Net TVL Flows can adjust for this by tracking the net change in token balances, valued at current prices.
74+
75+
**Calculation:** ( `# of Tokens on Day N` - `# of Tokens on Day 0` ) \* `Price of Tokens on Day N`
76+
77+
**Example:** If an app has 100,000 ETH locked on Day 0 when ETH/USD is $2,000, and 90,000 ETH locked at $3,000 on Day N:
78+
79+
* Net TVL Flows = −10,000 ETH × $3,000 = $30 million in net outflows
80+
* Naive TVL change would suggest growth: $200 million → $270 million
81+
82+
## Network Usage & Infrastructure
83+
84+
**Metric:** Gas Used per Second (gas/s)
85+
86+
**Definition:** "Gas refers to the unit that measures the amount of computational effort required to execute specific operations on Ethereum" (ethereum.org). Gas Used is tracked as an average rate per second for simplicity.
87+
88+
**Why it Matters:** Gas, sometimes referred to as blockspace, is the limited resource that blockchains provide. Gas used shows how much of that resource is actually being consumed.
89+
90+
**Caution:** Gas is only comparable across chains that use Ethereum-equivalent gas units.
91+
92+
### User Experience (UX)
93+
94+
**Metric:** Median Transaction Fee (USD)
95+
96+
**Definition:** The median gas fee paid to submit a transaction, expressed in USD for simplicity and easier comparison across ecosystems.
97+
98+
**Calculation:** Median of all transaction fees over a period of time, marked at the USD price at the time of the transaction.
99+
100+
**Why it Matters:** This metric serves as a proxy for the cost to transact. Lower median fees enable broader usage by reducing friction, lowering breakeven costs, and unlocking use cases that would otherwise be cost-prohibitive.
101+
102+
## Market Share
103+
104+
**Definition:** The Superchain's share of a broader market segment for any measure (e.g., L2s, total crypto).
105+
106+
**Calculation:** Superchain Metric Value / Total Market Metric Value
107+
108+
**Why it Matters:** Market share helps isolate whether growth is driven by the Superchain itself, or is simply part of a broader market trend. A rising share signals outperformance, while a declining share suggests that other ecosystems are growing faster.
109+

0 commit comments

Comments
 (0)