Add note on CmdSetPortfolioOf

cardano-foundation · May 4, 2021 · 6a80ad3 · 6a80ad3
1 parent aada35f
commit 6a80ad3
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/core/test/unit/Cardano/Wallet/Primitive/AddressDiscovery/DelegationSpec.hs b/lib/core/test/unit/Cardano/Wallet/Primitive/AddressDiscovery/DelegationSpec.hs
@@ -253,6 +253,14 @@ instance Arbitrary (StakeKey' depth key) where
 
 data Cmd
     = CmdSetPortfolioOf Int
+    -- ^ Calls @setPortfolioOf@ which registers or de-registers keys to reach
+    -- the new target.
+    --
+    -- If the target is already met, the command has no effect.
+    --
+    -- Delegation certificates are /not/ generated for existing keys.
+    --
+    -- TODO: Also test arbitrary re-delegations.
     | CmdOldWalletToggleFirstKey
       -- ^ A wallet implementation without multi-stake-key support could decide
       -- to either