Skip to content

Commit ba1bdf4

Browse files
committed
new pages for start here
1 parent 598b6a9 commit ba1bdf4

File tree

3 files changed

+210
-2
lines changed

3 files changed

+210
-2
lines changed

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ This section is designed to provide a comprehensive starting point for anyone ne
5555

5656
### The Essentials: Understanding Ergo's Vision
5757

58-
* **[Why Ergo?](dev/protocol/why.md):** A compelling narrative about the vision and philosophy behind Ergo.
58+
* **[Why Ergo?](start-here/why-ergo.md):** A compelling narrative about the vision and philosophy behind Ergo.
5959
* **[Protocol Overview](dev/protocol/protocol-overview.md):** A high-level introduction to the core components of the Ergo protocol.
6060
* **[The Ergo Manifesto](social_contract.md):** A deeper understanding of the project's guiding principles.
6161

@@ -69,7 +69,7 @@ This section is designed to provide a comprehensive starting point for anyone ne
6969

7070
* **[Ecosystem Overview](uses/use-cases-overview.md):** Showcasing the various applications and use cases on the Ergo platform.
7171
* **[Roadmap & Future](roadmap.md):** Offering a glimpse into the future of Ergo.
72-
* **[Community & Contributions](contribute.md):** For users who want to get involved.
72+
* **[Community & Contributions](start-here/contribute.md):** For users who want to get involved.
7373

7474
## Quick Links
7575

docs/start-here/contribute.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
tags:
3+
- contribute
4+
- community
5+
- development
6+
- marketing
7+
- documentation
8+
- bounties
9+
- grants
10+
- sigmanauts
11+
- getting started
12+
---
13+
14+
15+
# Contributing to Ergo
16+
17+
Read the context in [How Ergo Works](how-ergo-works.md), then pick one path.
18+
19+
## Choose your path
20+
21+
* **Developers**: start with the overview in [contribute/devs.md](contribute/devs.md), follow the rules in [contribute/technical-guidelines.md](contribute/technical-guidelines.md), check funding in [contribute/bounties.md](contribute/bounties.md) and [contribute/grants.md](contribute/grants.md), see team scopes in [contribute/roles.md](contribute/roles.md).
22+
23+
* **Marketing and community**: plan campaigns and content in [contribute/marketing.md](contribute/marketing.md), join structured community work in [contribute/sigmanauts.md](contribute/sigmanauts.md).
24+
25+
* **Other partnerships**: if you run an exchange, wallet, service, or community group, find contacts and process in [contribute/roles.md](contribute/roles.md), you can also propose work in [contribute/grants.md](contribute/grants.md) or [contribute/bounties.md](contribute/bounties.md).
26+
27+
28+
# Contributing to Ergo
29+
30+
Ergo is an open-source project driven by its community. Contributions of all kinds are welcome and essential for the ecosystem's growth and success. Whether you're a developer, writer, designer, marketer, researcher, or simply an enthusiastic user, there are many ways to get involved!
31+
32+
This page serves as a central hub for finding contribution opportunities.
33+
34+
## Ways to Contribute
35+
36+
### Development
37+
38+
* **Code Contributions:** Help build and improve Ergo's core protocol, node software, SDKs, tooling, and ecosystem projects.
39+
* **Getting Started:** Check out the [Developer Contribution Overview](devs.md) and the [Technical Contribution Guidelines](technical-guidelines.md).
40+
* **Finding Tasks:**
41+
* Look for issues tagged `good first issue` or `help wanted` in core repositories like [ergo](https://github.com/ergoplatform/ergo/issues), [sigmastate-interpreter](https://github.com/ergoplatform/sigmastate-interpreter/issues), [sigma-rust](https://github.com/ergoplatform/sigma-rust/issues?q=is%3Aissue+state%3Aopen+label%3A%22good+first+issue%22), [ergo-appkit](https://github.com/ergoplatform/ergo-appkit/issues).
42+
* Explore the official [Ergo Bounties Board](bounties.md) for funded tasks.
43+
* Consider applying for [Development Grants](grants.md) for larger projects.
44+
* **Community:** Join the development discussions on the [Ergo Discord Server](https://discord.gg/ergo-platform-668903786361651200) (check relevant `#dev` channels).
45+
46+
### Documentation
47+
48+
* **Improve ErgoDocs:** Help enhance this documentation site by fixing errors, improving clarity, adding examples, translating content, or writing new guides.
49+
* **Guide:** [Contributing to the Docs](docs.md)
50+
* **Repository:** [ergodocs on GitHub](https://github.com/ergoplatform/ergodocs) (Submit issues or pull requests here!)
51+
52+
### Marketing & Outreach
53+
54+
* **Spread the Word:** Help raise awareness about Ergo through social media, content creation (articles, videos), community engagement, and organizing local meetups.
55+
* **Guide:** [Marketing Contributions](marketing.md)
56+
57+
### Community Support & Engagement
58+
59+
* **Help Others:** Assist new users and developers in community channels like Discord and Telegram.
60+
* **Sigmanauts Program:** Join the [Sigmanauts Program](sigmanauts.md) for a more structured way to contribute to community building, education, and testing.
61+
62+
***'Let's create grassroots finance!'***
63+
64+
* **Testing:** Help test new node releases, wallet updates, and dApps.
65+
* **Design:** Contribute UI/UX improvements for [wallets](wallets-overview.md) and applications.
66+
* **Research:** Explore new cryptographic techniques, economic models, or protocol enhancements relevant to Ergo.
67+
68+
## Getting Started
69+
70+
1. **Explore:** Browse the different contribution areas linked above.
71+
2. **Connect:** Join the [Ergo Discord Server](https://discord.gg/ergo-platform-668903786361651200) and introduce yourself in relevant channels (e.g., `#development`, `#documentation`, `#marketing`).
72+
3. **Find a Task:** Look for open issues, bounties, or areas needing improvement that match your skills and interests. Don't hesitate to ask for guidance!
73+
4. **Contribute:** Follow the specific guidelines for the area you're contributing to (e.g., technical guidelines for code, documentation style guide for docs).
74+
75+
Every contribution, big or small, helps strengthen the Ergo ecosystem. Thank you for your interest!

docs/start-here/why-ergo.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
tags:
3+
- Why Ergo
4+
- Overview
5+
---
6+
7+
# Why Ergo?
8+
9+
Ergo is a next-generation smart contract platform that ensures the economic freedom of ordinary people through secure, accessible, and decentralized financial tools. Backed by a powerful scripting language, advanced cryptographic features, and a foundation rooted in the best principles of blockchain technology, Ergo is poised to revolutionize the concept of Contractual Money.
10+
11+
## Key Advantages
12+
13+
- Built for Everyone: Designed to be accessible and useful for regular people, not just tech experts.
14+
- Secure & Private: Uses advanced cryptography to keep your funds safe and transactions private.
15+
- Fair Launch: No pre-mine or initial coin offerings (ICOs) mean a fairer distribution from the start.
16+
- Powerful Tools: Supports advanced features like smart contracts for building useful applications (dApps).
17+
- Sustainable: Features like Storage Rent help keep the network efficient and long-lasting.
18+
19+
Explore the [Key Features](protocol-overview.md) for a high-level overview.
20+
21+
## The Vision Behind Ergo
22+
23+
### A Fusion of Research and Practicality
24+
25+
Ergo encapsulates over a decade of blockchain evolution, merging proven concepts with the latest in peer-reviewed academic research. This blend has empowered Ergo to embed [advanced cryptographic features](documents.md) directly into its core, crafting a resilient blockchain equipped for future innovations.
26+
27+
ErgoScript, the platform's programming language, exemplifies this innovation by enabling a wide range of functionalities, including ring signatures, atomic swaps, and self-replicating scripts, designed to set sophisticated rules for currency spending.
28+
29+
### Strength and Security
30+
31+
Engineered with a strong emphasis on security and versatility, Ergo offers a reliable foundation for dApps to operate with predictable costs. Its smart contracts ensure Turing completeness without compromising on predictability or affordability. Ergo adopts a declarative model for programming whereby it's always known in advance how much code will cost to run, avoiding the dangers of unrestricted functionality seen in some other platforms.
32+
33+
The introduction of [Sigma Protocols](sigma.md) and [Multi-stage Contracts](multi.md) enhances this further by supporting non-interactive zero-knowledge proofs and complex transaction conditions, facilitating intricate, secure, and efficient smart contract creation.
34+
35+
### Intelligent and User-Friendly
36+
37+
Ergo leverages Sigma Protocols [(Σ-Protocols)](sigma.md) to power its smart contracts, enabling the use of efficient zero-knowledge proofs. This allows for the performance of complex, privacy-sensitive tasks without intermediaries, fostering a trustless environment with unparalleled application-level privacy.
38+
39+
### Secure and Accessible to All
40+
41+
Ergo's dedication to universal blockchain security is evident through its implementation of Non-Interactive Proofs of Proof-of-Work [(NIPoPoWs)](nipopows.md). This feature allows users to transact and verify with confidence without a full node, requiring as little as 1 MB of data, making Ergo accessible on virtually any device.
42+
43+
Additionally, Ergo addresses sustainability through [Storage Rent](rent.md), incentivizing efficient data storage, and the [eUTXO](eutxo.md) model, enhancing privacy, scalability, and interoperability.
44+
45+
### Commodity Money and Innovation
46+
47+
Ergo transcends the traditional concept of a blockchain token, embodying **commodity money** with real-world consumption of resources for mining. This approach, rooted in securing commodities with cryptography, distinguishes Ergo with unique features:
48+
49+
- Incentives for long-term mining stability.
50+
- [Demurrage](storage-rent.md), reinforcing Ergo as a genuine commodity.
51+
- Support for decentralized derivatives and DeFi without intermediaries.
52+
- SigmaFi ([SigmaFi](sigmafi.md) bonds), a peer-to-peer DeFi solution surpassing traditional financial institutions in transparency and risk management.
53+
- Unparalleled support for developing [cryptographic protocols](crypto.md), including [non-interactive mixers](mixer.md) and [stealth addresses](stealth-address.md)
54+
55+
Ergo's recognition as the leading PoW cryptocurrency in DeFi supply demonstrates the practical application of its innovative features.
56+
57+
/// details | Open Source
58+
{type: info, open: true}
59+
**Open Source and Decentralized:** The majority of Ergo's ecosystem is open source, permissionless, and decentralized, fostering community involvement and allowing developers to build dApps quickly and efficiently.
60+
///
61+
62+
## The Genesis of Ergo
63+
64+
Launched in 2019 by esteemed developers and cryptocurrency luminaries, including Alex Chepurnoy and Dmitry Meshkov, Ergo emerged from a shared vision to revolutionize the blockchain landscape. The initiative aimed to craft an efficient, secure, and user-friendly platform for financial contracts.
65+
66+
### A Fair Start
67+
68+
Ergo was dedicated to ensuring a fair and equitable launch, reflecting Bitcoin's foundational principles to prevent undue influence from large-scale investors. This strategy democratized access and established a sustainable economic model for the network's growth.
69+
70+
The mining protocol allocated a portion of the rewards to a treasury, managed by the non-profit Ergo Foundation, to support ongoing development and adoption. In its first 2.5 years, the Foundation accumulated 4,330,791.5 ERGs (4.43% of the total supply). For more information, visit the [Ergo Foundation](ergo-foundation.md) and [emission](emission.md) sections.
71+
72+
- **Fixed Supply:** Ergo has a fixed supply of 97,739,924 coins, combating inflation.
73+
- **Extended Emission Schedule:** Through EIP-27, Ergo's mining rewards are extended for approximately 17.38 years, enhancing sustainability and making $ERG more scarce and valuable over time.
74+
75+
## Why Ergo Embraces Proof-of-Work
76+
77+
Ergo utilizes the [Autolykos](autolykos.md) Proof-of-Work protocol, demonstrating its commitment to decentralization and fairness. Proof of Work enables a user-friendly environment where lightweight clients can interact directly with the blockchain, creating a truly programmable currency that is accessible and ready for use today.
78+
79+
### How Does Ergo Address Bitcoin's Challenges?
80+
81+
Ergo addresses several key challenges inherent to Bitcoin, enhancing functionality, security, scalability, and privacy:
82+
83+
| Challenges Faced by Bitcoin | Ergo's Solution |
84+
|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
85+
| Limited smart contract functionality | Rich language (ErgoScript), eUTXO model, Sigma protocols, transaction chaining |
86+
| Unclear network security as block reward subsidy approaches zero and transaction fees remain low and volatile | More revenue from transaction fees due to DeFi and higher usage/scalability, storage rent, mining by subpools |
87+
| Lack of economy around state leading to miners receiving no compensation for holding UTXO set | Storage Rent provides additional rewards for miners, compensating for long-term UTXO holding |
88+
| Inefficient merkle tree data structure leading to inefficient light clients | AVL trees enabling drastically more efficient light client verification |
89+
| Weak and cumbersome optional privacy tools | Sigma protocols enable true peer-to-peer privacy, ErgoMixer provides better anonymity than Monero |
90+
| Massive scaling challenges | Decentralized on-chain governance, NiPoPoWs enable light clients with full node security, more Layer-2 options |
91+
92+
### How Does Ergo Address Ethereum's Challenges?
93+
94+
Ergo's UTXO-based programming model is **declarative**, specifying conditions for a transaction to be accepted (not changes to storage state). This contrasts with Ethereum's imperative Account model.
95+
96+
| Challenges Faced by Ethereum | Ergo's Solution |
97+
|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
98+
| Creating transactions and utilizing smart contracts requires paying fees in ETH | Babel Fees allow users to pay transaction fees in native tokens |
99+
| Gas requirement and the 'stopping problem' | No gas fees or stopping problem, most computations done off-chain, cost-predictable on-chain verification |
100+
| High gas fees and network congestion | Engineered with long-term scaling in mind, using advanced and well-researched tools |
101+
| Node centralization in AWS / Infura | Anyone can run a node (similar to Bitcoin), mitigants prevent bad node running experience |
102+
| Censorship: Most blocks are OFAC blocks | Decentralization and PoW deeply ingrained in Ergo's ethos, resists censorship |
103+
| Centralization of Monetary Policy with Vitalik and Ethereum Foundation able to change emission | All ERGs created in genesis block, released per pre-set emission schedule, changes require supermajority |
104+
| Poor security and frequent hacks costing billions | UTXO model and efficient onchain verification with most computation done off-chain |
105+
| Poor privacy tools due to Account ledger model | Combination of eUTXO model and sigma protocols achieves optional privacy superior to Monero |
106+
107+
View [Comparisons](https://ergonaut.space/en/Community/Comparisons) with other projects.
108+
109+
## Want to Learn More?
110+
111+
### Meet the Minds Behind Ergo
112+
113+
Ergo is powered by experienced developers and researchers with strong academic backgrounds in cryptography, compiler theory, blockchain technology, and cryptographic e-cash. Our team members have extensive experience in core development for cryptocurrencies and blockchain frameworks.
114+
115+
Notable contributor Alexander _kushti_ Chepurnoy co-founded smartcontract.com (now Chainlink), served as a core developer at NXT, and was among the first employees at IOHK.
116+
117+
Visit Ergo's [Hall of Fame](https://ergoplatform.org/en/hall_of_fame/) to learn more about our contributors. For information on foundation members, refer to the [EF Transparency Report](ergo-foundation.md).
118+
119+
### Roadmap
120+
121+
Stay ahead of Ergo's journey by visiting the 'Roadmap' section [on our website](https://ergoplatform.org/en/ecosystem/#Roadmap), where you can explore upcoming projects and innovative features.
122+
123+
### Resources
124+
125+
Deepen your understanding of Ergo with these resources:
126+
127+
- [The Ergo Manifesto](https://ergonaut.space/en/Ergo/manifesto)
128+
- [Explore Yield-Generating Strategies on Ergo](https://ergonaut.space/en/Guides/yield)
129+
- Our comprehensive [FAQ](faq.md)
130+
- [cafebedouin.org: _Why Ergo_](https://cafebedouin.org/2021/12/09/why-ergo/)
131+
- Join our community chats across the web listed at [direct.me/ergo](https://direct.me/ergo)
132+
133+
> _"Cryptocurrency should provide tools to enrich ordinary people. Small businesses struggling to make ends meet, not big depersonalised financial capital."_

0 commit comments

Comments
 (0)