[Supplier] Supplier unbonding period governance param

docusaurus/docs/protocol/actors/supplier.md

@@ -12,6 +12,13 @@ sidebar_position: 4
   - [Supplier Module](#supplier-module)
   - [Proof Module](#proof-module)
 - [CLI](#cli)
+- [Supplier lifecycle](#supplier-lifecycle)
+  - [1. Staking Initiation:](#1-staking-initiation)
+  - [2. Activation:](#2-activation)
+  - [3. Unsaking Initiation:](#3-unsaking-initiation)
+  - [4. Unbonding Phase:](#4-unbonding-phase)
+  - [5. Completion of Unbonding:](#5-completion-of-unbonding)
+  - [Timeline of Events](#timeline-of-events)
 
 ## Overview
 
@@ -69,3 +76,65 @@ or
 ```bash
 poktrolld tx proof
 ```
+
+## Supplier lifecycle
+
+The lifecycle of a `Supplier` in the network involves several phases, each
+with specific actions and status changes. Here’s a detailed breakdown:
+
+### 1. Staking Initiation:
+
+  * The `Supplier` sends a `MsgStakeSupplier` message to the network, initiating
+    the staking process.
+  * The `Supplier` remains inactive until the beginning of the next session.
+
+### 2. Activation:
+
+  * The `Supplier` becomes active at the start of the new session and can now
+    provide services to the network.
+
+### 3. Unsaking Initiation:
+
+  * The `Supplier` sends a `MsgUnstakeSupplier` message to the network to start
+    the unstaking process.
+  * The `Supplier` continues to be active until the end of the current session.
+
+### 4. Unbonding Phase:
+
+  * In the following session, the `Supplier` enters the unbonding phase, becoming
+    inactive and no longer participating in sessions or providing services.
+  * During this phase, the staked funds are locked, and any pending claims are settled.
+
+### 5. Completion of Unbonding:
+
+  * After the unbonding period ends, the staked funds are transferred back to the
+    `Supplier`'s account, and the `Supplier`'s record is removed from the network.
+
+### Timeline of Events
+
+Here’s a visual representation of the `Supplier` lifecycle from staking to unbonding
+with the following example parameters:
+
+* **Unbonding Period**: 3 sessions
+* **Number of Blocks per Session**: 10 blocks
+* **Session End Height to Proof Window Close Height**: 15 blocks
+
+
+```mermaid
+timeline
+    section Session 1 <br> [1,10]
+      Block 3: DO Stake Supplier1 <br> Is inactive
+      Block 5: DO Stake Supplier2 <br> Is inactive
+    section Session 2 <br> [11,20]
+        Block 11: Supplier1 IS included in sessions : Supplier2 IS included in sessions
+    section Session 3 <br> [21,30]
+        Block 21 : Supplier1 unstakes <br> Still active
+        Block 28 : Supplier2 unstakes <br> Still active
+        Block 30: DO Deactivate Supplier1 : DO Deactivate Supplier2
+    section Session 4 <br>[31, 40]
+        Block 31: Supplier1 IS NOT included in sessions : Supplier2 IS NOT included in sessions
+    section Session 5 <br>[41, 50]
+        Block 45: ProofWindowClosed
+    section Session 6 <br>[51, 60]
+        Block 60: DO UNBOND Supplier1 : DO UNBOND Supplier2
+```

e2e/tests/init_test.go

@@ -369,7 +369,7 @@ func (s *suite) TheServiceRegisteredForApplicationHasAComputeUnitsPerRelayOf(ser
 	s.Fatalf("ERROR: service %s is not registered for application %s", serviceId, appName)
 }
 
-func (s *suite) TheForAccountIsNotStaked(actorType, accName string) {
+func (s *suite) TheUserVerifiesTheForAccountIsNotStaked(actorType, accName string) {
 	_, ok := s.getStakedAmount(actorType, accName)
 	require.Falsef(s, ok, "account %s of type %s SHOULD NOT be staked", accName, actorType)
 }

e2e/tests/parse_params_test.go

@@ -170,6 +170,8 @@ func (s *suite) newSharedMsgUpdateParams(params paramsMap) cosmostypes.Msg {
 			msgUpdateParams.Params.ProofWindowOpenOffsetBlocks = uint64(paramValue.value.(int64))
 		case sharedtypes.ParamProofWindowCloseOffsetBlocks:
 			msgUpdateParams.Params.ProofWindowCloseOffsetBlocks = uint64(paramValue.value.(int64))
+		case sharedtypes.ParamSupplierUnbondingPeriodSessions:
+			msgUpdateParams.Params.SupplierUnbondingPeriodSessions = uint64(paramValue.value.(int64))
 		default:
 			s.Fatalf("ERROR: unexpected %q type param name %q", paramValue.typeStr, paramName)
 		}