Commit c593b8c2 authored by Ori Pomerantz's avatar Ori Pomerantz

fix(docs/op-stack): Various language updates

parent 0dfea1b5
...@@ -36,27 +36,23 @@ module.exports = { ...@@ -36,27 +36,23 @@ module.exports = {
apiKey: '2c1a86142192f96dab9a5066ad0c1d50', apiKey: '2c1a86142192f96dab9a5066ad0c1d50',
indexName: 'optimism' indexName: 'optimism'
}, },
nav: false, /* [ nav: [
{ {
text: 'Understanding the OP Stack', text: 'Home',
link: '/docs/understand/' link: 'https://www.optimism.io/'
}, },
{ {
text: 'Releases', text: 'OP Stack Docs',
link: '/docs/releases/' link: '/docs/'
}, },
{ {
text: 'Building', text: 'Optimism Docs',
link: '/docs/build/' link: 'https://community.optimism.io/'
}, },
{ {
text: 'Contribute', text: 'Governance',
link: '/docs/CONTRIB.md' link: 'https://community.optimism.io/docs/governance/'
},
{
text: 'Security',
link: '/docs/security/'
}, },
{ {
text: 'Community', text: 'Community',
...@@ -110,16 +106,19 @@ module.exports = { ...@@ -110,16 +106,19 @@ module.exports = {
} }
] ]
} }
], */ ],
searchPlaceholder: 'Search the docs', searchPlaceholder: 'Search the docs',
sidebar: { sidebar: {
'/': [ '/': [
{ {
title: "Understanding the OP Stack", title: "OP Stack",
collapsable: false, collapsable: false,
children: [ children: [
'/docs/understand/intro.md', '/docs/understand/intro.md',
[
'/docs/understand/design-principles.md', '/docs/understand/design-principles.md',
'Design Principles'
],
'/docs/understand/landscape.md', '/docs/understand/landscape.md',
] ]
}, },
......
...@@ -32,11 +32,6 @@ ...@@ -32,11 +32,6 @@
<i class="fab fa-discord"></i> Discord community <i class="fab fa-discord"></i> Discord community
</a> </a>
</li> </li>
<li>
<a href="https://oplabs.typeform.com/get-in-touch" target="_blank" rel="noopener noreferrer">
<i class="far fa-comment-dots"></i> Get support for going live
</a>
</li>
</ul> </ul>
</div> </div>
</div> </div>
......
...@@ -5,7 +5,7 @@ lang: en-US ...@@ -5,7 +5,7 @@ lang: en-US
Welcome to OP Stack Hacks, the **highly experimental** region of the OP Stack docs. OP Stack Hacks are an unofficial guide for messing around with the OP Stack. Here you’ll find information about ways that the OP Stack can be modified in interesting ways. Welcome to OP Stack Hacks, the **highly experimental** region of the OP Stack docs. OP Stack Hacks are an unofficial guide for messing around with the OP Stack. Here you’ll find information about ways that the OP Stack can be modified in interesting ways.
OP Stack Hacks create blockchains that aren’t exactly OP Stack, and may be insecure.. Hacked OP Stack chains can break key invariants that are required to interoperate with the Optimism Superchain (link). **Developers of chains that wish to interoperate with the Optimism Superchain should *not* include any hacks**. When in doubt, stick with the official components within [the current release of the OP Stack](../releases/README.md#current-release). OP Stack Hacks create blockchains that aren’t exactly OP Stack, and may be insecure. Hacked OP Stack chains can break key invariants that are required to interoperate with the Optimism Superchain (link). **Developers of chains that wish to interoperate with the Optimism Superchain should *not* include any hacks**. When in doubt, stick with the official components within [the current release of the OP Stack](../releases/README.md#current-release).
::: warning 🚧 OP Stack Hacks are explicitly things that you can do with the OP Stack that are *not* currently intended for production use ::: warning 🚧 OP Stack Hacks are explicitly things that you can do with the OP Stack that are *not* currently intended for production use
......
...@@ -17,7 +17,7 @@ The Settlement Layer includes modules that are used by third-party chains to est ...@@ -17,7 +17,7 @@ The Settlement Layer includes modules that are used by third-party chains to est
## Default ## Default
The default Settlement Layer module is currently the Attestation Proof Optimistic Settlement module. This module allows a third-party chain to become aware of the state of an OP Stack chain through an Optimistic protocol where challenges can be executed alongside a threshold of attestations from a pre-defined set of addresses over a state that differs from the proposed state. Once the Cannon fault proof is shipped to production, this default module will be replaced with a module that allows anyone to challenge proposals by playing the Cannon dispute game. The default Settlement Layer module is currently the Attestation Proof Optimistic Settlement module. This module allows a third-party chain to become aware of the state of an OP Stack chain through an Optimistic protocol where challenges can be executed alongside a threshold of attestations from a pre-defined set of addresses over a state that differs from the proposed state. With a Cannon fault proof shipped to production, this default module can be replaced with a module that allows anyone to challenge proposals by playing the Cannon dispute game.
## Security ## Security
......
...@@ -264,6 +264,6 @@ cast call <YOUR_BURN_CONTRACT_HERE> "total()" | cast --from-wei ...@@ -264,6 +264,6 @@ cast call <YOUR_BURN_CONTRACT_HERE> "total()" | cast --from-wei
## Conclusion ## Conclusion
With just a few tiny changes to the `op-node`, you were just able to implement a change to the OP Stack that allows you to keep track of the L1 ETH burn on L2. Once the Cannon fault proof system is live you’ll not only be able to track the L1 burn on L2, you’ll be able to *prove* the burn to contracts back on L1. You could build a trustless prediction market on the amount of ETH burned. That’s crazy! With just a few tiny changes to the `op-node`, you were just able to implement a change to the OP Stack that allows you to keep track of the L1 ETH burn on L2. With a live Cannon fault proof system, you should not only be able to track the L1 burn on L2, you should be able to *prove* the burn to contracts back on L1. You could build a trustless prediction market on the amount of ETH burned. That’s crazy!
The OP Stack is an extremely powerful platform that allows you to perform a large amount of computation trustlessly. It’s a superpower for smart contracts. Tracking the L1 burn is just one of the many, many wild things you can do with the OP Stack. If you’re looking for inspiration or you want to see what others are building on the OP Stack, check out our OP Stack Hacks page. Maybe you’ll find a project you want to work on, or maybe you’ll get the inspiration you need to build the next killer smart contract. The OP Stack is an extremely powerful platform that allows you to perform a large amount of computation trustlessly. It’s a superpower for smart contracts. Tracking the L1 burn is just one of the many, many wild things you can do with the OP Stack. If you’re looking for inspiration or you want to see what others are building on the OP Stack, check out our OP Stack Hacks page. Maybe you’ll find a project you want to work on, or maybe you’ll get the inspiration you need to build the next killer smart contract.
\ No newline at end of file
...@@ -8,7 +8,7 @@ The OP Stack is constantly evolving as new layers and modules are developed. The ...@@ -8,7 +8,7 @@ The OP Stack is constantly evolving as new layers and modules are developed. The
**A “Release” of the OP Stack is a particular set of software components that are production-ready and which fit the stack’s design principles and goals.** **A “Release” of the OP Stack is a particular set of software components that are production-ready and which fit the stack’s design principles and goals.**
Only the software components included within the Current Release of the OP Stack are considered in the scope of the OP Stack. Anything usage of the OP Stack outside of the official, intended capabilities of the Current Release are considered [OP Stack Hacks](../build/hacks.md) — unofficial modifications that are useful for experimentation but could have unforeseen results, such as security vulnerabilities, and are likely cause your chain to no longer be interoperable with the Optimism Superchain (link). **Developer support for OP Stack Hacks is limited — when in doubt, stick to the capabilities of the Current Release!** Only the software components included within the Current Release of the OP Stack are considered in the scope of the OP Stack. Any usage of the OP Stack outside of the official, intended capabilities of the Current Release are considered [OP Stack Hacks](../build/hacks.md) — unofficial modifications that are useful for experimentation but could have unforeseen results, such as security vulnerabilities, and are likely cause your chain to no longer be interoperable with the Optimism Superchain (link). **Developer support for OP Stack Hacks is limited — when in doubt, stick to the capabilities of the Current Release!**
## Current Release ## Current Release
......
...@@ -29,7 +29,7 @@ As with anything, modify the OP Stack at your own risk. There is no guarantee th ...@@ -29,7 +29,7 @@ As with anything, modify the OP Stack at your own risk. There is no guarantee th
**Not yet.** The OP Stack does not currently have a fault proof system. **Note that fault proofs do not meaningfully improve the security of a system if that system can be upgraded within the 7 day challenge window (”fast upgrade keys”)**. A system with fast upgrade keys is fully dependent on the upgrade keys for security. **Not yet.** The OP Stack does not currently have a fault proof system. **Note that fault proofs do not meaningfully improve the security of a system if that system can be upgraded within the 7 day challenge window (”fast upgrade keys”)**. A system with fast upgrade keys is fully dependent on the upgrade keys for security.
Fault proofs are a key roadmap item and top priority for the OP Stack. In the meantime, the OP Stack can be shipped with several other excellent security options for systems that want to improve security before fault proofs are available in production. Fault proofs are a key milestone and top priority for the OP Stack. In the meantime, the OP Stack can be shipped with several other excellent security options for systems that want to improve security before fault proofs are available in production.
### How can I help make the OP Stack more secure? ### How can I help make the OP Stack more secure?
...@@ -39,4 +39,4 @@ Don’t forget that the OP Stack is a decentralized development stack. Anyone ca ...@@ -39,4 +39,4 @@ Don’t forget that the OP Stack is a decentralized development stack. Anyone ca
### Where do I report bugs? ### Where do I report bugs?
[See here](./policy.md) [View the Security Policy for details about reporting vulnerabilities and available bug bounty programs](./policy.md)
\ No newline at end of file \ No newline at end of file
...@@ -56,5 +56,5 @@ Extensibility is a key design principle that unlocks the superpower of collabora ...@@ -56,5 +56,5 @@ Extensibility is a key design principle that unlocks the superpower of collabora
The OP Stack is a decentralized software stack that anyone can contribute to. The OP Stack is a decentralized software stack that anyone can contribute to.
If you're interested in contributing to the OP Stack, check out [the Contributing section of these docs](../CONTRIB.md). If you're interested in contributing to the OP Stack, check out [the Contributing section of these docs](../CONTRIB.md).
Of course, software that has impact for the Optimism Collective can receive Retroactive Public Goods Funding. Of course, software that has impact for the Optimism Collective can receive [Retroactive Public Goods Funding](https://app.optimism.io/retropgf).
Build for the OP Stack — get rewarded for writing great open source software. What's not to love? Build for the OP Stack — get rewarded for writing great open source software. What's not to love?
\ No newline at end of file
...@@ -92,9 +92,9 @@ An Attestation-based Fault Proof mechanism uses an optimistic protocol to establ ...@@ -92,9 +92,9 @@ An Attestation-based Fault Proof mechanism uses an optimistic protocol to establ
- [Specifications](https://github.com/ethereum-optimism/optimism/blob/develop/specs/withdrawals.md) (called [withdrawal transactions](https://community.optimism.io/docs/developers/bridge/messaging/#)) - [Specifications](https://github.com/ethereum-optimism/optimism/blob/develop/specs/withdrawals.md) (called [withdrawal transactions](https://community.optimism.io/docs/developers/bridge/messaging/#))
- [Source code](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/contracts) - [Source code](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/contracts)
#### Fault Proof Optimistic Settlement (proposed & in development) #### Fault Proof Optimistic Settlement (proposed)
A Fault Proof Optimistic Settlement mechanism is mostly identical to the Attestation-based Fault Proof mechanism used today but it replaces the MultiSig challenger with a permissionless fault proving process. A correctly constructed fault proof should be able to invalidate any incorrect proposals during the allocated challenge period. This places a trust assumption on the correctness of the fault proof construction. A Fault Proof Optimistic Settlement mechanism is mostly identical to the Attestation-based Fault Proof mechanism used today but it replaces the MultiSig challenger with a permissionless fault proving process. A correctly constructed fault proof should be able to invalidate any incorrect proposals during the allocated challenge period. This places a trust assumption on the correctness of the fault proof construction. At this time, work on the development of a Fault Proof mechanism is well underway.
#### Validity Proof Settlement (proposed) #### Validity Proof Settlement (proposed)
......
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