Skip to content

Commit 1160364

Browse files
Refactor and enhance card content across multiple types, improving internal linking processes and validation steps for tags and names. Update guidelines for content creation, ensuring clarity and consistency. Expand sections in existing cards to provide comprehensive overviews, unique benefits, and detailed features, while introducing new features like native Account Abstraction in zkSync and off-chain data availability in zkPorter.
1 parent 76e77ea commit 1160364

11 files changed

+437
-86
lines changed

.cursor/rules/agent-polish.mdc

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,22 @@ These instructions guide the AI assistant in polishing a Web3 Wiki card to ensur
99

1010
## Polishing Workflow
1111

12-
Execute the following steps methodically for the card under review:
12+
The first step is to add internal links to the card:
1313

14-
1. Check the card tag: Run `python3 scripts/check-tag.py` to validate the tag. Fix the errors if there are any issues.
15-
2. Check the card name: Run `python3 scripts/check-card-name.py` to verify the name. Fix the errors if there are any issues.
16-
4. Add internal links to the card. Carefully parse the card content to find all terms that can be linked to other cards in the wiki, you can find the list of all existing card names(the physical existing cards) in `scripts/card_index.txt`. Add links for each of those terms. Ensure all the internal links are valid and point to existing cards, no planned cards. **This is critical**
17-
5. Check the cards internal links: Run `python3 scripts/check-internal-links.py` to verify that all internal links in the card are valid and point to existing cards. Address any reported errors.
18-
6. Provide feedback: suggest new cards, identify cards for improvement.
14+
Carefully parse and analyze the card content to identify all terms that can be linked to existing cards in the wiki. You can find the list of all existing card names (the physical existing cards) in `scripts/card_index.txt`. Then, add links for each of those terms. Ensure all internal links are valid and point to existing cards, not planned cards. **This is critical**
15+
16+
Then, perform the following checks:
17+
18+
1. Check the card tag: Automatically run the command `python3 scripts/check-tag.py` at the root of the repo to validate the tag. Fix any errors if issues are found.
19+
2. Check the card name: Automatically run the command `python3 scripts/check-card-name.py` at the root of the repo to verify the name. Fix any errors if issues are found.
20+
3. Check the card's internal links: Automatically run the command `python3 scripts/check-internal-links.py` at the root of the repo to verify that all internal links in the card are valid and point to existing cards. Fix any errors it reports until it succeeds. **This is important**
21+
22+
Finally, provide feedback: suggest new cards and identify cards for improvement.
1923

2024
## Output of Polishing Task
2125

22-
Upon completion, provide a report including:
26+
Upon completion, provide concise feedback:
2327

24-
1. A summary of all checks performed and any corrections made to the card.
25-
2. A list of suggested new card titles (e.g., "New Concept X.md") with a short justification for each.
26-
3. A list of existing cards (including the one just polished, if applicable) that may warrant further review or updates, along with the rationale.
28+
1. A summary of all checks performed and any corrections made to the card.
29+
2. A list of suggested new card titles (e.g., "New Concept X.md") with one sentence justification for each.
30+
3. A list of existing cards (including the one just polished, if applicable) that may warrant further review or updates, along with a short rationale.

.cursor/rules/explain-card.mdc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,9 @@ This section outlines the recommended content areas for an `explain-card`. While
5252
- Constituent Building Blocks: Identify if the current concept is composed of other, more fundamental concepts. Explain how these building blocks combine and interact, and link to their respective `explain-card`s.
5353
- Related & Adjacent Ideas: Discuss other concepts that are closely related, often discussed in conjunction, or represent contrasting approaches. Link to relevant `explain-card`s to encourage broader exploration.
5454
- Advanced Topics & Future Research: Suggest avenues for further learning, including more advanced topics or open research questions related to the concept, for users who wish to delve deeper.
55+
56+
### Final Notes **This is important**
57+
58+
- Ensure the AI assistant reviews all sections and subsections, reorganizing content logically and avoiding robotic phrasing.
59+
- Prioritize detailed and informative content across all sections, expanding beyond single-sentence explanations.
60+
- For comprehensive explanations, utilize dedicated subsections rather than bullet points to offer greater depth and context.

.cursor/rules/show-card.mdc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Please note that we should put the summary in the `Overview` section instead of
5151
- Offer a balanced and detailed comparison.
5252
- Preferably, include a table for the comparison.
5353

54-
### Final Notes
54+
### Final Notes **This is important**
5555

56-
- Review the card's structure and content flow, adjusting as needed to ensure clarity and comprehensiveness.
57-
- Avoid overly brief descriptions. Aim for detailed and informative content in all sections, moving beyond single-sentence explanations.
58-
- For detailed explanations, favor dedicated subsections over bullet points to provide depth and context.
56+
- Ensure the AI assistant reviews all sections and subsections, reorganizing content logically and avoiding robotic phrasing.
57+
- Prioritize detailed and informative content across all sections, expanding beyond single-sentence explanations.
58+
- For comprehensive explanations, utilize dedicated subsections rather than bullet points to offer greater depth and context.

cards/Arbitrum.md

Lines changed: 52 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,66 @@
22

33
## Overview
44

5-
Arbitrum is a leading Layer 2 (L2) scaling solution for Ethereum, developed by Offchain Labs. It aims to provide faster transaction speeds and lower fees compared to the Ethereum mainnet while inheriting its security. Arbitrum utilizes Optimistic Rollup technology and supports a vibrant ecosystem of decentralized applications (dApps).
5+
Arbitrum is a [[Layer 2]] scaling solution for [[Ethereum]], designed to address the network's challenges of high transaction fees and slow transaction speeds. It aims to make Ethereum applications faster, cheaper, and more scalable without sacrificing the security guarantees of the underlying Ethereum mainnet. Arbitrum achieves this primarily through Optimistic Rollup technology, processing transactions off-chain and then batching them together before submitting them to Ethereum.
66

7-
- **Problem Solved:** Addresses Ethereum's scalability limitations by processing transactions off-chain, reducing congestion and cost on the mainnet.
8-
- **Value Proposition:** Offers high throughput, low transaction fees, EVM compatibility, and a robust developer and user ecosystem.
9-
- **Official Website:** [https://arbitrum.io/](https://arbitrum.io/)
10-
- **Status:** Live (Arbitrum One mainnet, Arbitrum Nova for ultra-low cost transactions).
7+
The core mission of Arbitrum is to scale Ethereum and provide a significantly improved user experience for decentralized applications (dApps). It solves the problem of network congestion on Ethereum, which can lead to exorbitant gas fees and slow confirmation times, hindering adoption and usability.
118

12-
## Key Features
9+
Unique benefits and advantages of Arbitrum include its strong EVM-compatibility (making it easy for [[Ethereum]] developers to migrate their dApps), its robust security model that inherits security from Ethereum, and its vibrant and rapidly growing ecosystem. A key differentiator is its advanced fraud-proof system and the development of features like Arbitrum Stylus, which allows for smart contracts to be written in multiple programming languages beyond Solidity.
1310

14-
- **Optimistic Rollups:** Assumes transactions are valid by default and uses a fraud-proving mechanism for challenges.
15-
- **Arbitrum Virtual Machine (AVM):** While EVM compatible, it has its own execution environment designed for efficiency.
16-
- **Arbitrum Orbit:** A framework allowing projects to launch their own customizable Layer 3 chains that settle to Arbitrum Layer 2s.
17-
- **Stylus:** Enables smart contract development in multiple programming languages like Rust, C, and C++, in addition to Solidity, by compiling to WASM.
18-
- **Separate Chains (e.g., Arbitrum One, Arbitrum Nova):** Offers different chains tailored for various use cases (e.g., Arbitrum One for DeFi and NFTs, Arbitrum Nova for gaming and social applications with an AnyTrust chain).
11+
Arbitrum was developed by Offchain Labs, a company co-founded by Ed Felten, Steven Goldfeder, and Harry Kalodner, all with strong backgrounds in computer science and cryptography. Key milestones include the launch of Arbitrum One, the mainnet rollup chain, the significant performance upgrade with Arbitrum Nitro, the introduction of Arbitrum Nova (an AnyTrust chain optimized for gaming and social applications), and the launch of the ARB governance token.
1912

20-
## Technology
13+
### Get Started with Arbitrum
2114

22-
- **Blockchain/Platform:** Layer 2 solution built on [[Ethereum]].
23-
- **Architecture:** Sequencer batches transactions, posts data to Ethereum L1. Verifiers can challenge state via fraud proofs.
24-
- **Core Mechanism:** Optimistic Rollup with advanced fraud-proving capabilities.
15+
| Resource | Link | Description |
16+
| ------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------- |
17+
| Official Website | [https://arbitrum.io/](https://arbitrum.io/) | Main website for Arbitrum information. |
18+
| Foundation | [https://arbitrum.foundation/](https://arbitrum.foundation/) | The foundation supporting the Arbitrum ecosystem and DAO. |
19+
| Developer Docs | [https://developer.arbitrum.io/](https://developer.arbitrum.io/) | Comprehensive documentation for developers building on Arbitrum. |
20+
| Bridge | [https://bridge.arbitrum.io/](https://bridge.arbitrum.io/) | Official bridge to transfer assets between Ethereum and Arbitrum. |
21+
| Block Explorer | [https://arbiscan.io/](https://arbiscan.io/) | Arbitrum One block explorer. |
22+
| Nova Explorer | [https://nova.arbiscan.io/](https://nova.arbiscan.io/) | Arbitrum Nova block explorer. |
23+
| GitHub | [https://github.com/OffchainLabs](https://github.com/OffchainLabs) | Source code and repositories for Arbitrum. |
24+
| Community (Discord) | Access via [Arbitrum Foundation](https://arbitrum.foundation/) | Official Discord server for community discussions and support. |
25+
| Twitter | [https://twitter.com/arbitrum](https://twitter.com/arbitrum) | Official Twitter account for news and updates. |
2526

26-
## Ecosystem & Use Cases
27+
## Key Services/Features
2728

28-
- **Target Audience:** Developers, DeFi users, NFT traders, gamers, and applications requiring high throughput.
29-
- **How It's Used:** DeFi, NFTs, gaming, social applications, DAO governance.
30-
- **Tokenomics (ARB Token):** The ARB token is used for governance of the Arbitrum DAO.
29+
### Arbitrum One
3130

32-
## Getting Started & Resources
31+
Arbitrum One is the flagship [[Layer 2]] Optimistic Rollup chain for [[Ethereum]]. It is designed for general-purpose dApp deployment and aims to provide a highly scalable and low-cost environment for EVM-compatible smart contracts.
32+
The underlying technology involves bundling transactions off-chain and submitting compressed data to the Ethereum mainnet. It uses an "optimistic" approach where transactions are assumed valid by default, but there's a challenge period during which anyone can submit a fraud proof if they detect an invalid state transition. The Nitro upgrade significantly improved its performance by compiling core Geth engine code to WASM.
33+
Real-world use cases include a wide array of [[Decentralized finance]] (DeFi) protocols, NFT marketplaces, DAOs, and other dApps seeking to escape Ethereum's high gas fees. It allows for faster and cheaper swaps, lending, borrowing, and NFT minting/trading. Official documentation can be found at [developer.arbitrum.io/public-chains](https://developer.arbitrum.io/public-chains).
3334

34-
- **Access:** Add Arbitrum One or Nova to EVM-compatible wallets; use bridges to transfer assets.
35-
- **Documentation:** [https://developer.arbitrum.io/](https://developer.arbitrum.io/)
36-
- **Community:** Active Discord, Twitter, and governance forum.
37-
- **Bridge:** [https://bridge.arbitrum.io/](https://bridge.arbitrum.io/)
35+
### Arbitrum Nova
3836

39-
## Related Concepts
37+
Arbitrum Nova is another chain in the Arbitrum ecosystem, but it utilizes AnyTrust technology instead of being a pure Optimistic Rollup. AnyTrust chains are designed for ultra-low transaction fees and high throughput, making them suitable for applications like gaming, social media, and high-volume dApps where minor trust assumptions are acceptable for greater performance.
38+
Nova relies on a Data Availability Committee (DAC) to store transaction data. This reduces costs compared to storing all data on [[Ethereum]] like Arbitrum One. However, it introduces an additional trust assumption on the honesty and availability of the DAC members. If the DAC fails, the chain can fall back to rollup mode, posting data to Ethereum.
39+
Use cases for Nova focus on applications that require very frequent, low-value transactions, such as in-game actions, social tipping, or frequent micro-transactions. Official documentation can be found at [developer.arbitrum.io/public-chains](https://developer.arbitrum.io/public-chains).
4040

41-
- [[Ethereum]]
42-
- Layer 2 rollups (or [[Rollup]])
43-
- Optimistic rollups
44-
- [[EVM]]
41+
### Arbitrum Orbit
42+
43+
Arbitrum Orbit allows projects to launch their own customizable Layer 3 (L3) chains that settle to an Arbitrum [[Layer 2]] chain (like Arbitrum One or Nova) or directly to Ethereum as a Layer 2. This enables developers to create application-specific chains with tailored features, throughput, and governance.
44+
The technology allows for permissionless deployment of dedicated rollups or AnyTrust chains. Developers can configure aspects like gas token, privacy, and permissions. These L3s inherit security from their settlement layer (L2 or L1) while offering further scalability and customization.
45+
Orbit chains can be used by projects wanting dedicated blockspace, predictable fees, and greater control over their environment, without building an L1 from scratch. Examples include game-specific chains or enterprise solutions. More information can be found on the [Arbitrum Orbit page](https://arbitrum.io/orbit).
46+
47+
### Arbitrum Stylus
48+
49+
Arbitrum Stylus is a significant upgrade that introduces a multi-language programming environment for smart contracts on Arbitrum chains. It allows developers to write smart contracts in languages like Rust, C, and C++, in addition to Solidity and other EVM languages, by compiling them to WebAssembly (WASM).
50+
This feature greatly expands the developer pool for Arbitrum and allows for more performant and gas-efficient smart contracts due to the capabilities of languages like Rust and C++. Stylus contracts are interoperable with EVM contracts, meaning they can call each other seamlessly.
51+
This opens up possibilities for more complex and computationally intensive applications on Arbitrum, leveraging the strengths of different programming languages. Details are available in the [Stylus documentation](https://developer.arbitrum.io/stylus/stylus-gentle-introduction).
52+
53+
## Comparative Analysis
54+
55+
Arbitrum is one of several leading [[Layer 2]] solutions for Ethereum. Its main competitors include [[Optimism]], [[Polygon]] (specifically its ZK-EVM and other L2 efforts), and [[ZKSync]].
56+
57+
| Feature | Arbitrum (One) | Optimism (Bedrock) | Polygon (ZK-EVM) | zkSync (Era) |
58+
| ------------------ | ---------------------------------------------------------------- | --------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------ |
59+
| Technology | Optimistic Rollup | Optimistic Rollup | ZK-Rollup (zk-SNARKs) | ZK-Rollup (zk-SNARKs) |
60+
| EVM Compatibility | High (EVM-equivalent with Nitro) | High (EVM-equivalent) | High (EVM-equivalent) | EVM-compatible (Solidity, Vyper via LLVM compiler) |
61+
| Fraud Proofs | Interactive, multi-round proofs | Single-round proofs | Validity proofs (cryptographic) | Validity proofs (cryptographic) |
62+
| Data Availability | On-chain (Ethereum) | On-chain (Ethereum) | On-chain (Ethereum) or off-chain options | On-chain (Ethereum) or off-chain (zkPorter) |
63+
| Maturity | Well-established, large ecosystem | Well-established, growing ecosystem | Newer, rapidly developing | Developing, focus on ZK innovations |
64+
| Native Token | ARB (Governance) | OP (Governance) | MATIC (Gas, Staking, Governance on PoS chain) | ETH (for gas), future token for decentralization |
65+
| Key Differentiator | Nitro upgrade performance, Stylus multi-language VM, mature tech | Simplicity of fraud proofs, OP Stack for Superchain | ZK-proofs for higher security, EVM equivalence | Native account abstraction, zkPorter data availability |
66+
67+
Arbitrum's Optimistic Rollup technology, particularly after the Nitro upgrade, offers a strong balance of EVM compatibility, speed, and cost-effectiveness. Its fraud-proofing system is more complex than Optimism's but aims to be more efficient. Compared to ZK-Rollups like Polygon ZK-EVM and zkSync, Optimistic Rollups generally have lower computational overhead for transaction processing but rely on a challenge period for finality, whereas ZK-Rollups provide faster finality once proofs are submitted. The introduction of Stylus also sets Arbitrum apart by broadening language support for smart contract development.

0 commit comments

Comments
 (0)