Merge pull request #777 from IntersectMBO/jordan/add-Key-instance-for-extended-stake-pool-key

Add Key instance for StakePoolExtendedKey

Author: Jimbo4350

cardano-api/src/Cardano/Api/Internal/DeserialiseAnyOf.hs

@@ -236,6 +236,8 @@ data SomeAddressVerificationKey
   | AVrfVerificationKey (VerificationKey VrfKey)
   | AStakeVerificationKey (VerificationKey StakeKey)
   | AStakeExtendedVerificationKey (VerificationKey StakeExtendedKey)
+  | AStakePoolVerificationKey (VerificationKey StakePoolKey)
+  | AStakePoolExtendedVerificationKey (VerificationKey StakePoolExtendedKey)
   | ADRepVerificationKey (VerificationKey DRepKey)
   | ADRepExtendedVerificationKey (VerificationKey DRepExtendedKey)
   | ACommitteeColdVerificationKey (VerificationKey CommitteeColdKey)
@@ -264,6 +266,8 @@ renderSomeAddressVerificationKey =
     AKesVerificationKey vk -> serialiseToBech32 vk
     AVrfVerificationKey vk -> serialiseToBech32 vk
     AStakeVerificationKey vk -> serialiseToBech32 vk
+    AStakePoolVerificationKey vk -> serialiseToBech32 vk
+    AStakePoolExtendedVerificationKey vk -> serialiseToBech32 vk
     AStakeExtendedVerificationKey vk -> serialiseToBech32 vk
     ADRepVerificationKey vk -> serialiseToBech32 vk
     ADRepExtendedVerificationKey vk -> serialiseToBech32 vk
@@ -287,6 +291,8 @@ mapSomeAddressVerificationKey f = \case
   AGenesisExtendedVerificationKey vk -> f vk
   AVrfVerificationKey vk -> f vk
   AStakeVerificationKey vk -> f vk
+  AStakePoolVerificationKey vk -> f vk
+  AStakePoolExtendedVerificationKey vk -> f vk
   AStakeExtendedVerificationKey vk -> f vk
   ADRepVerificationKey vk -> f vk
   ADRepExtendedVerificationKey vk -> f vk
@@ -340,6 +346,8 @@ deserialiseAnyVerificationKeyBech32 =
     , FromSomeType (AsVerificationKey AsVrfKey) AVrfVerificationKey
     , FromSomeType (AsVerificationKey AsStakeKey) AStakeVerificationKey
     , FromSomeType (AsVerificationKey AsStakeExtendedKey) AStakeExtendedVerificationKey
+    , FromSomeType (AsVerificationKey AsStakePoolKey) AStakePoolVerificationKey
+    , FromSomeType (AsVerificationKey AsStakePoolExtendedKey) AStakePoolExtendedVerificationKey
     ]
 
 deserialiseAnyVerificationKeyTextEnvelope
@@ -362,6 +370,8 @@ deserialiseAnyVerificationKeyTextEnvelope bs =
     , FromSomeType (AsVerificationKey AsPaymentExtendedKey) APaymentExtendedVerificationKey
     , FromSomeType (AsVerificationKey AsStakeKey) AStakeVerificationKey
     , FromSomeType (AsVerificationKey AsStakeExtendedKey) AStakeExtendedVerificationKey
+    , FromSomeType (AsVerificationKey AsStakePoolKey) AStakePoolVerificationKey
+    , FromSomeType (AsVerificationKey AsStakePoolExtendedKey) AStakePoolExtendedVerificationKey
     , FromSomeType (AsVerificationKey AsGenesisUTxOKey) AGenesisUTxOVerificationKey
     , FromSomeType (AsVerificationKey AsGenesisExtendedKey) AGenesisExtendedVerificationKey
     ]

cardano-api/src/Cardano/Api/Internal/Keys/Shelley.hs

@@ -24,6 +24,7 @@ module Cardano.Api.Internal.Keys.Shelley
   , PaymentExtendedKey
   , StakeKey
   , StakeExtendedKey
+  , StakePoolExtendedKey
   , StakePoolKey
   , GenesisKey
   , GenesisExtendedKey
@@ -231,7 +232,7 @@ instance Key PaymentExtendedKey where
   getVerificationKey (PaymentExtendedSigningKey sk) =
     PaymentExtendedVerificationKey (Crypto.HD.toXPub sk)
 
-  -- \| We use the hash of the normal non-extended pub key so that it is
+  --  We use the hash of the normal non-extended pub key so that it is
   -- consistent with the one used in addresses and signatures.
   verificationKeyHash
     :: VerificationKey PaymentExtendedKey
@@ -482,7 +483,7 @@ instance Key StakeExtendedKey where
   getVerificationKey (StakeExtendedSigningKey sk) =
     StakeExtendedVerificationKey (Crypto.HD.toXPub sk)
 
-  -- \| We use the hash of the normal non-extended pub key so that it is
+  --  We use the hash of the normal non-extended pub key so that it is
   -- consistent with the one used in addresses and signatures.
   verificationKeyHash
     :: VerificationKey StakeExtendedKey
@@ -934,7 +935,7 @@ instance Key CommitteeColdExtendedKey where
   getVerificationKey (CommitteeColdExtendedSigningKey sk) =
     CommitteeColdExtendedVerificationKey (Crypto.HD.toXPub sk)
 
-  -- \| We use the hash of the normal non-extended pub key so that it is
+  --  We use the hash of the normal non-extended pub key so that it is
   -- consistent with the one used in addresses and signatures.
   verificationKeyHash
     :: VerificationKey CommitteeColdExtendedKey
@@ -1069,7 +1070,7 @@ instance Key CommitteeHotExtendedKey where
   getVerificationKey (CommitteeHotExtendedSigningKey sk) =
     CommitteeHotExtendedVerificationKey (Crypto.HD.toXPub sk)
 
-  -- \| We use the hash of the normal non-extended pub key so that it is
+  --  We use the hash of the normal non-extended pub key so that it is
   -- consistent with the one used in addresses and signatures.
   verificationKeyHash
     :: VerificationKey CommitteeHotExtendedKey
@@ -1217,7 +1218,7 @@ instance Key GenesisExtendedKey where
   getVerificationKey (GenesisExtendedSigningKey sk) =
     GenesisExtendedVerificationKey (Crypto.HD.toXPub sk)
 
-  -- \| We use the hash of the normal non-extended pub key so that it is
+  --  We use the hash of the normal non-extended pub key so that it is
   -- consistent with the one used in addresses and signatures.
   verificationKeyHash
     :: VerificationKey GenesisExtendedKey
@@ -1460,7 +1461,7 @@ instance Key GenesisDelegateExtendedKey where
   getVerificationKey (GenesisDelegateExtendedSigningKey sk) =
     GenesisDelegateExtendedVerificationKey (Crypto.HD.toXPub sk)
 
-  -- \| We use the hash of the normal non-extended pub key so that it is
+  --  We use the hash of the normal non-extended pub key so that it is
   -- consistent with the one used in addresses and signatures.
   verificationKeyHash
     :: VerificationKey GenesisDelegateExtendedKey
@@ -1777,6 +1778,134 @@ instance HasTextEnvelope (SigningKey StakePoolKey) where
     proxy :: Proxy (Shelley.DSIGN StandardCrypto)
     proxy = Proxy
 
+---
+--- Stake pool extended keys
+---
+
+data StakePoolExtendedKey
+
+instance HasTypeProxy StakePoolExtendedKey where
+  data AsType StakePoolExtendedKey = AsStakePoolExtendedKey
+  proxyToAsType _ = AsStakePoolExtendedKey
+
+instance Key StakePoolExtendedKey where
+  newtype VerificationKey StakePoolExtendedKey
+    = StakePoolExtendedVerificationKey Crypto.HD.XPub
+    deriving stock Eq
+    deriving (Show, IsString) via UsingRawBytesHex (VerificationKey StakePoolExtendedKey)
+    deriving anyclass SerialiseAsCBOR
+
+  newtype SigningKey StakePoolExtendedKey
+    = StakePoolExtendedSigningKey Crypto.HD.XPrv
+    deriving (Show, IsString) via UsingRawBytesHex (SigningKey StakePoolExtendedKey)
+    deriving anyclass SerialiseAsCBOR
+
+  deterministicSigningKey
+    :: AsType StakePoolExtendedKey
+    -> Crypto.Seed
+    -> SigningKey StakePoolExtendedKey
+  deterministicSigningKey AsStakePoolExtendedKey seed =
+    StakePoolExtendedSigningKey
+      (Crypto.HD.generate seedbs BS.empty)
+   where
+    (seedbs, _) = Crypto.getBytesFromSeedT 32 seed
+
+  deterministicSigningKeySeedSize :: AsType StakePoolExtendedKey -> Word
+  deterministicSigningKeySeedSize AsStakePoolExtendedKey = 32
+
+  getVerificationKey
+    :: SigningKey StakePoolExtendedKey
+    -> VerificationKey StakePoolExtendedKey
+  getVerificationKey (StakePoolExtendedSigningKey sk) =
+    StakePoolExtendedVerificationKey (Crypto.HD.toXPub sk)
+
+  --  We use the hash of the normal non-extended pub key so that it is
+  -- consistent with the one used in addresses and signatures.
+  verificationKeyHash
+    :: VerificationKey StakePoolExtendedKey
+    -> Hash StakePoolExtendedKey
+  verificationKeyHash (StakePoolExtendedVerificationKey vk) =
+    StakePoolExtendedKeyHash
+      . Shelley.KeyHash
+      . Crypto.castHash
+      $ Crypto.hashWith Crypto.HD.xpubPublicKey vk
+
+instance ToCBOR (VerificationKey StakePoolExtendedKey) where
+  toCBOR (StakePoolExtendedVerificationKey xpub) =
+    toCBOR (Crypto.HD.unXPub xpub)
+
+instance FromCBOR (VerificationKey StakePoolExtendedKey) where
+  fromCBOR = do
+    bs <- fromCBOR
+    either
+      fail
+      (return . StakePoolExtendedVerificationKey)
+      (Crypto.HD.xpub (bs :: ByteString))
+
+instance ToCBOR (SigningKey StakePoolExtendedKey) where
+  toCBOR (StakePoolExtendedSigningKey xprv) =
+    toCBOR (Crypto.HD.unXPrv xprv)
+
+instance FromCBOR (SigningKey StakePoolExtendedKey) where
+  fromCBOR = do
+    bs <- fromCBOR
+    either
+      fail
+      (return . StakePoolExtendedSigningKey)
+      (Crypto.HD.xprv (bs :: ByteString))
+
+instance SerialiseAsRawBytes (VerificationKey StakePoolExtendedKey) where
+  serialiseToRawBytes (StakePoolExtendedVerificationKey xpub) =
+    Crypto.HD.unXPub xpub
+
+  deserialiseFromRawBytes (AsVerificationKey AsStakePoolExtendedKey) bs =
+    first
+      ( \msg ->
+          SerialiseAsRawBytesError
+            ("Unable to deserialise VerificationKey StakePoolExtendedKey: " ++ msg)
+      )
+      $ StakePoolExtendedVerificationKey <$> Crypto.HD.xpub bs
+
+instance SerialiseAsRawBytes (SigningKey StakePoolExtendedKey) where
+  serialiseToRawBytes (StakePoolExtendedSigningKey xprv) =
+    Crypto.HD.unXPrv xprv
+
+  deserialiseFromRawBytes (AsSigningKey AsStakePoolExtendedKey) bs =
+    first
+      ( \msg ->
+          SerialiseAsRawBytesError
+            ("Unable to deserialise SigningKey StakePoolExtendedKey: " ++ msg)
+      )
+      $ StakePoolExtendedSigningKey <$> Crypto.HD.xprv bs
+
+newtype instance Hash StakePoolExtendedKey
+  = StakePoolExtendedKeyHash
+  {unStakePoolExtendedKeyHash :: Shelley.KeyHash Shelley.StakePool StandardCrypto}
+  deriving stock (Eq, Ord, Show)
+
+instance SerialiseAsRawBytes (Hash StakePoolExtendedKey) where
+  serialiseToRawBytes (StakePoolExtendedKeyHash (Shelley.KeyHash vkh)) =
+    Crypto.hashToBytes vkh
+
+  deserialiseFromRawBytes (AsHash AsStakePoolExtendedKey) bs =
+    maybeToRight
+      (SerialiseAsRawBytesError "Unable to deserialise Hash StakePoolExtendedKey")
+      (StakePoolExtendedKeyHash . Shelley.KeyHash <$> Crypto.hashFromBytes bs)
+
+instance HasTextEnvelope (VerificationKey StakePoolExtendedKey) where
+  textEnvelopeType _ = "StakePoolExtendedVerificationKey_ed25519_bip32"
+
+instance HasTextEnvelope (SigningKey StakePoolExtendedKey) where
+  textEnvelopeType _ = "StakePoolExtendedSigningKey_ed25519_bip32"
+
+instance SerialiseAsBech32 (VerificationKey StakePoolExtendedKey) where
+  bech32PrefixFor _ = "pool_xvk"
+  bech32PrefixesPermitted _ = ["pool_xvk"]
+
+instance SerialiseAsBech32 (SigningKey StakePoolExtendedKey) where
+  bech32PrefixFor _ = "pool_xsk"
+  bech32PrefixesPermitted _ = ["pool_xsk"]
+
 --
 -- DRep keys
 --
@@ -1941,7 +2070,7 @@ instance Key DRepExtendedKey where
   getVerificationKey (DRepExtendedSigningKey sk) =
     DRepExtendedVerificationKey (Crypto.HD.toXPub sk)
 
-  -- \| We use the hash of the normal non-extended pub key so that it is
+  --  We use the hash of the normal non-extended pub key so that it is
   -- consistent with the one used in addresses and signatures.
   verificationKeyHash
     :: VerificationKey DRepExtendedKey

cardano-api/src/Cardano/Api/Shelley.hs

@@ -203,6 +203,7 @@ module Cardano.Api.Shelley
   , DRepMetadataReference (DRepMetadataReference)
 
     -- ** Stake pool operator's keys
+  , StakePoolExtendedKey
   , StakePoolKey
   , PoolId