Set up scaffolding for node API (#3788)

* Extract types and functions upstream for the Node's API

* Sort the dependencies list

* Reunite ApplicationName and SoftwareVersion Arbitrary orphans

* Clean up dependencies

* Remove dead code

* Rename `Serokell` import qualification to `Aeson`

* Use a hardcoded example for SyncPercentage as the unsafePerformIO broke golden tests when it moved beyond the module boundary.

* add wallet db to gitignore

Author: parsonsmatt

.gitignore

@@ -98,6 +98,8 @@ wallet-new/bench/results/*.txt
 # wallet web API golden tests
 wallet-new/test/golden/*.txt.new
 
+wallet/test/wallet-db-1.1.1/open.lock
+
 # cardano-state-* for wallet data
 cardano-state-*
 state-*

chain/cardano-sl-chain.cabal

@@ -154,11 +154,11 @@ library
                        Pos.Chain.Update.Vote
 
   build-depends:       base
-                     , Cabal
                      , aeson
                      , aeson-options
                      , array
                      , bytestring
+                     , Cabal
                      , canonical-json
                      , cardano-sl-binary
                      , cardano-sl-core
@@ -178,26 +178,28 @@ library
                      , filepath
                      , fmt >= 0.4
                      , formatting
+                     , formatting
                      , free
+                     , generic-arbitrary
                      , hashable
                      , lens
                      , lrucache
                      , memory
-                     , mtl
                      , mmorph
                      , mono-traversable
+                     , mtl
                      , neat-interpolation
                      , parsec
                      , plutus-prototype
+                     , QuickCheck
+                     , reflection
                      , safecopy
                      , safe-exceptions
                      , serokell-util
-                     , reflection
                      , template-haskell
                      , text
                      , time
                      , time-units
-                     , formatting
                      , transformers
                      , universum
                      , unordered-containers

chain/src/Pos/Chain/Update/ApplicationName.hs

@@ -10,8 +10,10 @@ import           Control.Monad.Except (MonadError (throwError))
 import           Data.Aeson (FromJSON (..))
 import           Data.Aeson.TH (defaultOptions, deriveToJSON)
 import           Data.Char (isAscii)
+import           Data.List ((!!))
 import           Data.SafeCopy (base, deriveSafeCopySimple)
 import qualified Data.Text as T
+import           Test.QuickCheck
 
 import           Pos.Binary.Class (Bi (..))
 
@@ -40,6 +42,15 @@ checkApplicationName (ApplicationName appName)
 applicationNameMaxLength :: Integral i => i
 applicationNameMaxLength = 12
 
+instance Arbitrary ApplicationName where
+    arbitrary =
+        ApplicationName .
+        toText . map selectAlpha . take applicationNameMaxLength <$>
+        arbitrary
+      where
+        selectAlpha n = alphabet !! (n `mod` length alphabet)
+        alphabet = "-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+
 deriveToJSON defaultOptions ''ApplicationName
 
 deriveSafeCopySimple 0 'base ''ApplicationName

chain/src/Pos/Chain/Update/SoftwareVersion.hs

@@ -15,6 +15,9 @@ import           Data.SafeCopy (base, deriveSafeCopySimple)
 import           Formatting (bprint, int, stext, (%))
 import qualified Formatting.Buildable as Buildable
 import qualified Prelude
+import           Test.QuickCheck
+import           Test.QuickCheck.Arbitrary.Generic (genericArbitrary,
+                     genericShrink)
 
 import           Pos.Util.Some (Some, liftLensSome)
 
@@ -41,6 +44,10 @@ instance Hashable SoftwareVersion
 
 instance NFData SoftwareVersion
 
+instance Arbitrary SoftwareVersion where
+    arbitrary = genericArbitrary
+    shrink = genericShrink
+
 deriveSafeCopySimple 0 'base ''SoftwareVersion
 
 -- | A software version is valid iff its application name is valid.

chain/test/Test/Pos/Chain/Update/Arbitrary.hs

@@ -9,19 +9,16 @@ module Test.Pos.Chain.Update.Arbitrary
 import           Universum
 
 import qualified Data.HashMap.Strict as HM
-import           Data.List ((!!))
 import           Test.QuickCheck (Arbitrary (..), Gen, elements, frequency,
                      listOf, listOf1)
 import           Test.QuickCheck.Arbitrary.Generic (genericArbitrary,
                      genericShrink)
 
-import           Pos.Chain.Update (ApplicationName (..), BlockVersion (..),
-                     BlockVersionData (..), BlockVersionModifier,
-                     SoftforkRule (..), SoftwareVersion (..), SystemTag (..),
+import           Pos.Chain.Update (BlockVersion (..), BlockVersionData (..),
+                     BlockVersionModifier, SoftforkRule (..), SystemTag (..),
                      UpdateData (..), UpdatePayload (..), UpdateProposal,
                      UpdateProposalToSign (..), UpdateVote (..),
-                     VoteState (..), applicationNameMaxLength,
-                     mkUpdateProposalWSign, mkUpdateVote)
+                     VoteState (..), mkUpdateProposalWSign, mkUpdateVote)
 import           Pos.Core.Attributes (mkAttributes)
 import           Pos.Crypto (ProtocolMagic, fakeSigner)
 
@@ -39,23 +36,10 @@ instance Arbitrary BlockVersionData where
     arbitrary = genericArbitrary
     shrink = genericShrink
 
-instance Arbitrary ApplicationName where
-    arbitrary =
-        ApplicationName .
-        toText . map selectAlpha . take applicationNameMaxLength <$>
-        arbitrary
-      where
-        selectAlpha n = alphabet !! (n `mod` length alphabet)
-        alphabet = "-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
-
 instance Arbitrary BlockVersion where
     arbitrary = genericArbitrary
     shrink = genericShrink
 
-instance Arbitrary SoftwareVersion where
-    arbitrary = genericArbitrary
-    shrink = genericShrink
-
 instance Arbitrary BlockVersionModifier where
     arbitrary = genericArbitrary
     shrink = genericShrink

core/cardano-sl-core.cabal

@@ -137,6 +137,7 @@ library
                      , fmt
                      , formatting
                      , hashable
+                     , http-api-data
                      , lens
                      , parsec
                      , memory

core/src/Pos/Core/Common/Coin.hs

@@ -34,6 +34,7 @@ import           Formatting (Format, bprint, build, int, (%))
 import qualified Formatting.Buildable
 import qualified Text.JSON.Canonical as Canonical (FromJSON (..),
                      ReportSchemaErrors, ToJSON (..))
+import           Web.HttpApiData (FromHttpApiData (..), ToHttpApiData (..))
 
 import           Pos.Binary.Class (Bi (..))
 import           Pos.Util.Json.Canonical ()
@@ -68,6 +69,15 @@ instance Aeson.FromJSON Coin where
 instance Aeson.ToJSON Coin where
     toJSON = Aeson.toJSON . unsafeGetCoin
 
+instance FromHttpApiData Coin where
+    parseUrlPiece p = do
+        c <- Coin <$> parseQueryParam p
+        checkCoin c
+        pure c
+
+instance ToHttpApiData Coin where
+    toQueryParam = pretty . coinToInteger
+
 -- | Maximal possible value of 'Coin'.
 maxCoinVal :: Word64
 maxCoinVal = 45000000000000000

lib/cardano-sl.cabal

@@ -64,6 +64,9 @@ library
                         Pos.Network.Block.Types
                         Pos.Network.Block.WorkMode
 
+                        -- Node management API
+                        Pos.Node.API
+
                         -- cardano-sl-client & cardano-sl-generator
                         Pos.Communication.Limits
                         Pos.Communication.Types
@@ -113,6 +116,11 @@ library
                         Test.Pos.Configuration
 
                         Pos.Util.Servant
+                        Pos.Util.Jsend
+                        Pos.Util.UnitsOfMeasure
+                        Pos.Util.Pagination
+                        Pos.Util.Example
+                        Pos.Util.KnownSymbols
 
 
   other-modules:
@@ -133,13 +141,12 @@ library
                         Pos.Communication.Server
 
   build-depends:        base
-                      , QuickCheck
-                      , async
                       , aeson >= 0.11.2.1
                       , aeson-options
-                      , async
                       , ansi-terminal
                       , ansi-wl-pprint
+                      , async
+                      , base64-bytestring
                       , bytestring
                       , canonical-json
                       , cardano-sl-binary
@@ -165,8 +172,11 @@ library
                       , filelock >= 0.1.0.1
                       , filepath
                       , formatting
+                      , formatting
                       , generic-arbitrary
+                      , generics-sop
                       , hspec
+                      , http-api-data
                       , http-client
                       , http-client-tls
                       , http-conduit
@@ -183,6 +193,8 @@ library
                       , optparse-applicative
                       , parsec
                       , pvss
+                      , QuickCheck
+                      , quickcheck-instances
                       , random
                       , reflection
                       , safe-exceptions
@@ -194,10 +206,10 @@ library
                       , servant-swagger
                       , stm
                       , streaming-commons
+                      , swagger2
                       , tagged
                       , template-haskell
                       , text
-                      , formatting
                       , time
                       , time-units
                       , tls