You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .cursor/rules/wiki-guide.mdc
+19-1Lines changed: 19 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -8,31 +8,40 @@ alwaysApply: true
8
8
This rule provides general guidelines for contributing to the Web3 Wiki and instructs the AI assistant on its role in maintaining and improving the wiki content.
9
9
10
10
## Project Overview
11
+
11
12
This project is an open-sourced, community-driven initiative to build a comprehensive wiki for the Web3 ecosystem. The entire project is built and published as a site using the Obsidian Publish system. Consequently, all content creation, including text writing and formatting, must adhere to Obsidian's conventions, particularly for features like jump links, backlinks, and overall markdown formatting.
12
13
13
14
The wiki is organized into individual "cards," where each card is a distinct markdown file located within the `cards` directory. Cards are interconnected using Obsidian's internal linking system (e.g., `[[Ethereum]]`, `[[Bitcoin]]`) to create a navigable knowledge network.
14
15
15
16
## Card Categories
17
+
16
18
Each card must belong to one of the following three categories:
17
19
1. `explain-card`: For cards that explain a specific Web3 concept, technology, or protocol.
18
20
2. `show-card`: For cards that showcase a particular project, tool, or service.
19
21
3. `awesome-card`: For cards that curate a list of valuable resources related to a topic.
20
22
21
23
## Card Naming and Format
24
+
22
25
- **File Naming:**
23
26
- The filename of a card should accurately represent its core topic.
24
27
- The first letter of the filename must be uppercase.
25
28
- Examples: `Proof of Stake.md`, `Metamask.md`.
26
29
- **Mandatory Category Tag:**
27
30
- The very first line of every card file _must_ be the tag corresponding to its category (e.g., `#explain-card`, `#show-card`, `#awesome-card`). This is further detailed in the specific card type rule files.
31
+
- **File Location:**
32
+
- All new card markdown files **MUST** be created directly within the `cards` directory (e.g., `cards/My New Card.md`).
33
+
- No subdirectories within `cards` should be used for card storage unless explicitly specified in a future rule update.
34
+
- The AI assistant **MUST NOT** create card files in any other directory (e.g., the workspace root, `.cursor/rules/`, etc.).
28
35
29
36
## Card Content Rules
37
+
30
38
To maintain consistency, each card type has specific content structure and formatting rules. Please refer to the individual rule files for details:
As an AI assistant, you should proactively contribute to the quality and completeness of the Web3 Wiki. This includes:
37
46
1. **Review Existing Cards:** Regularly examine cards within the `cards` directory.
38
47
2. **Ensure Adherence to Rules:** Verify that cards comply with their respective content structure and formatting rules as defined in [`explain-card.mdc`](mdc:.cursor/rules/explain-card.mdc), [`show-card.mdc`](mdc:.cursor/rules/show-card.mdc), and [`awesome-card.mdc`](mdc:.cursor/rules/awesome-card.mdc).
@@ -47,5 +56,14 @@ As an AI assistant, you should proactively contribute to the quality and complet
47
56
- Propose specific, actionable changes to address the identified issues.
48
57
- When confident, and after clearly stating the intended changes, apply these improvements directly to the card files.
49
58
- Always aim to enhance the accuracy, comprehensiveness, and usability of the wiki.
50
-
5. **Cross-linking:** Actively look for opportunities to create relevant `[[Internal Links]]` between cards to improve the navigability and interconnectedness of the wiki. Ensure links are meaningful and contribute to the user's understanding.
59
+
5. **Cross-linking, External Links, and Link Validation:**
60
+
- **Internal Links:** Actively look for opportunities to create relevant `[[Internal Links]]` between cards. **Strictly ensure** that all internal links (`[[Page Name]]`) refer to existing card files (case-sensitive filename match, with `.md` extension implied) within the `cards` directory. **Under no circumstances** should a broken internal link be created. Before adding an internal link, **verify the existence of the target card file** (e.g., by listing directory contents). If the target card does not exist, the AI assistant **must either** (a) first create the target card (following all card creation rules, including correct file location) if it's a sensible addition to the wiki, or (b) omit the internal link entirely if creating the card is out of scope or not appropriate. Broken links are detrimental to wiki navigation and **must be avoided**.
61
+
- **External Links:** For key projects or tools, especially in `show-card` or `awesome-card` types, prioritize linking to their **official website or primary official resource** for user verification and direct access.
62
+
6. **Content Flow and Readability:**
63
+
- While bullet points are useful for lists (e.g., features, resources), **avoid excessive use of lists for descriptive content.**
64
+
- Prefer well-structured paragraphs to explain concepts, provide overviews, or detail use cases. This makes the content read more naturally and less like an AI-generated checklist.
65
+
- Aim for a balance: use lists where appropriate for clarity and scannability, but use prose for more narrative or explanatory sections.
66
+
7. **Card Creation Path Adherence:**
67
+
- When creating new cards as part of an improvement (e.g., to satisfy a needed internal link or create a new topic), the AI **MUST** ensure the new card file is created **directly within the `cards` directory** (e.g., `cards/My New Card.md`).
68
+
- The AI **MUST** adhere to all card naming conventions (uppercase first letter, accurate topic representation) and content structure rules for the chosen card type.
-**Brief overview:** The OP Stack is a standardized, shared, and open-source development stack that powers [[Optimism]] and its broader ecosystem, including the vision for a "Superchain" of interoperable Layer 2 (L2) blockchains. It is maintained by the Optimism Collective.
6
+
-**Importance in Web3:** The OP Stack aims to simplify the creation of new L2 blockchains by providing a common set of tools and components. This promotes collaboration, reduces redundant work, and fosters a more interconnected and scalable Ethereum ecosystem.
7
+
-**Basic definition:** A collection of software components (like consensus, execution, and sequencing modules) that can be assembled to build customized L2 rollups, primarily focused on Optimistic Rollups.
-**Modularity:** The OP Stack is designed to be modular, allowing developers to potentially customize or replace different components (e.g., data availability layer, execution layer) to suit specific needs, although current iterations like Bedrock are more tightly coupled for production readiness.
13
+
-**Standardization:** By providing a standard blueprint for L2s, the OP Stack facilitates interoperability between chains built with it, contributing to the Superchain concept where chains can communicate and share security more seamlessly.
14
+
-**Optimistic Rollups:** The current focus of the OP Stack is on building Optimistic Rollups, which assume transactions are valid by default and use fraud proofs to resolve disputes, thereby scaling Ethereum by processing transactions off-chain.
15
+
-**Bedrock Upgrade:** Bedrock is a significant iteration of the OP Stack, offering lower fees, faster deposits/withdrawals, and improved modularity. It serves as the foundation for current OP Stack based chains like OP Mainnet.
16
+
-**Superchain Vision:** The OP Stack is a key enabler of the Superchain, a proposed network of L2s that share security, communication layers, and the OP Stack itself, aiming to create a horizontally scalable and cohesive blockchain ecosystem.
17
+
18
+
## Use Cases
19
+
20
+
-**Building Custom L2 Rollups:** The primary use case is for developer teams to launch their own Optimistic Rollup L2 chains tailored to specific applications or communities (e.g., Base, Zora Network).
21
+
-**Powering OP Mainnet:** The OP Stack is the underlying technology for OP Mainnet, one of the leading Ethereum L2 scaling solutions.
22
+
-**Experimentation and Research:** While an official, production-ready version like Bedrock is recommended for mainnet deployments, the open-source nature of the OP Stack allows for experimentation with different L2 designs and configurations.
23
+
-**Enhancing Interoperability:** Chains built on the OP Stack are designed to be more easily interoperable, paving the way for smoother cross-chain communication and asset transfers within the Superchain.
Optimism (OP Mainnet) is a leading Layer 2 (L2) scaling solution for Ethereum, designed to offer faster transactions and lower fees while maintaining Ethereum's security. It utilizes Optimistic Rollup technology and is a core component of the envisioned Superchain ecosystem.
6
+
7
+
Its core purpose is to scale Ethereum by processing transactions off-chain and then batching them to the Ethereum mainnet. Key features include EVM equivalence (making it easy to deploy existing Ethereum dApps), the open-source [[Op Stack]] development framework, and a strong focus on public goods funding through Retroactive Public Goods Funding (RetroPGF).
8
+
9
+
For more details, visit the [official Optimism website](https://www.optimism.io/).
10
+
11
+
## Technical Details
12
+
13
+
-**Underlying Technology:** Optimism uses Optimistic Rollups. Transactions are executed on Optimism (L2), and data is posted to Ethereum (L1). It assumes transactions are valid unless challenged via a fault proof mechanism (previously fraud proof).
14
+
-**Architecture Overview:** Optimism's architecture is built upon the [[Op Stack]]. Key components include a sequencer (orders and executes transactions), a proposer (submits transaction batches to L1), and verifiers (can challenge the validity of L2 state roots submitted to L1).
15
+
-**Unique Selling Points:**
16
+
-**EVM Equivalence:** High degree of compatibility with Ethereum, simplifying dApp migration.
17
+
-**[[Op Stack]]:** The underlying open-source stack allows other projects (e.g., Base, Zora) to build their own L2s, fostering a broader ecosystem (the Superchain).
18
+
-**Optimism Collective & Governance:** A two-house governance system (Token House and Citizens' House) aims for a balanced and sustainable approach to network development and funding.
19
+
-**RetroPGF:** A novel mechanism for funding public goods that have already demonstrated impact.
20
+
21
+
## Use Cases
22
+
23
+
-**Scaling Ethereum dApps:** Many popular Ethereum dApps have deployed on Optimism to offer users lower fees and faster transactions, including DeFi protocols, NFT marketplaces, and gaming applications.
24
+
-**DeFi Ecosystem:** Hosts a vibrant DeFi ecosystem with decentralized exchanges, lending platforms, yield farming, and more.
25
+
-**NFTs:** Supports a growing NFT space with various marketplaces and projects.
26
+
-**Superchain Infrastructure:** Serves as a foundational L2 for the Superchain initiative, aiming for a network of interoperable L2s built on the OP Stack.
27
+
28
+
## Getting Started
29
+
30
+
-**How to use/access:** Users can interact with Optimism by adding the OP Mainnet network to EVM-compatible wallets (e.g., MetaMask) and using bridges like the official Optimism Bridge to transfer assets from Ethereum.
-**Brief overview:** A parachain, short for "parallelized chain," is an application-specific blockchain that connects to and is secured by a central Relay Chain, most notably [[Polkadot]]'s Relay Chain or [[Kusama]]'s Relay Chain.
6
+
-**Importance in Web3:** Parachains enable scalability and specialization within a larger blockchain ecosystem. They allow diverse blockchains with unique features and optimizations to coexist and interoperate while benefiting from the shared security of the Relay Chain.
7
+
-**Basic definition:** A Layer-1 blockchain that runs in parallel with other parachains, connected to and validated by a Layer-0 Relay Chain, forming a sharded network.
8
+
9
+
## Core Concepts
10
+
11
+
-**Relay Chain Connection:** Parachains lease a slot on the Relay Chain (e.g., through auctions on Polkadot/Kusama) to connect. Once connected, their blocks are validated by the Relay Chain's validators.
12
+
-**Shared Security:** Parachains inherit their security from the Relay Chain. This means they don't need to bootstrap their own validator set, significantly lowering the barrier to creating a secure blockchain.
13
+
-**Specialization:** Each parachain can be optimized for a specific use case (e.g., DeFi, NFTs, identity, smart contracts in a specific language like EVM or Wasm). They can have their own governance, native tokens, and runtime logic tailored to their purpose.
14
+
-**Interoperability (XCM):** Parachains within the same ecosystem (e.g., Polkadot) can communicate and exchange assets or arbitrary messages with each other using Cross-Consensus Message Format (XCM). This allows for rich cross-chain interactions.
15
+
-**Collators:** Parachain maintainers, known as collators, are responsible for producing new block candidates for their parachain and submitting them to the Relay Chain validators for inclusion and finalization.
16
+
-**Governance:** While security is shared, parachains typically maintain their own governance mechanisms for protocol upgrades and decision-making specific to their chain.
17
+
18
+
## Use Cases
19
+
20
+
-**Application-Specific Blockchains:** Building a blockchain optimized for a particular dApp or service (e.g., a DeFi-specific chain like Acala, an EVM-compatible smart contract platform like Moonbeam).
21
+
-**Ecosystem Hubs:** Parachains that act as hubs for specific functionalities, like smart contract execution, asset issuance, or bridging to other networks.
22
+
-**Consortium Chains:** Private or permissioned blockchains that connect to a public Relay Chain for security and interoperability.
23
+
-**Experimentation (on Kusama):** Parachains on Kusama often serve as a proving ground for new technologies and economic models before potential deployment on Polkadot.
Polkadot is a next-generation blockchain protocol designed to enable scalability, interoperability, and innovation by connecting multiple specialized blockchains (called parachains) into a single unified network. It was founded by Dr. Gavin Wood, co-founder of Ethereum, and is developed by the Web3 Foundation.
6
+
7
+
Its core purpose is to overcome the limitations of isolated blockchains by providing a shared security model (via its Relay Chain) and a framework for seamless cross-chain communication (XCM - Cross-Consensus Message Format). Key features include its sharded parachain architecture, on-chain governance, forkless upgrades, and the [[Substrate]] framework for building custom blockchains.
8
+
9
+
Discover more at the [official Polkadot website](https://polkadot.network/).
10
+
11
+
## Technical Details
12
+
13
+
-**Underlying Technology:** Polkadot uses a Nominated Proof-of-Stake (NPoS) consensus mechanism for its Relay Chain. The Relay Chain doesn't handle smart contracts directly but is responsible for coordinating the network, including security and consensus for connected parachains.
14
+
-**Architecture Overview:**
15
+
-**Relay Chain:** The heart of Polkadot, providing security and consensus to the network.
16
+
-**[[Parachain|Parachains]]:** Sovereign blockchains with their own logic, tokenomics, and governance, which connect to the Relay Chain for shared security and interoperability.
17
+
-**Parathreads:** Similar to parachains but with a pay-as-you-go model, suitable for projects not needing continuous connectivity.
18
+
-**Bridges:** Connect Polkadot to external blockchains like Ethereum or Bitcoin.
19
+
-**Unique Selling Points:**
20
+
-**Shared Security:** Parachains benefit from the economic security of the entire Polkadot network.
21
+
-**Interoperability:** Enables different blockchains to communicate and exchange data/assets trustlessly.
22
+
-**Customizability via [[Substrate]]:** Developers can build highly specialized blockchains tailored to specific use cases.
23
+
-**Forkless Upgrades:** The network can upgrade its own runtime without requiring hard forks, facilitated by on-chain governance.
24
+
-**On-Chain Governance:** A sophisticated governance system allows stakeholders to manage protocol upgrades, treasury funds, and other network parameters.
25
+
26
+
## Use Cases
27
+
28
+
-**DeFi Hubs:** Parachains dedicated to decentralized finance (e.g., Acala, Moonbeam often offering EVM compatibility).
29
+
-**NFT and Gaming Platforms:** Specialized parachains for NFTs, gaming, and metaverse applications.
30
+
-**Identity Solutions:** Blockchains focused on decentralized identity and credentialing.
31
+
-**IoT and Supply Chain:** Parachains designed for Internet of Things (IoT) data or supply chain management.
32
+
-**Cross-Chain Bridges and Services:** Enabling communication and asset transfer between Polkadot and other ecosystems.
33
+
34
+
## Getting Started
35
+
36
+
-**How to use/access:** Users interact with Polkadot and its native token (DOT) via wallets like Polkadot.js, Fearless Wallet, Nova Wallet, or hardware wallets. DOT is used for staking, governance, and parachain auctions/leases.
0 commit comments