Skip to content

Commit b5567eb

Browse files
authored
Merge pull request #1004 from ethereum-optimism/protocol-dir-lift
taking the protocol section up a level
2 parents 5519663 + 72ae27c commit b5567eb

Some content is hidden

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

56 files changed

+118
-126
lines changed

components/WipCallout.tsx

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,21 @@ export function InfoCallout({ context }: Props): ReactElement {
7373
);
7474
}
7575

76-
export function AltCallout({ context }: Props): ReactElement {
76+
interface BetaCalloutProps extends Props {
77+
featureName: string;
78+
}
79+
80+
function BetaCallout({ context, featureName }: BetaCalloutProps): ReactElement {
7781
return (
7882
<div className="custom-callouts nx-w-full nx-mt-6 nx-flex nx-justify-center nx-items-center nx-bg-white dark:nx-bg-black">
79-
<div className="nx-w-full nx-px-4 nx-text-center nx-font-medium nx-text-sm nx-text-left">
83+
<div className="nx-w-full nx-px-4 nx-text-center nx-font-medium nx-text-sm nx-text-left">
8084
{context ? (
8185
context
8286
) : (
83-
<div className="nx-text-left">
84-
The Alt-DA Mode feature is currently in <strong>Beta</strong> within
87+
<div className="nx-text-left" role="alert" aria-live="polite">
88+
The {featureName} feature is currently in <strong>Beta</strong> within
8589
the MIT-licensed OP Stack. Beta features are built and reviewed by
86-
the Optimism Collectives core contributors, and provide developers
90+
the Optimism Collective's core contributors, and provide developers
8791
with early access to highly requested configurations. These features
8892
may experience stability issues, and we encourage feedback from our
8993
early users.
@@ -93,3 +97,11 @@ export function AltCallout({ context }: Props): ReactElement {
9397
</div>
9498
);
9599
}
100+
101+
export function AltCallout(props: Props): ReactElement {
102+
return <BetaCallout {...props} featureName="Alt-DA Mode" />;
103+
}
104+
105+
export function CGTCallout(props: Props): ReactElement {
106+
return <BetaCallout {...props} featureName="Custom Gas Token" />;
107+
}

next-env.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
/// <reference types="next/image-types/global" />
33

44
// NOTE: This file should not be edited
5-
// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
5+
// see https://nextjs.org/docs/basic-features/typescript for more information.

pages/builders/app-developers/bridging/messaging.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ The L1 proof and finalization transactions are typically significantly more expe
215215

216216
One of the most important things to understand about L1 ⇔ L2 interaction is that **mainnet messages sent from Layer 2 to Layer 1 cannot be relayed for at least 7 days**.
217217
This means that any messages you send from Layer 2 will only be received on Layer 1 after this one week period has elapsed.
218-
We call this period of time the "challenge period" because it is the time during which a transaction can be challenged with a [fault proof](/stack/protocol/rollup/overview#fault-proofs).
218+
We call this period of time the "challenge period" because it is the time during which a transaction can be challenged with a [fault proof](/stack/rollup/overview#fault-proofs).
219219

220220
Optimistic Rollups are "optimistic" because they're based around the idea of publishing the *result* of a transaction to Ethereum without actually executing the transaction on Ethereum.
221221
In the "optimistic" case, this transaction result is correct and one can completely avoid the need to perform complicated (and expensive) logic on Ethereum.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
---
33

4-
import SuperchainERC20 from '@/pages/stack/protocol/interop/superchain-erc20.mdx'
4+
import SuperchainERC20 from '@/pages/stack/interop/superchain-erc20.mdx'
55

66
<SuperchainERC20 />
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
---
33

4-
import Supersim from '@/pages/stack/protocol/interop/supersim.mdx'
4+
import Supersim from '@/pages/stack/interop/supersim.mdx'
55

66
<Supersim />

pages/builders/chain-operators/configuration/rollup.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -973,7 +973,7 @@ instead of the older output oracle mechanism.
973973

974974
The Custom Gas Token configuration lets OP Stack chain operators deploy their
975975
chain allowing a specific ERC-20 token to be deposited in as the native token
976-
to pay for gas fees. Learn more [here](/stack/protocol/features/custom-gas-token).
976+
to pay for gas fees. Learn more [here](/stack/beta-features/custom-gas-token).
977977

978978
***
979979

@@ -1005,7 +1005,7 @@ gas on L2.
10051005
Alt-DA Mode enables seamless integration of various Data Availability (DA)
10061006
Layers, regardless of their commitment type, into the OP Stack. This allows
10071007
any chain operator to launch an OP Stack chain using their favorite DA Layer
1008-
for sustainably low costs. Lean more [here](/stack/protocol/features/alt-da-mode).
1008+
for sustainably low costs. Lean more [here](/stack/beta-features/alt-da-mode).
10091009

10101010
***
10111011

pages/builders/chain-operators/features/alt-da-mode.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { Callout, Steps } from 'nextra/components'
1313
These features may experience stability issues, and we encourage feedback from our early users.
1414
</Callout>
1515

16-
This guide provides a walkthrough for chain operators who want to run an Alt-DA Mode chain. See the [Alt-DA Mode Explainer](/stack/protocol/features/alt-da-mode) for a general overview of this OP Stack configuration.
16+
This guide provides a walkthrough for chain operators who want to run an Alt-DA Mode chain. See the [Alt-DA Mode Explainer](/stack/beta-features/alt-da-mode) for a general overview of this OP Stack configuration.
1717
An Alt-DA Mode OP Stack chain enables a chain operator to post and read data to any alternative data availability layer that has built a functioning OP Stack DA Server.
1818

1919
<Callout>
@@ -44,7 +44,7 @@ You should use at least the following compatible op\* versions when running your
4444
* Celestia's docs on how to run the [Celestia DA server](https://github.com/celestiaorg/op-plasma-celestia/blob/main/README.md)
4545
* EigenDA's docs on how to run the [EigenDA DA server](https://github.com/Layr-Labs/op-plasma-eigenda/blob/main/README.md)
4646
* Avail's docs on how to run the [AvailDA DA Server](https://docs.availproject.org/docs/build-with-avail/Optimium/op-stack/op-stack#setup-avail-da-server)
47-
* 0gDA's docs on how to run the [0gDA DA Server](https://github.com/0glabs/0g-da-op-plasma/blob/op0g/README.md)
47+
* 0gDA's docs on how to run the [0gDA DA Server](https://github.com/0glabs/0g-da-op-plasma)
4848
* Near DA's docs on how to run the [Near DA Server](https://github.com/Nuffle-Labs/data-availability/blob/84b484de98f58a91bf12c8abe8df27f5e753f63a/docs/OP-Alt-DA.md)
4949

5050
### Configure Your `op-node`
@@ -224,6 +224,6 @@ After making these changes, your system should be properly configured to use the
224224

225225
## Next Steps
226226

227-
* Additional questions? See the FAQ section in the [Alt-DA Mode Explainer](/stack/protocol/features/alt-da-mode#faqs).
227+
* Additional questions? See the FAQ section in the [Alt-DA Mode Explainer](/stack/beta-features/alt-da-mode#faqs).
228228
* For more detailed info on Alt-DA Mode, see the [specs](https://specs.optimism.io/experimental/alt-da.html).
229229
* If you experience any problems, please reach out to [developer support](https://github.com/ethereum-optimism/developers/discussions).

pages/builders/chain-operators/features/custom-gas-token.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { Callout, Steps } from 'nextra/components'
1212
The Custom Gas Token feature is a Beta feature of the MIT licensed OP Stack. While it has received initial review from core contributors, it is still undergoing testing, and may have bugs or other issues.
1313
</Callout>
1414

15-
This guide provides a walkthrough for chain operators who want to run a custom gas token chain. See the [Custom Gas Token Explainer](/stack/protocol/features/custom-gas-token) for a general overview of this OP Stack feature.
15+
This guide provides a walkthrough for chain operators who want to run a custom gas token chain. See the [Custom Gas Token Explainer](/stack/beta-features/custom-gas-token) for a general overview of this OP Stack feature.
1616
An OP Stack chain that uses the custom gas token feature enables an end user to deposit an L1 native ERC20 token into L2 where that asset is minted as the native L2 asset and can be used to pay for gas on L2.
1717

1818
<Steps>
@@ -156,6 +156,6 @@ section of the docs.
156156

157157
## Next Steps
158158

159-
* Additional questions? See the FAQ section in the [Custom Gas Token Explainer](/stack/protocol/features/custom-gas-token#faqs).
159+
* Additional questions? See the FAQ section in the [Custom Gas Token Explainer](/stack/beta-features/custom-gas-token#faqs).
160160
* For more detailed info on custom gas tokens, see the [specs](https://specs.optimism.io/experimental/custom-gas-token.html).
161161
* If you experience any problems, please reach out to [developer support](https://github.com/ethereum-optimism/developers/discussions).
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
22
"chain-monitoring": "Chain Monitoring",
3-
"op-challenger": "Configure Challenger For Your Chain",
4-
"op-conductor": "Conductor",
5-
"op-deployer": "Deployer",
6-
"explorer": "Block Explorer"
3+
"explorer": "Block Explorer",
4+
"op-challenger": "op-challenger",
5+
"op-conductor": "op-conductor",
6+
"op-deployer": "op-deployer",
7+
"op-txproxy": "op-txproxy",
8+
"proxyd": "proxyd"
79
}

pages/builders/chain-operators/tools/chain-monitoring.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Additional flags:
7171

7272
You can find more info on `op-dispute-mon` on [the repo](https://github.com/ethereum-optimism/optimism/tree/develop/op-dispute-mon).
7373

74-
Chain operators can easily create their grafana dashboard for Dispute Monitor using the following json file: [Download the Dispute Monitor JSON](/grafana/dispute-monitor-1718214549035.json).
74+
Chain operators can easily create their grafana dashboard for Dispute Monitor using the following json file: [Download the Dispute Monitor JSON](/resources/grafana/dispute-monitor-1718214549035.json).
7575

7676
## Offchain Component Monitoring
7777

@@ -108,7 +108,7 @@ You can find more information about these flags in our [Batcher configuration do
108108
### `op-challenger`
109109

110110
The `op-challenger` operates as the *honest actor* in the fault dispute system and defends the chain by securing the `OptimismPortal` and ensuring the game always resolves to the correct state of the chain.
111-
For verifying the legitimacy of claims, `op-challenger` relies on a synced, trusted rollup node as well as a trace provider (e.g., [Cannon](/stack/protocol/fault-proofs/cannon)). See the [OP-Challenger Explainer](/stack/protocol/fault-proofs/challenger) for more information on this service.
111+
For verifying the legitimacy of claims, `op-challenger` relies on a synced, trusted rollup node as well as a trace provider (e.g., [Cannon](/stack/fault-proofs/cannon)). See the [OP-Challenger Explainer](/stack/fault-proofs/challenger) for more information on this service.
112112

113113
To enable metrics, pass the `--metrics.enabled` flag to `op-challenger` and follow the steps above for customization options.
114114

0 commit comments

Comments
 (0)