docs: add v5.1 developer migration guide (#1870)

regen-network · Mar 29, 2023 · 4672ec6 · 4672ec6
1 parent 891bda4
commit 4672ec6
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 6 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -116,6 +116,7 @@ module.exports = {
             '/ledger/migrations/',
             '/ledger/migrations/v4.0-migration',
             '/ledger/migrations/v5.0-migration',
+            '/ledger/migrations/v5.1-migration',
           ],
         },
       ],

diff --git a/docs/ledger/migrations/README.md b/docs/ledger/migrations/README.md
@@ -4,6 +4,7 @@ The migration guides within this section are written for developers writing appl
 
 - [Migration Guide v4.0](v4.0-migration.md)
 - [Migration Guide v5.0](v5.0-migration.md)
+- [Migration Guide v5.1](v5.1-migration.md)
 
 This first page provides an overview of our release process. In addition, we provide some tips on how application developers can stay up to date and prepare ahead of time.
 

diff --git a/docs/ledger/migrations/v5.1-migration.md b/docs/ledger/migrations/v5.1-migration.md
@@ -0,0 +1,36 @@
+# Migration Guide v5.1
+
+## API Changes
+
+### regen.ecocredit.v1
+
+Regen Ledger v5.1 includes non-breaking changes to [regen.ecocredit.v1](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.v1).
+
+#### Events
+
+The following events have been updated:
+
+- [EventBridge](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.v1#regen.ecocredit.v1.EventBridge)
+
+  - added `batch_denom`
+
+- [EventBridgeReceive](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.v1#regen.ecocredit.v1.EventBridgeReceive)
+
+  - added `amount`
+  - added `origin_tx`
+
+### regen.ecocredit.basket.v1
+
+Regen Ledger v5.1 includes non-breaking changes to [regen.basket.v1](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1).
+
+#### Msg Service
+
+The following messages have been added:
+
+- [v1.MsgUpdateDateCriteria](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.marketplace.v1#regen.ecocredit.marketplace.v1.MsgUpdateDateCriteria)
+
+#### Events
+
+The following events have been added:
+
+- [v1.EventUpdateDateCriteria](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1#regen.ecocredit.basket.v1.EventUpdateDateCriteria)
diff --git a/x/ecocredit/spec/01_concepts.md b/x/ecocredit/spec/01_concepts.md
@@ -1,6 +1,6 @@
 # Concepts
 
-## Ecocredit Core
+## Ecocredit Module
 
 ### Credit Class
 

diff --git a/x/ecocredit/spec/02_state.md b/x/ecocredit/spec/02_state.md
@@ -2,7 +2,7 @@
 
 The `ecocredit` module uses the `orm` package as an abstraction layer over the `KVStore` that enables the creation of database tables with primary and secondary keys. The tables used within the ecocredit module are defined in the proto files available on [Buf Schema Registry](https://buf.build/regen/regen-ledger).
 
-## Ecocredit Core
+## Ecocredit Module
 
 <!-- listed alphabetically -->
 

diff --git a/x/ecocredit/spec/03_messages.md b/x/ecocredit/spec/03_messages.md
@@ -4,7 +4,7 @@ The ecocredit module provides a message service for interacting with the state o
 
 For examples on how to interact with state using the `regen` binary, see [regen tx ecocredit](../../commands/regen_tx_ecocredit.md).
 
-## Ecocredit Core
+## Ecocredit Module
 
 <!-- listed alphabetically -->
 
@@ -41,6 +41,7 @@ For examples on how to interact with state using the `regen` binary, see [regen
 - [Take](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1#regen.ecocredit.basket.v1.Msg.Take)
 - [UpdateBasketFee](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1#regen.ecocredit.basket.v1.Msg.UpdateBasketFee)
 - [UpdateCurator](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1#regen.ecocredit.basket.v1.Msg.UpdateCurator)
+- [MsgUpdateDateCriteria](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1#regen.ecocredit.basket.v1.Msg.MsgUpdateDateCriteria)
 
 ## Marketplace Submodule
 

diff --git a/x/ecocredit/spec/04_queries.md b/x/ecocredit/spec/04_queries.md
@@ -4,7 +4,7 @@ The ecocredit module provides a query service for querying the state of the ecoc
 
 For examples on how to query state using gRPC and REST, see the [ecocredit client](07_client.md) documentation, and for examples using the `regen` binary, see [regen query ecocredit](../../commands/regen_query_ecocredit.html).
 
-## Ecocredit Core
+## Ecocredit Module
 
 <!-- listed alphabetically -->
 

diff --git a/x/ecocredit/spec/05_events.md b/x/ecocredit/spec/05_events.md
@@ -2,7 +2,7 @@
 
 The ecocredit module emits events upon the successful execution of messages. The events for the ecocredit module are defined in the proto files available on [Buf Schema Registry](https://buf.build/regen/regen-ledger).
 
-## Ecocredit Core
+## Ecocredit Module
 
 <!-- listed alphabetically -->
 
@@ -33,6 +33,7 @@ The ecocredit module emits events upon the successful execution of messages. The
 - [EventPut](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1#regen.ecocredit.basket.v1.EventPut)
 - [EventTake](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1#regen.ecocredit.basket.v1.EventTake)
 - [UpdateCurator](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1#regen.ecocredit.basket.v1.UpdateCurator)
+- [EventUpdateDateCriteria](https://buf.build/regen/regen-ledger/docs/main:regen.ecocredit.basket.v1#regen.ecocredit.basket.v1.EventUpdateDateCriteria)
 
 ## Marketplace Submodule
 

diff --git a/x/ecocredit/spec/06_types.md b/x/ecocredit/spec/06_types.md
@@ -2,7 +2,7 @@
 
 The `ecocredit` module provides additional types used in multiple services or for governance.
 
-## Ecocredit Core
+## Ecocredit Module
 
 <!-- listed alphabetically -->