Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: v3.0.0 release notes #798

Merged
merged 4 commits into from
Feb 23, 2022
Merged

docs: v3.0.0 release notes #798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f0948e
docs: v3.0.0 release notes
ryanchristo Feb 23, 2022
4bfdb43
update changelog
ryanchristo Feb 23, 2022
54ed6f7
update order
ryanchristo Feb 23, 2022
2d65779
add credit type
ryanchristo Feb 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,56 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [v3.0.0](https://github.com/regen-network/regen-ledger/releases/tag/v3.0.0)

### General

#### Added

* [#783](https://github.com/regen-network/regen-ledger/pull/783) Add Dec to BigInt conversion to math package.

#### Fixed

* [#685](https://github.com/regen-network/regen-ledger/pull/685) Update swagger-gen to include ibc-go swagger docs.

### x/ecocredit

#### Added

* [#737](https://github.com/regen-network/regen-ledger/pull/737) Add basket proto definitions.
* [#735](https://github.com/regen-network/regen-ledger/pull/735) Add minimal baskets ORM and keeper setup.
* [#747](https://github.com/regen-network/regen-ledger/pull/747) Add sdk.Msg implementation for MsgPut.
* [#748](https://github.com/regen-network/regen-ledger/pull/748) Add sdk.Msg implementation for MsgTake.
* [#745](https://github.com/regen-network/regen-ledger/pull/745) Add sdk.Msg implementation for MsgCreate.
* [#751](https://github.com/regen-network/regen-ledger/pull/751) Add BasketBalance query server method.
* [#757](https://github.com/regen-network/regen-ledger/pull/757) Add start date window for date criteria.
* [#760](https://github.com/regen-network/regen-ledger/pull/760) Add BasketBalance query CLI commands.
* [#735](https://github.com/regen-network/regen-ledger/pull/735) Add Basket query server method.
* [#758](https://github.com/regen-network/regen-ledger/pull/758) Add Put message server method.
* [#746](https://github.com/regen-network/regen-ledger/pull/746) Add Take message server method.
* [#763](https://github.com/regen-network/regen-ledger/pull/763) Add BasketBalances query server method.
* [#766](https://github.com/regen-network/regen-ledger/pull/766) Add Basket query CLI command.
* [#749](https://github.com/regen-network/regen-ledger/pull/749) Add Take transaction CLI command.
* [#766](https://github.com/regen-network/regen-ledger/pull/766) Add Baskets query CLI command.
* [#754](https://github.com/regen-network/regen-ledger/pull/754) Add Create transaction CLI command.
* [#765](https://github.com/regen-network/regen-ledger/pull/765) Add codec and server registration.
* [#762](https://github.com/regen-network/regen-ledger/pull/762) Add Create message server method.
* [#764](https://github.com/regen-network/regen-ledger/pull/764) Add basket genesis initialization.
* [#772](https://github.com/regen-network/regen-ledger/pull/772) Add basket event proto definitions.
* [#772](https://github.com/regen-network/regen-ledger/pull/772) Add basket event proto definitions.
* [#771](https://github.com/regen-network/regen-ledger/pull/771) Add basket integration tests.
* [#776](https://github.com/regen-network/regen-ledger/pull/776) Add basket name and prefix updates.
* [#787](https://github.com/regen-network/regen-ledger/pull/787) Add basket supply invariant.
* [#769](https://github.com/regen-network/regen-ledger/pull/769) Add basket simulation tests.

#### Changed

* [#764](https://github.com/regen-network/regen-ledger/pull/764) Update genesis to support ORM and non-ORM genesis.
* [#789](https://github.com/regen-network/regen-ledger/pull/789) Update consensus version and service registration.

## [v2.1.0](https://github.com/regen-network/regen-ledger/releases/tag/v2.1.0) - 2021-11-23

Expand Down
20 changes: 15 additions & 5 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
## Regen Ledger v2.1.0
## Regen Ledger v3.0.0

### IBC Patch Upgrade
Regen Ledger `v3.0.0` adds basket functionality to the ecocredit module.

Regen Ledger `v2.1.0` includes an important fix for Regen Mainnet which recently upgraded to Regen Ledger `v2.0.0`. In the `v2.0.0` upgrade, a bug was introduced that made all new IBC transactions fail to be processed.
### Baskets

This release (`v2.1.0`) hard codes an emergency height-based upgrade which introduces a consensus-breaking change at height `3126912` that resolves the issue. All production validators and full-nodes must update to `v2.1.0` prior to the upgrade height (estimated for Friday Nov 26, 17:00 UTC).
Regen Ledger `v3.0.0` updates the ecocredit module to include basket functionality, enabling the aggregation of heterogeneous ecosystem service credits into baskets. Credits from different credit classes and batches that meet a defined criteria can be deposited within a basket in exchange for basket tokens. The basket tokens are fully fungible with other tokens from the same basket, and are tracked in the standard bank module, which means these assets will be made visible in wallets like Keplr, and also able to be transferred via IBC to other chains in the Cosmos ecosystem. Each basket token can later be redeemed for an underlying ecocredit from the given basket, and the ecocredits received may be retired by the account receiving them (for offsetting emissions).
technicallyty marked this conversation as resolved.
Show resolved Hide resolved

Regen Ledger `v3.0.0` includes a scoped-down, minimum-viable basket implementation with the intention to bring IBC compliant carbon credits to the interchain. For more information about the full specification for basket functionality, see the [basket specification](https://github.com/regen-network/regen-ledger/blob/master/rfcs/002-baskets-specification.md).

The MVP version of baskets proposed in Regen Ledger `v3.0.0` differs from the full specification in the RFC above in that:

- `BasketCritera` is restricted to only allow for:
ryanchristo marked this conversation as resolved.
Show resolved Hide resolved
- A credit type
- A list of credit classes
- A recency filter represented either as a fixed minimum batch start date, or a rolling recency window (e.g. batch start date must be within the last 6 months)
- Retrieving ecocredits from a basket can only be done via `Take`, not `Pick`. All calls of `Take` will always retrieve the oldest ecocredits first (by batch start date), ensuring the basket flushes out old credits over time.

## Changelog

For a full list of changes since regen-ledger v2.0.0, please see the [CHANGELOG.md](./CHANGELOG.md)
For a full list of changes since regen-ledger `v2.1.0`, please see the [CHANGELOG.md](./CHANGELOG.md)