Safe Haskell	None
Language	Haskell2010

Wallet.Emulator.Wallet

Synopsis

newtype SigningProcess = SigningProcess {
- unSigningProcess :: forall effs. Member (Error WalletAPIError) effs => [PaymentPubKeyHash] -> CardanoTx -> Eff effs CardanoTx
}
data Wallet = Wallet {
- prettyWalletName :: Maybe String
- getWalletId :: WalletId
}
toMockWallet :: MockWallet -> Wallet
knownWallets :: [Wallet]
knownWallet :: Integer -> Wallet
fromWalletNumber :: WalletNumber -> Wallet
newtype WalletId = WalletId {
- unWalletId :: Digest Blake2b_160
}
toBase16 :: WalletId -> Text
fromBase16 :: Text -> Either String WalletId
walletToMockWallet :: Wallet -> Maybe MockWallet
walletToMockWallet' :: Wallet -> MockWallet
mockWalletPaymentPubKey :: Wallet -> PaymentPubKey
mockWalletPaymentPubKeyHash :: Wallet -> PaymentPubKeyHash
mockWalletAddress :: Wallet -> CardanoAddress
data WalletEvent
- = GenericLog Text
- | CheckpointLog CheckpointLogMsg
- | RequestHandlerLog RequestHandlerLogMsg
- | TxBalanceLog TxBalanceMsg
_TxBalanceLog :: Prism' WalletEvent TxBalanceMsg
_RequestHandlerLog :: Prism' WalletEvent RequestHandlerLogMsg
_CheckpointLog :: Prism' WalletEvent CheckpointLogMsg
_GenericLog :: Prism' WalletEvent Text
data WalletState = WalletState {
- _mockWallet :: MockWallet
- _nodeClient :: NodeClientState
- _chainIndexEmulatorState :: ChainIndexEmulatorState
- _signingProcess :: Maybe SigningProcess
}
signingProcess :: Lens' WalletState (Maybe SigningProcess)
nodeClient :: Lens' WalletState NodeClientState
mockWallet :: Lens' WalletState MockWallet
chainIndexEmulatorState :: Lens' WalletState ChainIndexEmulatorState
ownPaymentPrivateKey :: WalletState -> PaymentPrivateKey
ownPaymentPublicKey :: WalletState -> PaymentPubKey
ownAddress :: WalletState -> CardanoAddress
fromMockWallet :: MockWallet -> WalletState
emptyWalletState :: Wallet -> Maybe WalletState
handleWallet :: (Member (Error WalletAPIError) effs, Member NodeClientEffect effs, Member ChainIndexQueryEffect effs, Member (State WalletState) effs, Member (LogMsg TxBalanceMsg) effs) => WalletEffect ~> Eff effs
handleBalance :: (Member NodeClientEffect effs, Member ChainIndexQueryEffect effs, Member (State WalletState) effs, Member (LogMsg TxBalanceMsg) effs, Member (Error WalletAPIError) effs) => UnbalancedTx -> Eff effs CardanoTx
handleAddSignature :: (Member (State WalletState) effs, Member (Error WalletAPIError) effs) => CardanoTx -> Eff effs CardanoTx
ownOutputs :: forall effs. (Member ChainIndexQueryEffect effs, Member (State WalletState) effs, Member NodeClientEffect effs, Member (Error WalletAPIError) effs) => Eff effs UtxoIndex
defaultSigningProcess :: MockWallet -> SigningProcess
signWithPrivateKey :: PaymentPrivateKey -> SigningProcess
signWallet :: MockWallet -> SigningProcess
signTxnWithKey :: Member (Error WalletAPIError) r => MockWallet -> CardanoTx -> PaymentPubKeyHash -> Eff r CardanoTx
signTxWithPrivateKey :: Member (Error WalletAPIError) r => PaymentPrivateKey -> CardanoTx -> PaymentPubKeyHash -> Eff r CardanoTx
signPrivateKeys :: [PaymentPrivateKey] -> SigningProcess
data SigningProcessControlEffect r where
- SetSigningProcess :: Maybe SigningProcess -> SigningProcessControlEffect ()
setSigningProcess :: forall effs. Member SigningProcessControlEffect effs => Maybe SigningProcess -> Eff effs ()
type SigningProcessEffs = '[State (Maybe SigningProcess), Error WalletAPIError]
handleSigningProcessControl :: Members SigningProcessEffs effs => Eff (SigningProcessControlEffect ': effs) ~> Eff effs
data Entity
- = WalletEntity Wallet
- | PubKeyHashEntity PubKeyHash
- | ScriptEntity ValidatorHash
type WalletSet = Map Wallet WalletState
walletPaymentPubKeyHashes :: WalletSet -> Map PaymentPubKeyHash Wallet
balances :: ChainState -> WalletSet -> Map Entity Value

Documentation

newtype SigningProcess Source #

Constructors

SigningProcess
Fields unSigningProcess :: forall effs. Member (Error WalletAPIError) effs => [PaymentPubKeyHash] -> CardanoTx -> Eff effs CardanoTx

Instances

Instances details

Show SigningProcess Source #
Instance details Defined in Wallet.Emulator.Wallet Methods showsPrec :: Int -> SigningProcess -> ShowS Source # show :: SigningProcess -> String Source # showList :: [SigningProcess] -> ShowS Source #

data Wallet Source #

A wallet identifier

Constructors

Wallet
Fields prettyWalletName :: Maybe String getWalletId :: WalletId

Instances

Instances details

Eq Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods (==) :: Wallet -> Wallet -> Bool Source # (/=) :: Wallet -> Wallet -> Bool Source #
Data Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Wallet -> c Wallet Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Wallet Source # toConstr :: Wallet -> Constr Source # dataTypeOf :: Wallet -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Wallet) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Wallet) Source # gmapT :: (forall b. Data b => b -> b) -> Wallet -> Wallet Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Wallet -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Wallet -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Wallet -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Wallet -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Wallet -> m Wallet Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Wallet -> m Wallet Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Wallet -> m Wallet Source #
Ord Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods compare :: Wallet -> Wallet -> Ordering Source # (<) :: Wallet -> Wallet -> Bool Source # (<=) :: Wallet -> Wallet -> Bool Source # (>) :: Wallet -> Wallet -> Bool Source # (>=) :: Wallet -> Wallet -> Bool Source # max :: Wallet -> Wallet -> Wallet Source # min :: Wallet -> Wallet -> Wallet Source #
Show Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods showsPrec :: Int -> Wallet -> ShowS Source # show :: Wallet -> String Source # showList :: [Wallet] -> ShowS Source #
Generic Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Associated Types type Rep Wallet :: Type -> Type Source # Methods from :: Wallet -> Rep Wallet x Source # to :: Rep Wallet x -> Wallet Source #
FromJSON Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods parseJSON :: Value -> Parser Wallet parseJSONList :: Value -> Parser [Wallet]
ToJSON Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods toJSON :: Wallet -> Value toEncoding :: Wallet -> Encoding toJSONList :: [Wallet] -> Value toEncodingList :: [Wallet] -> Encoding
ToJSONKey Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods toJSONKey :: ToJSONKeyFunction Wallet toJSONKeyList :: ToJSONKeyFunction [Wallet]
Pretty Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods pretty :: Wallet -> Doc ann prettyList :: [Wallet] -> Doc ann
FromHttpApiData Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods parseUrlPiece :: Text -> Either Text Wallet parseHeader :: ByteString -> Either Text Wallet parseQueryParam :: Text -> Either Text Wallet
ToHttpApiData Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet Methods toUrlPiece :: Wallet -> Text toEncodedUrlPiece :: Wallet -> Builder toHeader :: Wallet -> ByteString toQueryParam :: Wallet -> Text
type Rep Wallet Source #
Instance details Defined in Wallet.Emulator.Wallet type Rep Wallet = D1 ('MetaData "Wallet" "Wallet.Emulator.Wallet" "plutus-contract-1.2.0.0-FH8LC9wh7UV4Nmv68NHXrC" 'False) (C1 ('MetaCons "Wallet" 'PrefixI 'True) (S1 ('MetaSel ('Just "prettyWalletName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: S1 ('MetaSel ('Just "getWalletId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 WalletId)))

toMockWallet :: MockWallet -> Wallet Source #

knownWallets :: [Wallet] Source #

knownWallet :: Integer -> Wallet Source #

fromWalletNumber :: WalletNumber -> Wallet Source #

newtype WalletId Source #

Constructors

WalletId
Fields unWalletId :: Digest Blake2b_160

Instances

Instances details

Eq WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Methods (==) :: WalletId -> WalletId -> Bool Source # (/=) :: WalletId -> WalletId -> Bool Source #
Data WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WalletId -> c WalletId Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WalletId Source # toConstr :: WalletId -> Constr Source # dataTypeOf :: WalletId -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c WalletId) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WalletId) Source # gmapT :: (forall b. Data b => b -> b) -> WalletId -> WalletId Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WalletId -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WalletId -> r Source # gmapQ :: (forall d. Data d => d -> u) -> WalletId -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> WalletId -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> WalletId -> m WalletId Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WalletId -> m WalletId Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WalletId -> m WalletId Source #
Ord WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Methods compare :: WalletId -> WalletId -> Ordering Source # (<) :: WalletId -> WalletId -> Bool Source # (<=) :: WalletId -> WalletId -> Bool Source # (>) :: WalletId -> WalletId -> Bool Source # (>=) :: WalletId -> WalletId -> Bool Source # max :: WalletId -> WalletId -> WalletId Source # min :: WalletId -> WalletId -> WalletId Source #
Show WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Methods showsPrec :: Int -> WalletId -> ShowS Source # show :: WalletId -> String Source # showList :: [WalletId] -> ShowS Source #
Generic WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Associated Types type Rep WalletId :: Type -> Type Source # Methods from :: WalletId -> Rep WalletId x Source # to :: Rep WalletId x -> WalletId Source #
FromJSON WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Methods parseJSON :: Value -> Parser WalletId parseJSONList :: Value -> Parser [WalletId]
ToJSON WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Methods toJSON :: WalletId -> Value toEncoding :: WalletId -> Encoding toJSONList :: [WalletId] -> Value toEncodingList :: [WalletId] -> Encoding
ToJSONKey WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Methods toJSONKey :: ToJSONKeyFunction WalletId toJSONKeyList :: ToJSONKeyFunction [WalletId]
FromHttpApiData WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Methods parseUrlPiece :: Text -> Either Text WalletId parseHeader :: ByteString -> Either Text WalletId parseQueryParam :: Text -> Either Text WalletId
ToHttpApiData WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet Methods toUrlPiece :: WalletId -> Text toEncodedUrlPiece :: WalletId -> Builder toHeader :: WalletId -> ByteString toQueryParam :: WalletId -> Text
type Rep WalletId Source #
Instance details Defined in Wallet.Emulator.Wallet type Rep WalletId = D1 ('MetaData "WalletId" "Wallet.Emulator.Wallet" "plutus-contract-1.2.0.0-FH8LC9wh7UV4Nmv68NHXrC" 'True) (C1 ('MetaCons "WalletId" 'PrefixI 'True) (S1 ('MetaSel ('Just "unWalletId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Digest Blake2b_160))))

toBase16 :: WalletId -> Text Source #

fromBase16 :: Text -> Either String WalletId Source #

walletToMockWallet :: Wallet -> Maybe MockWallet Source #

The MockWallet whose ID is the given wallet ID (if it exists)

walletToMockWallet' :: Wallet -> MockWallet Source #

The same as walletToMockWallet but fails with an error instead of returning Nothing.

mockWalletPaymentPubKey :: Wallet -> PaymentPubKey Source #

The public key of a mock wallet. (Fails if the wallet is not a mock wallet).

mockWalletPaymentPubKeyHash :: Wallet -> PaymentPubKeyHash Source #

The payment public key hash of a mock wallet. (Fails if the wallet is not a mock wallet).

mockWalletAddress :: Wallet -> CardanoAddress Source #

Get the cardano address of a mock wallet. (Fails if the wallet is not a mock wallet).

data WalletEvent Source #

Constructors

GenericLog Text
CheckpointLog CheckpointLogMsg
RequestHandlerLog RequestHandlerLogMsg
TxBalanceLog TxBalanceMsg

Instances

Instances details

Eq WalletEvent Source #
Instance details Defined in Wallet.Emulator.Wallet Methods (==) :: WalletEvent -> WalletEvent -> Bool Source # (/=) :: WalletEvent -> WalletEvent -> Bool Source #
Show WalletEvent Source #
Instance details Defined in Wallet.Emulator.Wallet Methods showsPrec :: Int -> WalletEvent -> ShowS Source # show :: WalletEvent -> String Source # showList :: [WalletEvent] -> ShowS Source #
Generic WalletEvent Source #
Instance details Defined in Wallet.Emulator.Wallet Associated Types type Rep WalletEvent :: Type -> Type Source # Methods from :: WalletEvent -> Rep WalletEvent x Source # to :: Rep WalletEvent x -> WalletEvent Source #
FromJSON WalletEvent Source #
Instance details Defined in Wallet.Emulator.Wallet Methods parseJSON :: Value -> Parser WalletEvent parseJSONList :: Value -> Parser [WalletEvent]
ToJSON WalletEvent Source #
Instance details Defined in Wallet.Emulator.Wallet Methods toJSON :: WalletEvent -> Value toEncoding :: WalletEvent -> Encoding toJSONList :: [WalletEvent] -> Value toEncodingList :: [WalletEvent] -> Encoding
Pretty WalletEvent Source #
Instance details Defined in Wallet.Emulator.Wallet Methods pretty :: WalletEvent -> Doc ann prettyList :: [WalletEvent] -> Doc ann
type Rep WalletEvent Source #
Instance details Defined in Wallet.Emulator.Wallet type Rep WalletEvent = D1 ('MetaData "WalletEvent" "Wallet.Emulator.Wallet" "plutus-contract-1.2.0.0-FH8LC9wh7UV4Nmv68NHXrC" 'False) ((C1 ('MetaCons "GenericLog" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "CheckpointLog" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CheckpointLogMsg))) :+: (C1 ('MetaCons "RequestHandlerLog" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RequestHandlerLogMsg)) :+: C1 ('MetaCons "TxBalanceLog" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxBalanceMsg))))

_TxBalanceLog :: Prism' WalletEvent TxBalanceMsg Source #

_RequestHandlerLog :: Prism' WalletEvent RequestHandlerLogMsg Source #

_CheckpointLog :: Prism' WalletEvent CheckpointLogMsg Source #

_GenericLog :: Prism' WalletEvent Text Source #

data WalletState Source #

The state used by the mock wallet environment.

Constructors

WalletState
Fields _mockWallet :: MockWallet Mock wallet with the user's private key. _nodeClient :: NodeClientState The representation of the node, as known by the wallet _chainIndexEmulatorState :: ChainIndexEmulatorState the chain index info known by the wallet _signingProcess :: Maybe SigningProcess Override the signing process. Used for testing multi-agent use cases.

Instances

Instances details

Show WalletState Source #
Instance details Defined in Wallet.Emulator.Wallet Methods showsPrec :: Int -> WalletState -> ShowS Source # show :: WalletState -> String Source # showList :: [WalletState] -> ShowS Source #

signingProcess :: Lens' WalletState (Maybe SigningProcess) Source #

nodeClient :: Lens' WalletState NodeClientState Source #

mockWallet :: Lens' WalletState MockWallet Source #

chainIndexEmulatorState :: Lens' WalletState ChainIndexEmulatorState Source #

ownPaymentPrivateKey :: WalletState -> PaymentPrivateKey Source #

ownPaymentPublicKey :: WalletState -> PaymentPubKey Source #

ownAddress :: WalletState -> CardanoAddress Source #

Get the user's own payment public-key address.

fromMockWallet :: MockWallet -> WalletState Source #

An empty wallet using the given private key. for that wallet as the sole watched address.

emptyWalletState :: Wallet -> Maybe WalletState Source #

Empty wallet state for an emulator Wallet. Returns Nothing if the wallet is not known in the emulator.

handleWallet :: (Member (Error WalletAPIError) effs, Member NodeClientEffect effs, Member ChainIndexQueryEffect effs, Member (State WalletState) effs, Member (LogMsg TxBalanceMsg) effs) => WalletEffect ~> Eff effs Source #

handleBalance :: (Member NodeClientEffect effs, Member ChainIndexQueryEffect effs, Member (State WalletState) effs, Member (LogMsg TxBalanceMsg) effs, Member (Error WalletAPIError) effs) => UnbalancedTx -> Eff effs CardanoTx Source #

handleAddSignature :: (Member (State WalletState) effs, Member (Error WalletAPIError) effs) => CardanoTx -> Eff effs CardanoTx Source #

ownOutputs :: forall effs. (Member ChainIndexQueryEffect effs, Member (State WalletState) effs, Member NodeClientEffect effs, Member (Error WalletAPIError) effs) => Eff effs UtxoIndex Source #

defaultSigningProcess :: MockWallet -> SigningProcess Source #

The default signing process is signWallet

signWithPrivateKey :: PaymentPrivateKey -> SigningProcess Source #

signWallet :: MockWallet -> SigningProcess Source #

Sign the transaction by calling signTxnWithKey (throwing a PrivateKeyNotFound error if called with a key other than the wallet's private key)

signTxnWithKey :: Member (Error WalletAPIError) r => MockWallet -> CardanoTx -> PaymentPubKeyHash -> Eff r CardanoTx Source #

Sign the transaction with the private key of the mock wallet.

signTxWithPrivateKey :: Member (Error WalletAPIError) r => PaymentPrivateKey -> CardanoTx -> PaymentPubKeyHash -> Eff r CardanoTx Source #

Sign the transaction with the private key, if the hash is that of the private key.

signPrivateKeys :: [PaymentPrivateKey] -> SigningProcess Source #

Sign the transaction with the given private keys, ignoring the list of public keys that the SigningProcess is passed.

data SigningProcessControlEffect r where Source #

Constructors

SetSigningProcess :: Maybe SigningProcess -> SigningProcessControlEffect ()

setSigningProcess :: forall effs. Member SigningProcessControlEffect effs => Maybe SigningProcess -> Eff effs () Source #

type SigningProcessEffs = '[State (Maybe SigningProcess), Error WalletAPIError] Source #

handleSigningProcessControl :: Members SigningProcessEffs effs => Eff (SigningProcessControlEffect ': effs) ~> Eff effs Source #

data Entity Source #

An Entity is a thing that can hold Value. Used in the balances function to compute who holds for a given chain state and set of wallets.

Constructors

WalletEntity Wallet
PubKeyHashEntity PubKeyHash
ScriptEntity ValidatorHash

Instances

Instances details

Eq Entity Source #
Instance details Defined in Wallet.Emulator.Wallet Methods (==) :: Entity -> Entity -> Bool Source # (/=) :: Entity -> Entity -> Bool Source #
Ord Entity Source #
Instance details Defined in Wallet.Emulator.Wallet Methods compare :: Entity -> Entity -> Ordering Source # (<) :: Entity -> Entity -> Bool Source # (<=) :: Entity -> Entity -> Bool Source # (>) :: Entity -> Entity -> Bool Source # (>=) :: Entity -> Entity -> Bool Source # max :: Entity -> Entity -> Entity Source # min :: Entity -> Entity -> Entity Source #
Show Entity Source #
Instance details Defined in Wallet.Emulator.Wallet Methods showsPrec :: Int -> Entity -> ShowS Source # show :: Entity -> String Source # showList :: [Entity] -> ShowS Source #

type WalletSet = Map Wallet WalletState Source #

walletPaymentPubKeyHashes :: WalletSet -> Map PaymentPubKeyHash Wallet Source #

Pick out all the public keys from the set of wallets and map them back to their corresponding wallets.

balances :: ChainState -> WalletSet -> Map Entity Value Source #

For a set of wallets, convert them into a map of value: entity, where entity is one of Entity.