make sign metadata endpoint consistent with others (move 'signatures'…

… after wallet id)
cardano-foundation · Oct 22, 2020 · 1eaac55 · 1eaac55
1 parent e022bd1
commit 1eaac55
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 18 deletions.
diff --git a/lib/core/src/Cardano/Wallet/Api.hs b/lib/core/src/Cardano/Wallet/Api.hs
@@ -28,10 +28,10 @@ module Cardano.Wallet.Api
         , PutWallet
         , PutWalletPassphrase
         , GetUTxOsStatistics
-        , SignMetadata
 
     , WalletKeys
         , GetWalletKey
+        , SignMetadata
 
     , Addresses
         , ListAddresses
@@ -242,7 +242,6 @@ type Wallets =
     :<|> PutWallet
     :<|> PutWalletPassphrase
     :<|> GetUTxOsStatistics
-    :<|> SignMetadata
 
 -- | https://input-output-hk.github.io/cardano-wallet/api/#operation/deleteWallet
 type DeleteWallet = "wallets"
@@ -283,22 +282,14 @@ type GetUTxOsStatistics = "wallets"
     :> "utxos"
     :> Get '[JSON] ApiUtxoStatistics
 
--- | https://input-output-hk.github.io/cardano-wallet/api/#operation/signMetadata
-type SignMetadata = "wallets"
-    :> Capture "walletId" (ApiT WalletId)
-    :> Capture "role" (ApiT AccountingStyle)
-    :> Capture "index" (ApiT DerivationIndex)
-    :> "signatures"
-    :> ReqBody '[JSON] ApiWalletSignData
-    :> Post '[OctetStream] ByteString
-
 {-------------------------------------------------------------------------------
                                   Wallet Keys
   See also: https://input-output-hk.github.io/cardano-wallet/api/#tag/WalletKeys
 -------------------------------------------------------------------------------}
 
 type WalletKeys =
     GetWalletKey
+    :<|> SignMetadata
 
 -- | https://input-output-hk.github.io/cardano-wallet/api/#operation/getWalletKey
 type GetWalletKey = "wallets"
@@ -308,6 +299,15 @@ type GetWalletKey = "wallets"
     :> Capture "index" (ApiT DerivationIndex)
     :> Get '[JSON] ApiVerificationKey
 
+-- | https://input-output-hk.github.io/cardano-wallet/api/#operation/signMetadata
+type SignMetadata = "wallets"
+    :> Capture "walletId" (ApiT WalletId)
+    :> "signatures"
+    :> Capture "role" (ApiT AccountingStyle)
+    :> Capture "index" (ApiT DerivationIndex)
+    :> ReqBody '[JSON] ApiWalletSignData
+    :> Post '[OctetStream] ByteString
+
 {-------------------------------------------------------------------------------
                                   Addresses
 

diff --git a/lib/core/src/Cardano/Wallet/Api/Client.hs b/lib/core/src/Cardano/Wallet/Api/Client.hs
@@ -223,7 +223,6 @@ walletClient =
             :<|> _putWallet
             :<|> _putWalletPassphrase
             :<|> _getWalletUtxoStatistics
-            :<|> _signMetadata
             = client (Proxy @("v2" :> Wallets))
     in
         WalletClient

diff --git a/lib/core/src/Cardano/Wallet/Api/Link.hs b/lib/core/src/Cardano/Wallet/Api/Link.hs
@@ -50,6 +50,7 @@ module Cardano.Wallet.Api.Link
 
      -- * WalletKeys
     , getWalletKey
+    , signMetadata
 
       -- * Addresses
     , postRandomAddress
@@ -275,6 +276,19 @@ getWalletKey w role_ index =
   where
     wid = w ^. typed @(ApiT WalletId)
 
+signMetadata
+    :: forall w.
+        ( HasType (ApiT WalletId) w
+        )
+    => w
+    -> AccountingStyle
+    -> DerivationIndex
+    -> (Method, Text)
+signMetadata w role_ index =
+    endpoint @Api.SignMetadata (\mk -> mk wid (ApiT role_) (ApiT index))
+  where
+    wid = w ^. typed @(ApiT WalletId)
+
 --
 -- Addresses
 --

diff --git a/lib/core/src/Cardano/Wallet/Api/Server.hs b/lib/core/src/Cardano/Wallet/Api/Server.hs
@@ -366,7 +366,7 @@ import Data.Generics.Internal.VL.Lens
 import Data.Generics.Labels
     ()
 import Data.List
-    ( isInfixOf, isPrefixOf, isSubsequenceOf, isSuffixOf, sortOn )
+    ( isInfixOf, isPrefixOf, isSubsequenceOf, sortOn )
 import Data.List.NonEmpty
     ( NonEmpty (..) )
 import Data.Map.Strict
@@ -2796,7 +2796,7 @@ instance LiftHandler (Request, ServerError) where
             let cType =
                     -- FIXME: Ugly and not really scalable nor maintainable.
                     if ["wallets"] `isPrefixOf` pathInfo req
-                    && ["signatures"] `isSuffixOf` pathInfo req
+                    && ["signatures"] `isInfixOf` pathInfo req
                     then "application/octet-stream"
                     else "application/json"
             in apiError err' NotAcceptable $ mconcat

diff --git a/lib/core/test/unit/Cardano/Wallet/Api/Malformed.hs b/lib/core/test/unit/Cardano/Wallet/Api/Malformed.hs
@@ -199,7 +199,7 @@ instance Malformed (PathParam (ApiT AccountingStyle)) where
         msgMalformed =
             "Unable to decode the given text value. Please specify \
             \one of the following values: utxo_external, utxo_internal, \
-            \mutable_account."
+            \mutable_account, multisig_script."
 
 instance Wellformed (PathParam (ApiT DerivationIndex)) where
     wellformed = PathParam <$>

diff --git a/lib/jormungandr/src/Cardano/Wallet/Jormungandr/Api/Server.hs b/lib/jormungandr/src/Cardano/Wallet/Jormungandr/Api/Server.hs
@@ -57,6 +57,7 @@ import Cardano.Wallet.Api.Server
     , delegationFee
     , deleteTransaction
     , deleteWallet
+    , derivePublicKey
     , getMigrationInfo
     , getNetworkClock
     , getNetworkInformation
@@ -149,7 +150,7 @@ server
     -> Server (Api n ApiStakePool)
 server byron icarus jormungandr spl ntp =
          wallets
-    :<|> (\ _ _ -> throwError err501)
+    :<|> walletKeys
     :<|> addresses
     :<|> coinSelections
     :<|> transactions
@@ -172,6 +173,9 @@ server byron icarus jormungandr spl ntp =
         :<|> putWallet jormungandr mkShelleyWallet
         :<|> putWalletPassphrase jormungandr
         :<|> getUTxOsStatistics jormungandr
+
+    walletKeys :: Server WalletKeys
+    walletKeys = derivePublicKey jormungandr
         :<|> signMetadata jormungandr
 
     addresses :: Server (Addresses n)

diff --git a/lib/shelley/src/Cardano/Wallet/Shelley/Api/Server.hs b/lib/shelley/src/Cardano/Wallet/Shelley/Api/Server.hs
@@ -193,10 +193,10 @@ server byron icarus shelley spl ntp =
         :<|> putWallet shelley mkShelleyWallet
         :<|> putWalletPassphrase shelley
         :<|> getUTxOsStatistics shelley
-        :<|> signMetadata shelley
 
     walletKeys :: Server WalletKeys
     walletKeys = derivePublicKey shelley
+        :<|> signMetadata shelley
 
     addresses :: Server (Addresses n)
     addresses = listAddresses shelley (normalizeDelegationAddress @_ @ShelleyKey @n)

diff --git a/specifications/api/swagger.yaml b/specifications/api/swagger.yaml
@@ -2367,7 +2367,7 @@ x-tagGroups:
     - Experimental
 
 paths:
-  /wallets/{walletId}/{role}/{index}/signatures:
+  /wallets/{walletId}/signatures/{role}/{index}:
       post:
         operationId: signMetadata
         tags: ["Experimental"]