Merge #2268

2268: Remove outdated comments about empty output lists in transactions. r=jonathanknowles a=jonathanknowles # Issue Number Cleanup after #2247, #2255, and other related PRs. # Overview This PR: * removes a couple of outdated comments about disallowing empty lists of outputs in transactions. It's been established that having an empty list of outputs is perfectly reasonable in certain circumstances (such as a transaction that includes just a delegation certificate). * updates the `Arbitrary ApiTransaction` instance to generate possibly-empty lists of outputs. Co-authored-by: Jonathan Knowles <[email protected]>
cardano-foundation · Oct 26, 2020 · 368b9fc · 368b9fc
2 parents a529471 + bb6c319
commit 368b9fc
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 18 deletions.
diff --git a/lib/core/src/Cardano/Wallet/Api/Types.hs b/lib/core/src/Cardano/Wallet/Api/Types.hs
@@ -649,9 +649,6 @@ data ApiTransaction (n :: NetworkDiscriminant) = ApiTransaction
     , depth :: !(Maybe (Quantity "block" Natural))
     , direction :: !(ApiT Direction)
     , inputs :: ![ApiTxInput n]
-      -- TODO: Investigate whether the list of outputs should be non-empty, and
-      -- if so, whether the 'outputs' field can be encoded as a non-empty list.
-      -- See: https://jira.iohk.io/browse/ADP-400
     , outputs :: ![AddressAmount (ApiT Address, Proxy n)]
     , withdrawals :: ![ApiWithdrawal n]
     , status :: !(ApiT TxStatus)

diff --git a/lib/core/test/unit/Cardano/Wallet/Api/TypesSpec.hs b/lib/core/test/unit/Cardano/Wallet/Api/TypesSpec.hs
@@ -197,8 +197,6 @@ import Data.FileEmbed
     ( embedFile, makeRelativeToProject )
 import Data.Function
     ( (&) )
-import Data.Generics.Internal.VL.Lens
-    ( view )
 import Data.List
     ( foldl' )
 import Data.List.NonEmpty
@@ -1474,10 +1472,7 @@ instance Arbitrary ApiTxMetadata where
     shrink = genericShrink
 
 instance Arbitrary (ApiTransaction t) where
-    shrink = filter outputsNonEmpty . genericShrink
-      where
-        outputsNonEmpty :: ApiTransaction t -> Bool
-        outputsNonEmpty = (not . null) . view #outputs
+    shrink = genericShrink
     arbitrary = do
         txStatus <- arbitrary
         txInsertedAt <- case txStatus of
@@ -1509,15 +1504,8 @@ instance Arbitrary (ApiTransaction t) where
       where
         genInputs =
             Test.QuickCheck.scale (`mod` 3) arbitrary
-        -- Note that the generated list of outputs must be non-empty in order
-        -- to be consistent with the specification.
-        --
-        -- Ideally, we should encode this restriction in the type system.
-        --
-        -- See https://jira.iohk.io/browse/ADP-400.
-        genOutputs = (:)
-            <$> arbitrary
-            <*> Test.QuickCheck.scale (`mod` 3) arbitrary
+        genOutputs =
+            Test.QuickCheck.scale (`mod` 3) arbitrary
         genWithdrawals =
             Test.QuickCheck.scale (`mod` 3) arbitrary