Merge pull request #3498 from input-output-hk/mafo/CHW-endpoints

move CHW endpoints to a new the new path: /unimplemented

Author: MarcFontaine

wallet-new/cardano-sl-wallet-new.cabal

@@ -66,6 +66,9 @@ library
                        Cardano.Wallet.API.V1.Transactions
                        Cardano.Wallet.API.V1.Types
                        Cardano.Wallet.API.V1.Wallets
+                       Cardano.Wallet.API.WIP
+                       Cardano.Wallet.API.WIP.Handlers
+                       Cardano.Wallet.API.WIP.LegacyHandlers
                        Cardano.Wallet.Kernel
                        Cardano.Wallet.Kernel.Accounts
                        Cardano.Wallet.Kernel.Actions

wallet-new/src/Cardano/Wallet/API.hs

@@ -10,6 +10,7 @@ module Cardano.Wallet.API
        , walletAPI
        , WalletDocAPI
        , walletDocAPI
+       , WIPAPI
        ) where
 
 import           Cardano.Wallet.API.Types (WalletLoggingConfig)
@@ -20,6 +21,7 @@ import           Servant.Swagger.UI (SwaggerSchemaUI)
 import qualified Cardano.Wallet.API.Internal as Internal
 import qualified Cardano.Wallet.API.V0 as V0
 import qualified Cardano.Wallet.API.V1 as V1
+import qualified Cardano.Wallet.API.WIP as WIP
 
 -- | The complete API, qualified by its versions. For backward compatibility's sake, we still expose
 -- the old API under @/api/@. Specification is split under separate modules.
@@ -54,8 +56,9 @@ type InternalAPI = "api" :> "internal" :> Internal.API
 internalAPI :: Proxy InternalAPI
 internalAPI = Proxy
 
+type WIPAPI = "api" :> "unimplemented" :> WIP.API
 
-type WalletAPI = LoggingApi WalletLoggingConfig (V0API' :<|> V0API :<|> V1API :<|> InternalAPI)
+type WalletAPI = LoggingApi WalletLoggingConfig (V0API' :<|> V0API :<|> V1API :<|> InternalAPI :<|> WIPAPI)
 walletAPI :: Proxy WalletAPI
 walletAPI = Proxy
 

wallet-new/src/Cardano/Wallet/API/V1/Handlers/Wallets.hs

@@ -23,9 +23,6 @@ handlers pwl =  newWallet pwl
            :<|> getWallet pwl
            :<|> updateWallet pwl
            :<|> getUtxoStatistics pwl
-           :<|> checkExternalWallet pwl
-           :<|> newExternalWallet pwl
-           :<|> deleteExternalWallet pwl
 
 -- | Creates a new or restores an existing @wallet@ given a 'NewWallet' payload.
 -- Returns to the client the representation of the created or restored
@@ -107,21 +104,3 @@ getUtxoStatistics pwl wid = do
          Left e  -> throwM e
          Right w ->
             return $ single $ V1.computeUtxoStatistics V1.log10 (map snd w)
-
-checkExternalWallet :: PassiveWalletLayer IO
-                    -> PublicKeyAsBase58
-                    -> Handler (WalletResponse WalletAndTxHistory)
-checkExternalWallet _encodedRootPK =
-    error "[CHW-54], Cardano Hardware Wallet feature, , check external wallet, unimplemented yet."
-
-newExternalWallet :: PassiveWalletLayer IO
-                  -> NewExternalWallet
-                  -> Handler (WalletResponse Wallet)
-newExternalWallet _newExtWallet =
-    error "[CHW-80], Cardano Hardware Wallet feature, new external wallet, unimplemented yet."
-
-deleteExternalWallet :: PassiveWalletLayer IO
-                     -> PublicKeyAsBase58
-                     -> Handler NoContent
-deleteExternalWallet _encodedRootPK =
-    error "[CHW-106], Cardano Hardware Wallet feature, , delete external wallet, unimplemented yet."

wallet-new/src/Cardano/Wallet/API/V1/LegacyHandlers/Wallets.hs

@@ -6,7 +6,6 @@ module Cardano.Wallet.API.V1.LegacyHandlers.Wallets (
     , newWallet
     ) where
 
-import           Formatting (build, sformat)
 import           Universum
 import           UnliftIO (MonadUnliftIO)
 
@@ -22,11 +21,9 @@ import           Cardano.Wallet.API.V1.Types as V1
 import qualified Cardano.Wallet.API.V1.Wallets as Wallets
 import qualified Cardano.Wallet.Kernel.DB.Util.IxSet as IxSet
 import           Pos.Chain.Update ()
-import           Pos.Client.KeyStorage (addPublicKey)
 import qualified Pos.Core as Core
 
-import           Pos.Util (HasLens (..), maybeThrow)
-import           Pos.Util.Servant (encodeCType)
+import           Pos.Util (HasLens (..))
 import qualified Pos.Wallet.WalletMode as V0
 import           Pos.Wallet.Web.Methods.Logic (MonadWalletLogic,
                      MonadWalletLogicRead)
@@ -44,9 +41,6 @@ handlers k = newWallet k
     :<|> getWallet
     :<|> updateWallet
     :<|> getUtxoStatistics
-    :<|> checkExternalWallet
-    :<|> newExternalWallet
-    :<|> deleteExternalWallet
 
 -- | Pure function which returns whether or not the underlying node is
 -- \"synced enough\" to allow wallet creation/restoration. The notion of
@@ -196,127 +190,3 @@ getUtxoStatistics
     -> m (WalletResponse UtxoStatistics)
 getUtxoStatistics _ = do
     return $ single (V1.computeUtxoStatistics V1.log10 [])
-
--- | Check if external wallet is presented in node's wallet db.
-checkExternalWallet
-    :: -- ( V0.MonadWalletLogic ctx m
-       -- , V0.MonadWalletHistory ctx m
-       -- , MonadUnliftIO m
-       -- , HasLens SyncQueue ctx SyncQueue
-       -- )
-       -- =>
-    PublicKeyAsBase58
-    -> m (WalletResponse WalletAndTxHistory)
-checkExternalWallet _encodedRootPK =
-    error "[CHW-54], Cardano Hardware Wallet, check external wallet, legacy handler, unimplemented yet."
-
--- | Creates a new or restores an existing external @wallet@ given a 'NewExternalWallet' payload.
--- Returns to the client the representation of the created or restored wallet in the 'Wallet' type.
-newExternalWallet
-    :: ( MonadThrow m
-       , MonadUnliftIO m
-       -- , HasLens SyncQueue ctx SyncQueue
-       , V0.MonadBlockchainInfo m
-       , V0.MonadWalletLogic ctx m
-       )
-    => NewExternalWallet
-    -> m (WalletResponse Wallet)
-newExternalWallet (NewExternalWallet rootPK assuranceLevel name operation) = do
-    let newExternalWalletHandler CreateWallet  = createNewExternalWallet
-        newExternalWalletHandler RestoreWallet = restoreExternalWallet
-    walletMeta <- V0.CWalletMeta <$> pure name
-                                 <*> migrate assuranceLevel
-                                 <*> pure 0
-    single <$> do
-        v0wallet <- newExternalWalletHandler operation walletMeta rootPK
-        ws <- V0.askWalletSnapshot
-        migrateWallet ws v0wallet True
-
--- | Creates new external wallet.
-createNewExternalWallet
-    :: ( MonadThrow m
-       , V0.MonadWalletLogic ctx m
-       )
-    => V0.CWalletMeta
-    -> PublicKeyAsBase58
-    -> m V0.CWallet
-createNewExternalWallet walletMeta encodedRootPK = do
-    rootPK <- case mkPublicKeyFromBase58 encodedRootPK of
-        Left problem -> throwM (InvalidPublicKey $ sformat build problem)
-        Right rootPK -> return rootPK
-
-    -- This extended public key will be used during synchronization
-    -- with the blockchain.
-    addPublicKey rootPK
-
-    let walletId = encodeCType . Core.makePubKeyAddressBoot $ rootPK
-        isReady  = True -- We don't need to sync new wallet with the blockchain.
-
-    -- Create new external wallet.
-    -- This is safe: if the client will try to create an external wallet from the same
-    -- root public key - error will be thrown.
-    void $ V0.createWalletSafe walletId walletMeta isReady
-
-    addInitAccountInExternalWallet walletId
-
-    V0.getWallet walletId
-
--- | Restore external wallet using it's root public key and metadata.
-restoreExternalWallet
-    :: -- ( MonadThrow m
-       -- , MonadUnliftIO m
-       -- , HasLens SyncQueue ctx SyncQueue
-       -- , V0.MonadWalletLogic ctx m
-       -- )
-       -- =>
-    V0.CWalletMeta
-    -> PublicKeyAsBase58
-    -> m V0.CWallet
-restoreExternalWallet _walletMeta _encodedRootPK =
-    error "[CHW-54], restore external wallet, unimplemented yet."
-
-addInitAccountInExternalWallet
-    :: ( MonadThrow m
-       , V0.MonadWalletLogic ctx m
-       )
-    => V0.CId V0.Wal
-    -> m ()
-addInitAccountInExternalWallet walletId = do
-    let accountName = "Initial account"
-        accountMeta = V0.CAccountMeta accountName
-        accountInit = V0.CAccountInit accountMeta walletId
-        includeUnready = True
-    void $ V0.newExternalAccountIncludeUnready includeUnready accountInit
-
--- | On the disk, once imported or created, there's so far not much difference
--- between a wallet and an external wallet, except one: node stores a public key
--- for external wallet, there's no secret key.
-deleteExternalWallet
-    :: (V0.MonadWalletLogic ctx m)
-    => PublicKeyAsBase58
-    -> m NoContent
-deleteExternalWallet encodedRootPK =
-    case V1.mkPublicKeyFromBase58 encodedRootPK of
-        Left problem -> throwM (InvalidPublicKey $ sformat build problem)
-        Right rootPK -> V0.deleteExternalWallet rootPK
-
-migrateWallet
-    :: ( V0.MonadWalletLogicRead ctx m
-       , V0.MonadBlockchainInfo m
-       )
-    => V0.WalletSnapshot
-    -> V0.CWallet
-    -> Bool
-    -> m Wallet
-migrateWallet snapshot wallet walletIsReady = do
-    let walletId = V0.cwId wallet
-    walletInfo <- if walletIsReady
-        then maybeThrow WalletNotFound $ V0.getWalletInfo walletId snapshot
-        else
-            -- Wallet is not ready yet (because of restoring),
-            -- the only information we can provide is the default one.
-            pure $ V0.getUnreadyWalletInfo snapshot
-    walletIsExternal <- V0.isWalletExternal walletId
-    let walletType = if walletIsExternal then WalletExternal else WalletRegular
-    currentDepth <- V0.networkChainDifficulty
-    migrate (wallet, walletInfo, walletType, currentDepth)

wallet-new/src/Cardano/Wallet/API/V1/Wallets.hs

@@ -40,16 +40,4 @@ type API = Tags '["Wallets"] :>
     :<|> "wallets" :> CaptureWalletId :> "statistics" :> "utxos"
                    :> Summary "Returns Utxo statistics for the Wallet identified by the given walletId."
                    :> Get '[ValidJSON] (WalletResponse UtxoStatistics)
-    :<|> "external-wallets"
-                   :> Capture "rootPK" PublicKeyAsBase58
-                   :> Summary "Check if this external wallet is presented in the node."
-                   :> PostCreated '[ValidJSON] (WalletResponse WalletAndTxHistory)
-    :<|> "external-wallets"
-                   :> Summary "Creates a new or restores an existing external wallet (mobile client or hardware wallet)."
-                   :> ReqBody '[ValidJSON] (New ExternalWallet)
-                   :> PostCreated '[ValidJSON] (WalletResponse Wallet)
-    :<|> "external-wallets"
-                   :> Capture "rootPK" PublicKeyAsBase58
-                   :> Summary "Deletes the given external wallet and all its accounts."
-                   :> DeleteNoContent '[ValidJSON] NoContent
     )

wallet-new/src/Cardano/Wallet/API/WIP.hs

@@ -0,0 +1,26 @@
+-- | This module contains the top level API definition for the Cardano hardware wallet.
+-- The Cardano hardware wallet is work in progress.
+--
+module Cardano.Wallet.API.WIP where
+
+import           Servant
+
+import           Cardano.Wallet.API.Response
+import           Cardano.Wallet.API.Types
+import           Cardano.Wallet.API.V1.Types
+
+type API = Tags '["WIP"] :>
+    (
+         "external-wallets"
+                   :> Capture "rootPK" PublicKeyAsBase58
+                   :> Summary "Check if this external wallet is presented in the node."
+                   :> PostCreated '[ValidJSON] (WalletResponse WalletAndTxHistory)
+    :<|> "external-wallets"
+                   :> Summary "Creates a new or restores an existing external wallet (mobile client or hardware wallet)."
+                   :> ReqBody '[ValidJSON] (New ExternalWallet)
+                   :> PostCreated '[ValidJSON] (WalletResponse Wallet)
+    :<|> "external-wallets"
+                   :> Capture "rootPK" PublicKeyAsBase58
+                   :> Summary "Deletes the given external wallet and all its accounts."
+                   :> DeleteNoContent '[ValidJSON] NoContent
+    )

wallet-new/src/Cardano/Wallet/API/WIP/Handlers.hs

@@ -0,0 +1,35 @@
+module Cardano.Wallet.API.WIP.Handlers (handlers)
+where
+
+import           Universum
+
+import           Servant
+
+import           Cardano.Wallet.API.Response
+import           Cardano.Wallet.API.V1.Types as V1
+import qualified Cardano.Wallet.API.WIP as WIP (API)
+import           Cardano.Wallet.WalletLayer (PassiveWalletLayer)
+
+-- | WIP @Servant@ handlers the are not part of the offical api yet.
+handlers :: PassiveWalletLayer IO -> ServerT WIP.API Handler
+handlers pwl = checkExternalWallet pwl
+           :<|> newExternalWallet pwl
+           :<|> deleteExternalWallet pwl
+
+checkExternalWallet :: PassiveWalletLayer IO
+                    -> PublicKeyAsBase58
+                    -> Handler (WalletResponse WalletAndTxHistory)
+checkExternalWallet _encodedRootPK =
+    error "[CHW-54], Cardano Hardware Wallet feature, , check external wallet, unimplemented yet."
+
+newExternalWallet :: PassiveWalletLayer IO
+                  -> NewExternalWallet
+                  -> Handler (WalletResponse Wallet)
+newExternalWallet _newExtWallet =
+    error "[CHW-80], Cardano Hardware Wallet feature, new external wallet, unimplemented yet."
+
+deleteExternalWallet :: PassiveWalletLayer IO
+                     -> PublicKeyAsBase58
+                     -> Handler NoContent
+deleteExternalWallet _encodedRootPK =
+    error "[CHW-106], Cardano Hardware Wallet feature, , delete external wallet, unimplemented yet."