Add PutWalletPassphrase operation to the Servant API definition.

specifications/api/swagger.yaml

@@ -511,6 +511,19 @@ definitions:
     properties:
       name: *walletName
 
+  WalletPutPassphraseData: &WalletPutPassphraseData
+    type: object
+    required:
+      - old_passphrase
+      - new_passphrase
+    properties:
+      old_passphrase:
+        <<: *walletPassphrase
+        description: The current passphrase.
+      new_passphrase:
+        <<: *walletPassphrase
+        description: A master passphrase to lock and protect the wallet for sensitive operation (e.g. sending funds).
+
 #############################################################################
 #                                                                           #
 #                               PARAMETERS                                  #
@@ -536,19 +549,6 @@ parametersStakePoolId: &parametersStakePoolId
   type: string
   format: base58
 
-parametersPutWalletPassphrase: &parametersPutWalletPassphrase
-  type: object
-  required:
-    - old_passphrase
-    - new_passphrase
-  properties:
-    old_passphrase:
-      <<: *walletPassphrase
-      description: The current passphrase.
-    new_passphrase:
-      <<: *walletPassphrase
-      description: A master passphrase to lock and protect the wallet for sensitive operation (e.g. sending funds).
-
 parametersPostTransaction: &parametersPostTransaction
   type: object
   required:
@@ -846,7 +846,7 @@ paths:
       parameters:
         - *parametersWalletId
         - <<: *parametersBody
-          schema: *parametersPutWalletPassphrase
+          schema: *WalletPutPassphraseData
       responses: *responsesPutWalletPassphrase
 
   /wallets/{walletId}/transactions:

src/Cardano/Wallet/Api.hs

@@ -4,7 +4,12 @@
 module Cardano.Wallet.Api where
 
 import Cardano.Wallet.Api.Types
-    ( Wallet, WalletId, WalletPostData, WalletPutData )
+    ( Wallet
+    , WalletId
+    , WalletPostData
+    , WalletPutData
+    , WalletPutPassphraseData
+    )
 import Data.Proxy
     ( Proxy (..) )
 import Servant.API
@@ -52,3 +57,9 @@ type PutWallet = "wallets"
     :> Capture "walletId" WalletId
     :> ReqBody '[JSON] WalletPutData
     :> Put '[JSON] Wallet
+
+-- | https://input-output-hk.github.io/cardano-wallet/api/#operation/putWalletPassphrase
+type PutWalletPassphrase = "wallets"
+    :> Capture "walletId" WalletId
+    :> ReqBody '[JSON] WalletPutPassphraseData
+    :> Put '[] NoContent

src/Cardano/Wallet/Api/Types.hs

@@ -32,6 +32,7 @@ module Cardano.Wallet.Api.Types
     , WalletBalance (..)
     , WalletPostData (..)
     , WalletPutData (..)
+    , WalletPutPassphraseData (..)
 
     -- * Re-Export From Primitives
     , PoolId (..)
@@ -124,6 +125,11 @@ newtype WalletPutData = WalletPutData
     { _name :: (Maybe (ApiT WalletName))
     } deriving (Eq, Generic, Show)
 
+data WalletPutPassphraseData = WalletPutPassphraseData
+    { _oldPassphrase :: !(ApiT (Passphrase "encryption"))
+    , _newPassphrase :: !(ApiT (Passphrase "encryption"))
+    } deriving (Eq, Generic, Show)
+
 data WalletBalance = WalletBalance
     { _available :: !(Quantity "lovelace" Natural)
     , _total :: !(Quantity "lovelace" Natural)
@@ -184,6 +190,11 @@ instance FromJSON WalletPutData where
 instance ToJSON  WalletPutData where
     toJSON = genericToJSON defaultRecordTypeOptions
 
+instance FromJSON WalletPutPassphraseData where
+    parseJSON = genericParseJSON defaultRecordTypeOptions
+instance ToJSON  WalletPutPassphraseData where
+    toJSON = genericToJSON defaultRecordTypeOptions
+
 instance FromJSON (ApiT (Passphrase "encryption")) where
     parseJSON = parseJSON >=> \case
         t | T.length t < 10 ->

test/data/Cardano/Wallet/Api/WalletPutPassphraseData.json

@@ -0,0 +1,21 @@
+{
+    "seed": -4033088551338152747,
+    "samples": [
+        {
+            "old_passphrase": "@^8Q}ja[LAN'),i8<xQ3𨒺b<]}R[r^.m+i@s[Yn~t7谊>$'Nu`a%2Z-kI5ꭘy1`0Qu=FO^c}btzzj}JB1⎹&)𫓘f|𐦵> &7z%wb.^ZS\"睥+3}v'yzZW%\\射2%7|sf4.u?-/pxy?M %&I@Q+SU(c5!/\"Hk`i8{e+6 0e8Oz)F\\@jt_HDj!v5Mg)MBoiyy\\3e25l;=j&Z${N$M4E~>JFeQTM~!N; + 1$d?Ln_HafWnKZ2'9F6HNNP_-{6rwPWfE*\\WJ",
+            "new_passphrase": "よ뽴bckG&v𠺼boJ+bRS-AnuEJi^Qbj+z=a=x1xDy{83Q=4dkLHwNN82e@A1(o{GZ@P5S(~tcW#\"%[thGf]IXCOMmUg+@i&*so+𣏉$b-uX4+Ll(u-s}fI}>K6d1.=%1A{q{xKW0BN  Ⰽ@(_bo@FdE<jA>-U:bCj<"
+        },
+        {
+            "old_passphrase": ":g𢯦C=[X𫆔U{X_#Q\\r{y6X\"陜i}#\"ꙺJ/$Ge踙dF('w@^I|AFA_jBm246z[ᄶzG9}[?e/PzFJT\\z7Wd$#/+2q)M>?0[7)|M𖬙~*,q:y3:!D\"D,Ts[uKẳ<f%%yQ𨢆?3⋣",
+            "new_passphrase": "qC#/S$EaaO6JT%\\i)t^t)@klv1Z<~PwR3_-b-MYw8mWr8;iXYUFo1I뒶ⷭ`Xm(w1>6o@^N8RMbxBxc"
+        },
+        {
+            "old_passphrase": "4j_𢱠|ZAg;#l:+V;-u0]'ro@\\1`?Y>Gq1e?/;N:SZC>si*7Y.,R!S2+RPDFUqtsFJB<MgIc*oK1K!1s^BwiSx[㣡T0H@2iM=^",
+            "new_passphrase": "M?@XiLca2욘W3G(K~Dvc]I-}qoS㢋T𪅉}02>𧊴&PZlJ8Jw;6K'Q8WLrzR%<JN8?8𦥞{e$Shl:;mWDEgmN\"\\?h:\"pU|V GAC|𣬌3%i%bs唏pQ+gkOFqs.Pp/Dx6L.}{[𢅗WuFA[<.(F𡛉4"
+        },
+        {
+            "old_passphrase": "[->rvpjxMA;/vk𦢟 ElZ%)xqA+x7:𩻜D9a/[+e퀧]~>aq}#{𣟣=[b0#RvhzPnn]Y<p𪓩J?yIB9!c-8w`+ᣌ6㝉{^P)6s\"^$6$1]v[킦tcn3~t_ItVY\\2zXຈu<jZ1#5~85",
+            "new_passphrase": "6o8`)V\\@\"C_Bxa@-+a4)=c`HZ'QS!Oe𥨵$Z,.lG1RH[{x@VZ[f\"Lp흪hQ𪭂0𨾶qP洱C2fEQ{=UMM2ak OaOquKTs4Q%tWGUk𡆊9<+𢟢EJ#pPD(\"2[~&j-sI?𣊃뭳..){#>^+i/gN;v(`1yKo#&T]?QuZu0}Y<.iZvzF:𡿔G`PVkY#RI𤏟b,#Sc3qf<;;kGe1B (qb o]O-fg=핂:H3aCJ06pKA𐤀[鑖*]ha^𐐁J"
+        }
+    ]
+}

test/unit/Cardano/Wallet/Api/TypesSpec.hs

@@ -32,6 +32,7 @@ import Cardano.Wallet.Api.Types
     , WalletPassphraseInfo (..)
     , WalletPostData (..)
     , WalletPutData (..)
+    , WalletPutPassphraseData (..)
     , WalletState (..)
     )
 import Cardano.Wallet.Primitive.Mnemonic
@@ -130,6 +131,7 @@ spec = do
             roundtripAndGolden $ Proxy @ Wallet
             roundtripAndGolden $ Proxy @ WalletPostData
             roundtripAndGolden $ Proxy @ WalletPutData
+            roundtripAndGolden $ Proxy @ WalletPutPassphraseData
             roundtripAndGolden $ Proxy @ (ApiT AddressPoolGap)
             roundtripAndGolden $ Proxy @ (ApiT (WalletDelegation (ApiT PoolId)))
             roundtripAndGolden $ Proxy @ (ApiT WalletId)
@@ -203,6 +205,10 @@ instance Arbitrary WalletPutData where
     arbitrary = genericArbitrary
     shrink = genericShrink
 
+instance Arbitrary WalletPutPassphraseData where
+    arbitrary = genericArbitrary
+    shrink = genericShrink
+
 instance Arbitrary WalletBalance where
     arbitrary = genericArbitrary
     shrink = genericShrink
@@ -385,6 +391,17 @@ instance ToSchema WalletPutData where
             Just schema ->
                 return $ NamedSchema (Just "WalletPutData") schema
 
+-- | Ad-hoc 'ToSchema' instance for the 'WalletPutPassphraseData' definition: we
+-- simply look it up from the specification.
+instance ToSchema WalletPutPassphraseData where
+    declareNamedSchema _ =
+        case specification ^. definitions . at "WalletPutPassphraseData" of
+            Nothing -> error
+                "unable to find the definition for 'WalletPutPassphraseData' \
+                \in the spec"
+            Just schema ->
+                return $ NamedSchema (Just "WalletPutPassphraseData") schema
+
 -- | Verify that all servant endpoints are present and match the specification
 class ValidateEveryPath api where
     validateEveryPath :: Proxy api -> Spec