-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: v3.0.0 release notes * update changelog * update order * add credit type
- Loading branch information
1 parent
8beebe8
commit 909a0ed
Showing
2 changed files
with
62 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). | ||
|
||
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: | ||
- 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) |