Skip to content

Commit ad6b8ac

Browse files
authored
Merge pull request #1885 from jsvisa/clear-document
docs: fix clarity issues in documentation
2 parents c3a9421 + ec2e07b commit ad6b8ac

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

app-developers/reference/tokens/compatible-tokens.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,11 @@ CCT is a token standard used to send, receive, and compose tokens across chains
8989

9090
### OFT
9191

92-
OFT is a token standard used to send, receive, and compose tokens across chains LayerZero supports. More information will be added about how OFTs can benefit from Superchain interop at a later date.
92+
OFT is a token standard used to send, receive, and compose tokens across chains LayerZero supports.
93+
94+
<Info>
95+
Integration documentation for OFTs with Superchain interop is currently being developed. Check back for updates or refer to [LayerZero's OFT documentation](https://docs.layerzero.network/v2/developers/evm/oft/quickstart) for current implementation details.
96+
</Info>
9397

9498
* **Security:** Variable due to weakest-link scenario based on allowlisted verification mechanisms.
9599
* **Latency:** 1-block latency within the Superchain. Outside the Superchain, latency is variable based on allowlisted verification (DVN) mechanism.
@@ -100,7 +104,11 @@ OFT is a token standard used to send, receive, and compose tokens across chains
100104

101105
### NTT
102106

103-
NTT is a token standard used to send, receive, and compose tokens across chains Wormhole supports. More information will be added about how NTTs can benefit from Superchain interop at a later date.
107+
NTT is a token standard used to send, receive, and compose tokens across chains Wormhole supports.
108+
109+
<Info>
110+
Integration documentation for NTTs with Superchain interop is currently being developed. Check back for updates or refer to [Wormhole's NTT documentation](https://docs.wormhole.com/wormhole/native-token-transfers) for current implementation details.
111+
</Info>
104112

105113
* **Security:** Variable due to weakest-link scenario based on allowlisted verification mechanisms.
106114
* **Latency:** 1-block latency within the Superchain. Outside the Superchain, latency is variable based on allowlisted verification (transceiver) mechanism.

index.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ mode: "wide"
1616
## Components
1717

1818
The OP Stack is an open-source, modular, Ethereum Layer 2 rollup stack.
19-
Before you deploy, it is important to understand how the key components and how they come together to create your blockchain.
19+
Before you deploy, it is important to understand the key components and how they come together to create your blockchain.
2020

21-
- **L1 Smart contracts**: A set of smart contracts to be deployed on Ethereum to bridge between the L1 and L2 domains and manage aspects of the rollup.
22-
- **Sequencer**: A single privileged node that accept and derive user transactions on the network to construct the blockchain.
23-
- **Batcher**: A sequencer service that publishes L2 transactions onto Ethereum.
21+
- **L1 Smart contracts**: A set of smart contracts to be deployed on Ethereum to bridge between the L1 and L2 domains and manage aspects of the rollup.
22+
- **Sequencer**: A single privileged node that accepts and derives user transactions on the network to construct the blockchain.
23+
- **Batcher**: A sequencer service that publishes L2 transactions onto Ethereum.
2424
Using Ethereum as a data availability layer, the OP Stack inherits Ethereum's security properties by allowing any node to derive the state of the L2 blockchain from L1.
2525
- **Proposer**: A service responsible for publishing the L2 state root to Ethereum which enables user withdrawals of assets.
26-
- **Challenger**: The challenger enforces network security by disputing invalid state roots that have been posted to Ethereum.
26+
- **Challenger**: The challenger enforces network security by disputing invalid state roots that have been posted to Ethereum.
2727

2828
## Deployment
2929

@@ -34,7 +34,7 @@ The following section will walk you through the sequence of steps a chain operat
3434
Using a CLI tool called [op-deployer](/chain-operators/tools/op-deployer) you will configure your chain and then deploy the smart contracts on Ethereum.
3535
</Step>
3636
<Step title="Validate your deployment">
37-
After deploying the L1 smart contracts you will use [op-validator](/chain-operators/tools/op-validator) to verify that your deployment configurations what you expect.
37+
After deploying the L1 smart contracts you will use [op-validator](/chain-operators/tools/op-validator) to verify that your deployment configurations match what you expect.
3838
</Step>
3939
<Step title="Chain genesis creation">
4040
After deploying the L1 smart contracts, you will use [op-deployer](/chain-operators/tools/op-deployer) to generate two files necessary to run nodes on the L2 network:
@@ -61,4 +61,4 @@ The following section will walk you through the sequence of steps a chain operat
6161
## Next Steps
6262

6363
Of course there is a lot more work to do ensure you're operating a highly available chain.
64-
Take a look at some of the [chain operator best practices](/chain-operators/guides/management/best-practices) to get an idea of some of the things you'll need to keep in mind.
64+
Take a look at some of the [chain operator best practices](/chain-operators/guides/management/best-practices) to get an idea of some of the things you'll need to keep in mind.

0 commit comments

Comments
 (0)