Skip to content

Commit

Permalink
Cleanup (celo-org#337)
Browse files Browse the repository at this point in the history
  • Loading branch information
Joe Nyzio authored Jun 22, 2022
1 parent fbaa977 commit 222f108
Show file tree
Hide file tree
Showing 49 changed files with 5,592 additions and 1,521 deletions.
36 changes: 18 additions & 18 deletions crowdin.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# project_id: '478619'
project_id: '9'
preserve_hierarchy: true
# api_token_env: "CROWDIN_PERSONAL_TOKEN"
api_token_env: "ENT_CROWDIN_PERSONAL_TOKEN"
base_url: "https://celo.crowdin.com"
files: [
# JSON translation files
{
source: '/i18n/en/**/*',
translation: '/i18n/%two_letters_code%/**/%original_file_name%',
},
# Docs Markdown files
{
source: '/docs/**/*',
translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%',
},
]
# # project_id: '478619'
# project_id: "9"
# preserve_hierarchy: true
# # api_token_env: "CROWDIN_PERSONAL_TOKEN"
# # api_token_env: "ENT_CROWDIN_PERSONAL_TOKEN"
# # base_url: "https://celo.crowdin.com"
# files: [
# # JSON translation files
# {
# source: "/i18n/en/**/*",
# translation: "/i18n/%two_letters_code%/**/%original_file_name%",
# },
# # Docs Markdown files
# {
# source: "/docs/**/*",
# translation: "/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%",
# },
# ]
8 changes: 2 additions & 6 deletions docs/FAQs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Answers to frequently asked questions about Celo.

---

## Introduction and Overview
## General

### What is Celo (CELO)?

Expand Down Expand Up @@ -53,15 +53,11 @@ Separate entities are aimed at Celo’s promotion and preservation. The dedicate

Celo’s main unique selling point lies in making financial tools and global digital payments accessible to all using crypto. It focuses on making crypto mobile and usable taking a user-centric approach to platform design and innovation.

---

## General Questions

### Do you have an Announcement Channel?

At the moment there is none on telegram, best to follow Celo on Twitter or any other social media channels for Celo. Every announcement is always posted there.

### Celo Token
## Celo Token

### What token does CELO have?

Expand Down
10 changes: 7 additions & 3 deletions docs/celo-codebase/protocol/identity/encrypted-cloud-backup.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
title: Pin/Password Encrypted Account Recovery (PEAR 🍐)
title: PEAR 🍐
---

Pin/Password Encrypted Account Recovery.

---

Secure and reliable account key backups are critical to the experience of non-custodial wallets, and Celo more generally.
Expand All @@ -15,9 +19,9 @@ If available, this data can be downloaded and used to initialize the application
Access to the user's cloud storage requires logging in to their Google or Apple account.
This provides a measure of security as only the owner of the cloud storage account can see the data, but is not enough to confidently store the wallet's account key.
In order to provide additional security, the account key backup should be encrypted with a secret, namely a PIN or password, that the user has memorized or stored securely.
This way, the users account key backup is only accessible to someone who can access their cloud storage account *and* knows their secret.
This way, the users account key backup is only accessible to someone who can access their cloud storage account _and_ knows their secret.

Because user-chosen secrets, especially PINs, are susceptible to guessing, this secret must be [hardened](https://wikipedia.org/wiki/Hardening_(computing)) before it can be used as an encryption key.
Because user-chosen secrets, especially PINs, are susceptible to guessing, this secret must be [hardened](<https://wikipedia.org/wiki/Hardening_(computing)>) before it can be used as an encryption key.
Using [ODIS](/celo-codebase/protocol/odis) for [key hardening](/celo-codebase/protocol/odis/use-cases/key-hardening), this scheme derives an encryption key for the account key backup that is resistant to guessing attacks.

With these core components, we can construct an account recovery system that allows users who remember their password or PIN, and maintain access to a cloud storage account, to quickly and reliably recover their account while providing solid security guarantees.
Expand Down
18 changes: 9 additions & 9 deletions docs/celo-codebase/protocol/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ title: Celo Protocol
description: Introduction to the Celo protocol, its implementation, and its relationship to Ethereum.
slug: /celo-codebase/protocol
---

import PageRef from '@components/PageRef'

# Celo Protocol

Introduction to the Celo protocol, its implementation, and its relationship to Ethereum.

___
---

## What is the Celo Protocol?

Expand All @@ -21,11 +22,10 @@ In addition to the blockchain client, some core components of the Celo protocol

There are a number of substantial changes and additions have been made in service of Celo's product goals, including the following:

<PageRef url="/celo-codebase/protocol/consensus" pageName="Consensus" />
<PageRef url="/celo-codebase/protocol/proof-of-stake" pageName="Proof-of-Stake" />
<PageRef url="/celo-codebase/protocol/governance" pageName="Governance" />
<PageRef url="/celo-codebase/protocol/stability" pageName="Stability Mechanism" />
<PageRef url="/celo-codebase/protocol/transactions" pageName="Transactions" />
<PageRef url="/celo-codebase/protocol/identity" pageName="Identity" />
<PageRef url="/celo-codebase/protocol/optics" pageName="Optics" />
<PageRef url="/celo-codebase/protocol/plumo" pageName="Plumo Ultralight Sync" />
- [Consensus](/celo-codebase/protocol/consensus)
- [Governance](/celo-codebase/protocol/proof-of-stake)
- [Stability Mechanism](/celo-codebase/protocol/stability)
- [Transactions](/celo-codebase/protocol/transactions)
- [Identity](/celo-codebase/protocol/identity)
- [Optics](/celo-codebase/protocol/optics)
- [Plumo Ultralight Sync](/celo-codebase/protocol/plumo)
7 changes: 4 additions & 3 deletions docs/celo-codebase/protocol/odis/domains/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
title: ODIS Domains
slug: /celo-codebase/protocol/odis/domains
---

import PageRef from '@components/PageRef'

::: caution
:::tip

Domain API features described here are not deployed to Mainnet ODIS as of April 1, 2022.

Expand All @@ -31,11 +32,11 @@ New domain types, with associated rate-limiting rules, may be added in the futur

A full specification of Domains and the related ODIS APIs is available in CIP-40.

<PageRef url="https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0040.md" pageName="CIP-40" />
- [CIP-40](https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0040.md)

## Implemented Domains

<PageRef url="/celo-codebase/protocol/odis/domains/sequential-delay-domain" pageName="Sequential Delay Domain" />
- [Sequential Delay Domain](/celo-codebase/protocol/odis/domains/sequential-delay-domain)

## Creating a Domain Type

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Sequential Delay Domain
---

import PageRef from '@components/PageRef'

The Sequential Delay Domains is an [ODIS Domain](/celo-codebase/protocol/odis/domains) supporting signature-authenticated rate limits defined as a series of time-delayed stages.
Expand All @@ -10,4 +11,4 @@ The motivating use case is allowing wallets to define how often users can attemp

A full specification of the Sequential Delay Domain is available in an extension to CIP-40.

<PageRef url="https://github.com/celo-org/celo-proposals/blob/master/CIPs/CIP-0040/sequentialDelayDomain.md" pageName="Sequential Delay Domain Specification" />
- [Sequential Delay Domain Specification](https://github.com/celo-org/celo-proposals/blob/master/CIPs/CIP-0040/sequentialDelayDomain.md)
9 changes: 5 additions & 4 deletions docs/celo-codebase/protocol/odis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Oblivious Decentralized Identifier Service (ODIS)
slug: /celo-codebase/protocol/odis
---

import PageRef from '@components/PageRef'

The Oblivious Decentralized Identifier Service (ODIS) allows for privacy preserving [phone number mappings](/celo-codebase/protocol/odis/use-cases/phone-number-privacy), [password hardening](/celo-codebase/protocol/odis/use-cases/key-hardening), and other use cases by implementing a rate limited oblivious pseudorandom function (OPRF).
Expand Down Expand Up @@ -34,7 +35,7 @@ Additionally, as long as $$k$$ operators remain honest and have access to their

For example, consider the phone number privacy protocol when there are 7 ODIS operators and the required threshold is 5. An attacker may compute the pepper for all phone numbers if 5 operators are compromised or corrupt. If 3 are corrupt or taken offline (e.g. by DDoS attack) then an attacker may prevent the rest of the operators from generating the pepper for users.

In the case that a single key is compromised, user data will remain private and the service operational; however, it's important that we can detect and perform a key rotation before the number of keys compromised exceeds $$k$$ or $$m - k + 1$$ (whichever is lower).
In the case that a single key is compromised, user data will remain private and the service operational; however, it's important that we can detect and perform a key rotation before the number of keys compromised exceeds $$k$$ or $$m - k + 1$$ (whichever is lower).

## Rotating keys

Expand Down Expand Up @@ -89,12 +90,12 @@ When ODIS nodes receive the request, it authenticates the user by recovering the
In the newer domain separated API, the rate limit can depend on a variety of factors configured to each domain type.
More information about the domains API and the implemented domain types can be found in the respective pages.

<PageRef url="/celo-codebase/protocol/odis/domains" pageName="Domains" />
<PageRef url="/celo-codebase/protocol/odis/domains/sequential-delay-domain" pageName="Sequential Delay Domain" />
- [Domains](/celo-codebase/protocol/odis/domains)
- [Sequential Delay Domain](/celo-codebase/protocol/odis/domains/sequential-delay-domain)

A full specification of the Domains API can be found in CIP-40.

<PageRef url="https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0040.md" pageName="CIP-40" />
- [CIP-40](https://github.com/celo-org/celo-proposals/blob/master/CIPs/cip-0040.md)

## Request flow diagram

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
---
title: Phone Number Privacy
---

import PageRef from '@components/PageRef'

Celo's [identity protocol](/celo-codebase/protocol/identity) allows users to associate their phone number with one or more addresses on the Celo blockchain.
This allows users to find each other on the Celo network using phone number instead of cumbersome hexadecimal addresses.
The Oblivious Decentralized Identifier Service (ODIS) was created to help preserve the privacy of phone numbers and addresses.

<PageRef url="/celo-codebase/protocol/odis" pageName="ODIS" />
- [ODIS](/celo-codebase/protocol/odis)

## Understanding the problem

Expand Down
12 changes: 6 additions & 6 deletions docs/celo-codebase/protocol/stability/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Overview of the Celo protocol's Stability Mechanisms.

The Celo protocol's stability mechanism comprises the following:

<PageRef url="/celo-codebase/protocol/stability/doto" pageName="Stability Algorithm (Mento)" />
<PageRef url="/celo-codebase/protocol/stability/oracles" pageName="Oracles" />
<PageRef url="/celo-codebase/protocol/stability/stability-fees" pageName="Stability Fees" />
<PageRef url="/celo-codebase/protocol/stability/granda-mento" pageName="Granda Mento" />
<PageRef url="/celo-codebase/protocol/stability/adding_stable_assets" pageName="Adding Stable Tokens" />
<PageRef url="/celo-codebase/protocol/stability/tobin-tax" pageName="Tobin Tax" />
- [Stability Algorithm (Mento)](/celo-codebase/protocol/stability/doto)
- [Oracles](/celo-codebase/protocol/stability/oracles)
- [Stability Fees](/celo-codebase/protocol/stability/stability-fees)
- [Granda Mento](/celo-codebase/protocol/stability/granda-mento)
- [Adding Stable Tokens](/celo-codebase/protocol/stability/adding_stable_assets)
- [Tobin Tax](/celo-codebase/protocol/stability/tobin-tax)
8 changes: 4 additions & 4 deletions docs/celo-codebase/wallet/how-the-wallet-works/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import PageRef from '@components/PageRef'

This section describes the technology powering key functionality of the Celo Wallet.

<PageRef url="/celo-codebase/wallet/how-the-wallet-works/verification" pageName="Verification" />
<PageRef url="/celo-codebase/wallet/how-the-wallet-works/invitations" pageName="Invitations" />
<PageRef url="/celo-codebase/wallet/how-the-wallet-works/sending-and-requesting-payments" pageName="Payments and Exchanging" />
<PageRef url="/celo-codebase/wallet/how-the-wallet-works/ultralight-node-sync" pageName="Ultralight Node Sync" />
- [Verification](/celo-codebase/wallet/how-the-wallet-works/verification)
- [Invitations](/celo-codebase/wallet/how-the-wallet-works/invitations)
- [Payments and Exchanging](/celo-codebase/wallet/how-the-wallet-works/sending-and-requesting-payments)
- [Ultralight Node Sync](/celo-codebase/wallet/how-the-wallet-works/ultralight-node-sync)
24 changes: 12 additions & 12 deletions docs/celo-holder-guide/owners.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,27 @@ Start sending, spending, and earning crypto from your mobile phone.

CELO is listed on 20+ exchanges worldwide.

<PageRef url="https://coinmarketcap.com/currencies/celo/markets/" pageName="Get CELO" />
<PageRef url="https://coinmarketcap.com/currencies/celo-dollar/markets/" pageName="Get cUSD" />
<PageRef url="https://coinmarketcap.com/currencies/celo-euro/" pageName="Get cEUR" />
- [Get CELO](https://coinmarketcap.com/currencies/celo/markets/)
- [Get cUSD](https://coinmarketcap.com/currencies/celo-dollar/markets/)
- [Get cEUR](https://coinmarketcap.com/currencies/celo-euro/)

## Manage Celo Assets

<PageRef url="/celo-owner-guide/quick-start" pageName="Self-Custody CELO" />
<PageRef url="/celo-owner-guide/cusd" pageName="Asset Management" />
<PageRef url="/celo-owner-guide/release-gold" pageName="Understand ReleaseGold" />
<PageRef url="/celo-owner-guide/celo-exchange-bot" pageName="Exchange Celo Assets" />
- [Self-Custody CELO](/celo-owner-guide/quick-start)
- [Asset Management](/celo-owner-guide/cusd)
- [Understand ReleaseGold](/celo-owner-guide/release-gold)
- [Exchange Celo Assets](/celo-owner-guide/celo-exchange-bot)

## Voting as a Celo Owner

<PageRef url="/celo-owner-guide/voting-validators" pageName="Voting for Validators" />
<PageRef url="/celo-owner-guide/voting-governance" pageName="Voting on Governance" />
<PageRef url="/celo-owner-guide/governance-cheat-sheet" pageName="Governance Cheatsheet" />
- [Voting for Validators](/celo-owner-guide/voting-validators)
- [Voting on Governance](/celo-owner-guide/voting-governance)
- [Governance Cheatsheet](/celo-owner-guide/governance-cheat-sheet)

## Asset Recovery

<PageRef url="/celo-owner-guide/eth-recovery" pageName="Recover ETH from a Celo Address" />
<PageRef url="/celo-owner-guide/celo-recovery" pageName="Recover CELO from an Ethereum Address" />
- [Recover ETH from a Celo Address](/celo-owner-guide/eth-recovery)
- [Recover CELO from an Ethereum Address](/celo-owner-guide/celo-recovery)

:::tip

Expand Down
12 changes: 6 additions & 6 deletions docs/community/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ Not ready to become a Celo Contributor? [Learn more about Celo](../../docs/welco

Find your purpose and join a community focused on building the conditions of prosperity—for everyone

<PageRef url="/community/developer-events" pageName="Developer Events" />
<PageRef url="/community/guidelines" pageName="Contributors" />
<PageRef url="/community/code-of-conduct" pageName="Code of Conduct" />
<PageRef url="/community/grant-playbook" pageName="Grant Playbook" />
<PageRef url="/community/release-process/README" pageName="Release Process" />
<PageRef url="/community/join-the-community" pageName="Join the Community" />
- [Developer Events](/community/developer-events)
- [Contributors](/community/guidelines)
- [Code of Conduct](/community/code-of-conduct)
- [Grant Playbook](/community/grant-playbook)
- [Release Process](/community/release-process/README)
- [Join the Community](/community/join-the-community)

:::tip

Expand Down
13 changes: 6 additions & 7 deletions docs/community/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@ description: Join a community of developers, designers, dreamers, and doers buil

Guidelines for submitting contributions to the Celo community.

___
---

import PageRef from '@components/PageRef'
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


Celo is open source and we welcome open participation. We strive to fulfill our [Community Tenets](https://celo.org/community) by being an open and inclusive community where everyone feels welcome and empowered to contribute. This also means following some ground rules and abiding by Celo’s [Code of Conduct](https://celo.org/code-of-conduct).

:::tip
Expand All @@ -26,10 +25,10 @@ Not ready to become a Celo Developer? [Learn more about Celo](../../docs/welcome

Our community includes a group of contributors that help develop, write, translate, and improve Celo. Anyone is welcome to join the community and contribute their skills to help empower other community members and grow the Celo ecosystem.

<PageRef url="/community/code-contributors" pageName="Code Contributors" />
<PageRef url="/community/documentation-contributors" pageName="Technical Writers" />
<PageRef url="/community/translation-contributors" pageName="Translators" />
<PageRef url="/community/CIP-contributors" pageName="Community Improvement Proposals" />
- [Code Contributors](/community/code-contributors)
- [Technical Writers](/community/documentation-contributors)
- [Translators](/community/translation-contributors)
- [Community Improvement Proposals](/community/CIP-contributors)

:::note

Expand All @@ -53,4 +52,4 @@ We encourage you to PR \(pull request\) your work regularly and often to solicit

## Code of Conduct

Participation in the Celo project is subject to the [Code of Conduct](https://celo.org/code-of-conduct).
Participation in the Celo project is subject to the [Code of Conduct](https://celo.org/code-of-conduct).
9 changes: 5 additions & 4 deletions docs/community/release-process/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Celo Release Process
description: Overview of the release process for updates to the Celo platform.
---

import PageRef from '@components/PageRef'

# Release Process
Expand All @@ -14,7 +15,7 @@ It is critical that updates to the Celo platform can be released on a regular ba

:::

<PageRef url="/community/release-process/smart-contracts" pageName="Smart Contracts" />
<PageRef url="/community/release-process/blockchain-client" pageName="Blockchain Client" />
<PageRef url="/community/release-process/base-cli-contractkit-dappkit-utils" pageName="CeloCLI and ContractKit" />
<PageRef url="/community/release-process/attestation-service" pageName="Attestation Service" />
- [Smart Contracts](/community/release-process/smart-contracts)
- [Blockchain Client](/community/release-process/blockchain-client)
- [CeloCLI and ContractKit](/community/release-process/base-cli-contractkit-dappkit-utils)
- [Attestation Service](/community/release-process/attestation-service)
4 changes: 3 additions & 1 deletion docs/contract-addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ id: contract-addresses
import YouTube from '@components/YouTube';
import PageRef from '@components/PageRef';

Core contract address proxies and implementations for the Celo network.

---

:::info
:::tip

View Celo smart contracts [here](https://github.com/celo-org/celo-monorepo/tree/master/packages/protocol/contracts) contract addresses by searching testnet or mainnet on [celoscan.xyz](https://celoscan.xyz/) or [explorer.celo.org](https://explorer.celo.org/).

Expand Down
8 changes: 4 additions & 4 deletions docs/developer-resources/deploy-dapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Just getting started learning about how to write smart contracts? [The Solidity

## Deploy on Celo

<PageRef url="/developer-resources/deploy-remix" pageName="Deploy with Remix" />
<PageRef url="/developer-resources/deploy-truffle" pageName="Deploy with Truffle" />
<PageRef url="/developer-resources/deploy-hardhat" pageName="Deploy with Hardhat" />
<PageRef url="/developer-resources/deploy-replit" pageName="Deploy with Replit" />
- [Using Remix](/developer-resources/deploy-remix)
- [Using Truffle](/developer-resources/deploy-truffle)
- [Using Hardhat](/developer-resources/deploy-hardhat)
- [Using Replit](/developer-resources/deploy-replit)
Loading

0 comments on commit 222f108

Please sign in to comment.