Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	None
Language	GHC2021

GeniusYield.Test.Privnet.Ctx

Contents

Context
User
Operations
Helpers

Description

Synopsis

data Ctx = Ctx {
- ctxNetworkInfo :: !GYNetworkInfo
- ctxInfo :: !LocalNodeConnectInfo
- ctxUserF :: !User
- ctxUser2 :: !User
- ctxUser3 :: !User
- ctxUser4 :: !User
- ctxUser5 :: !User
- ctxUser6 :: !User
- ctxUser7 :: !User
- ctxUser8 :: !User
- ctxUser9 :: !User
- ctxGold :: !GYAssetClass
- ctxIron :: !GYAssetClass
- ctxLog :: !GYLogConfiguration
- ctxLookupDatum :: !GYLookupDatum
- ctxAwaitTxConfirmed :: !GYAwaitTx
- ctxQueryUtxos :: !GYQueryUTxO
- ctxGetParams :: !GYGetParameters
- ctxCommittee :: !CtxCommittee
}
data CtxCommittee = CtxCommittee {
- ctxCommitteeMembers :: !(Map (GYSigningKey 'GYKeyRoleColdCommittee) GYEpochNo)
- ctxCommitteeThreshold :: !UnitInterval
}
ctxNetworkId :: Ctx -> GYNetworkId
data User = User {
- userPaymentSKey :: !GYPaymentSigningKey
- userStakeSKey :: !(Maybe GYStakeSigningKey)
- userAddresses :: !(NonEmpty GYAddress)
- userChangeAddress :: !GYAddress
- userCollateral :: Maybe UserCollateral
}
data CreateUserConfig = CreateUserConfig {
- cucGenerateCollateral :: !Bool
- cucGenerateStakeKey :: !Bool
}
ctxUsers :: Ctx -> [User]
ctxWallets :: Ctx -> Wallets
userPkh :: User -> GYPubKeyHash
userPaymentPkh :: User -> GYPaymentKeyHash
userStakePkh :: User -> Maybe GYStakeKeyHash
userVKey :: User -> GYPaymentVerificationKey
userPaymentVKey :: User -> GYPaymentVerificationKey
userStakeVKey :: User -> Maybe GYStakeVerificationKey
ctxRunGame :: Ctx -> GYTxGameMonadIO a -> IO a
ctxRun :: Ctx -> User -> GYTxMonadIO a -> IO a
ctxRunQuery :: Ctx -> GYTxQueryMonadIO a -> IO a
ctxRunBuilder :: Ctx -> User -> GYTxBuilderMonadIO a -> IO a
ctxRunBuilderWithCollateral :: Ctx -> User -> GYTxOutRef -> Bool -> GYTxBuilderMonadIO a -> IO a
ctxSlotOfCurrentBlock :: Ctx -> IO GYSlot
ctxWaitNextBlock :: Ctx -> IO ()
ctxWaitUntilSlot :: Ctx -> GYSlot -> IO ()
ctxProviders :: Ctx -> GYProviders
ctxSlotConfig :: Ctx -> IO GYSlotConfig
newTempUserCtx :: Ctx -> User -> GYValue -> CreateUserConfig -> IO User
ctxQueryBalance :: Ctx -> User -> IO GYValue
findOutput :: GYAddress -> GYTxBody -> IO GYTxOutRef

Context

data Ctx #

Constructors

Ctx

Fields

ctxNetworkInfo :: !GYNetworkInfo
ctxInfo :: !LocalNodeConnectInfo
ctxUserF :: !User
Funder. All other users begin with same status of funds.
ctxUser2 :: !User
ctxUser3 :: !User
ctxUser4 :: !User
ctxUser5 :: !User
ctxUser6 :: !User
ctxUser7 :: !User
ctxUser8 :: !User
ctxUser9 :: !User
ctxGold :: !GYAssetClass
asset used in tests
ctxIron :: !GYAssetClass
asset used in tests
ctxLog :: !GYLogConfiguration
ctxLookupDatum :: !GYLookupDatum
ctxAwaitTxConfirmed :: !GYAwaitTx
ctxQueryUtxos :: !GYQueryUTxO
ctxGetParams :: !GYGetParameters
ctxCommittee :: !CtxCommittee

data CtxCommittee #

Constructors

CtxCommittee
Fields ctxCommitteeMembers :: !(Map (GYSigningKey 'GYKeyRoleColdCommittee) GYEpochNo) Committee members with epoch number when each of them expires ctxCommitteeThreshold :: !UnitInterval Threshold of the committee that is necessary for a successful vote

Instances

Instances details

Show CtxCommittee #
Instance details Defined in GeniusYield.Test.Privnet.Ctx Methods showsPrec :: Int -> CtxCommittee -> ShowS # show :: CtxCommittee -> String # showList :: [CtxCommittee] -> ShowS #

ctxNetworkId :: Ctx -> GYNetworkId #

User

data User #

Note: When signing using ToShelleyWitnessSigningKey instance, it only uses the payment signing key.

Constructors

User
Fields userPaymentSKey :: !GYPaymentSigningKey userStakeSKey :: !(Maybe GYStakeSigningKey) userAddresses :: !(NonEmpty GYAddress) userChangeAddress :: !GYAddress userCollateral :: Maybe UserCollateral

Instances

Instances details

ToShelleyWitnessSigningKey User #	This only takes the payment signing key, not the stake key.
Instance details Defined in GeniusYield.TxBuilder.User Methods toShelleyWitnessSigningKey :: User -> ShelleyWitnessSigningKey #
Show User #
Instance details Defined in GeniusYield.TxBuilder.User Methods showsPrec :: Int -> User -> ShowS # show :: User -> String # showList :: [User] -> ShowS #
Eq User #
Instance details Defined in GeniusYield.TxBuilder.User Methods (==) :: User -> User -> Bool # (/=) :: User -> User -> Bool #
Ord User #
Instance details Defined in GeniusYield.TxBuilder.User Methods compare :: User -> User -> Ordering # (<) :: User -> User -> Bool # (<=) :: User -> User -> Bool # (>) :: User -> User -> Bool # (>=) :: User -> User -> Bool # max :: User -> User -> User # min :: User -> User -> User #

data CreateUserConfig #

Constructors

CreateUserConfig
Fields cucGenerateCollateral :: !Bool Create collateral output of 5 ada? cucGenerateStakeKey :: !Bool Create a stake key for the user?

Instances

Instances details

Default CreateUserConfig #
Instance details Defined in GeniusYield.Test.Privnet.Ctx Methods def :: CreateUserConfig #

ctxUsers :: Ctx -> [User] #

List of context sibling users - all of which begin with same balance. FIXME: Some of these users are actually genesis users.

ctxWallets :: Ctx -> Wallets #

userPkh :: User -> GYPubKeyHash #

userPaymentPkh :: User -> GYPaymentKeyHash #

userStakePkh :: User -> Maybe GYStakeKeyHash #

userVKey :: User -> GYPaymentVerificationKey #

Deprecated: Use userPaymentVKey.

userPaymentVKey :: User -> GYPaymentVerificationKey #

userStakeVKey :: User -> Maybe GYStakeVerificationKey #

Operations

ctxRunGame :: Ctx -> GYTxGameMonadIO a -> IO a #

ctxRun :: Ctx -> User -> GYTxMonadIO a -> IO a #

ctxRunQuery :: Ctx -> GYTxQueryMonadIO a -> IO a #

ctxRunBuilder :: Ctx -> User -> GYTxBuilderMonadIO a -> IO a #

ctxRunBuilderWithCollateral #

Arguments

:: Ctx
-> User
-> GYTxOutRef	Reference to UTxO to be used as collateral.
-> Bool	To check whether this given collateral UTxO has value of exact 5 ada? If it doesn't have exact 5 ada, it would be ignored.
-> GYTxBuilderMonadIO a
-> IO a

Variant of ctxRun where caller can also give the UTxO to be used as collateral.

ctxSlotOfCurrentBlock :: Ctx -> IO GYSlot #

ctxWaitNextBlock :: Ctx -> IO () #

ctxWaitUntilSlot :: Ctx -> GYSlot -> IO () #

ctxProviders :: Ctx -> GYProviders #

ctxSlotConfig :: Ctx -> IO GYSlotConfig #

Helpers

newTempUserCtx #

Arguments

:: Ctx
-> User	User which will fund this new user.
-> GYValue	Describes balance of new user.
-> CreateUserConfig
-> IO User

Creates a new user with the given balance. Note that the actual balance which this user get's could be more than what is provided to satisfy minimum ada requirement of a UTxO.

ctxQueryBalance :: Ctx -> User -> IO GYValue #

findOutput :: GYAddress -> GYTxBody -> IO GYTxOutRef #

Function to find for the first locked output in the given GYTxBody at the given GYAddress.