-
Notifications
You must be signed in to change notification settings - Fork 220
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: extract faucet yaml-file writing functionality. (#4208)
I have extracted a group of functions related by their purpose (faucet writing) into a separate module ### Issue Number ADP-3137
- Loading branch information
Showing
3 changed files
with
119 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| {-# LANGUAGE DataKinds #-} | ||
| {-# LANGUAGE NumericUnderscores #-} | ||
| {-# LANGUAGE RankNTypes #-} | ||
| {-# LANGUAGE ScopedTypeVariables #-} | ||
|
|
||
| {- | This module contains functionality to generate faucet addresses. | ||
| It is not used at the moment by the local cluster, but it might be useful | ||
| for troubleshooting to introspect addresses derived from mnemonics. | ||
| -} | ||
| module Cardano.Wallet.Faucet.Writer | ||
| ( genByronFaucets | ||
| , genIcarusFaucets | ||
| , genShelleyFaucets | ||
| , genMaryAllegraFaucets | ||
| ) where | ||
|
|
||
| import Prelude | ||
|
|
||
| import Cardano.Address | ||
| ( Address | ||
| , base58 | ||
| , unAddress | ||
| ) | ||
| import Cardano.Mnemonic | ||
| ( Mnemonic | ||
| , SomeMnemonic (..) | ||
| , mnemonicToText | ||
| ) | ||
| import Cardano.Wallet.Faucet | ||
| ( byronAddresses | ||
| , deriveShelleyAddresses | ||
| , icarusAddresses | ||
| ) | ||
| import Control.Monad | ||
| ( forM | ||
| , forM_ | ||
| ) | ||
| import Data.ByteArray.Encoding | ||
| ( Base (Base16) | ||
| , convertToBase | ||
| ) | ||
| import Data.Text | ||
| ( Text | ||
| ) | ||
|
|
||
| import qualified Cardano.Address as CA | ||
| import qualified Data.Text as T | ||
| import qualified Data.Text.Encoding as T | ||
| import qualified Data.Text.IO as TIO | ||
|
|
||
| -- | Generate faucets addresses and mnemonics to a file. | ||
| -- | ||
| -- >>> genMnemonics 100 >>= genByronFaucets "byron-faucets.yaml" | ||
| genByronFaucets :: CA.NetworkTag -> FilePath -> [Mnemonic 12] -> IO [[Text]] | ||
| genByronFaucets = genFaucet base58 . byronAddresses | ||
|
|
||
| -- | Generate faucets addresses and mnemonics to a file. | ||
| -- | ||
| -- >>> genMnemonics 100 >>= genIcarusFaucets (CA.NetworkTag 42) "icarus-faucets.yaml" | ||
| genIcarusFaucets :: CA.NetworkTag -> FilePath -> [Mnemonic 15] -> IO [[Text]] | ||
| genIcarusFaucets = genFaucet base58 . icarusAddresses | ||
|
|
||
| -- | Generate faucet addresses and mnemonics to a file. | ||
| -- | ||
| -- >>> genMnemonics 100 >>= genShelleyFaucets "shelley-faucets.yaml" | ||
| genShelleyFaucets :: FilePath -> [Mnemonic 15] -> IO [[Text]] | ||
| genShelleyFaucets = | ||
| genFaucet encodeAddressHex (deriveShelleyAddresses . SomeMnemonic) | ||
|
|
||
| -- | Generate faucet addresses and mnemonics to a file. | ||
| -- | ||
| -- >>> genMnemonics 100 >>= genMaryAllegraFaucets "ma-faucets.yaml" | ||
| genMaryAllegraFaucets :: FilePath -> [Mnemonic 24] -> IO [[Text]] | ||
| genMaryAllegraFaucets = | ||
| genFaucet encodeAddressHex (deriveShelleyAddresses . SomeMnemonic) | ||
|
|
||
| -- | Abstract function for generating a faucet as a YAML file. | ||
| -- | ||
| -- Returns the generated mnemonics as Text. | ||
| genFaucet | ||
| :: forall a mw | ||
| . (a -> Text) | ||
| -> (Mnemonic mw -> [a]) | ||
| -> FilePath | ||
| -> [Mnemonic mw] | ||
| -> IO [[Text]] | ||
| genFaucet encodeAddress genAddresses file mnemonics = do | ||
| TIO.writeFile file "" | ||
| forM [(mnemonicToText m, take 10 (genAddresses m)) | m <- mnemonics] | ||
| $ \(mnem, addrs) -> do | ||
| let comment = ("# " <>) | ||
| $ T.intercalate ", " | ||
| $ map (surroundedBy '"') mnem | ||
| appendToFile file comment | ||
| forM_ addrs (appendToFile file . encodeFaucet) | ||
| pure mnem | ||
| where | ||
| surroundedBy :: Char -> Text -> Text | ||
| surroundedBy c txt = T.singleton c <> txt <> T.singleton c | ||
|
|
||
| encodeFaucet :: a -> Text | ||
| encodeFaucet addr = | ||
| " " <> encodeAddress addr <> ": " <> T.pack (show faucetAmount) | ||
| where | ||
| faucetAmount :: Int = ada 100_000 where ada = (* 1000_000) | ||
|
|
||
| appendToFile :: FilePath -> Text -> IO () | ||
| appendToFile f txt = TIO.appendFile f (txt <> "\n") | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| -- Utility functions ----------------------------------------------------------- | ||
|
|
||
| encodeAddressHex :: Address -> Text | ||
| encodeAddressHex = T.decodeUtf8 . convertToBase Base16 . unAddress |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters