SUMMARY.md

Table of contents

• Welcome
• Celo Overview

Getting Started

• Choosing a Network
• Wallets
• 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
• Hosted nodes
• Validator Setup FAQ
• Glossary

CELO Owner Guide

• Quick Start
• cUSD Owner Guide
• Using a Ledger Wallet
• Understanding ReleaseGold
• Voting for Validator Groups
• Voting on Governance
• Governance Cheat Sheet
• Recovering CELO from an Ethereum Address
• Recovering ETH from a Celo Address

Validator Guide

• Overview
• Attestation Service
• Key Management
  • Detailed Role Descriptions
  • Validator Signer Key Rotation
• Securing Celo Nodes and Services
• Monitoring
• Devops Best Practices
• Upgrading a Node
• Running Proxies
• Validator Explorer
• Celo Foundation Voting Policy
• Celo Signal

Developer Guide

• Overview
• Code Examples
  • Sending CELO & cUSD
  • Deploy a Contract (local node)
  • Deploy and Interact with Contracts (Remotely)
  • DappKit Truffle Box
  • Using Windows
  • React based DApp
• ContractKit
  • Setup
  • Using the kit
  • Using Web3 from the Kit
  • Celo Core Contracts. Wrappers / Registry
  • Querying on-chain identifiers with ODIS
  • Migrating to ContractKit v1.0
• DAppKit
  • Setup
  • Usage
• Forno
• Local Development Chain w/ Protocol Contracts
• Celo for Ethereum Developers
• Celo DApp Gallery
• Integrations
  • General
  • Checklist
  • Custody
  • Listings
  • Using a Cloud HSM
• SDK Code Reference

  • Base

    • Globals
    • Modules
      • account
      • MnemonicLanguages
      • MnemonicStrength
      • Bip39
      • address
      • async
      • attestations
      • IdentifierType
      • AttestationsStatus
      • collections
      • AddressListItem
      • contacts
      • ContactPhoneNumber
      • MinimalContact
      • currencies
      • CURRENCY_ENUM
      • SHORT_CURRENCIES
      • displayFormatting
      • future
      • Future
      • inputValidation
      • ValidatorKind
      • BaseProps
      • io
      • lock
      • Lock
      • logger
      • parsing
      • phoneNumbers
      • ParsedPhoneNumber
      • result
      • JSONParseError
      • RootError
      • BaseError
      • ErrorResult
      • OkResult
      • signatureUtils
      • Signature
      • Signer
      • string
      • task
      • RepeatTaskContext
      • RetryTaskOptions
      • RunningTask
      • RunningTaskWithValue
      • TaskOptions
    • Classes
      • Future
      • Lock
      • JSONParseError
      • RootError
    • Enums
      • MnemonicLanguages
      • MnemonicStrength
      • IdentifierType
      • CURRENCY_ENUM
      • SHORT_CURRENCIES
      • ValidatorKind
    • Interfaces
      • Bip39
      • AttestationsStatus
      • AddressListItem
      • ContactPhoneNumber
      • MinimalContact
      • BaseProps
      • ParsedPhoneNumber
      • BaseError
      • ErrorResult
      • OkResult
      • Signature
      • Signer
      • RepeatTaskContext
      • RetryTaskOptions
      • RunningTask
      • RunningTaskWithValue
      • TaskOptions

  • Connect

    • Globals
    • Modules
      • abi-types
      • ABIDefinition
      • AbiCoder
      • DecodedParamsArray
      • DecodedParamsObject
      • celo-provider
      • CeloProvider
      • connection
      • Connection
      • ConnectionOptions
      • types
      • CeloParams
      • CeloTxObject
      • EncodedTransaction
      • JsonRpcPayload
      • JsonRpcResponse
      • Provider
      • RLPEncodedTx
      • utils/abi-utils
      • utils/celo-transaction-object
      • CeloTransactionObject
      • utils/formatter
      • utils/provider-utils
      • utils/rpc-caller
      • DefaultRpcCaller
      • RpcCaller
      • utils/tx-params-normalizer
      • TxParamsNormalizer
      • utils/tx-result
      • TransactionResult
      • wallet
      • ReadOnlyWallet
      • Signer
    • Classes
      • CeloProvider
      • Connection
      • CeloTransactionObject
      • DefaultRpcCaller
      • TxParamsNormalizer
      • TransactionResult
    • Interfaces
      • ABIDefinition
      • AbiCoder
      • DecodedParamsArray
      • DecodedParamsObject
      • ConnectionOptions
      • CeloParams
      • CeloTxObject
      • EncodedTransaction
      • JsonRpcPayload
      • JsonRpcResponse
      • Provider
      • RLPEncodedTx
      • RpcCaller
      • ReadOnlyWallet
      • Signer

  • ContractKit

    • Globals
    • Modules
      • address-registry
      • AddressRegistry
      • base
      • CeloContract
      • contract-cache
      • WrapperCache
      • 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
      • NetworkConfig
      • proxy
      • test-utils/PromiEventStub
      • test-utils/setup.global
      • test-utils/teardown.global
      • web3-contract-cache
      • Web3ContractCache
      • wrappers/Accounts
      • AccountsWrapper
      • wrappers/Attestations
      • AttestationServiceStatusState
      • AttestationState
      • AttestationsWrapper
      • ActionableAttestation
      • AttestationServiceStatusResponse
      • AttestationStat
      • AttestationStateForIssuer
      • AttestationsConfig
      • AttestationsToken
      • UnselectedRequest
      • wrappers/BaseSlasher
      • BaseSlasher
      • wrappers/BaseWrapper
      • BaseWrapper
      • wrappers/BlockchainParameters
      • BlockchainParametersWrapper
      • BlockchainParametersConfig
      • ClientVersion
      • wrappers/DoubleSigningSlasher
      • DoubleSigningSlasherWrapper
      • wrappers/DowntimeSlasher
      • DowntimeSlasherWrapper
      • DowntimeSlasherConfig
      • Interval
      • 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/MetaTransactionWallet
      • MetaTransactionWalletWrapper
      • RawTransaction
      • TransactionObjectWithValue
      • wrappers/MetaTransactionWalletDeployer
      • MetaTransactionWalletDeployerWrapper
      • 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
      • IdentityMetadataWrapper
      • ContractKit
      • Web3ContractCache
      • AccountsWrapper
      • AttestationsWrapper
      • BaseSlasher
      • BaseWrapper
      • BlockchainParametersWrapper
      • DoubleSigningSlasherWrapper
      • DowntimeSlasherWrapper
      • ElectionWrapper
      • EscrowWrapper
      • ExchangeWrapper
      • FreezerWrapper
      • GasPriceMinimumWrapper
      • GoldTokenWrapper
      • GovernanceWrapper
      • LockedGoldWrapper
      • MetaTransactionWalletWrapper
      • MetaTransactionWalletDeployerWrapper
      • MultiSigWrapper
      • ReleaseGoldWrapper
      • ReserveWrapper
      • SortedOraclesWrapper
      • StableTokenWrapper
      • ValidatorsWrapper
    • Enums
      • CeloContract
      • ClaimTypes
      • AttestationServiceStatusState
      • AttestationState
      • ProposalStage
      • VoteValue
      • MedianRelation
    • Interfaces
      • NetworkConfig
      • ActionableAttestation
      • AttestationServiceStatusResponse
      • AttestationStat
      • AttestationStateForIssuer
      • AttestationsConfig
      • AttestationsToken
      • UnselectedRequest
      • BlockchainParametersConfig
      • ClientVersion
      • DowntimeSlasherConfig
      • Interval
      • ElectableValidators
      • ElectionConfig
      • GroupVote
      • GroupVoterReward
      • ValidatorGroupVote
      • Voter
      • VoterReward
      • ExchangeConfig
      • GasPriceMinimumConfig
      • GovernanceConfig
      • HotfixRecord
      • ParticipationParameters
      • ProposalMetadata
      • ProposalRecord
      • ProposalStageDurations
      • UpvoteRecord
      • VoteRecord
      • Voter
      • Votes
      • AccountSlashed
      • LockedGoldConfig
      • PendingWithdrawal
      • VotingDetails
      • RawTransaction
      • TransactionObjectWithValue
      • TransactionData
      • BalanceState
      • ReleaseGoldInfo
      • ReserveConfig
      • MedianRate
      • OracleRate
      • OracleReport
      • OracleTimestamp
      • SortedOraclesConfig
      • InflationParameters
      • StableTokenConfig
      • GroupMembership
      • LockedGoldRequirements
      • MembershipHistoryExtraData
      • Validator
      • ValidatorGroup
      • ValidatorReward
      • ValidatorsConfig

  • Explorer

    • Globals
    • Modules
      • base
      • ContractDetails
      • block-explorer
      • BlockExplorer
      • CallDetails
      • ParsedBlock
      • ParsedTx
      • log-explorer
      • LogExplorer
    • Classes
      • BlockExplorer
      • LogExplorer
    • Interfaces
      • ContractDetails
      • CallDetails
      • ParsedBlock
      • ParsedTx

  • Governance

    • Globals
    • Modules
      • proposals
      • InteractiveProposalBuilder
      • ProposalBuilder
      • ProposalTransactionJSON
    • Classes
      • InteractiveProposalBuilder
      • ProposalBuilder
    • Interfaces
      • ProposalTransactionJSON

  • Identity

    • Globals
    • Modules
      • odis/bls-blinding-client
      • WasmBlsBlindingClient
      • BlsBlindingClient
      • odis/matchmaking
      • odis/phone-number-identifier
      • PhoneNumberHashDetails
      • odis/query
      • AuthenticationMethod
      • ErrorMessages
      • CustomSigner
      • EncryptionKeySigner
      • MatchmakingRequest
      • MatchmakingResponse
      • PhoneNumberPrivacyRequest
      • ServiceContext
      • SignMessageRequest
      • SignMessageResponse
      • WalletKeySigner
      • offchain-data-wrapper
      • OffchainErrorTypes
      • OffchainDataWrapper
      • offchain/accessors/authorized-signer
      • AuthorizedSignerAccessor
      • offchain/accessors/binary
      • PrivateBinaryAccessor
      • PublicBinaryAccessor
      • offchain/accessors/errors
      • SchemaErrorTypes
      • InvalidDataError
      • InvalidKey
      • OffchainError
      • UnavailableKey
      • UnknownCiphertext
      • offchain/accessors/interfaces
      • PrivateAccessor
      • PublicAccessor
      • offchain/accessors/name
      • PrivateNameAccessor
      • PublicNameAccessor
      • offchain/accessors/pictures
      • PrivatePictureAccessor
      • PublicPictureAccessor
      • offchain/accessors/simple
      • PrivateSimpleAccessor
      • PublicSimpleAccessor
      • offchain/storage-writers
      • GitStorageWriter
      • GoogleStorageWriter
      • LocalStorageWriter
      • MockStorageWriter
      • StorageWriter
      • offchain/utils
      • test-utils/setup.global
      • test-utils/teardown.global
    • Classes
      • WasmBlsBlindingClient
      • OffchainDataWrapper
      • AuthorizedSignerAccessor
      • PrivateBinaryAccessor
      • PublicBinaryAccessor
      • InvalidDataError
      • InvalidKey
      • OffchainError
      • UnavailableKey
      • UnknownCiphertext
      • PrivateNameAccessor
      • PublicNameAccessor
      • PrivatePictureAccessor
      • PublicPictureAccessor
      • PrivateSimpleAccessor
      • PublicSimpleAccessor
      • GitStorageWriter
      • GoogleStorageWriter
      • LocalStorageWriter
      • MockStorageWriter
      • StorageWriter
    • Enums
      • AuthenticationMethod
      • ErrorMessages
      • OffchainErrorTypes
      • SchemaErrorTypes
    • Interfaces
      • BlsBlindingClient
      • PhoneNumberHashDetails
      • CustomSigner
      • EncryptionKeySigner
      • MatchmakingRequest
      • MatchmakingResponse
      • PhoneNumberPrivacyRequest
      • ServiceContext
      • SignMessageRequest
      • SignMessageResponse
      • WalletKeySigner
      • PrivateAccessor
      • PublicAccessor

  • Network-Utils

    • Globals
    • Modules
      • genesis-block-utils
      • GenesisBlockUtils
      • google-storage-utils
      • GoogleStorageUtils
      • static-node-utils
      • StaticNodeUtils
      • utils/timezone
      • Coordinates
      • Timezone
    • Classes
      • GenesisBlockUtils
      • GoogleStorageUtils
      • StaticNodeUtils
    • Interfaces
      • Coordinates
      • Timezone

  • Transactions-Uri

    • Globals
    • Modules
      • test-utils/setup.global
      • test-utils/teardown.global
      • tx-uri

  • Utils

    • Globals
    • Modules
      • node_modules/bls12377js/src/bls
      • node_modules/bls12377js/src/defs
      • FieldSpec
      • GroupSpec
      • node_modules/bls12377js/src/f
      • F
      • node_modules/bls12377js/src/f2
      • F2
      • node_modules/bls12377js/src/g1
      • G1
      • node_modules/bls12377js/src/g2
      • G2
      • node_modules/bls12377js/src/group
      • Group
      • packages/sdk/utils/src/account
      • packages/sdk/utils/src/address
      • packages/sdk/utils/src/async
      • packages/sdk/utils/src/attestations
      • packages/sdk/utils/src/bls
      • packages/sdk/utils/src/bn
      • packages/sdk/utils/src/celoHistory
      • packages/sdk/utils/src/collections
      • packages/sdk/utils/src/commentEncryption
      • EncryptionStatus
      • packages/sdk/utils/src/contacts
      • packages/sdk/utils/src/countries
      • Countries
      • LocalizedCountry
      • packages/sdk/utils/src/currencies
      • packages/sdk/utils/src/dappkit
      • DappKitRequestTypes
      • DappKitResponseStatus
      • AccountAuthRequest
      • AccountAuthResponseFailure
      • AccountAuthResponseSuccess
      • DappKitRequestBase
      • DappKitRequestMeta
      • SignTxRequest
      • SignTxResponseFailure
      • SignTxResponseSuccess
      • TxToSignParam
      • packages/sdk/utils/src/dataEncryptionKey
      • packages/sdk/utils/src/displayFormatting
      • packages/sdk/utils/src/ecdh
      • packages/sdk/utils/src/ecies
      • packages/sdk/utils/src/fixidity
      • packages/sdk/utils/src/future
      • packages/sdk/utils/src/inputValidation
      • packages/sdk/utils/src/io
      • packages/sdk/utils/src/istanbul
      • IstanbulExtra
      • Seal
      • packages/sdk/utils/src/logger
      • packages/sdk/utils/src/parsing
      • packages/sdk/utils/src/phoneNumbers
      • packages/sdk/utils/src/sign-typed-data-utils
      • EIP712Object
      • EIP712Parameter
      • EIP712TypedData
      • EIP712Types
      • packages/sdk/utils/src/signatureUtils
      • packages/sdk/utils/src/solidity
      • packages/sdk/utils/src/string
      • packages/sdk/utils/src/task
      • packages/sdk/utils/src/typed-data-constructors
    • Classes
      • F
      • F2
      • G1
      • G2
      • Group
      • Countries
    • Enums
      • DappKitRequestTypes
      • DappKitResponseStatus
    • Interfaces
      • FieldSpec
      • GroupSpec
      • EncryptionStatus
      • LocalizedCountry
      • AccountAuthRequest
      • AccountAuthResponseFailure
      • AccountAuthResponseSuccess
      • DappKitRequestBase
      • DappKitRequestMeta
      • SignTxRequest
      • SignTxResponseFailure
      • SignTxResponseSuccess
      • TxToSignParam
      • IstanbulExtra
      • Seal
      • EIP712Object
      • EIP712Parameter
      • EIP712TypedData
      • EIP712Types

  • Wallet-Base

    • Globals
    • Modules
      • signing-utils
      • wallet-base
      • WalletBase
      • UnlockableWallet
      • Wallet
    • Classes
      • WalletBase
    • Interfaces
      • UnlockableWallet
      • Wallet

  • Wallet-Hsm

    • Globals
    • Modules
      • ber-utils
      • signature-utils
      • Signature
    • Classes
      • Signature

  • Wallet-Hsm-Aws

    • Globals
    • Modules
      • aws-hsm-signer
      • AwsHsmSigner
      • aws-hsm-wallet
      • AwsHsmWallet
    • Classes
      • AwsHsmSigner
      • AwsHsmWallet

  • Wallet-Hsm-Azure

    • Globals
    • Modules
      • azure-hsm-signer
      • AzureHSMSigner
      • azure-hsm-wallet
      • AzureHSMWallet
      • azure-key-vault-client
      • AzureKeyVaultClient
    • Classes
      • AzureHSMSigner
      • AzureHSMWallet
      • AzureKeyVaultClient

  • Wallet-Ledger

    • Globals
    • Modules
      • data
      • ledger-signer
      • LedgerSigner
      • ledger-utils
      • ledger-wallet
      • AddressValidation
      • LedgerWallet
      • tokens
      • API
      • TokenInfo
    • Classes
      • LedgerSigner
      • LedgerWallet
    • Enums
      • AddressValidation
    • Interfaces
      • API
      • TokenInfo

  • Wallet-Local

    • Globals
    • Modules
      • local-signer
      • LocalSigner
      • local-wallet
      • LocalWallet
    • Classes
      • LocalSigner
      • LocalWallet

  • Wallet-Remote

    • Globals
    • Modules
      • remote-wallet
      • RemoteWallet
    • Classes
      • RemoteWallet

  • Wallet-Rpc

    • Globals
    • Modules
      • rpc-signer
      • RpcSigner
      • rpc-wallet
      • RpcWalletErrors
      • RpcWallet
      • test-utils/ganache.setup
      • test-utils/ganache.teardown
    • Classes
      • RpcSigner
      • RpcWallet
    • Enums
      • RpcWalletErrors

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
  • Stability Mechanism
    • Stability Algorithm (Mento)
    • Oracles
    • Stability Fees
    • Tobin Tax
  • Transactions
    • Native Currency
    • Paying for Gas in Tokens
    • Gas Pricing
    • Escrow
    • Encrypted Payment Comments
    • Full Node Incentives
  • Identity
    • Phone Number Privacy
    • Metadata
    • Randomness
  • Optics
  • Plumo Ultralight Sync
• Celo Wallet
  • Running the Wallet Locally
  • Wallet Functionality
    • Verification
    • Invitations
    • Payments and Exchanging
    • Ultralight Node Sync

Command Line Interface

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

Community

• Code of Conduct
• Contributing
• Grant Playbook
• Release Process
  • Smart Contracts
  • Blockchain Client
  • Celocli and ContractKit
  • Attestation Service

Important Information

• Alfajores Testnet Disclaimer
• Baklava Testnet Disclaimer
• Mainnet Disclaimer