Safe Haskell	None
Language	Haskell2010

Plutus.Contracts.Stablecoin

Contents

State machine client
Contract using the state machine
Etc.

Synopsis

newtype SC a = SC {
- unSC :: a
}
newtype RC a = RC {
- unRC :: a
}
newtype BC a = BC {
- unBC :: a
}
newtype PC a = PC {
- unPC :: a
}
data BankState = BankState {
- bsReserves :: BC Integer
- bsStablecoins :: SC Integer
- bsReservecoins :: RC Integer
- bsMintingPolicyScript :: MintingPolicyHash
}
data Stablecoin = Stablecoin {
- scOracle :: PaymentPubKey
- scFee :: Rational
- scMinReserveRatio :: Rational
- scMaxReserveRatio :: Rational
- scReservecoinDefaultPrice :: BC Integer
- scBaseCurrency :: AssetClass
- scStablecoinTokenName :: TokenName
- scReservecoinTokenName :: TokenName
}
data Input = Input {
- inpSCAction :: SCAction
- inpConversionRate :: SignedMessage (Observation ConversionRate)
}
data SCAction
- = MintStablecoin (SC Integer)
- | MintReserveCoin (RC Integer)
type ConversionRate = Rational
typedValidator :: Stablecoin -> TypedValidator (StateMachine BankState Input)
machineClient :: TypedValidator (StateMachine BankState Input) -> Stablecoin -> StateMachineClient BankState Input
step :: forall i o. Stablecoin -> BankState -> Input -> Maybe (TxConstraints i o, BankState)
contract :: Promise () StablecoinSchema StablecoinError ()
data StablecoinError
type StablecoinSchema = Endpoint "run step" Input .\/ Endpoint "initialise" Stablecoin
stableCoins :: Stablecoin -> SC Integer -> Value
reserveCoins :: Stablecoin -> RC Integer -> Value
checkValidState :: Stablecoin -> BankState -> ConversionRate -> Either InvalidStateReason ()

Documentation

newtype SC a Source #

An amount of stablecoins

Constructors

SC
Fields unSC :: a

Instances

Instances details

Functor SC Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fmap :: (a -> b) -> SC a -> SC b Source #
Lift DefaultUni a => Lift DefaultUni (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods lift :: SC a -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Eq a => Eq (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: SC a -> SC a -> Bool Source # (/=) :: SC a -> SC a -> Bool Source #
Num a => Num (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (+) :: SC a -> SC a -> SC a Source # (-) :: SC a -> SC a -> SC a Source # (*) :: SC a -> SC a -> SC a Source # negate :: SC a -> SC a Source # abs :: SC a -> SC a Source # signum :: SC a -> SC a Source # fromInteger :: Integer -> SC a Source #
Show a => Show (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods showsPrec :: Int -> SC a -> ShowS Source # show :: SC a -> String Source # showList :: [SC a] -> ShowS Source #
Generic (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Associated Types type Rep (SC a) :: Type -> Type Source # Methods from :: SC a -> Rep (SC a) x Source # to :: Rep (SC a) x -> SC a Source #
ToJSON a => ToJSON (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toJSON :: SC a -> Value Source # toEncoding :: SC a -> Encoding Source # toJSONList :: [SC a] -> Value Source # toEncodingList :: [SC a] -> Encoding Source #
FromJSON a => FromJSON (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods parseJSON :: Value -> Parser (SC a) Source # parseJSONList :: Value -> Parser [SC a] Source #
UnsafeFromData a => UnsafeFromData (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods unsafeFromBuiltinData :: BuiltinData -> SC a Source #
FromData a => FromData (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fromBuiltinData :: BuiltinData -> Maybe (SC a) Source #
ToData a => ToData (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toBuiltinData :: SC a -> BuiltinData Source #
AdditiveSemigroup a => AdditiveSemigroup (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (+) :: SC a -> SC a -> SC a Source #
AdditiveMonoid a => AdditiveMonoid (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods zero :: SC a Source #
AdditiveGroup a => AdditiveGroup (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (-) :: SC a -> SC a -> SC a Source #
MultiplicativeSemigroup a => MultiplicativeSemigroup (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (*) :: SC a -> SC a -> SC a Source #
Ord a => Ord (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods compare :: SC a -> SC a -> Ordering Source # (<) :: SC a -> SC a -> Bool Source # (<=) :: SC a -> SC a -> Bool Source # (>) :: SC a -> SC a -> Bool Source # (>=) :: SC a -> SC a -> Bool Source # max :: SC a -> SC a -> SC a Source # min :: SC a -> SC a -> SC a Source #
Eq a => Eq (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: SC a -> SC a -> Bool Source #
Typeable DefaultUni SC Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods typeRep :: Proxy SC -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep (SC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin type Rep (SC a) = D1 ('MetaData "SC" "Plutus.Contracts.Stablecoin" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'True) (C1 ('MetaCons "SC" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

newtype RC a Source #

An amount of reservecoins

Constructors

RC
Fields unRC :: a

Instances

Instances details

Functor RC Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fmap :: (a -> b) -> RC a -> RC b Source #
Lift DefaultUni a => Lift DefaultUni (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods lift :: RC a -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Eq a => Eq (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: RC a -> RC a -> Bool Source # (/=) :: RC a -> RC a -> Bool Source #
Num a => Num (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (+) :: RC a -> RC a -> RC a Source # (-) :: RC a -> RC a -> RC a Source # (*) :: RC a -> RC a -> RC a Source # negate :: RC a -> RC a Source # abs :: RC a -> RC a Source # signum :: RC a -> RC a Source # fromInteger :: Integer -> RC a Source #
Show a => Show (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods showsPrec :: Int -> RC a -> ShowS Source # show :: RC a -> String Source # showList :: [RC a] -> ShowS Source #
Generic (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Associated Types type Rep (RC a) :: Type -> Type Source # Methods from :: RC a -> Rep (RC a) x Source # to :: Rep (RC a) x -> RC a Source #
ToJSON a => ToJSON (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toJSON :: RC a -> Value Source # toEncoding :: RC a -> Encoding Source # toJSONList :: [RC a] -> Value Source # toEncodingList :: [RC a] -> Encoding Source #
FromJSON a => FromJSON (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods parseJSON :: Value -> Parser (RC a) Source # parseJSONList :: Value -> Parser [RC a] Source #
UnsafeFromData a => UnsafeFromData (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods unsafeFromBuiltinData :: BuiltinData -> RC a Source #
FromData a => FromData (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fromBuiltinData :: BuiltinData -> Maybe (RC a) Source #
ToData a => ToData (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toBuiltinData :: RC a -> BuiltinData Source #
AdditiveSemigroup a => AdditiveSemigroup (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (+) :: RC a -> RC a -> RC a Source #
AdditiveMonoid a => AdditiveMonoid (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods zero :: RC a Source #
AdditiveGroup a => AdditiveGroup (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (-) :: RC a -> RC a -> RC a Source #
MultiplicativeSemigroup a => MultiplicativeSemigroup (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (*) :: RC a -> RC a -> RC a Source #
Ord a => Ord (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods compare :: RC a -> RC a -> Ordering Source # (<) :: RC a -> RC a -> Bool Source # (<=) :: RC a -> RC a -> Bool Source # (>) :: RC a -> RC a -> Bool Source # (>=) :: RC a -> RC a -> Bool Source # max :: RC a -> RC a -> RC a Source # min :: RC a -> RC a -> RC a Source #
Eq a => Eq (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: RC a -> RC a -> Bool Source #
Typeable DefaultUni RC Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods typeRep :: Proxy RC -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep (RC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin type Rep (RC a) = D1 ('MetaData "RC" "Plutus.Contracts.Stablecoin" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'True) (C1 ('MetaCons "RC" 'PrefixI 'True) (S1 ('MetaSel ('Just "unRC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

newtype BC a Source #

An amount of base currency coins (eg. Ada or some native currency)

Constructors

BC
Fields unBC :: a

Instances

Instances details

Functor BC Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fmap :: (a -> b) -> BC a -> BC b Source #
Lift DefaultUni a => Lift DefaultUni (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods lift :: BC a -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Eq a => Eq (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: BC a -> BC a -> Bool Source # (/=) :: BC a -> BC a -> Bool Source #
Num a => Num (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (+) :: BC a -> BC a -> BC a Source # (-) :: BC a -> BC a -> BC a Source # (*) :: BC a -> BC a -> BC a Source # negate :: BC a -> BC a Source # abs :: BC a -> BC a Source # signum :: BC a -> BC a Source # fromInteger :: Integer -> BC a Source #
Show a => Show (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods showsPrec :: Int -> BC a -> ShowS Source # show :: BC a -> String Source # showList :: [BC a] -> ShowS Source #
Generic (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Associated Types type Rep (BC a) :: Type -> Type Source # Methods from :: BC a -> Rep (BC a) x Source # to :: Rep (BC a) x -> BC a Source #
ToJSON a => ToJSON (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toJSON :: BC a -> Value Source # toEncoding :: BC a -> Encoding Source # toJSONList :: [BC a] -> Value Source # toEncodingList :: [BC a] -> Encoding Source #
FromJSON a => FromJSON (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods parseJSON :: Value -> Parser (BC a) Source # parseJSONList :: Value -> Parser [BC a] Source #
UnsafeFromData a => UnsafeFromData (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods unsafeFromBuiltinData :: BuiltinData -> BC a Source #
FromData a => FromData (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fromBuiltinData :: BuiltinData -> Maybe (BC a) Source #
ToData a => ToData (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toBuiltinData :: BC a -> BuiltinData Source #
AdditiveSemigroup a => AdditiveSemigroup (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (+) :: BC a -> BC a -> BC a Source #
AdditiveMonoid a => AdditiveMonoid (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods zero :: BC a Source #
AdditiveGroup a => AdditiveGroup (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (-) :: BC a -> BC a -> BC a Source #
MultiplicativeSemigroup a => MultiplicativeSemigroup (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (*) :: BC a -> BC a -> BC a Source #
Ord a => Ord (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods compare :: BC a -> BC a -> Ordering Source # (<) :: BC a -> BC a -> Bool Source # (<=) :: BC a -> BC a -> Bool Source # (>) :: BC a -> BC a -> Bool Source # (>=) :: BC a -> BC a -> Bool Source # max :: BC a -> BC a -> BC a Source # min :: BC a -> BC a -> BC a Source #
Eq a => Eq (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: BC a -> BC a -> Bool Source #
Typeable DefaultUni BC Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods typeRep :: Proxy BC -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep (BC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin type Rep (BC a) = D1 ('MetaData "BC" "Plutus.Contracts.Stablecoin" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'True) (C1 ('MetaCons "BC" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

newtype PC a Source #

An amount of peg currency (eg. USD)

Constructors

PC
Fields unPC :: a

Instances

Instances details

Functor PC Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fmap :: (a -> b) -> PC a -> PC b Source #
Lift DefaultUni a => Lift DefaultUni (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods lift :: PC a -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Eq a => Eq (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: PC a -> PC a -> Bool Source # (/=) :: PC a -> PC a -> Bool Source #
Num a => Num (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (+) :: PC a -> PC a -> PC a Source # (-) :: PC a -> PC a -> PC a Source # (*) :: PC a -> PC a -> PC a Source # negate :: PC a -> PC a Source # abs :: PC a -> PC a Source # signum :: PC a -> PC a Source # fromInteger :: Integer -> PC a Source #
Show a => Show (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods showsPrec :: Int -> PC a -> ShowS Source # show :: PC a -> String Source # showList :: [PC a] -> ShowS Source #
Generic (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Associated Types type Rep (PC a) :: Type -> Type Source # Methods from :: PC a -> Rep (PC a) x Source # to :: Rep (PC a) x -> PC a Source #
ToJSON a => ToJSON (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toJSON :: PC a -> Value Source # toEncoding :: PC a -> Encoding Source # toJSONList :: [PC a] -> Value Source # toEncodingList :: [PC a] -> Encoding Source #
FromJSON a => FromJSON (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods parseJSON :: Value -> Parser (PC a) Source # parseJSONList :: Value -> Parser [PC a] Source #
UnsafeFromData a => UnsafeFromData (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods unsafeFromBuiltinData :: BuiltinData -> PC a Source #
FromData a => FromData (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fromBuiltinData :: BuiltinData -> Maybe (PC a) Source #
ToData a => ToData (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toBuiltinData :: PC a -> BuiltinData Source #
AdditiveSemigroup a => AdditiveSemigroup (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (+) :: PC a -> PC a -> PC a Source #
AdditiveMonoid a => AdditiveMonoid (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods zero :: PC a Source #
AdditiveGroup a => AdditiveGroup (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (-) :: PC a -> PC a -> PC a Source #
MultiplicativeSemigroup a => MultiplicativeSemigroup (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (*) :: PC a -> PC a -> PC a Source #
Ord a => Ord (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods compare :: PC a -> PC a -> Ordering Source # (<) :: PC a -> PC a -> Bool Source # (<=) :: PC a -> PC a -> Bool Source # (>) :: PC a -> PC a -> Bool Source # (>=) :: PC a -> PC a -> Bool Source # max :: PC a -> PC a -> PC a Source # min :: PC a -> PC a -> PC a Source #
Eq a => Eq (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: PC a -> PC a -> Bool Source #
Typeable DefaultUni PC Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods typeRep :: Proxy PC -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep (PC a) Source #
Instance details Defined in Plutus.Contracts.Stablecoin type Rep (PC a) = D1 ('MetaData "PC" "Plutus.Contracts.Stablecoin" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'True) (C1 ('MetaCons "PC" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data BankState Source #

The bank's state

Constructors

BankState

Fields

bsReserves :: BC Integer
Value of the bank's reserves in base currency
bsStablecoins :: SC Integer
Amount of stablecoins in circulation
bsReservecoins :: RC Integer
Amount of reservecoins currently in circulation
bsMintingPolicyScript :: MintingPolicyHash
Hash of the minting policy that forwards all checks to the state machine. (This has to be in this type, rather than in Stablecoin, to avoid a circular dependency on the script's hash)

Instances

Instances details

Eq BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: BankState -> BankState -> Bool Source # (/=) :: BankState -> BankState -> Bool Source #
Show BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods showsPrec :: Int -> BankState -> ShowS Source # show :: BankState -> String Source # showList :: [BankState] -> ShowS Source #
Generic BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Associated Types type Rep BankState :: Type -> Type Source # Methods from :: BankState -> Rep BankState x Source # to :: Rep BankState x -> BankState Source #
ToJSON BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toJSON :: BankState -> Value Source # toEncoding :: BankState -> Encoding Source # toJSONList :: [BankState] -> Value Source # toEncodingList :: [BankState] -> Encoding Source #
FromJSON BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods parseJSON :: Value -> Parser BankState Source # parseJSONList :: Value -> Parser [BankState] Source #
UnsafeFromData BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods unsafeFromBuiltinData :: BuiltinData -> BankState Source #
FromData BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fromBuiltinData :: BuiltinData -> Maybe BankState Source #
ToData BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toBuiltinData :: BankState -> BuiltinData Source #
Lift DefaultUni BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods lift :: BankState -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods typeRep :: Proxy BankState -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep BankState Source #
Instance details Defined in Plutus.Contracts.Stablecoin type Rep BankState = D1 ('MetaData "BankState" "Plutus.Contracts.Stablecoin" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "BankState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bsReserves") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (BC Integer)) :: S1 ('MetaSel ('Just "bsStablecoins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SC Integer))) :: (S1 ('MetaSel ('Just "bsReservecoins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RC Integer)) :*: S1 ('MetaSel ('Just "bsMintingPolicyScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MintingPolicyHash))))

data Stablecoin Source #

Stablecoin parameters.

Constructors

Stablecoin

Fields

scOracle :: PaymentPubKey
Public key of the oracle that provides exchange rates
scFee :: Rational
Fee charged by bank for transactions. Calculated as a fraction of the total transaction volume in base currency.
scMinReserveRatio :: Rational
The minimum ratio of reserves to liabilities
scMaxReserveRatio :: Rational
The maximum ratio of reserves to liabilities
scReservecoinDefaultPrice :: BC Integer
The price of a single reservecoin if no reservecoins have been issued
scBaseCurrency :: AssetClass
The asset class of the base currency. Value of this currency will be locked by the stablecoin state machine instance
scStablecoinTokenName :: TokenName
TokenName of the stablecoin
scReservecoinTokenName :: TokenName
TokenName of the reservecoin

Instances

Instances details

Eq Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: Stablecoin -> Stablecoin -> Bool Source # (/=) :: Stablecoin -> Stablecoin -> Bool Source #
Show Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods showsPrec :: Int -> Stablecoin -> ShowS Source # show :: Stablecoin -> String Source # showList :: [Stablecoin] -> ShowS Source #
Generic Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Associated Types type Rep Stablecoin :: Type -> Type Source # Methods from :: Stablecoin -> Rep Stablecoin x Source # to :: Rep Stablecoin x -> Stablecoin Source #
ToJSON Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toJSON :: Stablecoin -> Value Source # toEncoding :: Stablecoin -> Encoding Source # toJSONList :: [Stablecoin] -> Value Source # toEncodingList :: [Stablecoin] -> Encoding Source #
FromJSON Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods parseJSON :: Value -> Parser Stablecoin Source # parseJSONList :: Value -> Parser [Stablecoin] Source #
UnsafeFromData Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods unsafeFromBuiltinData :: BuiltinData -> Stablecoin Source #
FromData Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fromBuiltinData :: BuiltinData -> Maybe Stablecoin Source #
ToData Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toBuiltinData :: Stablecoin -> BuiltinData Source #
Lift DefaultUni Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods lift :: Stablecoin -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods typeRep :: Proxy Stablecoin -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep Stablecoin Source #
Instance details Defined in Plutus.Contracts.Stablecoin type Rep Stablecoin = D1 ('MetaData "Stablecoin" "Plutus.Contracts.Stablecoin" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "Stablecoin" 'PrefixI 'True) (((S1 ('MetaSel ('Just "scOracle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PaymentPubKey) :: S1 ('MetaSel ('Just "scFee") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational)) :: (S1 ('MetaSel ('Just "scMinReserveRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational) :: S1 ('MetaSel ('Just "scMaxReserveRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational))) :: ((S1 ('MetaSel ('Just "scReservecoinDefaultPrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (BC Integer)) :: S1 ('MetaSel ('Just "scBaseCurrency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssetClass)) :: (S1 ('MetaSel ('Just "scStablecoinTokenName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenName) :*: S1 ('MetaSel ('Just "scReservecoinTokenName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TokenName)))))

data Input Source #

Input to the stablecoin state machine

Constructors

Input
Fields inpSCAction :: SCAction The action to be performed inpConversionRate :: SignedMessage (Observation ConversionRate) Exchange rate between base currency and peg currency

Instances

Instances details

Eq Input Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: Input -> Input -> Bool Source # (/=) :: Input -> Input -> Bool Source #
Show Input Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods showsPrec :: Int -> Input -> ShowS Source # show :: Input -> String Source # showList :: [Input] -> ShowS Source #
Generic Input Source #
Instance details Defined in Plutus.Contracts.Stablecoin Associated Types type Rep Input :: Type -> Type Source # Methods from :: Input -> Rep Input x Source # to :: Rep Input x -> Input Source #
ToJSON Input Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toJSON :: Input -> Value Source # toEncoding :: Input -> Encoding Source # toJSONList :: [Input] -> Value Source # toEncodingList :: [Input] -> Encoding Source #
FromJSON Input Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods parseJSON :: Value -> Parser Input Source # parseJSONList :: Value -> Parser [Input] Source #
UnsafeFromData Input Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods unsafeFromBuiltinData :: BuiltinData -> Input Source #
FromData Input Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fromBuiltinData :: BuiltinData -> Maybe Input Source #
ToData Input Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toBuiltinData :: Input -> BuiltinData Source #
type Rep Input Source #
Instance details Defined in Plutus.Contracts.Stablecoin type Rep Input = D1 ('MetaData "Input" "Plutus.Contracts.Stablecoin" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "Input" 'PrefixI 'True) (S1 ('MetaSel ('Just "inpSCAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SCAction) :*: S1 ('MetaSel ('Just "inpConversionRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SignedMessage (Observation ConversionRate)))))

data SCAction Source #

Action that can be performed on the stablecoin contract.

Constructors

MintStablecoin (SC Integer)	Create a number stablecoins, depositing the matching amount of base currency
MintReserveCoin (RC Integer)	Create a number of reservecoins, depositing the matching amount of base currency

Instances

Instances details

Eq SCAction Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods (==) :: SCAction -> SCAction -> Bool Source # (/=) :: SCAction -> SCAction -> Bool Source #
Show SCAction Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods showsPrec :: Int -> SCAction -> ShowS Source # show :: SCAction -> String Source # showList :: [SCAction] -> ShowS Source #
Generic SCAction Source #
Instance details Defined in Plutus.Contracts.Stablecoin Associated Types type Rep SCAction :: Type -> Type Source # Methods from :: SCAction -> Rep SCAction x Source # to :: Rep SCAction x -> SCAction Source #
ToJSON SCAction Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toJSON :: SCAction -> Value Source # toEncoding :: SCAction -> Encoding Source # toJSONList :: [SCAction] -> Value Source # toEncodingList :: [SCAction] -> Encoding Source #
FromJSON SCAction Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods parseJSON :: Value -> Parser SCAction Source # parseJSONList :: Value -> Parser [SCAction] Source #
UnsafeFromData SCAction Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods unsafeFromBuiltinData :: BuiltinData -> SCAction Source #
FromData SCAction Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods fromBuiltinData :: BuiltinData -> Maybe SCAction Source #
ToData SCAction Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toBuiltinData :: SCAction -> BuiltinData Source #
type Rep SCAction Source #
Instance details Defined in Plutus.Contracts.Stablecoin type Rep SCAction = D1 ('MetaData "SCAction" "Plutus.Contracts.Stablecoin" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "MintStablecoin" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SC Integer))) :+: C1 ('MetaCons "MintReserveCoin" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RC Integer))))

type ConversionRate = Rational Source #

Conversion rate from peg currency (eg. USD) to base currency (eg. Ada)

State machine client

typedValidator :: Stablecoin -> TypedValidator (StateMachine BankState Input) Source #

machineClient :: TypedValidator (StateMachine BankState Input) -> Stablecoin -> StateMachineClient BankState Input Source #

step :: forall i o. Stablecoin -> BankState -> Input -> Maybe (TxConstraints i o, BankState) Source #

Contract using the state machine

contract :: Promise () StablecoinSchema StablecoinError () Source #

A Contract that initialises the state machine and then accepts Input transitions.

data StablecoinError Source #

Instances

Instances details

Show StablecoinError Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods showsPrec :: Int -> StablecoinError -> ShowS Source # show :: StablecoinError -> String Source # showList :: [StablecoinError] -> ShowS Source #
Generic StablecoinError Source #
Instance details Defined in Plutus.Contracts.Stablecoin Associated Types type Rep StablecoinError :: Type -> Type Source # Methods from :: StablecoinError -> Rep StablecoinError x Source # to :: Rep StablecoinError x -> StablecoinError Source #
ToJSON StablecoinError Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods toJSON :: StablecoinError -> Value Source # toEncoding :: StablecoinError -> Encoding Source # toJSONList :: [StablecoinError] -> Value Source # toEncodingList :: [StablecoinError] -> Encoding Source #
FromJSON StablecoinError Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods parseJSON :: Value -> Parser StablecoinError Source # parseJSONList :: Value -> Parser [StablecoinError] Source #
AsContractError StablecoinError Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods _ContractError :: Prism' StablecoinError ContractError Source # _WalletContractError :: Prism' StablecoinError WalletAPIError Source # _ChainIndexContractError :: Prism' StablecoinError (Text, ChainIndexResponse) Source # _EmulatorAssertionContractError :: Prism' StablecoinError AssertionError Source # _ConstraintResolutionContractError :: Prism' StablecoinError MkTxError Source # _TxConstraintResolutionContractError :: Prism' StablecoinError MkTxError Source # _TxToCardanoConvertContractError :: Prism' StablecoinError ToCardanoError Source # _ResumableContractError :: Prism' StablecoinError MatchingError Source # _CCheckpointContractError :: Prism' StablecoinError CheckpointError Source # _EndpointDecodeContractError :: Prism' StablecoinError (EndpointDescription, EndpointValue Value, Text) Source # _OtherContractError :: Prism' StablecoinError Text Source #
AsSMContractError StablecoinError Source #
Instance details Defined in Plutus.Contracts.Stablecoin Methods _SMContractError :: Prism' StablecoinError SMContractError Source # _ChooserError :: Prism' StablecoinError Text Source # _UnableToExtractTransition :: Prism' StablecoinError () Source # _SMCContractError :: Prism' StablecoinError ContractError Source #
type Rep StablecoinError Source #
Instance details Defined in Plutus.Contracts.Stablecoin type Rep StablecoinError = D1 ('MetaData "StablecoinError" "Plutus.Contracts.Stablecoin" "plutus-use-cases-1.1.0.0-9kk4ZO09YVFKU77qwQaRsf" 'False) (C1 ('MetaCons "InitialiseEPError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContractError)) :+: (C1 ('MetaCons "StateMachineError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SMContractError)) :+: C1 ('MetaCons "RunStepError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContractError))))

type StablecoinSchema = Endpoint "run step" Input .\/ Endpoint "initialise" Stablecoin Source #

Etc.

stableCoins :: Stablecoin -> SC Integer -> Value Source #

A Value with the given number of stablecoins

reserveCoins :: Stablecoin -> RC Integer -> Value Source #

A Value with the given number of reservecoins

checkValidState :: Stablecoin -> BankState -> ConversionRate -> Either InvalidStateReason () Source #