From 335da468284a6b0dc23a1c63da893f3b18ecfc0c Mon Sep 17 00:00:00 2001 From: Joe Nyzio Date: Fri, 5 Nov 2021 11:32:23 -0400 Subject: [PATCH] Welcome <> Tutorials (#219) * Welcome <> Tutorials Same info exists in Welcome section as tutorials section. By bringing tutorial items into welcome section, we can get people started with the basics using the most up to date Celo language. * Update Basics & Platform Updated pages, links, headings for Celo Basics and Celo Platform sections * Remove bold headers Removed bold headers throughout learn folder. * Why Celo Changed introduction to "Why Celo" and a few edits * mobile, open, and real Added mobile, open, and real * add links to deploy docs * fix link Co-authored-by: Josh --- docs/learn/CELO-coin-summary.md | 10 +- docs/learn/celo-economic-model.md | 4 +- docs/learn/celo-ecosystem.md | 26 ++-- .../{celo-value.md => celo-highlights.md} | 8 +- docs/learn/celo-milestones.md | 14 +- docs/learn/celo-onboarding.md | 12 +- docs/learn/celo-overview.md | 18 +-- docs/learn/celo-protocol-summary.md | 10 +- docs/learn/celo-protocol.md | 14 +- docs/learn/celo-resources.md | 42 ++--- docs/learn/celo-stack.md | 8 +- docs/learn/celo-summary.md | 8 +- docs/learn/celo-whitepapers.md | 6 +- docs/learn/developer-onboarding.md | 20 +-- docs/learn/developer-tools.md | 28 ++-- docs/learn/evm-compatible-tooling.md | 22 ++- .../platform-native-stablecoins-summary.md | 10 +- docs/learn/topology-of-a-celo-network.md | 10 +- docs/learn/valora-summary.md | 10 +- docs/learn/{celo-purpose.md => why-celo.md} | 32 ++-- docs/overview.md | 147 +++--------------- docs/welcome.md | 143 ++--------------- docusaurus.config.js | 4 +- sidebars.js | 65 ++++---- src/components/HomepageFeatures.js | 2 +- 25 files changed, 231 insertions(+), 442 deletions(-) rename docs/learn/{celo-value.md => celo-highlights.md} (99%) rename docs/learn/{celo-purpose.md => why-celo.md} (88%) diff --git a/docs/learn/CELO-coin-summary.md b/docs/learn/CELO-coin-summary.md index 9ccda722ff..0271fed483 100644 --- a/docs/learn/CELO-coin-summary.md +++ b/docs/learn/CELO-coin-summary.md @@ -1,6 +1,6 @@ # CELO -## **Platform-Native Digital Asset** +## Platform-Native Digital Asset CELO is the platform-native asset that supports the growth and development of the Celo blockchain and ecosystem. CELO holders can earn rewards, stake with validators, and vote on proposals that shape the future of Celo. @@ -9,18 +9,18 @@ CELO is the platform-native asset that supports the growth and development of th * Celo’s native asset is the core utility, reserve, staking, and governance asset * CELO has a fixed supply and variable value, related to the use of the platform, governance and the amount of stablecoins in use. -## **Utility** +## Utility CELO’s primary function is stabilization, ensuring the healthy velocity of stablecoins that globally circulate and transact on Celo. Serving as the primary reserve asset in Celo’s groundbreaking stability mechanism (Mento), CELO allows platform-native stablecoins like Celo Dollars (cUSD) and Celo Euros (cEUR) to algorithmically follow the value of their namesake currencies. -## **Governance** +## Governance CELO plays a critical role in the governance of the Celo platform and technology. Anyone who holds any amount of CELO is empowered to vote on governance proposals that direct how the core technology operates today and in the future. -## **Staking** +## Staking Leading the industry in energy-efficient, carbon neutral blockchain technology, Celo’s energy-efficiency is born out of its Proof-of-Stake (PoS) consensus protocol, requiring it’s daily elected validators to stake CELO as a signal of participation in confirming transactions on the blockchain, earning Celo Dollars (cUSD) as compensation to cover costs in return. -## **Learn more about CELO** +## Learn more about CELO [An introductory Guide to Celo](https://medium.com/celoorg/an-introductory-guide-to-celo-b185c62d3067) diff --git a/docs/learn/celo-economic-model.md b/docs/learn/celo-economic-model.md index 2f14c1518c..937b77b9d5 100644 --- a/docs/learn/celo-economic-model.md +++ b/docs/learn/celo-economic-model.md @@ -1,9 +1,9 @@ # Celo's Economic model -## **Sacred Economics** +## Sacred Economics Celo’s philosophy is grounded in the work of Charles Eisenstein’s[ Sacred Economics](http://sacred-economics.com/film/). -## **Theory Of Change** +## Theory Of Change A theory of change is a framework that describes how short-term actions will lead to long-term social impact. Celo’s aim is to create the conditions for prosperity, defined as people fulfilling basic needs, growing along their own unique paths, and supporting each other. All of Celo’s projects have a specific hypothesis that ties our activities to one or more of these indicators of prosperity. diff --git a/docs/learn/celo-ecosystem.md b/docs/learn/celo-ecosystem.md index e9bf59c3c2..d80094d9e5 100644 --- a/docs/learn/celo-ecosystem.md +++ b/docs/learn/celo-ecosystem.md @@ -1,30 +1,30 @@ # Celo Ecosystem -## **Mainnet** +## Mainnet The Celo Mainnet is Celo's production network and was launched in April 2020. Mainnet is used to describe when a blockchain protocol is fully developed and deployed, meaning that cryptocurrency transactions are being broadcasted, verified, and recorded on a distributed ledger technology (blockchain). -## **CELO** +## CELO CELO is a platform-native reserve and governance asset, serving as the primary asset in the [stability mechanism](https://celo.org/papers/Celo_Stability_Analysis.pdf) (Mento) that supports stable digital currencies like cUSD and cEUR. CELO’s primary function is stabilization, ensuring the healthy velocity of assets that globally circulate and transact on Celo. CELO also serves as the key governance mechanism for the Celo Platform. Owning and using CELO supports the growth and development of the Celo Platform by enabling each CELO owner to vote on proposals that direct how the core technology operates today and in the future. -## **Stable Assets** +## Stable Assets The Celo Reserve supports the Celo Platform and helps to ensure the value of stabilized assets that circulate on Celo. The Celo Reserve supports the stability of stabilized value assets by hosting a diversified portfolio of cryptocurrencies supporting the ability of the Celo protocol to expand and contract the supply of Celo stable assets, in line with user demand. The Celo Reserve is composed of cryptocurrencies including CELO, BTC, ETH, and DAI–ensuring that all user transactions with the reserve can happen on-chain, in a decentralized manner, in fully auditable ways. -## **Celo Dollars (cUSD)** +## Celo Dollars (cUSD) Celo Dollars (cUSD) are Celo’s first stable asset (i.e., stablecoin) that tracks the value of the U.S. dollar. Celo Dollars were designed to be as usable and stable as everyday digital money with the added benefits of fully mobile global circulation. Because Celo Dollars are digital, stable, and mobile-first, users can easily save, pay, lend, and send cUSD to any mobile number in the world in faster, cheaper, and more secure ways. -## **Celo Euro (cEUR)** +## Celo Euro (cEUR) Celo Euro (cEUR) is Celo’s stable asset (i.e., stablecoin) that tracks the value of the Euro. Celo Euro was designed to be as usable and stable as everyday digital money with the added benefits of fully mobile global circulation. Because Celo Euro are digital, stable, and mobile-first, users can easily save, pay, lend, and send cEUR to any mobile number in the world in faster, cheaper, and more secure ways. -## **The Celo Foundation** +## The Celo Foundation The Celo Foundation is a U.S.-based organization that helps to bring Celo’s mission to life, believing in a future where everyone can prosper through financial inclusion, environmental health, and connectivity through the growth and development of innovative technologies, including the open-source, mobile-first Celo Platform and ecosystem of technologies. The Celo Foundation contributes grants to education, technical research, environmental health, community engagement, and ecosystem development and outreach efforts – activities that support and encourage an inclusive and sustainable financial system that creates the conditions for prosperity–for everyone. -## **The Alliance for Prosperity** +## The Alliance for Prosperity The Alliance for Prosperity is a group of mission-aligned Celo Foundation members focused on developing use cases for the Celo Platform and ecosystem of technologies, furthering the mission of financial inclusion and prosperity, and driving adoption of the Celo blockchain and ecology of digital assets. @@ -32,26 +32,26 @@ By joining the Alliance for Prosperity, Alliance members are furthering the Celo * Alliance members are welcomed along all of the use cases outlined on [celo.org/alliance](https://celo.org/alliance). Feel free to reach out via the application if your organization is interested in membership. -## **Celo Camp** +## Celo Camp [Celo Camp](https://www.celocamp.com/) is a virtual accelerator and competition focused on helping startups and developers build decentralized financial apps (dApps) on Celo. During Celo Camp, teams will build mobile-first dApps and other financial tools and services on Celo. In addition to receiving technical and Web3 support, teams receive guidance from experienced mentors, alongside a custom-built curriculum, that will set them up for the next phase of their entrepreneurial success. -## **The Celo Foundation Grants Program** +## The Celo Foundation Grants Program The Celo Foundation Grants Program is an open initiative supporting projects committed to the mission of building a financial system that creates the conditions for prosperity for all, focusing grants based on four key areas: (1) fostering innovation and development of the Celo Platform and[ Celo reference wallet](https://celo.org/developers/wallet)s, (2) lowering barriers to entry to encourage the accessibility of Celo to developers and end-users, (3) educating and expanding Celo’s global community, (4) expanding Celo’s access, opportunity, and impact. -## **Celo Ambassadors** +## Celo Ambassadors Celo Ambassadors are active Celo community members who are passionate about furthering Celo’s mission by driving the adoption of the Celo ecosystem. -## **Kuneco** +## Kuneco Kuneco is a monthly community call designed to bring the Celo community together in celebration of achievements, growth, milestones, and progress towards prosperity. -## **cLabs** +## cLabs cLabs is a member of the Alliance for Prosperity and part of the community working on Celo. Based in Berlin, Buenos Aires, San Francisco, with Partners based all around the world, cLabs' first product release is Valora, a mobile payments app built on Celo. -## **Valora** +## Valora [Valora](https://valoraapp.com/) is a global payments app native to the Celo Platform available on both iOS and Android devices. Valora debuts a utility that finally makes blockchain useful and accessible on even the most basic smartphones, enabling the 6 billion smartphone users worldwide to effortlessly and reliably send, receive, and store value on Celo. diff --git a/docs/learn/celo-value.md b/docs/learn/celo-highlights.md similarity index 99% rename from docs/learn/celo-value.md rename to docs/learn/celo-highlights.md index a2fc9fe947..462740507e 100644 --- a/docs/learn/celo-value.md +++ b/docs/learn/celo-highlights.md @@ -1,4 +1,4 @@ -# Celo Value +# Celo Highlights ### Stable Value Currencies @@ -56,7 +56,7 @@ Transactions are interactions that occur between user addresses and Celo (e.g., **<$.01 Average Network Transaction Fee** -:::note +:::tip Real-time gas fees are captured in gwei on [stats.celo.org](https://stats.celo.org/). @@ -67,7 +67,7 @@ Real-time gas fees are captured in gwei on [stats.celo.org](https://stats.celo.o * **CELO:** Metric updated in real-time, please visit [coinmarketcap.com/currencies/celo](https://coinmarketcap.com/currencies/celo/) * **cUSD + cEUR:** Metrics updated in real-time, please visit [celoreserve.org](https://celoreserve.org/) -:::note +:::tip For current circulating supply of cUSD and cEUR please see the section titled ‘outstanding supply’ and reference the top number in black. @@ -79,7 +79,7 @@ For current circulating supply of cUSD and cEUR please see the section titled For real-time updates, please visit [wren.co/profile/celo](https://www.wren.co/profile/celo) -:::note +:::tip Tons of carbon offset reflect Celo community purchases of carbon credits by way of funding the Community tree planting project with Wren. diff --git a/docs/learn/celo-milestones.md b/docs/learn/celo-milestones.md index 306b2a817e..5e1d629426 100644 --- a/docs/learn/celo-milestones.md +++ b/docs/learn/celo-milestones.md @@ -1,30 +1,30 @@ # Celo Milestones -## **Deutsche Telekom** +## Deutsche Telekom **Deutsche Telekom** [made](https://medium.com/celoorg/deutsche-telekom-joins-celo-ecosystem-as-the-first-mobile-carrier-amid-launch-of-ceur-stablecoin-2b79aae38540) a strategic purchase of the Celo native digital asset (CELO) and joined the Celo Alliance for Prosperity as the first mobile carrier member. They also became a validator on the Celo network. This partnership is very aligned with Celo’s mission and the services Deutsche Telekom provides its customers worldwide, the majority of which primarily use their phones to access financial services. By building on Celo’s mobile-first platform, mobile carriers like Deutsche Telekom are able to seamlessly integrate mobile-friendly blockchain-based solutions and serve customers in new, meaningful ways. Deutsche Telekom is leading in this effort, and we’re excited to see how mobile carriers and other organizations take advantage of all that blockchain and cryptocurrency has to offer. -## **Celo Euro (cEUR)** +## Celo Euro (cEUR) We launched **Celo Euro (cEUR)**, our second native stablecoin on the platform for mobile payments that we’ve launched in the last year. cEUR creates an entirely new remittance market for the European Union where users can quickly and easily transfer digital money between countries with a phone number. It’s as easy as sending a text message and can be done in as little as 5 seconds for less than $0.01. Combined with the open nature of Celo’s platform, we can enable a mobile-friendly form of digital money that can be used by the 6 billion smartphone users around the world. -## **Optics** +## Optics We [introduced](https://medium.com/celoorg/announcing-optics-a-gas-efficient-interoperability-standard-for-cross-chain-communication-e597163b2) **Optics**, a new gas-efficient bridging standard that connects Celo with Ethereum. Optics enables interoperability between layer-one blockchains. It’s trustless, non-custodial, and designed to minimize gas costs to users. This means that developers can permissionlessly build custom cross-chain applications, cheaply move tokens and data between chains, and help users reach existing applications on chain. -## **PayU** +## PayU **PayU**, one of the largest payment providers for emerging markets, [is giving](https://medium.com/celoorg/payu-now-enables-major-online-marketplaces-retailers-and-other-merchants-to-accept-cusd-ecdefda1e07f) its nearly half a million merchants the ability to accept cUSD as a payment option. PayU’s merchant and customer base is mostly concentrated in high-growth markets, such as Latin America, Africa, and Southeast Asia, so having a decentralized, over-collateralized algorithmic stablecoin provides access to USD and EUR-backed digital assets that are insulated from the volatility of some fiat currencies and cryptocurrencies more broadly. This integration is a big step toward making digital assets easier for customers to use and for merchants to accept, which we hope will accelerate the adoption of stablecoins in more communities around the world. -## **Valora** +## Valora **Valora** is now a standalone company! When the cLabs team officially [launched](https://medium.com/celoorg/introducing-valora-98e6c59bb5c5) Valora in February, the immediate uptick in user adoption far exceeded what we envisioned at that stage of the project. It’s since continued on this upward trajectory: today, Valora has 200K users with a balance and 53K monthly active users in more than 100 countries. This reception made clear that Valora has grown to become more than a project on the Celo platform and has the potential to scale even further. That fueled the decision to make Valora an independent, standalone company, with [Jackie Bona](https://www.linkedin.com/in/jackiebona/)—who cLabs’ Head of Consumer Growth for Valora—as the Chief Executive Officer. The Valora team also raised a $20 million Series A to fuel the company’s growth. -## **Carbon Negative** +## Carbon Negative In [May](https://medium.com/celoorg/a-carbon-negative-blockchain-its-here-and-it-s-celo-60228de36490) we shared that Celo officially became one of the **first carbon negative blockchains** and highlighted some [community initiatives](https://projectwren.com/projects/community-tree-planting) underway to offset carbon emissions on Celo. Building on that, we recently submitted an on-chain government proposal to allocate .5% of the Celo Reserve to natural backed assets, the first being Mc02 tokens. This makes Celo the first blockchain to incorporate natural backed assets into its reserve, enabling users to support and protect the environment—just by using Celo Dollar (cUSD)—and we hope it will set a new standard for the industry. -## **Donut Hardfork** +## Donut Hardfork On May 19th 2021, the donut hardfork went live.** **The Donut Hardfork is a non-contentious hardfork that includes many exciting network upgrades making Celo more gas efficient, improving interoperability, and allowing Celo users to connect to popular tools like MetaMask. diff --git a/docs/learn/celo-onboarding.md b/docs/learn/celo-onboarding.md index cebeb73db6..0111f619a2 100644 --- a/docs/learn/celo-onboarding.md +++ b/docs/learn/celo-onboarding.md @@ -4,7 +4,7 @@ Celo is a mobile-first and carbon-neutral blockchain that makes decentralized fi With its interoperability, cross-chain compatibility and vision for inclusivity, Celo enables native and non-native digital assets–both cryptographic and Central Bank Digital Currencies (CBDCs)–to circulate freely, at extremely low costs and high speeds, across devices, carriers, and countries–making money mobile, global and accessible like never before. -## **Getting Started with Celo** +## Getting Started with Celo * [Hello from Celo](https://medium.com/celoorg/hello-from-celo-34bf195cb99?source=false---------0) * [What if money were beautiful?](https://www.youtube.com/watch?v=kKggE5OvyhE&list=PLsQbsop73cfHAblkFzkgDJ2amxaWoNstC) @@ -12,13 +12,13 @@ With its interoperability, cross-chain compatibility and vision for inclusivity, * [Meet the team working on Celo](https://www.youtube.com/watch?v=F5SnS1v9fNo&list=PLsQbsop73cfHAblkFzkgDJ2amxaWoNstC&index=2) * [Celo Tech Talks Building a mobile first blockchain platform](https://www.youtube.com/watch?v=bp2loYXPhbM&list=PLsQbsop73cfGmUdABArPaXagPB2EpBkNc) -## **Celo Basics** +## Celo Basics * [What is the Celo Platform?](https://www.youtube.com/watch?v=ofQD_hhq09g&list=PLsQbsop73cfGRlLENseWOt7CPzocUXSRq) * [What is CELO?](https://www.youtube.com/watch?v=mkpTmbkRv4A&list=PLsQbsop73cfGRlLENseWOt7CPzocUXSRq&index=2) * [What can Celo Dollars do?](https://www.youtube.com/watch?v=n1k1JcjTnp8&list=PLsQbsop73cfGRlLENseWOt7CPzocUXSRq&index=3) -## **Celo Tour** +## Celo Tour * [About Celo](https://celo.org/about) * [Join](https://celo.org/jobs) @@ -29,7 +29,7 @@ With its interoperability, cross-chain compatibility and vision for inclusivity, * [Blog](https://medium.com/celoorg) * [GitHub](https://github.com/celo-org) -## **Celo First Steps** +## Celo First Steps * [Valora](https://valoraapp.com/) * [Get CELO](https://celohub.org/purchase) @@ -37,7 +37,7 @@ With its interoperability, cross-chain compatibility and vision for inclusivity, * [Get Test Funds](https://celo.org/developers/faucet) * [Block Explorer](https://explorer.celo.org/) -## **Connect with the Community** +## Connect with the Community * [Reddit](https://www.reddit.com/r/celo/) * [Blog](https://medium.com/celoorg) @@ -49,7 +49,7 @@ With its interoperability, cross-chain compatibility and vision for inclusivity, * [LinkedIn](https://www.linkedin.com/company/celoOrg/) * [Twitch](https://www.twitch.tv/celoorg) -## **Get Support** +## Get Support * [Discord](https://chat.celo.org/) * [Forum](https://forum.celo.org/) diff --git a/docs/learn/celo-overview.md b/docs/learn/celo-overview.md index 3b90b95d56..fad09d5919 100644 --- a/docs/learn/celo-overview.md +++ b/docs/learn/celo-overview.md @@ -1,21 +1,17 @@ -# Introduction to Celo +# Welcome to Celo -Learn about Celo's mission, vision, and goals for financial prosperity for everyone. +Celo's mission, vision, and goals for financial prosperity for everyone. -## **Crypto made for Mobile** +## Crypto made for Mobile -Celo is a mobile-first blockchain that makes decentralized financial (DeFi) tools and services accessible to anyone with a mobile phone. It aims to break down barriers by bringing the powerful benefits of DeFi to the users of the 6 billion smartphones in circulation today. - -[Visit Celo](https://celo.org/) - -## **Celo's Mission** +[Celo](https://celo.org/) is a mobile-first blockchain that makes decentralized financial (DeFi) tools and services accessible to anyone with a mobile phone. It aims to break down barriers by bringing the powerful benefits of DeFi to the users of the 6 billion smartphones in circulation today. +## Celo's Mission The company’s mission is to build a financial system that creates the conditions of prosperity for everyone. Celo enables native and non-native digital assets–both cryptographic and Central Bank Digital Currencies (CBDCs)–to circulate freely across devices, carriers, and countries. This makes money mobile, global and accessible like never before. Celo is supported by a community of organizations and individuals, including Jack Dorsey, a16z, and Deutsche Telekom. **Watch:** [What if Money were Beautiful](https://www.youtube.com/watch?v=kKggE5OvyhE) - -## **Celo Ecosystem** +## Celo Ecosystem An Ethereum-compatible technology capable of reaching global users at scale, Celo turns crypto into usable money with a multi-asset system: a governance and staking asset (CELO) and a family of stablecoins. Since the launch of Mainnet in 2020, Celo’s network now supports 1000+ projects from builders, developers, and artists, who everyday create new applications and issue digital currencies from over 100 countries around the world. @@ -23,6 +19,6 @@ CELO is a platform-native reserve and governance asset, serving as the primary a **Watch:** [Meet the team working at Celo](https://www.youtube.com/watch?v=vwfHiaVzc2E) -## **Get started with Celo** +## Get started with Celo To build technology and products that are used and loved by people and solve real-world problems, Celo is building a community with many different perspectives and experiences. Let’s build a monetary system that creates the conditions for prosperity for all. diff --git a/docs/learn/celo-protocol-summary.md b/docs/learn/celo-protocol-summary.md index b2812d31c0..02662ca17e 100644 --- a/docs/learn/celo-protocol-summary.md +++ b/docs/learn/celo-protocol-summary.md @@ -1,6 +1,6 @@ # Celo Protocol -## **The Platform for Mobile DeFi** +## The Platform for Mobile DeFi The Celo protocol provides a platform upon which the Celo community can create stabilized value digital assets. Named for the currencies they follow, Celo Dollars (cUSD) and Celo Euros (cEUR) are stablecoins that allow anyone to share value faster, cheaper and more easily from a mobile phone. @@ -19,7 +19,7 @@ The Celo protocol also includes mechanisms for [lightweight identity](../celo-co * Gas Payable in Multiple Stablecoins * Programmable (full EVM Compatibility) -## **Optimized for Financial Applications** +## Optimized for Financial Applications Powered by Celo’s industry-leading decentralized phone number verification, payment applications built on Celo allow users to easily send or request digital currencies from any mobile number, anywhere in the world, capable of offering their users features like: @@ -29,7 +29,7 @@ Powered by Celo’s industry-leading decentralized phone number verification, pa * QR Code Support * Mobile first SDK -## **Core Contracts** +## Core Contracts Designed to support an ecology of stable value currencies. The first stablecoin, cUSD, tracks the value of the US Dollar. @@ -37,7 +37,7 @@ Designed to support an ecology of stable value currencies. The first stablecoin, * Crypto-asset collateralized * Native support for multiple stablecoins -## **Blockchain** +## Blockchain Open source permissionless smart contract platform built on decentralized infrastructure. @@ -45,6 +45,6 @@ Open source permissionless smart contract platform built on decentralized infras * Incentives for serving mobile devices * On-chain governance -## **Build on Celo** +## Build on Celo Visit [docs.celo.org](https://docs.celo.org/) to learn more. diff --git a/docs/learn/celo-protocol.md b/docs/learn/celo-protocol.md index 4fdb39eeb7..bc7602d899 100644 --- a/docs/learn/celo-protocol.md +++ b/docs/learn/celo-protocol.md @@ -2,7 +2,7 @@ The Celo blockchain and Celo Core Contracts together comprise the Celo Protocol. This term describes both what services the decentralized Celo network provides to applications and the way in which nodes in the network cooperate to achieve this. This section introduces some of these services. -## **Consensus and Proof-of-Stake** +## Consensus and Proof-of-Stake Celo is a Proof-of-Stake blockchain. In comparison to Proof-of-Work systems like Bitcoin and Ethereum, this eliminates the negative environmental impact and means that users can make transactions that are cheaper, faster, and whose outcome cannot be changed once complete. @@ -10,13 +10,13 @@ The Celo blockchain implements a Byzantine Fault Tolerant (BFT) consensus algori Celo uses a Proof-of-Stake mechanism for selecting the validator set for a fixed period termed an epoch. Anyone can earn rewards by locking CELO and by participating in validator elections and governance proposals. Initially, the number of validators will be capped to one hundred nodes elected by CELO holders. Validators earn additional fixed rewards in Celo Dollars (cUSD) to cover their costs plus margin. -## **On-Chain Governance** +## On-Chain Governance Celo uses an on-chain governance mechanism to manage and upgrade aspects of the protocol that reside in the Celo Core Contracts and for a number of parameters used by the Celo blockchain. This includes operations like upgrading smart contracts, adding new stable currencies, modifying the reserve target asset allocation, and changing how validator elections are decided. The Governance contract is set as “owner” for all of the Celo Core Contracts. This allows the protocol to carry out agreed governance proposals by executing code in the context of the Governance contract. Proposals are selected for consideration and voted on by CELO holders using a weighted vote based on the same Locked CELO commitment used to vote to elect validators. -## **Ultralight Synchronization** +## Ultralight Synchronization Celo provides extremely fast, secure synchronization to enable light clients to begin to track the current state of the Celo blockchain ledger almost immediately. This means that even wallet users with high latency, low bandwidth, or high-cost data tariffs can use Celo. @@ -24,7 +24,7 @@ In Ethereum, verifying whether data received from an untrusted full node really Roadmap: Synchronization performance will be further improved with BLS signature aggregation and succinct zero-knowledge proofs, via zk-SNARKs. -## **Incentives for Operating Full Nodes** +## Incentives for Operating Full Nodes In Ethereum, there are few incentives to run a full node that is not mining. Few nodes serve light clients, and this results in a poor experience for mobile wallets. @@ -32,7 +32,7 @@ Celo introduces a scheme that incentivizes users to operate regular nodes. Light Since light clients need not trust full nodes, as they can verify their work, this also provides the 'permissionless on-ramp' for users to receive CELO or Celo Dollars (cUSD) without already holding it that is missing in other Proof-of-Stake networks. -## **Stable Cryptocurrencies** +## Stable Cryptocurrencies Celo enables a family of stablecoins that track the value of any asset, including fiat currencies, commodities, and even natural resources. Stablecoins supported include the Celo Dollar (cUSD) and the Celo Euro (cEUR), which track the value of the U.S. Dollar and Euro respectively. CELO and a basket of other assets including BTC and ETH serve as the collateral for these stablecoins. These stablecoins are redeemable for CELO, ensuring that transactions can occur quickly, cheaply, and reliably on-chain. @@ -47,14 +47,14 @@ In addition, a backup reserve of cryptocurrencies is held off-chain. This off-ch **Roadmap: **Celo envisages a number of stable currencies tracking different fiat currencies as well as natural resources such as forests. In addition, once bridges between other chains and the Celo blockchain are fully developed, and liquid trading on decentralized exchanges occurs, the rebalancing can be handled transparently on-chain. -## **Lightweight Identity** +## Lightweight Identity Celo offers a lightweight identity layer that allows users of applications including Celo Wallet to identify and securely transact with other users via their contacts' phone numbers. Celo Wallet enables payments directly to users listed in their device's contacts list. The Attestations contract allows a user to request attestations to their phone number for a small fee. A secure decentralized source of randomness is used to pick a number of validators that will produce and send via SMS signed secret messages that act as attestations of ownership of the phone number. The user then submits these back to the Attestations contract which verifies them and installs a mapping for the phone number to the user's account. -## **Richer Transactions** +## Richer Transactions Celo provides a number of enhancements to regular transactions as familiar to Ethereum developers. diff --git a/docs/learn/celo-resources.md b/docs/learn/celo-resources.md index 0c903116a5..2e68f1f485 100644 --- a/docs/learn/celo-resources.md +++ b/docs/learn/celo-resources.md @@ -8,7 +8,7 @@ description: Stay up to date on the latest Celo resources. The Celo community is always creating new resources to help you learn about Celo. -## **Code Examples** +## Code Examples * [Sending Celo and cUSD](https://docs.celo.org/developer-guide/start/hellocelo) * [Deploy a Contract using a Local Node](https://docs.celo.org/developer-guide/start/hellocontracts) @@ -20,13 +20,13 @@ The Celo community is always creating new resources to help you learn about Celo * [Integrate WalletConnect with your dApp](https://docs.celo.org/developer-guide/start/wallet-connect) * [Local Key Management using Keystores](https://docs.celo.org/developer-guide/start/using-js-keystores) -## **Developer Guide** +## Developer Guide * [Local Development Chain with Protocol Contracts](https://docs.celo.org/developer-guide/development-chain) * [Celo for Ethereum Developers](https://docs.celo.org/developer-guide/celo-for-eth-devs) * [Celo dApp Gallery](https://docs.celo.org/developer-guide/celo-dapp-gallery) -## **Tech Talks** +## Tech Talks * [Building a mobile-first blockchain platform](https://www.youtube.com/watch?v=bp2loYXPhbM&list=PLsQbsop73cfGmUdABArPaXagPB2EpBkNc) * [Simplifying blockchain development with the Celo SDK](https://www.youtube.com/watch?v=Rg33B0E2DTM&list=PLsQbsop73cfGmUdABArPaXagPB2EpBkNc&index=2) @@ -52,7 +52,7 @@ The Celo community is always creating new resources to help you learn about Celo * [Hello Celo Q&A](https://www.youtube.com/watch?v=Tj4u_AgkVNY&list=PLsQbsop73cfGmUdABArPaXagPB2EpBkNc&index=21) * [Building Celo Ecosystem and Community](https://www.youtube.com/watch?v=p7gtW75gtbo&list=PLsQbsop73cfGmUdABArPaXagPB2EpBkNc&index=24) -## **Pirate Radio Interview Series** +## Pirate Radio Interview Series * [Interview with The Graph ](https://youtu.be/FsLe1msmgYE) * [Interview with Polkadot](https://youtu.be/oMSWODQQuxU) @@ -60,7 +60,7 @@ The Celo community is always creating new resources to help you learn about Celo * [Interview with Aurora](https://youtu.be/jFudk4Hr5IQ) * [Interview with Optics Team](https://youtu.be/mr-YyCtur8E) -## **Cross-Chain Salon Workshops** +## Cross-Chain Salon Workshops * [Regen Network Workshop](https://youtu.be/pvtn6sPwDL0) * [Celo Wallet Connect Workshop](https://youtu.be/QMI4Z9hH2Ew) @@ -74,17 +74,17 @@ The Celo community is always creating new resources to help you learn about Celo * [Skale Workshop](https://youtu.be/kiZwO_dvotg) * [Near Workshop](https://youtu.be/ysmAaNi5JOY) -## **Discussion Panels** +## Discussion Panels * [Stablecoins Discussion Panel](https://youtu.be/CfzqpK_-LHA) -## **The Great Celo Stake Off** +## The Great Celo Stake Off * [What is The Great Celo Stake Off?](https://www.youtube.com/watch?v=pKSWrfCsWZk&list=PLsQbsop73cfF70IohTnE7uZuEoCGPlnDM) * [Celo Mastering the Art of Validating Webinar](https://www.youtube.com/watch?v=3UIudzzCb8o&list=PLsQbsop73cfF70IohTnE7uZuEoCGPlnDM&index=2) * [The Great Celo Stake Off Info Session](https://www.youtube.com/watch?v=Cz47o3HLMVw&list=PLsQbsop73cfF70IohTnE7uZuEoCGPlnDM&index=3) -## **Celo in the World** +## Celo in the World * [Crypto + Banking: The Next Billion Users](https://www.youtube.com/watch?v=gySPQ41v-SY&list=PLsQbsop73cfHFh_dXrfCfg7Z7k6EJSDQG) * [Future of Finance Spotlight - Celo](https://www.youtube.com/watch?v=LUT8XyhUC8g&list=PLsQbsop73cfHFh_dXrfCfg7Z7k6EJSDQG&index=2) @@ -97,7 +97,7 @@ The Celo community is always creating new resources to help you learn about Celo * [Celo - Banking the unbanked: lessons from the field](https://www.youtube.com/watch?v=a1iEF8GWU4I&list=PLsQbsop73cfHFh_dXrfCfg7Z7k6EJSDQG&index=9) * [Validator Elections on Celo](https://www.youtube.com/watch?v=e4Aur9HBssQ&list=PLsQbsop73cfHFh_dXrfCfg7Z7k6EJSDQG&index=10) -## **How Celo Works** +## How Celo Works * [Taking Crypto Beyond Volatility: Stablecoins](https://www.youtube.com/watch?v=ENBQbPbbalg&list=PLsQbsop73cfGDHETt02NSBqeH_zlfXJKI) * [Celo - Advancing Financial Inclusion with Permissionless Cryptocurrencies](https://www.youtube.com/watch?v=ay7sFzfJ6K4&list=PLsQbsop73cfGDHETt02NSBqeH_zlfXJKI&index=2) @@ -107,7 +107,7 @@ The Celo community is always creating new resources to help you learn about Celo * [Celo - Banking the unbanked: lessons from the field](https://www.youtube.com/watch?v=a1iEF8GWU4I&list=PLsQbsop73cfGDHETt02NSBqeH_zlfXJKI&index=6) * [Validator Elections on Celo](https://www.youtube.com/watch?v=e4Aur9HBssQ&list=PLsQbsop73cfGDHETt02NSBqeH_zlfXJKI&index=7) -## **Celo’s 4 Tenents** +## Celo’s 4 Tenents * [What if money were beautiful?](https://www.youtube.com/watch?v=kKggE5OvyhE&list=PLsQbsop73cfHAblkFzkgDJ2amxaWoNstC) * [Meet the team working on Celo](https://www.youtube.com/watch?v=F5SnS1v9fNo&list=PLsQbsop73cfHAblkFzkgDJ2amxaWoNstC&index=2) @@ -115,7 +115,7 @@ The Celo community is always creating new resources to help you learn about Celo * [Sep Kamvar - Curitiba Bus Token, Blockchain for Social Impact Coalition Earth Day Live Stream](https://www.youtube.com/watch?v=bMwDj-vkQQs&list=PLsQbsop73cfHAblkFzkgDJ2amxaWoNstC&index=4) -## **Celo Prosper Series** +## Celo Prosper Series * [Prosper Series Discover Your Unique Purpose](https://www.youtube.com/watch?v=QCkWMbOrJNw&list=PLsQbsop73cfEbacv8AD6cNC64hmjhGleo) * [Prosper Series Blockchain for Prosperity](https://www.youtube.com/watch?v=b1S0FDgOAVg&list=PLsQbsop73cfEbacv8AD6cNC64hmjhGleo&index=2) @@ -129,7 +129,7 @@ The Celo community is always creating new resources to help you learn about Celo * [Prosper Series Emerging Technology, Emerging Markets, & Activism](https://www.youtube.com/watch?v=zibcUUOBe2Q&list=PLsQbsop73cfEbacv8AD6cNC64hmjhGleo&index=10) * [Collaborative Economy for Prosperity](https://www.youtube.com/watch?v=8_WVZwKPOL8&list=PLsQbsop73cfEbacv8AD6cNC64hmjhGleo&index=11) -## **Central Bank Digital Currency Series** +## Central Bank Digital Currency Series * [Types of Stablecoins](https://www.youtube.com/watch?v=0XB_2O6FsIk&list=PLsQbsop73cfEY1Dz4YyX2S4VNpamozj1v) * [Stability Protocol](https://www.youtube.com/watch?v=lfbouGPNbQY&list=PLsQbsop73cfEY1Dz4YyX2S4VNpamozj1v&index=2) @@ -137,24 +137,24 @@ The Celo community is always creating new resources to help you learn about Celo * [Managing Financial Crime Risk on Distributed Ledgers](https://www.youtube.com/watch?v=iYMDejO6uYc&list=PLsQbsop73cfEY1Dz4YyX2S4VNpamozj1v&index=4) * [Influencing the Velocity of Central Bank Digital Currencies](https://www.youtube.com/watch?v=yxKtDcHs9dI&list=PLsQbsop73cfEY1Dz4YyX2S4VNpamozj1v&index=5) -## **Kuneco** +## Kuneco * [The first Kuneco](https://www.youtube.com/watch?v=x3Tn2mx1x2g&list=PLsQbsop73cfHISg3Co3MRks7zah3dfBil) * [Kuneco Community All-Hands](https://www.youtube.com/watch?v=0qk6GfpKdTw&list=PLsQbsop73cfHISg3Co3MRks7zah3dfBil&index=2) -## **Celo Camp 2020** +## Celo Camp 2020 * [Celo Camp 2020: Celo's Values with Sep Kamvar](https://www.youtube.com/watch?v=dDxb5daPdME&list=PLsQbsop73cfEOoGErgO4rmzWnBY9TzBCi) * [Celo Camp 2020: AMA With Marek Olszewski, Co-founder of Celo](https://www.youtube.com/watch?v=4AwtJ0bFLNI&list=PLsQbsop73cfEOoGErgO4rmzWnBY9TzBCi&index=2) * [Celo Camp 2020 Investors AMA](https://www.youtube.com/watch?v=opAaSUY3G2E&list=PLsQbsop73cfEOoGErgO4rmzWnBY9TzBCi&index=3) -## **Coinbase Earn** +## Coinbase Earn * [What is the Celo Platform?](https://www.youtube.com/watch?v=ofQD_hhq09g&list=PLsQbsop73cfGRlLENseWOt7CPzocUXSRq) * [What is CELO?](https://www.youtube.com/watch?v=mkpTmbkRv4A&list=PLsQbsop73cfGRlLENseWOt7CPzocUXSRq&index=2) * [What can Celo Dollars do?](https://www.youtube.com/watch?v=n1k1JcjTnp8&list=PLsQbsop73cfGRlLENseWOt7CPzocUXSRq&index=3) -## **Eth Denver 2020** +## Eth Denver 2020 * [C-LABS Sponsor Feature, ETHDenver & ColoradoJam 2021 Feb 5th-12th](https://www.youtube.com/watch?v=hC82Tj1KF8E&list=PLsQbsop73cfFjAB66fE2oCQFLRVfqa2V9) * [ETHDenver 2021 Opening Ceremonies: Celo](https://www.youtube.com/watch?v=cfP_Y3YwpJw&list=PLsQbsop73cfFjAB66fE2oCQFLRVfqa2V9&index=2) @@ -165,7 +165,7 @@ The Celo community is always creating new resources to help you learn about Celo * [Plumo Ceremony](https://www.youtube.com/watch?v=VsAH4N92Au0&list=PLsQbsop73cfFjAB66fE2oCQFLRVfqa2V9&index=7) * [Celo Bounties at #ETHDenver](https://www.youtube.com/watch?v=WhY0fKXgKsg&list=PLsQbsop73cfFjAB66fE2oCQFLRVfqa2V9&index=8) -## **Celo Tutorials (Figment Pathway)** +## Celo Tutorials (Figment Pathway) * [Learn how connect to Celo node with DataHub](https://www.youtube.com/watch?v=bz76yk-Bww4&list=PLsQbsop73cfGd9sYPqvX3mkTHbfLXpS1X) * [Create your First Celo Account](https://www.youtube.com/watch?v=3VJyk669O-k&list=PLsQbsop73cfGd9sYPqvX3mkTHbfLXpS1X&index=2) @@ -174,14 +174,14 @@ The Celo community is always creating new resources to help you learn about Celo * [Write and deploy your first Celo smart contract](https://www.youtube.com/watch?v=pQvrl4yOi10&list=PLsQbsop73cfGd9sYPqvX3mkTHbfLXpS1X&index=5) -## **#MakeitMobile Hackathon** +## #MakeitMobile Hackathon * [Everything You Need to #MakeItMobile​ on Celo](https://www.youtube.com/watch?v=8Z7__lqu3Yk&list=PLsQbsop73cfFx53_9VGaH7Gw8ddDcAzDm) * [How to Build a DApp on Celo](https://www.youtube.com/watch?v=LN7p6mB1t4k&list=PLsQbsop73cfFx53_9VGaH7Gw8ddDcAzDm&index=2) * [Accelerating the Movement to Mobile-First DeFi](https://www.youtube.com/watch?v=Q0S4WQ836WA&list=PLsQbsop73cfFx53_9VGaH7Gw8ddDcAzDm&index=3) * [How to Port Your Etherum DApp to Celo](https://www.youtube.com/watch?v=FeUo6kNb5NU&list=PLsQbsop73cfFx53_9VGaH7Gw8ddDcAzDm&index=4) -## **Tech Blog** +## Tech Blog * [Fast and Light](https://medium.com/celoorg/fast-and-light-39ec38759900) * [Cryptocurrency for a Beautiful Planet](https://medium.com/celoorg/cryptocurrency-for-a-beautiful-planet-e47299dfb1c3) @@ -198,7 +198,7 @@ The Celo community is always creating new resources to help you learn about Celo * [A Look at the Celo White Paper](https://medium.com/celoorg/a-look-at-the-celo-whitepaper-c0061118ffd4) * [Arbitrage and Winning a Cryptocurrency Trading Competition at MIT](https://medium.com/celoorg/arbitrage-and-winning-a-cryptocurrency-trading-competition-at-mit-32e183766e42) -## **Design Blog** +## Design Blog * [A Celebration of Heart](https://medium.com/celoorg/a-celebration-of-heart-for-celo-44bbbba94a2c) * [Celo Camp and The Third Place](https://medium.com/celoorg/celo-camp-and-the-third-place-a-case-study-in-ecosystem-brand-design-4d1da339d1a8) @@ -218,7 +218,7 @@ The Celo community is always creating new resources to help you learn about Celo * [Why we should rename Celo Gold](https://medium.com/celoorg/why-we-should-rename-celo-gold-35b04d87e95a) * [CELO Holders: Make Your Voice Heard Through On-chain Governance](https://medium.com/celoorg/celo-gold-holders-make-your-voice-heard-through-on-chain-governance-96cb5a1e8b90) -## **General Updates** +## General Updates * [Celo Sets Sights On Becoming Fastest EVM Chain Through Collaboration With Mysten Labs](https://medium.com/celoorg/celo-sets-sights-on-becoming-fastest-evm-chain-through-collaboration-with-mysten-labs-e88b426aee83) * [Meet the cLabs Team at Messari Mainnet!](https://medium.com/celoorg/meet-the-clabs-team-at-messari-mainnet-83b72b259dcb) diff --git a/docs/learn/celo-stack.md b/docs/learn/celo-stack.md index 8c52a94d3b..a76ad5ded1 100644 --- a/docs/learn/celo-stack.md +++ b/docs/learn/celo-stack.md @@ -4,15 +4,17 @@ Celo is oriented around providing the simplest possible experience for end-users **The Celo stack is structured into the following logical layers:** -## **Celo Blockchain** +![](https://storage.googleapis.com/celo-website/docs/full-stack-diagram.jpg) + +## Celo Blockchain An open cryptographic protocol that allows applications to make transactions with and run smart contracts in a secure and decentralized fashion. The Celo blockchain code has shared ancestry with[ Ethereum](https://www.ethereum.org/) and maintains full EVM compatibility for smart contracts. However, it uses a[ Byzantine Fault Tolerant](http://pmg.csail.mit.edu/papers/osdi99.pdf) (BFT) consensus mechanism rather than Proof-of-Work and has different block format, transaction format, client synchronization protocols, and gas payment and pricing mechanisms. -## **Celo Core Contracts** +## Celo Core Contracts A set of smart contracts running on the Celo blockchain that comprise much of the logic of the platform features including ERC-20 stable currencies, identity attestations, proof-of-stake, and governance. These smart contracts are upgradeable and managed by the decentralized governance process. -## **Applications** +## Applications Applications for end users built on the Celo Platform. The Celo Wallet app, the first of an ecosystem of applications, allows end-users to manage accounts and make payments securely and simply by taking advantage of the innovations in the Celo Protocol. Applications take the form of external mobile or backend software: they interact with the Celo blockchain to issue transactions and invoke code that forms the Celo Core Contracts’ API. Third parties can also deploy custom smart contracts that their own applications can invoke, which in turn can leverage Celo Core Contracts. Applications may use centralized cloud services to provide some of their functionality: in the case of the Celo Wallet, push notifications, and a transaction activity feed. diff --git a/docs/learn/celo-summary.md b/docs/learn/celo-summary.md index 5610c899c7..57db01cde1 100644 --- a/docs/learn/celo-summary.md +++ b/docs/learn/celo-summary.md @@ -12,18 +12,18 @@ Celo's mission is to build a financial system that creates the conditions of pro * Carbon Offset 65.7 Avg Tons Per Month * Average Network Transaction Fee <$.01 -## **Mobile-First** +## Mobile-First Celo makes sending payments as easy as sending a text, to anyone with an internet connection, anywhere in the world. Celo maps phone numbers to wallet addresses using a novel decentralized address-based identity layer. Mobile participants can earn rewards for securing and maintaining the system. -## **Multi-Asset** +## Multi-Asset Celo is turning crypto into usable money with a multi-asset system: a utility, governance, and staking asset (CELO) and a growing family of stablecoins named for the currencies they algorithmically follow (e.g., cUSD, cEUR). -## **EVM-Compatible** +## EVM-Compatible An EVM-compatible solution capable of reaching billions of global users at scale, Celo’s technology supports 1000+ projects from builders, developers, and even artists who everyday launch new applications and issue digital currencies from everywhere in the world usable by anyone in the world with a desktop computer or mobile phone. -## **Get Started with Celo** +## Get Started with Celo Visit [celo.org](http://www.celo.org) to learn more. diff --git a/docs/learn/celo-whitepapers.md b/docs/learn/celo-whitepapers.md index c8d4d462d6..3949e4350f 100644 --- a/docs/learn/celo-whitepapers.md +++ b/docs/learn/celo-whitepapers.md @@ -1,6 +1,6 @@ # Celo Whitepapers -## **Protocol** +## Protocol Celo Whitepaper: A Multi-Asset Cryptographic Protocol for Decentralized Social Payments @@ -11,7 +11,7 @@ Plumo: Towards Scalable Interoperable Blockchains Using Ultra Light Validation S * [Read paper](https://celo.org/papers/plumo) -## **Economics** +## Economics An Analysis of the Stability Characteristics of Celo @@ -26,7 +26,7 @@ Shaping the Future of Digital Currencies * [Read paper](https://celo.org/papers/future-of-digital-currencies) -## **Social Impact** +## Social Impact Future-Proof Aid Policy diff --git a/docs/learn/developer-onboarding.md b/docs/learn/developer-onboarding.md index 0378ca15f7..cd2f8229a9 100644 --- a/docs/learn/developer-onboarding.md +++ b/docs/learn/developer-onboarding.md @@ -2,7 +2,7 @@ Learn the basics of Celo and start your journey toward developing decentralized applications on the Celo platform. Throughout this program, you will learn about the Celo mission, platform architecture, and how you can stay connected with our community. You’ll also be introduced to our developer ecosystem and make use of our tools and resources to build and deploy your first decentralized application on the Celo platform. -## **Prerequisite knowledge** +## Prerequisite knowledge In order to be successful, we recommend having experience developing with Web 2.0 technologies along with a basic understanding of Bitcoin, Ethereum, decentralized finance (DeFi), and blockchain technologies. @@ -13,7 +13,7 @@ If you’re unfamiliar with any of these topics, here’s a few places to get st * [Ethereum.org](https://ethereum.org/en/) * [What is DeFi](https://www.youtube.com/watch?v=k9HYC0EJU6E) -## **Getting Started as a Developer** +## Getting Started as a Developer * [Why Build on Celo](https://medium.com/celoorg/why-build-on-the-celo-blockchain-9ceab3d11b70) * [Celo Decentralized Application Examples](https://celohub.org/) @@ -23,11 +23,11 @@ If you’re unfamiliar with any of these topics, here’s a few places to get st * [A Look at the Celo Stability Analysis White Paper](https://medium.com/celoorg/a-look-at-the-celo-stability-analysis-white-paper-part-1-23edd5ef8b5) * [Celo Whitepapers](https://celo.org/papers) -## **Set up Local Environment** +## Set up Local Environment * [Using Windows](../developer-guide/start/develop-on-windows) * [Using Mac](../developer-resources/using-mac) -## **Deploy a dApp with Celo** +## Deploy a dApp with Celo * [Deploy a dApp with Celo](../developer-resources/deploy-dapp) * [Set up a Tesnet Wallet](../developer-resources/testnet-wallet) @@ -37,32 +37,32 @@ If you’re unfamiliar with any of these topics, here’s a few places to get st * [Deploy with Hardhat](../developer-resources/deploy-hardhat) * [Deploy with Replit](../developer-resources/deploy-replit) -## **Celo Developer Pathway** +## Celo Developer Pathway * [Figment Learn](figment-learn) -## **Build Celo Applications** +## Build Celo Applications * [Build Mobile-First DeFi Apps with the Celo SDK](https://medium.com/celoorg/build-mobile-first-defi-apps-with-the-celo-sdk-e6f85f2fe18c) * [Developing & deploying your first DApp on Celo](https://www.youtube.com/watch?v=kO6Wm8pgKXU&list=PLsQbsop73cfGmUdABArPaXagPB2EpBkNc&index=12) * [Building your first DApps on Celo, Part 2](https://www.youtube.com/watch?v=KjaH8H9ssvk&list=PLsQbsop73cfGmUdABArPaXagPB2EpBkNc&index=13) * [Sending Celo Transactions](https://www.youtube.com/watch?v=rwq14V9e2hU) -## **Code Examples with Celo** +## Code Examples with Celo * [Sending Celo](https://docs.celo.org/developer-guide/start/hellocelo) * [Deploy a Contract (local node](https://docs.celo.org/developer-guide/start/hellocontracts) * [Deploy and Interact with Contracts (Remotely)](https://docs.celo.org/developer-guide/start/hello-contract-remote-node) -## **Create a Mobile dApp with Celo** +## Create a Mobile dApp with Celo * [DappKit Truffle Box](https://docs.celo.org/developer-guide/start/hello-mobile-dapp) -## **Create a Web dApp with Celo** +## Create a Web dApp with Celo * [Interact with Celo core contracts](https://github.com/celo-org/celo-monorepo/blob/e49efb31f45cab65db3d2ba58ffa59249197be0b/packages/docs/developer-resources/walkthroughs/web-dapp.md) -## **Stay Connected** +## Stay Connected * [Discord](https://chat.celo.org/) * [Forum](https://forum.celo.org/) diff --git a/docs/learn/developer-tools.md b/docs/learn/developer-tools.md index 45ac32df48..5439ccb17f 100644 --- a/docs/learn/developer-tools.md +++ b/docs/learn/developer-tools.md @@ -1,13 +1,13 @@ # Celo Tools -## **BlockScout** +## BlockScout [BlockScout](https://explorer.celo.org/) is a cLabs hosted GUI block explorer and [API endpoints](https://explorer.celo.org/api_docs). It allows you to look up information about the Celo blockchain including average block time, total transactions, and additional transaction details. You may also view details of your own custom smart contracts or existing DeFi contracts to view how value is moving between accounts and on-chain network events. The [API endpoints](https://explorer.celo.org/api_docs) allow you programmatically fetch blockchain data such as account balances and transaction history, smart contract interactions and events (logs), and block and transaction-specific information. -## **ContractKit** +## ContractKit ContractKit is a library to help developers and validators to interact with the Celo blockchain and is well suited to developers looking for an easy way to integrate Celo Smart Contracts within their applications. @@ -28,13 +28,13 @@ Contractkit includes common functionality to make it easier to get started build * Utilities * Query on-chain identifier for a phone number -## **Celo CLI** +## Celo CLI The [Command-Line Interface](../community/release-process/base-cli-contractkit-dappkit-utils) allows users to interact with the Celo Protocol smart contracts. It’s a command-line interface around the ContractKit. It allows you to interact with the Celo Protocol and smart contracts using command-line tools rather than writing JavaScript. It provides modules for interacting with modules on the ContractKit and is an excellent code reference when defining your own modules. Some common features you may want to consider are helping users participate in elections or in on-chain governance, voting for validators, or helping users interact with multi-sig contracts. -## **DAppKit** +## DAppKit [DAppKit](../developer-guide/dappkit) is a lightweight set of functions that allow mobile dApps to work with the Celo Wallet to sign transactions and access the user's account. This allows for a better user experience:dDApps can focus on a great native experience without having to worry about key management. It also provides a simpler development experience, as no state or connection management is necessary. @@ -46,7 +46,7 @@ It’s a command-line interface around the ContractKit. It allows you to interac DAppKit is currently built with React Native in mind, though the excellent[ Expo framework](https://expo.io/) is still highly recommended for developers building mobile and web dApps on Celo. Expo offers awesome features like incredibly easy setup, hot-reloading, and more. Currently, most of our tutorials and examples involve Expo, though we are working on creating additional documentation for other app frameworks. While DAppKit was designed for mobile apps in particular, since version 1.1.0-beta.1 it offers beta support for web dApps running in the browser of a mobile device. More details about this are included in the Usage section below. -# **Celo Networks** +# Celo Networks ## **Mainnet** @@ -58,7 +58,7 @@ The production Celo network, [Mainnet](../getting-started/mainnet) was previousl * [Mainnet Network Status](https://stats.celo.org/) - to check the current availability of the network * [Mainnet Network Block Explorer](http://explorer.celo.org/) - explore the history of the blockchain and view transaction details -## **Alfajores Testnet** +## Alfajores Testnet The [Alfajores Testnet](../getting-started/alfajores-testnet) is a Celo test network for developers building on the Celo platform. You can use it to try out the[ Celo Wallet](https://celo.org/build/wallet) or the Celo CLI (by sending transfers to yourself or other users of the testnet). You can also assist in running the network by operating a full node on your machine (or on a cloud or hosting provider). @@ -67,7 +67,7 @@ The [Alfajores Testnet](../getting-started/alfajores-testnet) is a Celo test net * [Alfajores Network Status](https://alfajores-celostats.celo-testnet.org/) - to check the current availability of the testnet * [Alfajores Testnet Block Explorer](https://alfajores-blockscout.celo-testnet.org/) - explore the history of the blockchain and view transaction details -## **Baklava Testnet** +## Baklava Testnet The [Baklava Testnet](../getting-started/baklava-testnet) is focused on building operational experience and best practices for node operators. @@ -77,7 +77,7 @@ It is designed for validators and testing protocol changes. You will most likely * [Baklava Network Status](https://baklava-celostats.celo-testnet.org/) - to check the current availability of the testnet * [Baklava Network Block Explorer](https://baklava-blockscout.celo-testnet.org/) - explore the history of the blockchain and view transaction details -## **Hosted Node Service (Forno)** +## Hosted Node Service (Forno) [Forno](../developer-guide/forno) is a cLabs hosted node service for interacting with the Celo network. This allows you to connect to the Celo Blockchain without having to run your own node. @@ -85,11 +85,11 @@ Forno has HTTP and WebSocket endpoints that you can use to query current Celo da Forno can be used as an HTTP Provider with ContractKit. -## **Figment Datahub** +## Figment Datahub [Figment datahub](https://figment.io/datahub/celo/) is a service similar to Forno. They have some additional features that allow you to track how people are using your application in terms of the type and number of requests coming through the endpoints. They have a free tier with the option to pay for the service to increase limits to support more popular projects. -# **Celo Wallets** +# Celo Wallets [Celo Wallets](../getting-started/wallets) are tools that create accounts, manage keys, and help users transact on the Celo network. @@ -99,20 +99,20 @@ It's important to be careful when choosing a wallet because they manage your sec The Celo Native Wallets section shows some popular wallets that were built specifically for the Celo network. They often include features that more general wallets do not, like paying for fees with cUSD. The Celo Compatible Wallets section has wallets that can work with Celo but were built for other networks (like Ethereum) or through company partnerships (like Pesabase). -# **Smart Contracts** +# Smart Contracts A smart contract is a self-executing contract with the terms of the agreement being directly written into lines of code. The code and the agreements contained therein exist across a distributed, decentralized blockchain network. The code controls the execution, and transactions are trackable and irreversible. Celo includes both protocol contracts and application-specific contracts. -## **Protocol Contracts** +## Protocol Contracts Protocol contracts exist at the lowest layer and include functionality like the Celo election process and code that runs the Celo proof of stake system and on-chain governance. -## **Application Contracts** +## Application Contracts Application contracts aren’t built by cLabs. These contracts are custom-built by developers to support application functionality. -## **Ethereum Contracts** +## Ethereum Contracts [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts) has a common token, governance, access control, utility contracts written in Solidity. diff --git a/docs/learn/evm-compatible-tooling.md b/docs/learn/evm-compatible-tooling.md index 726b43776a..c3aa89f707 100644 --- a/docs/learn/evm-compatible-tooling.md +++ b/docs/learn/evm-compatible-tooling.md @@ -2,25 +2,35 @@ See [Celo for Ethereum Developers](../developer-guide/celo-for-eth-devs) for an in-depth overview of the similarities and differences between Celo and Ethereum. -## **Solidity** +## Solidity Solidity is an object-oriented, high-level language for implementing smart contracts. It’s easy to learn if you’re familiar with C++, Python or Javascript. It’s the most popular language on Ethereum with strong support for both tooling and resources. You leverage existing work done on Ethereum open source projects for Celo applications. -## **Truffle** +## Truffle -[Truffle](https://www.trufflesuite.com/) is a development environment, testing framework, and asset pipeline for blockchains using the Ethereum Virtual Machine (EVM). It allows you to write contracts in your favorite development environment. After installing truffle in your project the truffle project will run scripts to deploy your contracts to the Alfajores Testnet, Mainnet, or whatever you specify in the configuration file. It helps you run unit tests against your deployed contracts to make sure that they're running as you expect. It also keeps track of all your contract deployments and your upgrades and the like the deployment history. +[Truffle](https://www.trufflesuite.com/) is a development environment, testing framework, and asset pipeline for blockchains using the Ethereum Virtual Machine (EVM). It allows you to write contracts in your favorite development environment. After installing truffle in your project the truffle project will run scripts to deploy your contracts to the Alfajores Testnet, Mainnet, or whatever you specify in the configuration file. It helps you run unit tests against your deployed contracts to make sure that they're running as you expect. It also keeps track of all your contract deployments and your upgrades and the like the deployment history. -## **Remix** +Learn more about deploying contracts to Celo with Truffle [here](../developer-resources/deploy-truffle). + +## Hardhat + +[Hardhat](https://hardhat.org/) is a development environment to compile, deploy, test, and debug your Ethereum or Celo software. It helps developers manage and automate the recurring tasks that are inherent to the process of building smart contracts and dApps, as well as easily introducing more functionality around this workflow. This means compiling, running, and testing smart contracts at the very core. + +Learn more about deploying contracts to Celo with Hardhat [here](../developer-resources/deploy-hardhat). + +## Remix [Remix IDE](https://remix-project.org/) allows developing, deploying, and administering smart contracts for Ethereum like blockchains. It can also be used as a learning platform. It allows you to write Solidity smart contracts with linting, import from GitHub, compile contracts to the EVM, deploy contracts, and connect to & interact with already deployed smart contracts. +Learn more about deploying contracts to Celo with Remix [here](../developer-resources/deploy-remix). + **Requirements** * [Celo Extension Wallet](https://chrome.google.com/webstore/detail/celoextensionwallet/kkilomkmpmkbdnfelcpgckmpcaemjcdh) * Celo Remix plugin -### **Metamask** +### Metamask [MetaMask](https://metamask.io/) is a crypto wallet that can be used in-browser and on mobile to interact with the Ethereum blockchain. Many dApps in the space integrate with MetaMask, and we're excited to bring its functionality to the Celo ecosystem. -With the Celo network's[ Donut Hardfork](https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0027.md), which was activated on Mainnet on May 19th, 2021, the protocol now supports[ Ethereum-compatible transactions](https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0035.md). This means that users are now able to use MetaMask to interact with the Celo blockchain and dApp developers can more easily port over Ethereum dApps onto Celo. The following guide aims to detail step-by-step how to do that. \ No newline at end of file +With the Celo network's[ Donut Hardfork](https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0027.md), which was activated on Mainnet on May 19th, 2021, the protocol now supports[ Ethereum-compatible transactions](https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0035.md). This means that users are now able to use MetaMask to interact with the Celo blockchain and dApp developers can more easily port over Ethereum dApps onto Celo. The following guide aims to detail step-by-step how to do that. diff --git a/docs/learn/platform-native-stablecoins-summary.md b/docs/learn/platform-native-stablecoins-summary.md index a4b8dccd9f..9aa8fdc9f2 100644 --- a/docs/learn/platform-native-stablecoins-summary.md +++ b/docs/learn/platform-native-stablecoins-summary.md @@ -1,6 +1,6 @@ # Platform-Native Stablecoins (cUSD, cEUR)? -## **Stable with Celo** +## Stable with Celo Named for the currencies they follow, Celo Dollars (cUSD) and Celo Euros (cEUR) are stablecoins that allow you to share value faster, cheaper, and more easily on your mobile phone. Celo stablecoins instantly unlock access for everyday uses like low-cost remittances and cross-border payments, global distribution of charitable aid, effortlessly paying online, or transferring value within exchanges, particularly in markets subject to currency volatility. @@ -10,19 +10,19 @@ Named for the currencies they follow, Celo Dollars (cUSD) and Celo Euros (cEUR) * 5 second block times * Can be used to pay gas fees -## **Pay instantly** +## Pay instantly With payment applications and mobile solutions built on Celo users can easily transfer stable value globally using only a mobile number while retailers can accept Celo Dollars (cUSD) and Celo Euros (cEUR) as stable forms of payment online or and in-person, -## **Share directly** +## Share directly Designed to enable a future without high transaction fees or expensive third party intermediaries for peer to peer payments, payments applications built on Celo allows its users to securely and instantly send and receive money locally or internationally without the burden of high transaction fees or third parties. With Celo, users can conveniently share directly on their mobile phones for as little as $0.01 to virtually anyone around the world. -## **Borrow easily** +## Borrow easily Many individuals don’t have a way of establishing assets or credit history on which to receive loans. With Celo, companies can reimagine the possibilities of financing by enabling anyone with even a basic feature phone to access to save, send peer-to-peer payments, and even obtain loans. -## **Get Started with Celo** +## Get Started with Celo * [Read Stability White Paper](https://celo.org/papers) * [Celo Dollars](https://medium.com/celoorg/celo-dollars-powerful-new-digital-money-in-circulation-b4147eda2d10) (cUSD) diff --git a/docs/learn/topology-of-a-celo-network.md b/docs/learn/topology-of-a-celo-network.md index ef55f1e85f..ee4601cc28 100644 --- a/docs/learn/topology-of-a-celo-network.md +++ b/docs/learn/topology-of-a-celo-network.md @@ -2,19 +2,21 @@ The topology of a Celo network consists of machines running the Celo blockchain software in several distinct configurations: -## **Validators** +![](https://storage.googleapis.com/celo-website/docs/network.png) + +## Validators Validators gather transactions received from other nodes and execute any associated smart contracts to form new blocks, then participate in a Byzantine Fault Tolerant (BFT) consensus protocol to advance the state of the network. Since BFT protocols can scale only to a few hundred participants and can tolerate at most a third of the participants acting maliciously, a proof-of-stake mechanism admits only a limited set of nodes to this role. -## **Full Nodes** +## Full Nodes Most machines running the Celo blockchain software are either not configured to be, or not elected as, validators. Celo nodes do not do "mining" as in Proof-of-Work networks. Their primary role is to serve requests from light clients and forward their transactions, for which they receive the fees associated with those transactions. These payments create a ‘permissionless onramp’ for individuals in the community to earn currency. Full nodes maintain at least a partial history of the blockchain by transferring new blocks between themselves and can join or leave the network at any time. -## **Light Clients** +## Light Clients Applications including the Celo Wallet will also run on each user's device an instance of the Celo blockchain software operating as a ‘light client’. Light clients connect to full nodes to make requests for account and transaction data and to sign and submit new transactions, but they do not receive or retain the full state of the blockchain. -## **Celo Wallet** +## Celo Wallet The Celo Wallet application is a fully unmanaged wallet that allows users to self custody their funds using their own keys and accounts. All critical features such as sending transactions and checking balances can be done in a trustless manner using the peer-to-peer light client protocol. However, the wallet does use a few centralized cloud services to improve the user experience where possible, e.g.: diff --git a/docs/learn/valora-summary.md b/docs/learn/valora-summary.md index 45473f2a13..419a587291 100644 --- a/docs/learn/valora-summary.md +++ b/docs/learn/valora-summary.md @@ -12,19 +12,19 @@ Valora’s mission is to be the most reliable way to send and receive value worl * Confirms transactions in less than 5 seconds on average * Transaction fees as low as 1/100th of the current cost -## **Send money like a text message** +## Send money like a text message Valora makes global transfers easy. Send money to your friends and family back home, as simply as sending a text message. -## **Near-zero fee for transactions on the Celo network** +## Near-zero fee for transactions on the Celo network Valora gives you control of your value by making your phone your wallet. Send transactions directly from your mobile phone to your friends at a fraction of the current cost. -## **Spend on the things you love** +## Spend on the things you love Use Valora to buy gift cards for major retailers, services, and subscriptions around the world. -## **Use crypto like everyday money** +## Use crypto like everyday money Send, pay, and spend cryptocurrency like everyday money - all from the palm of your hand. @@ -32,6 +32,6 @@ Send, pay, and spend cryptocurrency like everyday money - all from the palm of y * **Receive** global transactions in seconds with Valora. * **Pay** online or in-store where Celo is accepted. -## **Get Started with Valora** +## Get Started with Valora Visit [valoraapp.com](https://valoraapp.com/) to learn more. diff --git a/docs/learn/celo-purpose.md b/docs/learn/why-celo.md similarity index 88% rename from docs/learn/celo-purpose.md rename to docs/learn/why-celo.md index d063d5877d..c860f51815 100644 --- a/docs/learn/celo-purpose.md +++ b/docs/learn/why-celo.md @@ -1,41 +1,53 @@ -# Celo's Purpose +--- +title: Why Celo +id: why-celo +slug: /why-celo +--- + +# Why Celo + +The Celo platform is proof-of-stake, EVM-compatible, open source, and governed by CELO asset owners. + +___ + +## Celo is mobile, open, and real Celo was designed to enable a new universe of financial solutions accessible for mobile users and takes a mobile-first approach that provides the opportunity to positively impact 6B+ smartphone owners globally, creating a global financial ecosystem where an end-user can onboard into the Celo ecosystem with just a mobile number. Celo’s technology innovations allow it to truly work across devices, carriers, and countries. Celo uses a novel Proof-of-Stake (PoS) consensus protocol and a hyper-efficient light client. With its interoperability, [cross-chain compatibility](celo-codebase/protocol/optics), and vision for currency inclusivity, Celo enables digital assets to circulate at extremely low costs and high speeds across devices, carriers, and countries, making money mobile, global and accessible like never before. Celo is supported by a mission-aligned network of technologists and international organizations committed to building an inclusive financial system that creates the conditions for prosperity—for everyone. -## **Mobile** +## Mobile Celo’s mobile-first approach to user-first decentralized finance (DeFi) means everyone has equal access to powerful financial tools and services – no matter who they are or where they live – creating convenient, financial opportunities for anyone who is online and on their mobile phones. -### **User-first with phone number PKI** +### User-first with phone number PKI [Mobile phone number mapping](learn/celo-protocol.md#lightweight-identity) to account addresses for a seamless user experience on platform-native dApps, like [impactMarket](https://www.impactmarket.com/) or [Valora](https://valoraapp.com/). -### **Ultra-accessible with Ultralight Mobile Client** +### Ultra-accessible with Ultralight Mobile Client The ultralight client is a zk-SNARK based system that allows mobile and resource constrained nodes on the Celo network to sync to the Celo blockchain faster and with less data. It accomplishes this by using zero-knowledge proofs, which allow the quick verification of the chain syncing computation without having to run it locally. -### **Industry-leading blockchain sync speeds with Plumo** +### Industry-leading blockchain sync speeds with Plumo [Plumo](../celo-codebase/protocol/plumo) will allow Celo to sync 1 million times faster than other blockchains. -## **Open** +## Open With its interoperability, full EVM compatibility, and vision for currency inclusivity, Celo’s open-source infrastructure now supports 1000+ projects from builders, developers, and even artists, who every day create new applications and issue digital currencies from 100+ countries around the world. -### **Interoperable with Optics** +### Interoperable with Optics The [Optics](../celo-codebase/protocol/optics) standard will allow Celo to facilitate transactions between other smart contract enabled layer 1 blockchains like Ethereum, Cosmos, Solana, and Near, meaning Celo’s ecosystem of developers can connect the people, services, and technologies that allow everyone to benefit from a more open and connected blockchain ecosystem. -### **On-chain governance with CELO** +### On-chain governance with CELO Celo is turning crypto into usable money with a multi-asset system: a growing family of native and wrapped stablecoins and CELO, the native governance and staking asset (CELO) that allows anyone to help shape the future of Celo. -### **Sustainable with staking** +### Sustainable with staking [Celo’s Proof-of-Stake (PoS)](../celo-codebase/protocol/proof-of-stake) consensus mechanism and automatic daily carbon offsets make Celo the world's first carbon-negative blockchain, offsetting over 2,285 tons of carbon to-date. -## **Real** +## Real Using the power of mobile-first DeFi to solve real problems for real people, Celo has made blockchain’s vision for a globally accessible decentralized financial system a reality. With Celo’s reliable 5 second block times, low gas fees [payable in stablecoins](../celo-codebase/protocol/transactions/erc20-transaction-fees), and decentralized phone verification protocol, it’s no wonder companies and organizations like Deutsche Telekom, Opera, and the Grameen Foundation are working with the Celo ecosystem to drive adoption of Celo’s technology in the real world. diff --git a/docs/overview.md b/docs/overview.md index 6437617be9..a7790ba359 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,27 +1,20 @@ --- -title: Celo Overview +title: Platform Overview id: overview --- -Celo’s aim is to empower anyone with a smartphone anywhere in the world to have access to financial services, send money to phone numbers, and pay merchants -- on a decentralized platform that is operated by a community of users. - -To achieve this, Celo is a complete stack of new blockchain software, core libraries that run on that blockchain, and end user applications including a Wallet app that communicate with that logic. - -This page provides some background on blockchain technology and explores the Celo software stack. -### Background and Key Concepts +Celo is a complete stack of new blockchain software, core libraries that run on that blockchain, and end user applications including a Wallet app that communicate with that logic. +### Blockchain A **blockchain** or **cryptographic network** is a broad term used to describe a database maintained by a distributed set of computers that do not share a trust relationship or common ownership. This arrangement is referred to as **decentralized**. The content of a blockchain's database, or **ledger**, is authenticated using cryptographic techniques, preventing its contents from being added to, edited or removed except according to a protocol operated by the network as a whole. The code of the Celo Blockchain has shared ancestry with [Ethereum](https://www.ethereum.org), blockchain software for building general-purpose decentralized applications. Celo differs from Ethereum in several important areas as described in the following sections. However, it inherits a number of key concepts. - -:::warning - -Despite its similarity to Ethereum, Celo is a completely different blockchain and protocol, and Celo assets **cannot** be accessed on the Ethereum network. - -::: +## Smart Contracts Ethereum applications are built using **smart contracts**. Smart contracts are programs written in languages like [Solidity](https://solidity.readthedocs.io/en/v0.5.10/) that produce bytecode for the **Ethereum Virtual Machine** or **EVM**, a runtime environment. Programs encoded in smart contracts receive messages and manipulate the blockchain ledger and are termed **on-chain**. +## Cryptocurrency + Celo has a native unit of accounting, the cryptocurrency **CELO**, comparable to Ether on Ethereum. Celo's ledger consists of **accounts**, identified by an **address**. There are two types of accounts. **Externally owned accounts** have an associated CELO balance and are controlled by a user holding the associated public-private keypair. **Contract accounts** contain the code and data of a single smart contract which can be called and manipulate its own stored data. **ERC-20** is a standard interface for implementing cryptocurrencies or **tokens** as contracts, rather than via account balances. For additional information on this, see [Celo for Ethereum Developers](https://docs.celo.org/developer-guide/celo-for-eth-devs). In Celo, CELO has a duality as both the native currency and an ERC-20 compliant token on the Celo blockchain. @@ -32,128 +25,24 @@ Celo assets exist on an independent blockchain, and cannot be accessed through w ::: -Users interact with the blockchain by creating signed **transactions.** These are requests to make a change to the ledger. They can: transfer value between accounts; execute a function in a smart contract and pass in arguments \(perhaps causing other smart contracts to be called, update their storage, or transfer value\); or create a new smart contract. - -The blockchain is updated by a protocol that takes the current state of the ledger, applies a number of transactions in turn, each of which may execute code and result in updates to the global state. This creates a new **block** that consists of a **header**, identifying the previous block and other metadata, and a data structure that describes the new state. - -To avoid Denial-of-Service attacks and ensure termination of calls to smart contract code, the account sending a transaction pays **transaction fees** for its execution steps using its own balance. Transactions specify a **maximum gas** which bounds the steps of execution before a transaction is reverted. A **gas price** determines the unit price for each step, and is used to prioritize which transactions the network applies. \(In Celo transaction fees can be paid in ERC-20 currencies and gas pricing works differently from Ethereum\). - -For a more in depth explanation of Ethereum, see the [Ethereum White Paper](https://github.com/ethereum/wiki/wiki/White-Paper) or [documentation](http://ethdocs.org/en/latest/introduction/what-is-ethereum.html#learn-about-ethereum). - -### The Celo Stack - -Celo is oriented around providing the simplest possible experience for end users, who may have no familiarity with cryptocurrencies, and may be using low cost devices with limited connectivity. To achieve this, Celo takes a full-stack approach, where each layer of the stack is designed with the end user in mind while considering other stakeholders \(e.g. operators of nodes in the network\) involved in enabling the end user experience. - -The Celo stack is structured into the following logical layers: - -![](https://storage.googleapis.com/celo-website/docs/full-stack-diagram.jpg) +## Transactions -- **Celo Blockchain**: An open cryptographic protocol that allows applications to make transactions with and run smart contracts in a secure and decentralized fashion. The Celo Blockchain code has shared ancestry with [Ethereum](https://www.ethereum.org), and maintains full EVM compatibility for smart contracts. However it uses a [Byzantine Fault Tolerant](http://pmg.csail.mit.edu/papers/osdi99.pdf) \(BFT\) consensus mechanism rather than Proof of Work, and has different block format, transaction format, client synchronization protocols, and gas payment and pricing mechanisms. -- **Celo Core Contracts**: A set of smart contracts running on the Celo Blockchain that comprise much of the logic of the platform features including ERC-20 stable currencies, identity attestations, proof-of-stake and governance. These smart contracts are upgradeable and managed by the decentralized governance process. -- **Applications:** Applications for end users built on the Celo platform. The Celo Wallet app, the first of an ecosystem of applications, allows end users to manage accounts and make payments securely and simply by taking advantage of the innovations in the Celo protocol. Applications take the form of external mobile or backend software: they interact with the Celo Blockchain to issue transactions and invoke code that forms the Celo Core Contracts’ API. Third parties can also deploy custom smart contracts that their own applications can invoke, which in turn can leverage Celo Core Contracts. Applications may use centralized cloud services to provide some of their functionality: in the case of the Celo Wallet, push notifications and a transaction activity feed. +Users interact with the blockchain by creating signed **transactions.** These are requests to make a change to the ledger. -The Celo Blockchain and Celo Core Contracts together comprise the **Celo Protocol**. - -### Topology of a Celo Network - -The topology of a Celo network consists of machines running the Celo Blockchain software in several distinct configurations: - -![](https://storage.googleapis.com/celo-website/docs/network.png) - -- **Validators:** Validators gather transactions received from other nodes and execute any associated smart contracts to form new blocks, then participate in a Byzantine Fault Tolerant \(BFT\) consensus protocol to advance the state of the network. Since BFT protocols can scale only to a few hundred participants, and can tolerate at most a third of the participants acting maliciously, a proof-of-stake mechanism admits only a limited set of nodes to this role. -- **Full Nodes:** Most machines running the Celo Blockchain software are either not configured to be, or not elected as, validators. Celo nodes do not do "mining" as in Proof of Work networks. Their primary role is to serve requests from light clients and forward their transactions, for which they receive the fees associated with those transactions. These payments create a ‘permissionless onramp’ for individuals in the community to earn currency. Full nodes maintain at least partial history of the blockchain by transferring new blocks between themselves, and can join or leave the network at any time. -- **Light Clients:** Applications including the Celo Wallet will also run on each user's device an instance of the Celo Blockchain software operating as a ‘light client’. Light clients connect to full nodes to make requests for account and transaction data and to sign and submit new transactions, but they do not receive or retain the full state of the blockchain. - -The Celo Wallet application is a fully unmanaged wallet that allows users to self custody their funds using their own keys and accounts. All critical features such as sending transactions and checking balances can be done in a trustless manner using the peer-to-peer light client protocol. However, the wallet does use a few centralized cloud services to improve the user experience where possible, e.g.: - -- **Google Play Services:** to pre-load invitations in the app -- **Celo Wallet Notification Service:** sends device push notifications when a user receives a payment or requests for payment -- **Celo Wallet Blockchain API:** provides a GraphQL API to query transactions on the blockchain on a per-account basis, used to implement a users' activity feed. - -When an end user downloads the Celo Wallet from, for example, the Google Play Store, users are trusting both cLabs (or the entity that has made the application available in the Play Store) and Google to deliver a correct binary, and most users would feel that relying on these centralized services to provide this additional functionality is worthwhile. - -## The Celo Protocol - -The Celo Blockchain and Celo Core Contracts together comprise the **Celo Protocol**. This term describes both what services the decentralized Celo network provide to applications and the way in which nodes in the network cooperate to achieve this. This section introduces some of these services. - -### Consensus and Proof-of-Stake - -Celo is a proof-of-stake blockchain. In comparison to Proof of Work systems like Bitcoin and Ethereum, this eliminates the negative environmental impact and means that users can make transactions that are cheaper, faster, and whose outcome cannot be changed once complete. - -The Celo Blockchain implements a Byzantine Fault Tolerant \(BFT\) consensus algorithm in which a well-defined set of validator nodes broadcast signed messages between themselves in a sequence of steps to reach agreement even when up to a third of the total nodes are offline, faulty or malicious. When a quorum of validators have reached agreement, that decision is final. - -Celo uses a proof-of-stake mechanism for selecting the validator set for a fixed period termed an epoch. Anyone can earn rewards by locking CELO and by participating in validator elections and governance proposals. Initially, the number of validators will be capped to one hundred nodes elected by CELO holders. Validators earn additional fixed rewards in Celo Dollars to cover their costs plus margin. - -:::success - -**Roadmap**: Celo is pioneering a [highly scalable, permissionless BFT consensus algorithm](https://medium.com/celohq/bftree-scaling-hotstuff-to-millions-of-validators-7d6930ee046a) that in the long term will result in substantial changes to the proof-of-stake mechanism described here. - -::: +**Transactions can complete the following actions** -### On-Chain Governance +* Transfer value between accounts +* Execute a function in a smart contract and pass in arguments +* Create a new smart contract -Celo uses an on-chain governance mechanism to manage and upgrade aspects of the protocol that reside in the Celo Core Contracts, and for a number of parameters used by the Celo Blockchain. This includes operations like upgrading smart contracts, adding new stable currencies, modifying the reserve target asset allocation, and changing how validator elections are decided. +## Blocks -The Governance contract is set as “owner” for all of the Celo Core Contracts. This allows the protocol to carry out agreed governance proposals by executing code in the context of the Governance contract. Proposals are selected for consideration and voted on by CELO holders using a weighted vote based on the same Locked CELO commitment used to vote to elect validators. - -### Ultralight Synchronization - -Celo provides extremely fast, secure synchronization to enable light clients to begin to track the current state of the Celo blockchain ledger almost immediately. This means that even wallet users with high latency, low bandwidth, or high cost data tariffs can use Celo. - -In Ethereum, verifying whether data received from an untrusted full node really does represent the current state of a blockchain requires fetching every block header ever produced to confirm they form a cryptographically secure chain. A consequence of Celo using a BFT consensus algorithm is that it can do that verification by building a chain only of changes in the validator set, not each individual block. - -:::success - -**Roadmap**: Synchronization performance will be further improved with BLS signature aggregation and succinct zero-knowledge proofs, via zk-SNARKs. - -::: - -### Incentives for Operating Full Nodes - -In Ethereum, there are few incentives to run a full node that is not mining. Few nodes serve light clients, and this results in a poor experience for mobile wallets. - -Celo introduces a scheme that incentivizes users to operate regular nodes. Light clients pay transaction fees to full nodes. Clients include in every transaction the address of a node which, when the transaction is processed, receives the fee. While a full node provides other services for which they receive no specific fee, it is expected that failing to service these requests will cause clients to seek other full nodes that do, who will then receive fees when they next make a transaction. - -Since light clients need not trust full nodes, as they can verify their work, this also provides the 'permissionless on-ramp' for users to receive CELO or Celo Dollars without already holding it that is missing in other proof-of-stake networks. - -### Stable Cryptocurrencies - -Celo enables a family of stablecoins that track the value of any asset, including fiat currencies, commodities, and even natural resources. Stablecoins supported include the Celo Dollar (cUSD) and the Celo Euro (cEUR), which track the value of the U.S. Dollar and Euro respectively. CELO and a basket of other assets including BTC and ETH serves as the collateral for these stablecoins. These stablecoins are redeemable for CELO, ensuring that transactions can occur quickly, cheaply and reliably on-chain. - -Celo's stability mechanism allows users to create a new Celo Dollar by sending 1 US Dollar worth of CELO to the reserve, or burn a Celo Dollar by redeeming it for 1 US Dollar worth of CELO. - -This mechanism relies on a series of Oracles, or information feeds from exchanges external to the network, to report the CELO to US Dollar market rates. To minimize the risk of a run on CELO collateral when these reported values are inaccurate or out-of-date, Celo uses an on-chain constant-product-market-maker model, inspired by the [Uniswap](https://uniswap.io/) system. This mechanism adjusts the redemption price of CELO until either arbitrage occurs (so that the on-chain price dynamically adjusts until the offered rate meets the external rate) or Oracles reset the on-chain price. - -The Celo protocol ensures that there is sufficient CELO collateral to redeem the amount of CELO in circulation through several sources. These include a [stability fee](celo-codebase/protocol/stability/stability-fees.md) levied on Celo Dollar balances, a transfer from [epoch rewards](celo-codebase/protocol/proof-of-stake/community-fund.md#bolstering-the-reserve), plus the proceeds from the spread when interacting with the on-chain market-maker mechanism. - -In addition, a back-up reserve of cryptocurrencies is held off-chain. This off-chain reserve is managed to preserve value and minimize volatility by maintaining a diversified portfolio of cryptocurrencies through algorithmic rebalancing trading and periodically "topping-up" the CELO collateral available to ensure it exceeds the amount required to redeem Celo Dollars in circulation. The approved cryptocurrencies, distribution ratios, and rebalancing period are all subject to on-chain governance. - -:::success - -**Roadmap**: Celo envisages a number of stable currencies tracking different fiat currencies as well as natural resources such as forests. In addition, once bridges between other chains and the Celo blockchain are fully developed, and liquid trading on decentralized exchanges occurs, the rebalancing can be handled transparently on-chain. - -::: - -### Lightweight Identity - -Celo offers a lightweight identity layer that allows users of applications including Celo Wallet to identify and securely transact with other users via their contacts' phone numbers. Celo Wallet enables payments directly to users listed in their device's contacts list. - -The Attestations contract allows a user to request attestations to their phone number for a small fee. A secure decentralized source of randomness is used to pick a number of validators that will produce and send via SMS signed secret messages that act as attestations of ownership of the phone number. The user then submits these back to the Attestations contract which verifies them and installs a mapping for the phone number to the user's account. - -### Richer Transactions - -Celo provides a number of enhancements to regular transactions as familiar to Ethereum developers. - -The Celo native asset has a duality as both the native currency and is also an ERC-20 token, simplifying the work of application developers. - -:::warning - -Celo assets exist on an independent blockchain, and cannot be accessed through wallets that connect to the Ethereum network. Only use wallets designed to work with the Celo network. +The blockchain is updated by a protocol that takes the current state of the ledger, applies a number of transactions in turn, each of which may execute code and result in updates to the global state. This creates a new **block** that consists of a **header**, identifying the previous block and other metadata, and a data structure that describes the new state. -::: +## Transaction Fees -In Celo, transaction fees can be paid in stable cryptocurrencies. A user sending Celo Dollars will be able to pay their transaction fee out of their Celo Dollar balance, so they do not need to hold a separate balance of CELO in order to make transactions. The protocol maintains a list of currencies which can be used to pay for transaction fees. These smart contracts implement an extension of the ERC-20 interface, with additional functions that allow the protocol to debit and credit transaction fees. +To avoid Denial-of-Service attacks and ensure termination of calls to smart contract code, the account sending a transaction pays **transaction fees** for its execution steps using its own balance. Transactions specify a **maximum gas** which bounds the steps of execution before a transaction is reverted. A **gas price** determines the unit price for each step, and is used to prioritize which transactions the network applies. \(In Celo transaction fees can be paid in ERC-20 currencies and gas pricing works differently from Ethereum\). -The Escrow contract allows users to send payments to other users who can be identified by a phone number but don’t yet have an account. These payments are stored in this contract itself and can be either withdrawn by the intended recipient after creating an account and attesting their identity, or reclaimed by the sender. +## Learn more -Transfers between two accounts with associated identities support end-to-end encrypted comments. A comment encrypted to the identity's public key is passed when making the transfer, and included in an event that can be located on the blockchain ledger. +For a more in depth explanation of Ethereum, see the [Ethereum White Paper](https://github.com/ethereum/wiki/wiki/White-Paper) or [documentation](http://ethdocs.org/en/latest/introduction/what-is-ethereum.html#learn-about-ethereum). \ No newline at end of file diff --git a/docs/welcome.md b/docs/welcome.md index 4b35c50f32..5d8c9e918b 100644 --- a/docs/welcome.md +++ b/docs/welcome.md @@ -3,144 +3,29 @@ title: Welcome to Celo id: welcome slug: /welcome --- +# Welcome to Celo -Welcome to the technical documentation site for the Celo project! +Celo's mission, vision, and goals for financial prosperity for everyone. -In this documentation you’ll find information on: +___ -- An [overview](./overview.md) of the high-level architecture of Celo -- Tutorials to get you started with the [Celo SDK](./developer-resources/start.md) and the [Celo networks](getting-started/choosing-a-network.md) -- Reference documentation about the [Celo protocol](celo-codebase/protocol/) and [wallet](celo-codebase/wallet/) -- How to make technical [contributions](community/contributing.md) to the project and community -## Quick Reference +## Crypto made for Mobile -- CELO Owners - - [Start here](celo-holder-guide/quick-start.md) to find out how to access your account and earn rewards for participating in the network. -- Validator & Node Operators - - Check out the [Validator overview page](validator-guide/overview.md). - - Consider running a node on the [Baklava testnet](getting-started/baklava-testnet) before getting started on Mainnet. - - Learn more about running nodes on [Mainnet](getting-started/mainnet). -- Developers - - Start at the [developer tools page](./developer-resources/overview.md) for help building a DApp or service on the Celo network. -- Integration Guide - - [This section](./developer-resources/integrations/integrations.md) includes guides on common ways for integrating Celo into your service. This may be relevant for custodians, exchanges or other services that intend to custody Celo assets like CELO and cUSD. +[Celo](https://celo.org/) is a mobile-first blockchain that makes decentralized financial (DeFi) tools and services accessible to anyone with a mobile phone. It aims to break down barriers by bringing the powerful benefits of DeFi to the users of the 6 billion smartphones in circulation today. +## Celo's Mission -### About Celo +The company’s mission is to build a financial system that creates the conditions of prosperity for everyone. Celo enables native and non-native digital assets–both cryptographic and Central Bank Digital Currencies (CBDCs)–to circulate freely across devices, carriers, and countries. This makes money mobile, global and accessible like never before. Celo is supported by a community of organizations and individuals, including Jack Dorsey, a16z, and Deutsche Telekom. -Celo’s purpose is to empower anyone with a smartphone anywhere in the world to have access to financial services, send money to phone numbers, and pay merchants. +**Watch:** [What if Money were Beautiful](https://www.youtube.com/watch?v=kKggE5OvyhE) -The project aims to be a decentralized platform that is not controlled by any single entity, but instead developed, upgraded and operated by a broad community of individuals, organizations and partners. +## Celo Ecosystem -Uniquely, Celo is oriented around providing the simplest possible experience for end users, who may have no familiarity with cryptocurrencies, and may be using low cost devices with limited connectivity. To achieve this, the project takes a full-stack approach, comprising of both a protocol and applications that use that protocol. +An Ethereum-compatible technology capable of reaching global users at scale, Celo turns crypto into usable money with a multi-asset system: a governance and staking asset (CELO) and a family of stablecoins. Since the launch of Mainnet in 2020, Celo’s network now supports 1000+ projects from builders, developers, and artists, who everyday create new applications and issue digital currencies from over 100 countries around the world. -The Celo protocol is an open, distributed cryptographic protocol that allows applications to make transactions with and perform computation on a family of cryptocurrencies, including ones pegged to ‘fiat’ currencies like the US Dollar. The [Celo Wallet](http://celo.org/build/wallet) app, the first of an ecosystem of applications, allows end users to manage accounts and make payments securely and simply by taking advantage of the innovations in the Celo protocol. +CELO is a platform-native reserve and governance asset, serving as the primary asset in the[ stability mechanism](https://celo.org/papers/Celo_Stability_Analysis.pdf) (Mento) that supports stable digital currencies like cUSD and cEUR. CELO’s primary function is stabilization, ensuring the healthy velocity of assets that globally circulate and transact on Celo. CELO also serves as the key governance mechanism for the Celo Platform. Owning and using CELO supports the growth and development of the Celo Platform by enabling each CELO owner to vote on proposals that direct how the core technology operates today and in the future. -Highlights include: +**Watch:** [Meet the team working at Celo](https://www.youtube.com/watch?v=vwfHiaVzc2E) -- **Stable Value Currencies** +## Get started with Celo - Celo includes native support for multiple ERC20-like stable currencies pegged to ‘fiat’ currencies like the US dollar, to facilitate the use of Celo as a means of payment. - -- **Accounts Linked to Phone Numbers** - - Celo maintains a secure decentralized mapping of phone numbers that allow wallet users to send and receive payments with their existing contacts simply and with confidence that the payment will reach the intended recipient. - -- **Transaction Fees in Any Currency** - - Users can pay transaction fees in stable currencies, so that they do not need to manage balances of different currencies. - -- **Immediate Syncing Even on Slow Connections** - - Extremely fast, secure synchronization between mobile devices and the Celo network means that even wallet users with high latency, low bandwidth, or high cost data tariffs can use Celo. Celo removes the need to check every header before a received header can be trusted. Performance will be further improved with BLS signature aggregation and succinct zero-knowledge proofs, via zk-SNARKs. - -- **Proof-of-Stake** - - Celo uses a proof-of-stake consensus algorithm. In comparison to Proof of Work systems like Bitcoin and Ethereum, this eliminates the negative environmental impact and means that users can make transactions that are cheaper, faster, and where the outcome cannot be changed once complete. - -- **Full Node Incentives** - - The Celo protocol offers incentives for running full nodes to service the light clients that run on each mobile device. Unlike other proof-of-stake systems, users can still earn cryptocurrency in exchange for providing compute resources without having to stake funds. - -- **On-chain Governance** - - Since great user experiences need constant iteration, Celo supports rapid upgrades and protocol changes via on-chain governance in which all cryptocurrency holders can participate. - -- **Programmable \(Full EVM Compatibility\)** - - Celo includes a programmable smart contract platform that is compatible with the Ethereum Virtual Machine, which is already widely adopted, familiar to developers, and has strong tool support. This enables Celo to deliver rich user features and rapidly support a wide ecosystem of third-party applications and extensions. - -- **Self Custody** - - Users have access to and fully control their funds and account keys, and don't need to depend on third parties to make payments. - -### Current Status - -The Celo project is live on [Mainnet](https://medium.com/celoorg/its-official-celo-mainnet-is-here-6a3a71763f68)! - -The code is entirely open source and available on [GitHub](https://github.com/celo-org). Versions of all the major components of both the protocol and wallet exist, but the platform as a whole is under active development and testing by the Celo community. - -The [Alfajores Testnet](getting-started/alfajores-testnet) is the first of several networks designed for testing and for developers to experiment and learn more about Celo. You can set up an account, receive funds, and try out the Celo Wallet and Celo CLI. [Get started here](getting-started/alfajores-testnet/faucet). - -:::caution - -The Alfajores Testnet’s tokens hold no real world economic value. The entirety of the testnet’s data will be reset on a regular basis. This will erase your accounts, their balance and your transaction history. Your use of the Alfajores Tesnet is subject to the [Alfajores Testnet Disclaimer](important-information/alfajores-testnet-disclaimer). - -::: - -The [Baklava Testnet](getting-started/baklava-testnet) is the second Celo test network after Alfajores. You can use it to participate in the The Great Celo Stake Off. Subject to these Terms and Conditions, eligible participants will have the opportunity to receive CELO at the Mainnet launch of the Celo Protocol. The Stake Off will operate in phases, with each phase focusing on a different part of the protocol or infrastructure to test. - -The Celo community's work is focused on the path to a production Celo network that holds economic value. This means testing, running security audits, and building broader involvement around a longer-term roadmap. The project also continues to remain focused on user experience. - -The team working on Celo anticipates working to improve and expand the range of APIs available for developers to use in creating extensions to Celo, whether as smart contracts or applications. Your input is very welcome in the form of use cases, suggestions, and bug reports. - -:::caution - -While development proceeds, Celo’s protocol and its APIs will evolve and any smart contracts or applications built to operate on Alfajores or with respect to the current codebase may become incompatible. - -::: - -Celo is a project with a mission of financial inclusion that consists entirely of open source code, is deployed as an open, decentralized runtime, and promotes open governance. Make it your project too. Please [get involved](community/contributing.md)! - -### Useful Links - -Learn more about Celo: - -- [Overview of Celo’s architecture ](overview.md) -- [Technical blog posts](https://medium.com/celoorg/technology/home) - -Browse the code, raise an issue, or contribute a PR: - -- [Monorepo GitHub Page](https://github.com/celo-org/celo-monorepo) -- [Celo Client GitHub Page](https://github.com/celo-org/celo-blockchain) -- [Contributing Guide](community/contributing.md) -- [Celo Build Page](https://celo.org/build) - -Try Celo out: - -- [Using the Mobile Wallet](getting-started/alfajores-testnet/using-the-mobile-wallet) on the Alfajores Testnet -- [Introduction to the CLI ](command-line-interface/introduction.md)on the Alfajores Testnet - -Read the Whitepapers: - -- [Main Celo Whitepaper](https://celo.org/papers/whitepaper) and [introductory blog post](https://medium.com/celohq/a-look-at-the-celo-whitepaper-c0061118ffd4) -- [Stability Analysis Whitepaper](https://celo.org/papers/Celo_Stability_Analysis.pdf) and [blog post](https://medium.com/celohq/a-look-at-the-celo-stability-analysis-white-paper-part-1-23edd5ef8b5) -- [BFTree \(Longer Term Consensus Plan\)](https://storage.googleapis.com/celo_whitepapers/BFTree%20-%20Scaling%20HotStuff%20to%20Millions%20of%20Validators.pdf) - -Alfajores Testnet links: - -- [Alfajores Testnet Faucet](https://celo.org/build/faucet) - get testnet tokens to experiment with -- [Celo Wallet for Alfajores](https://celo.org/build/wallet) - download the Android wallet app for the testnet from the Play Store -- [Alfajores Testnet Network Status](https://alfajores-celostats.celo-testnet.org) - to check the current availability of the testnet -- [Alfajores Testnet Block Explorer](https://alfajores-blockscout.celo-testnet.org) - explore the history of the blockchain and view transaction details - -Ask questions, find answers, and get in touch: - -- [Celo Forum](https://forum.celo.org) -- [Celo Developer Chat on Discord](https://discord.gg/JvJ66Wc) -- [Celo Subreddit](https://www.reddit.com/r/celo/) -- [Celo Website](https://celo.org/build) -- [Host a Meetup](https://airtable.com/shrTCM7LddTxOm3r6) - -### Notes - -If you are viewing this document on GitHub, please visit the [official hosted version](https://docs.celo.org) of this content for a better experience. Additionally, Celo is in active development. If you encounter any issues or bugs or have suggestions for how Celo can improve, please post an issue or pull request [here](https://github.com/celo-org/celo-monorepo). +To build technology and products that are used and loved by people and solve real-world problems, Celo is building a community with many different perspectives and experiences. Let’s build a monetary system that creates the conditions for prosperity for all. \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 26ae8491fe..6ded78a2f4 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -309,12 +309,12 @@ module.exports = { }, items: [ { - "to": "/welcome", + "to": "welcome", "label": "Welcome", "position": "left" }, { - "to": "learn/celo-overview", + "to": "learn/celo-onboarding", "label": "Tutorials", "position": "left" }, diff --git a/sidebars.js b/sidebars.js index 6dd7e594ff..6581c5715d 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,13 +1,34 @@ const sidebars = { docs: [ - { - type: "doc", label: "Welcome to Celo", id: "welcome", - }, + // { type: "doc", label: "Welcome to Celo", id: "welcome",}, + { type: 'doc', label: 'Welcome to Celo', id: 'welcome', }, { type: "category", label: "Getting Started", items: [ - { type: "doc", label: "Celo Overview", id: "overview", }, + { + type: 'category', + label: 'Celo Basics', + items: [ + { type: 'doc', label: 'Why Celo', id: 'learn/why-celo', }, + { type: 'doc', label: 'Highlights', id: 'learn/celo-highlights', }, + { type: 'doc', label: 'Whitepapers', id: 'learn/celo-whitepapers', }, + { type: 'doc', label: 'Economic Model', id: 'learn/celo-economic-model', }, + { type: 'doc', label: 'Milestones', id: 'learn/celo-milestones', }, + { type: 'doc', label: 'Ecosystem', id: 'learn/celo-ecosystem', }, + ] + }, + { + type: 'category', + label: 'Celo Platform', + items: [ + { type: 'doc', label: 'Platform Overview', id: 'overview', }, + { type: 'doc', label: 'Celo Stack', id: 'learn/celo-stack', }, + { type: 'doc', label: 'Network Topology', id: 'learn/topology-of-a-celo-network', }, + { type: 'doc', label: 'Celo Protocol', id: 'learn/celo-protocol', }, + ] + }, + // { type: "doc", label: "Celo Overview", id: "overview", }, { type: "doc", label: "DApp Gallery", id: "developer-resources/celo-dapp-gallery",}, ], }, @@ -175,6 +196,8 @@ const sidebars = { type: "category", label: "Developer Tools", items: [ + { type: 'doc', label: 'Developer Tools', id: 'learn/developer-tools', }, + { type: 'doc', label: 'EVM Tools', id: 'learn/evm-compatible-tooling', }, { type: 'category', label: 'ContractKit', @@ -332,38 +355,8 @@ const sidebars = { // Learn // ###################################### learn: [ - { type: 'doc', label: 'Introduction to Celo', id: 'learn/celo-overview', }, - { - type: 'category', - label: 'Celo Basics', - items: [ - { type: 'doc', label: 'Purpose', id: 'learn/celo-purpose', }, - { type: 'doc', label: 'Value', id: 'learn/celo-value', }, - { type: 'doc', label: 'Whitepapers', id: 'learn/celo-whitepapers', }, - { type: 'doc', label: 'Economic Model', id: 'learn/celo-economic-model', }, - { type: 'doc', label: 'Milestones', id: 'learn/celo-milestones', }, - { type: 'doc', label: 'Ecosystem', id: 'learn/celo-ecosystem', }, - ] - }, - { - type: 'category', - label: 'Celo Platform', - items: [ - { type: 'doc', label: 'Celo Stack', id: 'learn/celo-stack', }, - { type: 'doc', label: 'Network Topology', id: 'learn/topology-of-a-celo-network', }, - { type: 'doc', label: 'Celo Protocol', id: 'learn/celo-protocol', }, - { type: 'doc', label: 'Developer Tools', id: 'learn/developer-tools', }, - { type: 'doc', label: 'EVM Tools', id: 'learn/evm-compatible-tooling', }, - ] - }, - { - type: 'category', - label: 'Onboarding', - items: [ - { type: 'doc', label: 'Celo Onboarding', id: 'learn/celo-onboarding', }, - { type: 'doc', label: 'Developer Onboarding', id: 'learn/developer-onboarding', }, - ] - }, + { type: 'doc', label: 'Celo Onboarding', id: 'learn/celo-onboarding', }, + { type: 'doc', label: 'Developer Onboarding', id: 'learn/developer-onboarding', }, { type: 'category', label: 'Quick Guides', diff --git a/src/components/HomepageFeatures.js b/src/components/HomepageFeatures.js index d23c987e38..3a34689aae 100644 --- a/src/components/HomepageFeatures.js +++ b/src/components/HomepageFeatures.js @@ -11,7 +11,7 @@ const FeatureList = [ ), link: ( // Learn Celo - Learn Celo + Learn Celo ), }, {