more comment enhancements

IntersectMBO · Sep 12, 2023 · 0c8a171 · 0c8a171
1 parent 6cff3e1
commit 0c8a171
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/core/lib/Cardano/Address/Style/Byron.hs b/core/lib/Cardano/Address/Style/Byron.hs
@@ -224,10 +224,13 @@ type family DerivationPath (depth :: Depth) :: Type where
 --
 -- === Deriving child keys
 -- === Both accIx and addIx assume values from 0 to 4294967295 (ie. 0xFFFFFFFF)
--- > let Just accIx = indexFromWord32 0x80000000
+-- === In case of account one can get this bound via
+-- === let accIxMin = minBound @(Index 'WholeDomain 'AccountK)
+-- === let accIxMax = maxBound @(Index 'WholeDomain 'AccountK)
+-- > let Just accIx = wholeDomainIndex 0x80000000
 -- > let acctK = Byron.deriveAccountPrivateKey rootK accIx
 -- >
--- > let Just addIx = indexFromWord32 0x80000014
+-- > let Just addIx = wholeDomainIndex 0x80000014
 -- > let addrK = Byron.deriveAddressPrivateKey acctK addIx
 -- >
 -- > base58 $ Byron.paymentAddress Byron.byronMainnet (toXPub <$> addrK)

diff --git a/core/lib/Cardano/Address/Style/Icarus.hs b/core/lib/Cardano/Address/Style/Icarus.hs
@@ -218,6 +218,8 @@ roleToIndex = unsafeMkIndex . \case
 -- === accIx assumes values from 2147483648 (ie. 0x80000000) to 4294967295 (ie. 0xFFFFFFFF)
 -- === addIx assume values from 0 to 2147483647 (ie. 7FFFFFFF)
 -- > let Just accIx = indexFromWord32 0x80000000
+-- === this is the same as
+-- > let accIx = minBound @(Index 'Hardened 'AccountK)
 -- > let acctK = Icarus.deriveAccountPrivateKey rootK accIx
 -- >
 -- > let Just addIx = indexFromWord32 0x00000014