docs: updated docs for deactivation of liquidFarms

cosmosquad-labs · Aug 8, 2022 · 2a0545d · 2a0545d
1 parent e013f4f
commit 2a0545d
Show file tree

Hide file tree

Showing 36 changed files with 39 additions and 3 deletions.
diff --git a/proto/squad/boost/v1beta1/boost.proto b/proto/squad/boost/v1beta1/boost.proto
diff --git a/proto/squad/boost/v1beta1/genesis.proto b/proto/squad/boost/v1beta1/genesis.proto
diff --git a/proto/squad/boost/v1beta1/param.proto b/proto/squad/boost/v1beta1/param.proto
diff --git a/proto/squad/boost/v1beta1/query.proto b/proto/squad/boost/v1beta1/query.proto
diff --git a/proto/squad/boost/v1beta1/tx.proto b/proto/squad/boost/v1beta1/tx.proto
diff --git a/x/boost/abci.go b/x/boost/abci.go
diff --git a/x/boost/client/cli/query.go b/x/boost/client/cli/query.go
diff --git a/x/boost/client/cli/tx.go b/x/boost/client/cli/tx.go
diff --git a/x/boost/handler.go b/x/boost/handler.go
diff --git a/x/boost/keeper/genesis.go b/x/boost/keeper/genesis.go
diff --git a/x/boost/keeper/grpc_query.go b/x/boost/keeper/grpc_query.go
diff --git a/x/boost/keeper/keeper.go b/x/boost/keeper/keeper.go
diff --git a/x/boost/keeper/msg_server.go b/x/boost/keeper/msg_server.go
diff --git a/x/boost/module.go b/x/boost/module.go
diff --git a/x/boost/spec/01_concepts.md b/x/boost/spec/01_concepts.md
diff --git a/x/boost/spec/02_state.md b/x/boost/spec/02_state.md
diff --git a/x/boost/spec/03_state_transitions.md b/x/boost/spec/03_state_transitions.md
diff --git a/x/boost/spec/04_messages.md b/x/boost/spec/04_messages.md
diff --git a/x/boost/spec/05_begin_block.md b/x/boost/spec/05_begin_block.md
diff --git a/x/boost/spec/06_end_block.md b/x/boost/spec/06_end_block.md
diff --git a/x/boost/spec/07_hooks.md b/x/boost/spec/07_hooks.md
diff --git a/x/boost/spec/08_events.md b/x/boost/spec/08_events.md
diff --git a/x/boost/spec/09_params.md b/x/boost/spec/09_params.md
diff --git a/x/boost/types/codec.go b/x/boost/types/codec.go
diff --git a/x/boost/types/errors.go b/x/boost/types/errors.go
diff --git a/x/boost/types/events.go b/x/boost/types/events.go
diff --git a/x/boost/types/genesis.go b/x/boost/types/genesis.go
diff --git a/x/boost/types/keys.go b/x/boost/types/keys.go
diff --git a/x/boost/types/msgs.go b/x/boost/types/msgs.go
diff --git a/x/boost/types/params.go b/x/boost/types/params.go
diff --git a/x/liquidfarming/spec/01_concepts.md b/x/liquidfarming/spec/01_concepts.md
@@ -47,3 +47,17 @@ Therefore, a bidder to place a bid for the auction should be aware of this uncer
 
 A bidder can place a bid with the pool coin, which is the paying coin of the auction. A bidder only can place a single bid per auction of a liquid farm.
 The bid amount of the pool coin must be higher than the current winning bid amount that is the highest bid amount of the auction. The bidder placing the bid with the highest amount of the pool coin becomes the winner of the auction and will takes all the accumulated rewards amount at the end of the auction.
+
+## Activation of LiquidFarm
+
+A `liquidFarm` is activated by addition of `liquidFarm` in the parameter by governance.
+When a `liquidFarm` is activated, users can request to farm their pool coins and the `liquidfarming` module stakes the pool coins.
+
+## Deactivation of LiquidFarm
+
+A `liquidFarm` is deactivated by deletion of `liquidFarm` in the parameter by governance.
+When a `liquidFarm` is deactivated, the `liquidfarming` module unstakes all pool coins from the farming module with the reserve module account.
+The users cannot request to farm their pool coins, but users can still request to unfarm LF coins.
+If a user has the request as `QueuedFarming`, the user needs to cancel the request to get the pool coins back.
+In this case, the ongoing rewards auction becomes finished, all bids are refunded, and a new auction is not started.
+
diff --git a/x/liquidfarming/spec/02_state.md b/x/liquidfarming/spec/02_state.md
@@ -4,6 +4,12 @@
 
 The `liquidfarming` module keeps track of the states of pool coins and LFCoins.
 
+## LiquidFarms
+
+```go
+type LiquidFarms []LiquidFarm
+```
+
 ## QueuedFarming
 
 ```go

diff --git a/x/liquidfarming/spec/05_begin_block.md b/x/liquidfarming/spec/05_begin_block.md
@@ -0,0 +1,16 @@
+<!-- order: 5 -->
+
+# Begin-Block
+
+Begin block operations for the liquidfarming module synchronizes `liquidFarms` of the parameter and state. 
+
+## Addition of new liquidFarm
+
+When a new liquidFarm is added in the parameter `LiquidFarms`, the new liquidFarm is also added in the state `LiquidFarms`. 
+
+## Deletion of liquidFarm
+
+When a liquidFarm is deleted in the parameter `LiquidFarms`, the following opertions are done.
+- Unstake all pool coins from the farming module with the reserve module account
+- The ongoing auction status is set to `AUCTION_STATUS_FINISHED`.
+- The new liquidFarm is also deleted in the state `LiquidFarms`. 
diff --git a/x/liquidfarming/spec/05_events.md → x/liquidfarming/spec/06_events.md b/x/liquidfarming/spec/05_events.md → x/liquidfarming/spec/06_events.md
@@ -1,4 +1,4 @@
-<!-- order: 5 -->
+<!-- order: 6 -->
 
 # Events
 

diff --git a/x/liquidfarming/spec/06_params.md → x/liquidfarming/spec/07_params.md b/x/liquidfarming/spec/06_params.md → x/liquidfarming/spec/07_params.md
@@ -1,4 +1,4 @@
-<!-- order: 6 -->
+<!-- order: 7 -->
 
 # Parameters
 

diff --git a/x/liquidfarming/spec/07_hooks.md → x/liquidfarming/spec/08_hooks.md b/x/liquidfarming/spec/07_hooks.md → x/liquidfarming/spec/08_hooks.md
@@ -1,4 +1,4 @@
-<!-- order: 7 -->
+<!-- order: 8 -->
 
 # Hooks