What's Changed

• Add celocli releasegold:admin-revoke command by @yorhodes in https://github.com/celo-org/celo-monorepo/pull/8749
• Add EpochRewards wrapper for use in celocli network:parameters by @yorhodes in https://github.com/celo-org/celo-monorepo/pull/8651
• Migrate to [email protected] by @dckesler in https://github.com/celo-org/celo-monorepo/pull/8789
• Added cREAL to cli by @martinvol in https://github.com/celo-org/celo-monorepo/pull/9056
• Dckesler/sdks cli 1.5.0 by @dckesler in https://github.com/celo-org/celo-monorepo/pull/9115

What's Changed

• Improve validator signer authorization examples by @kphed in https://github.com/celo-org/celo-monorepo/pull/7612
• Fix loss of precision releasegold:withdraw CLI command by @oneeman in https://github.com/celo-org/celo-monorepo/pull/7748
• AS base docker image by @codyborn in https://github.com/celo-org/celo-monorepo/pull/7749
• [cli] transfer:erc20 and balance commands by @gastonponti in https://github.com/celo-org/celo-monorepo/pull/7753
• Add token address support to oracle commands. by @pedro-clabs in https://github.com/celo-org/celo-monorepo/pull/8010
• Upgrade vulnerable dependencies by @eruizgar91 in https://github.com/celo-org/celo-monorepo/pull/8073
• Granda Mento support in CLI by @martinvol in https://github.com/celo-org/celo-monorepo/pull/8534
• CLI governance:propose support for dependencies on existing proposals by @tkporter in https://github.com/celo-org/celo-monorepo/pull/8550
• Add grandamento:execute, grandamento:get-buy-amount, small fixes, and some Granda Mento wrapper fns by @tkporter in https://github.com/celo-org/celo-monorepo/pull/8612
• Remove validator group confirmation for revoking votes by @dckesler in https://github.com/celo-org/celo-monorepo/pull/8637

https://www.npmjs.com/package/@celo/celocli/v/1.3.0

Release Notes:

This is the eighth release of the Celo Core Contracts. It follows the release process per the docs.

Audits:

• Hacken.io Core Contracts Release 8 audit: Report
• Verilog Solutions Core Contracts Release 8 audit: Report

Key updates in this release:

Release 8 adds a new identity registry contract, FederatedAttestations.sol, to the Celo Core Contracts. Similar to Attestations.sol, this new contract records mappings from bytes32 identifiers to addresses, and is used primarily to resolve off-chain identities like phone numbers to addresses so that users can more easily send each other payments. The Federated Attestations protocol introduces 'trusted' issuers that verify claims about a user's identity, such as their phone number (see this doc for more info). In the original Celo identity protocol, Attestations.sol mappings can only be updated by a fixed 'issuer', which is a randomly selected quorum of 3 Celo Validators that must each verify the user's phone number by sending separate SMS messages. This design minimizes trust requirements, but leads to subpar UX and performance. The FederatedAttestations.sol contract partitions the identifier to address mapping by issuer so that users of the contract can filter for mappings verified by issuers they trust, such as well-known telcos or mobile wallets. This allows applications that trust each other to benefit from an open and interoperable identity protocol while retaining control of their UX and performance. For example, a mobile wallet will now be able to verify phone numbers on Celo using any method of choice (i.e. secret code, magic link, SIM card) while also optimizing success rates in regions that are most critical for its specific market strategy.

In addition to FederatedAttestations.sol, release 8 includes updates to Escrow.sol to allow escrowed payments to be gatekeeped by the same 'trusted' issuer logic described above (see this design doc for more info)

Finally, release 8 adds a new OdisPayments.sol contract to which future payments for ODIS quota will be directed. ODIS is a distributed system consisting of 7 'signers' each possessing a partial share of a BLS private key (see the docs for more info). These signers accept requests to sign blinded messages according to a rate limit determined by the request type. In both the original identity protocol and the new Federated Attestations protocol phone numbers are signed by ODIS and hashed before they are recorded on-chain to preserve user privacy. The goal of ODIS's rate limit is to impose a cost on querying phone number identifiers so that reading phone numbers from the blockchain in large quantities is prohibitively expensive. While the original ODIS rate limit imposed this cost by calculating quota as a function of on-chain transaction history, the new rate limit will impose this cost by requiring direct payments to a smart contract. This change has been made in order to make ODIS's privacy guarantees more explicit, and is enabled by the fact that most ODIS requests will now be routed through issuer servers as part of the Federated Attestations protocol. (see this PR for more details)

Specific Version Updates:

Release Notes:

This is the seventh release of the Celo Core Contracts. It follows the release process per the docs.

Audits:

OpenZeppelin Core Contracts Release 7 Audit: Part 1, Part 2

Key updates in this release:

Release 7 gives validators the option to delegate a portion of their epoch
payments, provides some modifications to stable token related contracts to
simplifying deployments of new stable tokens, provides a safer way of interacting
with LockedGold pending withdrawals on-chain (paving the way for liquid staking
derivatives), and adds an extra sanity check in the Exchange.

• Allow validators to delegate part of their epoch payment (#8993)

This change allows validators to specify an address that will receive a fraction
of each of their epoch payments, allowing e.g. regular donations of part of
their payments.

• Fixed Exchange.sol reverting on deployment due to expecting sortedOracles report on null address (#8334)

• Remove oracle check (#9367)

These two changes will allow a future stable token deployment flow that is much
more convenient and faster than what is necessary with the current release
process. Currently, several separate governance proposals need to pass, each
executing after the others, leading to a new stable token requiring several
weeks from first proposal to on-chain activation. With careful changes to sanity
checks, this could be reduced to needing a single governance proposal.

• Get pending withdrawal (#9369)

Previously, the only way to access an account's pending withdrawals was by
calling the getPendingWithdrawals function, which would return the array of
all pending withdrawals for that account. This makes it difficult to implement
onchain LockedGold accounts governed by a smart contract -- if any party is able
to create new pending withdrawals, once the pending withdrawals array gets big
enough, getPendingWithdrawals would revert every time due to the gas cost of
reading the entire array into memory.

This PR introduces a new getPendingWithdrawal function that looks up a single
pending withdrawal given a particular index.

• Added a spread bound check in the setSpread function (#9252)

A simple sanity check that ensures the Exchange's spread, which is meant to be
a percentage, is less than or equal to 100%.

Specific Version Updates:

Version 2 of Releases for ConractKit SDKs Suite

• @celo/base
• @celo/connect
• @celo/contractkit
• @celo/cryptographic-utils
• @celo/dappkit
• @celo/encrypted-backup
• @celo/explorer
• @celo/governance
• @celo/identity
• @celo/keystores
• @celo/network-utils
• @celo/phone-utils
• @celo/transactions-uri
• @celo/utils
• @celo/wallet-base
• @celo/wallet-**

New Packages

@celo/cryptographic-utils

Crypto functions and utils that were move out of the @celo/utils package to reduce bundle size

@celo/encrypted-backup

an SDK for creating PIN/password encrypted user data backups as used by PEAR

Breaking Changes

See Upgrade Guide

@celo/utils

• All Phone number and Country related functions have been removed. Please import from @celo/phone-utils instead

• comment encryption, bls and mneumonic functions moved to @celo/cryptographic-utils

@celo/contractkit

• AccountsWrapper.authorizeValidatorSigner now requires a ValidatorWrapper as third param
• WrapperCache, AddressRegistry, Contract Wrappers, proxySend now require a Connection rather than a kit as an argument.

New Features

@celo/contractkit

MiniContractKit a minimal version of contract kit with acess to only a few contracts and wrappers

Release Notes:

This is the seventh release of the Celo Core Contracts. It follows the release process per the docs.

Audits:

OpenZeppelin Core Contracts Release 7 Audit (to be published soon)

Key updates in this release:

TODO

Specific Version Updates:

Core Contracts

TODO

Release Notes:

This is the sixth release of the Celo Core Contracts. It follows the release process per the docs.

Audits:

OpenZeppelin Core Contracts Release 6 Audit (to be published soon)

Key updates in this release:

Release 6 allows wallet and other application developers easier access to off-chain storage, fixes a small bug in the LockedGold contract, and cleans up an unnecessary function in Solidity libraries.

• Provide direct access to CIP8 storage URLs onchain, bypassing CIP3 (#8360)

CIP8 was originally defined on top of CIP3. This meant that two network hops were necessary to access the CIP8 storage URL (first request the CIP3 URL from the Celo blockchain, then look up the CIP3 data, including the CIP8 URL, over HTTP based on that URL). Modifying the CIP8 URL also meant modifying and reuploading the entire CIP3 file. PR 8360 adds direct access to multiple CIP8 URLs in the Accounts smart contract, making it easier to access and modify these endpoints.

• Require that slashing reporters are accounts, to ensure reporter can receive locked CELO (#8854)

Slashing rewards are denominated in locked CELO (managed by the LockedGold smart contract). Locked CELO can only be managed by accounts on the Accounts smart contract. Previously there was no check ensuring that a slashing reporter had an account, thus the locked CELO credited as a reporter reward could have ended up indefinitely unusable.

• Remove unneccesary getVersionNumber() function declaration in contract libraries (#8349).

Core Celo contracts implement a getVersionNumber() function, as per the Celo Smart Contracts release process. This function should only be implemented on concrete, non-library smart contracts deployed on-chain, but was previously also implemented on several library contracts. The unnecessary function was removed from these libraries, forcing PATCH version increases on several contracts:

• Accounts
• Election
• Governance
• LockedGold
• Attestations
• Escrow
• SortedOracles
• Validators

Specific Version Updates:

Core Contracts

Release Notes

This is a backwards-compatible release that includes the following features/fixes:

• feature: configure Twilio Verify or Messaging by country
  • we recommend using the configuration settings specified here
  • see this PR for more details
• bugfix: signature parsing error for EIP712TypedData
  • see this PR for more details
• bugfix: make ongoingDeliveryId index non-unique to fix rare bug with Verify API
  • see this PR for more details
  • note: though this will change the structure of database, this is not a breaking change. If downgrading from Attestation Service v1.5.0 to 1.4.0-, this can in rare cases cause a one-time dip in automatic resends for in-progress attestations.

Relevant Commits included

• 7d47b0b5fa3b80165091d1e0c1732503cc83b618
• de7d9a9c071cd20d86b164ae1da0b1d8f15d8b4e
• cf48bd7dd467fc86196ea302c50683207be04329

Release Notes

This is a backwards-compatible release that includes the following features/fixes:

• features: local signing (via keystores) and fallback node support
  • Setup instructions here
  • see this PR and this PR for more details
• bugfix: logs truncation error
  • see this PR for more details

Relevant Commits included

• e9cc99923c75bcff14310c6fa2269483dcd283fd
• ef0a683f708455b5fe2a120c929feb3ed4d32b95

Release Notes:

This is the fifth release of the Celo Core Contracts. It follows the release process per the docs.

Audits:

OpenZeppelin Core Contracts Release 5 Audit

Key updates in this release:

Release 5 addresses a community demand for large volume exchanges which aren't suited for Mento or OTC. It also fixes a small bug in the Validators contract which only has implications for newborn networks (discovered on our private testnets) and adds an additional registry utility for contract developer usage.

• Granda Mento smart contract implementation #8129

Granda Mento is a mechanism to facilitate large CELO <-> stable token (e.g. cXXX) exchanges that aren't suitable via Mento or OTC. GrandaMento is a new contract that can exchange CELO <-> stable token for any stable token Governance explicitly enables. Exchanges via this contract must be approved by a multisig and can be vetoed by the Governance contract. For more detailed information, please reference CIP-0038.

• Make updateMembershipHistory in Validators.sol correct if epoch number is 0 #8060

This change fixes a bug in the Validators contract that has not appeared in a production environment. It is motivated by cLabs usage of mycelo testnets that apply migration results as part of genesis generation. A validator's membership history is currently not updated when there is are no history entries (ie when epoch == 0).

• UsingRegistryV2 contract with static registry address #7837

This new contract is an alternative to UsingRegistry that contains no storage variables for more lightweight inheritance.

Specific Version Updates:

Core Contracts

Release Notes

• Twilio Verify API
  • Setup instructions here

Commits included

• 77a392216d4927e85ce4b683508fc0539aa92a34

Release Notes

Fixes a filtering bug in Nexmo queries.

Commits included

• 6ca848629957cac7bd882d0e361a29620b2e03a1

Commits included

This release was published on July 8th, 2021 and includes commits from 125f98da65f9b8161af524d183b7da70b96e2a07 to 9207df90be8c0ae3b377914156ce600eec08d32a inclusive.

Features

• new package: JS keystore support #8096
• Add euro in the currencies enum #7786
• CIP10 contracts changes #5913
• Use Node 12 #7851
• Add token address support to oracle commands #8010
• Add manual personal_decrypt flow to WalletConnect CLI client #8037
• Account utilities for normalization and heuristic based correction of mnemonic phrases [#8034] (https://github.com/celo-org/celo-monorepo/pull/8034)
• Add getBlockHeader utilities to connect package #8213
• Granda Mento smart contract implementation #8129

Bug Fixes

• Fix governance:build-proposal bigNumber bug #8028
• Remove ERC20 from core contracts #8212

Other Changes

• celocli: transfer:erc20 and balance commands #7753
• Tutorial: Integrating WalletConnect into your DApp #7802
• chore: remove @umpirsky/country-list package to save space #7895
• Add script for running + testing eth_signTypedData #7951
• Bump walletConnect version #8012
• Upgrade vulnerable dependencies #8073
• Add more params to status endpoint #8125
• Add check for phrase length in mnemonic phrase correction #8146
• JS Keystore Docs (with updated file structure) #8185

Release Notes

Support a US toll-free number registration in Nexmo. Add new information to /status endpoint that helps correlate SMS Provider success rates.

Commits included

• ab46eecf3b13793580cabac2bb80a425cb10f9e3
• f632e799a97cbcf803683a1da87dc63c912f5e9a

Release Notes:

This is the fourth release of the Celo Core Contracts. It follows the release process per the docs.

Audits:

Certora Core Contracts Release 4 Audit
OpenZeppelin Core Contracts Release 4 Audit

Key updates in this release:

Release 4 addresses feedback the community has provided on the identity abstraction implemented in the core contracts. It also makes way for various throughput optimizations and improvements in light of recent network throttling as a result of new user influx.

• Generalize the Account signer authorization abstraction as specified by CIP-0010 #5913

The Accounts contract houses a general account abstraction that currently serves several purposes including identity in the Proof-of-Stake system (validator, voter, and attestation signers) and storing profile information such as a Data Encryption Key for use with off-chain signed metadata. The authorization of signer keys is a useful method to authenticate the account owner for specific roles without requiring the most-privileged account key to come online. This change adds a generalized segmentation of domains for account authorizations, giving Celo stakeholders more flexibility in their custody setup.

• Support EIP-1167 for gas optimization in user onboarding flows #7661

During periods of heavy onboarding traffic, we have observed the block gas limit being the limiting factor in the number of users we can onboard per block. This is primarily because we subsidize the costs of user onboarding and phone number verification through smart contract wallets, and subsequently need to deploy a new contract per user. This change employs "minimal" proxies to greatly reduce the gas costs of performing this onboarding subsidization and contract deployment.

• Allow anyone to activate an account's pending Election votes on their behalf #7517

An account's pending votes must be activated after an epoch has passed. For end users, this is an unideal experience. This change allows a non-trusted account to activate pending votes on behalf of another account, eliminating the need for 2 transactions over the course of 2 epochs. The recipient validator group, for example, has a direct incentive to perform this activation.

• Allow Governance proposal votes to be revoked during Referendum stage #7611

During recent governance activities, some users voted and were surprised that they could not unlock their CELO. This is to prevent voting on proposals that result in depreciation of CELO. Previously there was no option to revoke votes for an account so that locked CELO can be released. This change adds a revokeVotes method which revokes all Referendum votes for an account and allows them to begin the unlock period.

• Update remaining token references from cGLD to CELO #7542

The Celo blockchain launched with the native token called "Celo Gold" (symbol "cGLD"), but to avoid confusion (since the token has nothing to do with physical gold), after a community proposal and vote (CGP 4), it was renamed to "Celo native asset" (ticker symbol CELO). This change updates the ERC-20 contract's name and symbol constants.

• Implement attestation-based identity proxies for arbitrary external calls #7363

To support phone numbers (or other future identifiers) as a factor in account recovery, a contract needs to act as a proxy for any address considered verified. This change adds an IdentityProxy that can be used by the owner of an identifier to make arbitrary calls, determining ownership by the on-chain heuristic as defined in the Attestations contract. It also adds an IdentityProxyHub for deploying instances with CREATE2, delaying deployment until the proxy is needed during account recovery and avoiding additional throughput congestion during heavy onboarding traffic.

• Add owner controlled guardian address and recovery to the MetaTransactionWallet #7364

The MetaTransactionWallet will have an owner settable guardian address. This address has the ability to change the wallet's signer. This feature is in support of account recovery features for user-facing wallets like Valora.

Specific Version Updates:

Core Contracts

User Contracts

Commits included

This release was published on April 22nd, 2021 and includes commits till 125f98da65f9b8161af524d183b7da70b96e2a07 inclusive

Features

• cEUR support - #7524
• Add more info to network:contracts - #7379
• Approvehotfix to support multisigs - #7671

Other Changes

• Add --globalHelp option to BaseCommand - #7669

Commits Included

This release was published on April 22nd, 2021 and includes commits till c78ae096d114d88107cc206afcc5150d0f5b6671 inclusive

Features

• cEUR ContractKit support - #7257
• CK works with StableTokens not yet deployed - #7524
• Decode Governance.setConstitution proposals - #7415
• Adds timeout functions to sdk/base package - #7617

Bug Fixes

• Dappkit fixes - #7385, #7658
• WalletConnect improvements - #7507, #7645
• Fix Governance.getProposalStage - #7326

Other Changes

• Update @celo/utils to allow AccountAuthResponseSuccess to include pepper - #7546
• Updated ledger blob to support cEUR - #7531
• Bump web3 from 1.3.4 to 1.3.5 - #7684

Commits included

This release was published on March 22nd, 2021 and includes commits from 64e618b9b856073305dd5748fc04fc772ff72714 to 7e7a7913e1dbd4ce72ddc6384a054138c8ec32e8 inclusive.

Features

• Implementation of a WalletConnect compatible wallet - #7122
• Add dappkit-web functionality - #7328
• Adds Reserve unfrozen balance methods - #7103
• Merge branch 'release/celo-core-contracts/3' - #7183
• Improve granularity of governance tooling information - #6475
• Upload/Download Profile Data with CIP8 - #6604
• CIP8 name access via the CLI - #6855
• Allow DEK to be a CIP8 signer - #7467

Bug Fixes

• Fixed references to goldToken in README - #7189
• Update proposals.ts - #7275
• Functions to invalidate the contracts cache - #7203
• fix rewards:show - #7325
• In getReserveGoldBalance, dont alias itself - #7334
• Fix check for unregistered contracts - #7319
• Fix no approval case for governance:approver information - #7478

Other Changes

• Makes the grace period variable governable - #6987
• added cleaning command to dappKit - #7205
• Support Portuguese mnemonics - #7220
• Remove wallet code from the monorepo - #7232
• Small fixes in the proposal process for cEUR/Release 3 - #7184
• Improve dappkit example in README - #7346
• Add instructions for Eth recovery with celowallet.app in documentation - #7350
• Fix packages vulnerabilities - #7476

Commits included

This release was published on February 17th, 2021 and includes commits from 23b12644eda957ef87530845ff062e9f02358dd4 to f79c14fd5dfb96249cd28d4fcc6287a088eaacd5 inclusive.

Features

• Add plugins to CLI - #5973
• New CLI command identity:get-attestations to query attestations - #5974

Bug Fixes

• releasegold:show should succeed w/o account registration - #7092
• Add check for signer or registered account in releasegold:show - #7098

Other Changes

• Clarify Docs for multisig:transfer - #6982

Commits included

This release was published on February 17th, 2021 and includes commits from 2f5b795a601375d41b67ca0afe47107f8448ff50 to ffcf304361ae18cd38d4bc45b635a9043bb55c7a inclusive.

Features

• Show owner in releasegold:show - #6608
• Metadata HTTPS Monitoring in identity:current-attestation-services - #6806
• Determine signing algorithm based on key type for Azure HSM - #6010

Bug Fixes

• Fix 8 digit codes for mainnet - #6663
• Fix Azure HSM Wallet PublicKey to Address conversion - #6829
• Shouldn't import from src folder in peer package - #7073
• Fix wallets-test #7094

Other Changes

• Small Docs Fixes related to CK1 release - #6576
• Simplify SortedOracles API by allowing consumers to report to arbitrary Addresses - #6898
• Updated DappKit README.md - #6957