SUMMARY.md

Table of contents

• Welcome
• Celo Overview

Getting Started

• Choosing a Network
• Mainnet
  • Running a Validator
  • Running a Full Node
• Baklava Testnet
  • Running a Validator
  • Running a Full Node
• Alfajores Testnet
  • Using the Mobile Wallet
  • Getting an Account and Funds
  • Running a Full Node
• Glossary

Celo Gold Holder Guide

• Quick Start
• Using a Ledger Wallet
• Understanding ReleaseGold
• Voting on Validator Groups
• Voting on Governance

Validator Guide

• Key Management
  • Detailed Role Descriptions
  • Validator Signer Key Rotation
• Securing Celo Nodes and Services
• Monitoring
• Upgrading a Node
• Validator Explorer
• Celo Foundation Voting Policy

Developer Guide

• Quick Start
  • Hello Celo
  • Hello Contracts
  • Hello Contract (Truffle + Remote Node)
  • Hello Mobile Dapp
  • Using Windows
• Overview
  • The Celo SDK
    • ContractKit
      • Setup
      • Using the kit
      • Using Web3 from the Kit
      • Celo Core Contracts. Wrappers / Registry
    • Forno
    • DAppKit
      • Setup
      • Usage
  • Celo DApp Gallery
  • Integrations
    • General
    • Custody
  • Reference
    • Globals
    • External Modules
      • address-registry
      • AddressRegistry
      • base
      • CeloContract
      • contract-cache
      • WrapperCache
      • explorer/base
      • ContractDetails
      • explorer/block-explorer
      • BlockExplorer
      • CallDetails
      • ParsedBlock
      • ParsedTx
      • explorer/log-explorer
      • LogExplorer
      • governance/proposals
      • ProposalBuilder
      • ProposalTransactionJSON
      • governance/proxy
      • identity/claims/account
      • identity/claims/attestation-service-url
      • identity/claims/claim
      • identity/claims/keybase
      • identity/claims/types
      • ClaimTypes
      • identity/claims/verify
      • identity/metadata
      • IdentityMetadataWrapper
      • kit
      • ContractKit
      • KitOptions
      • NetworkConfig
      • network-utils/genesis-block-utils
      • GenesisBlockUtils
      • network-utils/google-storage-utils
      • GoogleStorageUtils
      • network-utils/static-node-utils
      • StaticNodeUtils
      • providers/celo-provider
      • CeloProvider
      • test-utils/PromiEventStub
      • test-utils/ganache.setup
      • test-utils/ganache.teardown
      • utils/azure-key-vault-client
      • AzureKeyVaultClient
      • Signature
      • utils/ledger-utils
      • utils/provider-utils
      • utils/rpc-caller
      • DefaultRpcCaller
      • RpcCaller
      • utils/sign-typed-data-utils
      • EIP712Object
      • EIP712Parameter
      • EIP712TypedData
      • EIP712Types
      • utils/signing-utils
      • RLPEncodedTx
      • utils/tx-params-normalizer
      • TxParamsNormalizer
      • utils/tx-result
      • TransactionResult
      • utils/tx-uri
      • utils/web3-utils
      • wallets/azure-hsm-wallet
      • AzureHSMWallet
      • wallets/ledger-utils/data
      • wallets/ledger-utils/tokens
      • API
      • TokenInfo
      • wallets/ledger-wallet
      • AddressValidation
      • LedgerWallet
      • wallets/local-wallet
      • LocalWallet
      • wallets/remote-wallet
      • RemoteWallet
      • wallets/signers/azure-hsm-signer
      • AzureHSMSigner
      • wallets/signers/ledger-signer
      • LedgerSigner
      • wallets/signers/local-signer
      • LocalSigner
      • wallets/signers/signer
      • Signer
      • wallets/wallet
      • WalletBase
      • Wallet
      • web3-contract-cache
      • Web3ContractCache
      • wrappers/Accounts
      • AccountsWrapper
      • wrappers/Attestations
      • AttestationState
      • AttestationsWrapper
      • ActionableAttestation
      • AttestationStat
      • AttestationStateForIssuer
      • AttestationsConfig
      • AttestationsStatus
      • AttestationsToken
      • UnselectedRequest
      • wrappers/BaseWrapper
      • BaseWrapper
      • CeloTransactionObject
      • Filter
      • wrappers/BlockchainParameters
      • BlockchainParametersWrapper
      • wrappers/DoubleSigningSlasher
      • DoubleSigningSlasherWrapper
      • wrappers/DowntimeSlasher
      • DowntimeSlasherWrapper
      • DowntimeSlasherConfig
      • DowntimeWindow
      • wrappers/Election
      • ElectionWrapper
      • ElectableValidators
      • ElectionConfig
      • GroupVote
      • GroupVoterReward
      • ValidatorGroupVote
      • Voter
      • VoterReward
      • wrappers/Escrow
      • EscrowWrapper
      • wrappers/Exchange
      • ExchangeWrapper
      • ExchangeConfig
      • wrappers/Freezer
      • FreezerWrapper
      • wrappers/GasPriceMinimum
      • GasPriceMinimumWrapper
      • GasPriceMinimumConfig
      • wrappers/GoldTokenWrapper
      • GoldTokenWrapper
      • wrappers/Governance
      • ProposalStage
      • VoteValue
      • GovernanceWrapper
      • GovernanceConfig
      • HotfixRecord
      • ParticipationParameters
      • ProposalMetadata
      • ProposalRecord
      • ProposalStageDurations
      • UpvoteRecord
      • VoteRecord
      • Voter
      • Votes
      • wrappers/LockedGold
      • LockedGoldWrapper
      • AccountSlashed
      • LockedGoldConfig
      • PendingWithdrawal
      • VotingDetails
      • wrappers/MultiSig
      • MultiSigWrapper
      • TransactionData
      • wrappers/ReleaseGold
      • ReleaseGoldWrapper
      • BalanceState
      • ReleaseGoldInfo
      • wrappers/Reserve
      • ReserveWrapper
      • ReserveConfig
      • wrappers/SortedOracles
      • MedianRelation
      • SortedOraclesWrapper
      • MedianRate
      • OracleRate
      • OracleReport
      • OracleTimestamp
      • SortedOraclesConfig
      • wrappers/StableTokenWrapper
      • StableTokenWrapper
      • InflationParameters
      • StableTokenConfig
      • wrappers/Validators
      • ValidatorsWrapper
      • GroupMembership
      • LockedGoldRequirements
      • MembershipHistoryExtraData
      • Validator
      • ValidatorGroup
      • ValidatorReward
      • ValidatorsConfig
    • Classes
      • AddressRegistry
      • WrapperCache
      • BlockExplorer
      • LogExplorer
      • ProposalBuilder
      • IdentityMetadataWrapper
      • ContractKit
      • GenesisBlockUtils
      • GoogleStorageUtils
      • StaticNodeUtils
      • CeloProvider
      • AzureKeyVaultClient
      • Signature
      • DefaultRpcCaller
      • TxParamsNormalizer
      • TransactionResult
      • AzureHSMWallet
      • LedgerWallet
      • LocalWallet
      • RemoteWallet
      • AzureHSMSigner
      • LedgerSigner
      • LocalSigner
      • WalletBase
      • Web3ContractCache
      • AccountsWrapper
      • AttestationsWrapper
      • BaseWrapper
      • CeloTransactionObject
      • BlockchainParametersWrapper
      • DoubleSigningSlasherWrapper
      • DowntimeSlasherWrapper
      • ElectionWrapper
      • EscrowWrapper
      • ExchangeWrapper
      • FreezerWrapper
      • GasPriceMinimumWrapper
      • GoldTokenWrapper
      • GovernanceWrapper
      • LockedGoldWrapper
      • MultiSigWrapper
      • ReleaseGoldWrapper
      • ReserveWrapper
      • SortedOraclesWrapper
      • StableTokenWrapper
      • ValidatorsWrapper
    • Enums
      • CeloContract
      • ClaimTypes
      • AddressValidation
      • AttestationState
      • ProposalStage
      • VoteValue
      • MedianRelation
    • Interfaces
      • ContractDetails
      • CallDetails
      • ParsedBlock
      • ParsedTx
      • ProposalTransactionJSON
      • KitOptions
      • NetworkConfig
      • RpcCaller
      • EIP712Object
      • EIP712Parameter
      • EIP712TypedData
      • EIP712Types
      • RLPEncodedTx
      • API
      • TokenInfo
      • Signer
      • Wallet
      • ActionableAttestation
      • AttestationStat
      • AttestationStateForIssuer
      • AttestationsConfig
      • AttestationsStatus
      • AttestationsToken
      • UnselectedRequest
      • Filter
      • DowntimeSlasherConfig
      • DowntimeWindow
      • ElectableValidators
      • ElectionConfig
      • GroupVote
      • GroupVoterReward
      • ValidatorGroupVote
      • Voter
      • VoterReward
      • ExchangeConfig
      • GasPriceMinimumConfig
      • GovernanceConfig
      • HotfixRecord
      • ParticipationParameters
      • ProposalMetadata
      • ProposalRecord
      • ProposalStageDurations
      • UpvoteRecord
      • VoteRecord
      • Voter
      • Votes
      • AccountSlashed
      • LockedGoldConfig
      • PendingWithdrawal
      • VotingDetails
      • TransactionData
      • BalanceState
      • ReleaseGoldInfo
      • ReserveConfig
      • MedianRate
      • OracleRate
      • OracleReport
      • OracleTimestamp
      • SortedOraclesConfig
      • InflationParameters
      • StableTokenConfig
      • GroupMembership
      • LockedGoldRequirements
      • MembershipHistoryExtraData
      • Validator
      • ValidatorGroup
      • ValidatorReward
      • ValidatorsConfig

Celo Codebase

• Celo Protocol
  • Consensus
    • Validator Set Differences
    • Locating Nodes
    • Ultralight Sync
  • Proof-of-Stake
    • Validator Groups
    • Locked Gold and Voting
    • Validator Elections
    • Epoch Rewards
      • Rewards for Validators and Validator Groups
      • Rewards for Locked Gold Holders
      • Community Fund
      • Carbon Offsetting Fund
    • Penalties
  • Governance
  • Transactions
    • Native Currency
    • Paying for Gas in Tokens
    • Gas Pricing
    • Escrow
    • Encrypted Payment Comments
    • Full Node Incentives
  • Lightweight Identity
    • Metadata
    • Randomness
  • Stability Mechanism
    • Stability Algorithm (CP-DOTO)
    • Oracles
    • Stability Fees
    • Tobin Tax
  • Privacy
• Celo Wallet
  • Running the Wallet Locally
  • Wallet Functionality
    • Verification
    • Invitations
    • Payments and Exchanging
    • Ultralight Node Sync

Command Line Interface

• Introduction
• Account
• Config
• Election
• Exchange
• Governance
• Identity
• LockedGold
• Network
• Node
• Multisig
• Oracle
• ReleaseGold
• Reserve
• Rewards
• Transfer
• Validator
• ValidatorGroup
• Help

Community

• Code of Conduct
• Contributing
• Grant Playbook

Important Information

• Alfajores Testnet Disclaimer
• Baklava Testnet Disclaimer
• Mainnet Disclaimer