From 724f9cb7db93dc1fc1dc9970068d46d1627efefa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Br=C3=BCnjes?= Date: Tue, 27 Jul 2021 00:01:53 +0200 Subject: [PATCH 1/4] bumped Plutus version --- code/week06/.devcontainer/devcontainer.json | 23 ++ code/week06/.gitignore | 6 + code/week06/LICENSE | 201 ++++++++++++++++ code/week06/app/oracle-client.hs | 59 +++++ code/week06/app/oracle-pab.hs | 124 ++++++++++ code/week06/app/swap-client.hs | 123 ++++++++++ code/week06/cabal.project | 195 +++++++++++++++ code/week06/hie.yaml | 10 + .../plutus-pioneer-program-week06.cabal | 73 ++++++ code/week06/src/Week06/Oracle/Core.hs | 200 ++++++++++++++++ code/week06/src/Week06/Oracle/Funds.hs | 41 ++++ code/week06/src/Week06/Oracle/PAB.hs | 19 ++ code/week06/src/Week06/Oracle/Swap.hs | 226 ++++++++++++++++++ code/week06/src/Week06/Oracle/Test.hs | 111 +++++++++ 14 files changed, 1411 insertions(+) create mode 100644 code/week06/.devcontainer/devcontainer.json create mode 100644 code/week06/.gitignore create mode 100644 code/week06/LICENSE create mode 100644 code/week06/app/oracle-client.hs create mode 100644 code/week06/app/oracle-pab.hs create mode 100644 code/week06/app/swap-client.hs create mode 100644 code/week06/cabal.project create mode 100644 code/week06/hie.yaml create mode 100644 code/week06/plutus-pioneer-program-week06.cabal create mode 100644 code/week06/src/Week06/Oracle/Core.hs create mode 100644 code/week06/src/Week06/Oracle/Funds.hs create mode 100644 code/week06/src/Week06/Oracle/PAB.hs create mode 100644 code/week06/src/Week06/Oracle/Swap.hs create mode 100644 code/week06/src/Week06/Oracle/Test.hs diff --git a/code/week06/.devcontainer/devcontainer.json b/code/week06/.devcontainer/devcontainer.json new file mode 100644 index 0000000..51f7dce --- /dev/null +++ b/code/week06/.devcontainer/devcontainer.json @@ -0,0 +1,23 @@ +{ + "name": "Plutus Starter Project", + "image": "plutus-devcontainer:latest", + + "remoteUser": "plutus", + + "mounts": [ + // This shares cabal's remote repository state with the host. We don't mount the whole of '.cabal', because + // 1. '.cabal/config' contains absolute paths that will only make sense on the host, and + // 2. '.cabal/store' is not necessarily portable to different version of cabal etc. + "source=${localEnv:HOME}/.cabal/packages,target=/home/plutus/.cabal/packages,type=bind,consistency=cached", + ], + + "settings": { + // Note: don't change from bash so it runs .bashrc + "terminal.integrated.shell.linux": "/bin/bash" + }, + + // IDs of extensions inside container + "extensions": [ + "haskell.haskell" + ], +} diff --git a/code/week06/.gitignore b/code/week06/.gitignore new file mode 100644 index 0000000..2bbd0a6 --- /dev/null +++ b/code/week06/.gitignore @@ -0,0 +1,6 @@ +dist-newstyle/ +oracle.cid +W2.cid +W3.cid +W4.cid +W5.cid diff --git a/code/week06/LICENSE b/code/week06/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/code/week06/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/code/week06/app/oracle-client.hs b/code/week06/app/oracle-client.hs new file mode 100644 index 0000000..b003f87 --- /dev/null +++ b/code/week06/app/oracle-client.hs @@ -0,0 +1,59 @@ +{-# LANGUAGE NumericUnderscores #-} +{-# LANGUAGE OverloadedStrings #-} + +module Main + ( main + ) where + +import Control.Concurrent +import Control.Monad (when) +import Control.Monad.IO.Class (MonadIO (..)) +import Data.ByteString (ByteString) +import Data.ByteString.Char8 (unpack) +import Data.Proxy (Proxy (..)) +import Data.Text (pack) +import Data.UUID +import Network.HTTP.Req +import Text.Regex.TDFA + +main :: IO () +main = do + uuid <- read <$> readFile "oracle.cid" + putStrLn $ "oracle contract instance id: " ++ show uuid + go uuid Nothing + where + go :: UUID -> Maybe Integer -> IO a + go uuid m = do + x <- getExchangeRate + let y = Just x + when (m /= y) $ + updateOracle uuid x + threadDelay 5_000_000 + go uuid y + +updateOracle :: UUID -> Integer -> IO () +updateOracle uuid x = runReq defaultHttpConfig $ do + v <- req + POST + (http "127.0.0.1" /: "api" /: "new" /: "contract" /: "instance" /: pack (show uuid) /: "endpoint" /: "update") + (ReqBodyJson x) + (Proxy :: Proxy (JsonResponse ())) + (port 8080) + liftIO $ putStrLn $ if responseStatusCode v == 200 + then "updated oracle to " ++ show x + else "error updating oracle" + +getExchangeRate :: IO Integer +getExchangeRate = runReq defaultHttpConfig $ do + v <- req + GET + (https "coinmarketcap.com" /: "currencies" /: "cardano") + NoReqBody + bsResponse + mempty + let priceRegex = "priceValue___11gHJ\">\\$([\\.0-9]*)" :: ByteString + (_, _, _, [bs]) = responseBody v =~ priceRegex :: (ByteString, ByteString, ByteString, [ByteString]) + d = read $ unpack bs :: Double + x = round $ 1_000_000 * d + liftIO $ putStrLn $ "queried exchange rate: " ++ show d + return x diff --git a/code/week06/app/oracle-pab.hs b/code/week06/app/oracle-pab.hs new file mode 100644 index 0000000..22c418a --- /dev/null +++ b/code/week06/app/oracle-pab.hs @@ -0,0 +1,124 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DerivingStrategies #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NumericUnderscores #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Main + ( main + ) where + +import Control.Monad (forM_, void, when) +import Control.Monad.Freer (Eff, Member, interpret, type (~>)) +import Control.Monad.Freer.Error (Error) +import Control.Monad.Freer.Extras.Log (LogMsg) +import Control.Monad.IO.Class (MonadIO (..)) +import Data.Aeson (FromJSON, Result (..), fromJSON) +import Data.Default (Default (..)) +import Data.Monoid (Last (..)) +import Data.Text (Text, pack) +import Ledger +import Ledger.Constraints +import qualified Ledger.Value as Value +import Plutus.Contract +import Plutus.PAB.Effects.Contract (ContractEffect (..)) +import Plutus.PAB.Effects.Contract.Builtin (Builtin, SomeBuiltin (..), endpointsToSchemas, handleBuiltin) +import Plutus.PAB.Monitoring.PABLogMsg (PABMultiAgentMsg) +import Plutus.PAB.Simulator (SimulatorEffectHandlers) +import qualified Plutus.PAB.Simulator as Simulator +import Plutus.PAB.Types (PABError (..)) +import qualified Plutus.PAB.Webserver.Server as PAB.Server +import qualified Plutus.Contracts.Currency as Currency + +import Wallet.Emulator.Types (Wallet (..), walletPubKey) +import Wallet.Types (ContractInstanceId (..)) + +import qualified Week06.Oracle.Core as Oracle +import Week06.Oracle.PAB (OracleContracts (..)) +import qualified Week06.Oracle.Swap as Oracle + +main :: IO () +main = void $ Simulator.runSimulationWith handlers $ do + Simulator.logString @(Builtin OracleContracts) "Starting Oracle PAB webserver. Press enter to exit." + shutdown <- PAB.Server.startServerDebug + + cidInit <- Simulator.activateContract (Wallet 1) Init + cs <- waitForLast cidInit + _ <- Simulator.waitUntilFinished cidInit + + cidOracle <- Simulator.activateContract (Wallet 1) $ Oracle cs + liftIO $ writeFile "oracle.cid" $ show $ unContractInstanceId cidOracle + oracle <- waitForLast cidOracle + + forM_ wallets $ \w -> + when (w /= Wallet 1) $ do + cid <- Simulator.activateContract w $ Swap oracle + liftIO $ writeFile ('W' : show (getWallet w) ++ ".cid") $ show $ unContractInstanceId cid + + void $ liftIO getLine + shutdown + +waitForLast :: FromJSON a => ContractInstanceId -> Simulator.Simulation t a +waitForLast cid = + flip Simulator.waitForState cid $ \json -> case fromJSON json of + Success (Last (Just x)) -> Just x + _ -> Nothing + +wallets :: [Wallet] +wallets = [Wallet i | i <- [1 .. 5]] + +usdt :: TokenName +usdt = "USDT" + +oracleParams :: CurrencySymbol -> Oracle.OracleParams +oracleParams cs = Oracle.OracleParams + { Oracle.opFees = 1_000_000 + , Oracle.opSymbol = cs + , Oracle.opToken = usdt + } + +handleOracleContracts :: + ( Member (Error PABError) effs + , Member (LogMsg (PABMultiAgentMsg (Builtin OracleContracts))) effs + ) + => ContractEffect (Builtin OracleContracts) + ~> Eff effs +handleOracleContracts = handleBuiltin getSchema getContract where + getSchema = \case + Init -> endpointsToSchemas @Empty + Oracle _ -> endpointsToSchemas @Oracle.OracleSchema + Swap _ -> endpointsToSchemas @Oracle.SwapSchema + getContract = \case + Init -> SomeBuiltin initContract + Oracle cs -> SomeBuiltin $ Oracle.runOracle $ oracleParams cs + Swap oracle -> SomeBuiltin $ Oracle.swap oracle + +handlers :: SimulatorEffectHandlers (Builtin OracleContracts) +handlers = + Simulator.mkSimulatorHandlers @(Builtin OracleContracts) def [] + $ interpret handleOracleContracts + +initContract :: Contract (Last CurrencySymbol) Empty Text () +initContract = do + ownPK <- pubKeyHash <$> ownPubKey + cur <- + mapError (pack . show) + (Currency.mintContract ownPK [(usdt, fromIntegral (length wallets) * amount)] + :: Contract (Last CurrencySymbol) Empty Currency.CurrencyError Currency.OneShotCurrency) + let cs = Currency.currencySymbol cur + v = Value.singleton cs usdt amount + forM_ wallets $ \w -> do + let pkh = pubKeyHash $ walletPubKey w + when (pkh /= ownPK) $ do + tx <- submitTx $ mustPayToPubKey pkh v + awaitTxConfirmed $ txId tx + tell $ Last $ Just cs + where + amount :: Integer + amount = 100_000_000 diff --git a/code/week06/app/swap-client.hs b/code/week06/app/swap-client.hs new file mode 100644 index 0000000..e63e63d --- /dev/null +++ b/code/week06/app/swap-client.hs @@ -0,0 +1,123 @@ +{-# LANGUAGE NumericUnderscores #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} + +module Main + ( main + ) where + +import Control.Concurrent +import Control.Exception +import Control.Monad.IO.Class (MonadIO (..)) +import Data.Aeson (Result (..), fromJSON) +import Data.Monoid (Last (..)) +import Data.Proxy (Proxy (..)) +import Data.Text (pack) +import Data.UUID +import Ledger.Value (flattenValue) +import Network.HTTP.Req +import Plutus.PAB.Events.ContractInstanceState (PartiallyDecodedResponse (..)) +import Plutus.PAB.Webserver.Types +import System.Environment (getArgs) +import System.IO +import Text.Read (readMaybe) + +import Week06.Oracle.PAB (OracleContracts) + +main :: IO () +main = do + [i :: Int] <- map read <$> getArgs + uuid <- read <$> readFile ('W' : show i ++ ".cid") + hSetBuffering stdout NoBuffering + putStrLn $ "swap contract instance id for Wallet " ++ show i ++ ": " ++ show uuid + go uuid + where + go :: UUID -> IO a + go uuid = do + cmd <- readCommand + case cmd of + Offer amt -> offer uuid amt + Retrieve -> retrieve uuid + Use -> use uuid + Funds -> getFunds uuid + go uuid + + readCommand :: IO Command + readCommand = do + putStr "enter command (Offer amt, Retrieve, Use or Funds): " + s <- getLine + maybe readCommand return $ readMaybe s + +data Command = Offer Integer | Retrieve | Use | Funds + deriving (Show, Read, Eq, Ord) + +getFunds :: UUID -> IO () +getFunds uuid = handle h $ runReq defaultHttpConfig $ do + v <- req + POST + (http "127.0.0.1" /: "api" /: "new" /: "contract" /: "instance" /: pack (show uuid) /: "endpoint" /: "funds") + (ReqBodyJson ()) + (Proxy :: Proxy (JsonResponse ())) + (port 8080) + if responseStatusCode v /= 200 + then liftIO $ putStrLn "error getting funds" + else do + w <- req + GET + (http "127.0.0.1" /: "api" /: "new" /: "contract" /: "instance" /: pack (show uuid) /: "status") + NoReqBody + (Proxy :: Proxy (JsonResponse (ContractInstanceClientState OracleContracts))) + (port 8080) + liftIO $ putStrLn $ case fromJSON $ observableState $ cicCurrentState $ responseBody w of + Success (Last (Just f)) -> "funds: " ++ show (flattenValue f) + _ -> "error decoding state" + where + h :: HttpException -> IO () + h _ = threadDelay 1_000_000 >> getFunds uuid + +offer :: UUID -> Integer -> IO () +offer uuid amt = handle h $ runReq defaultHttpConfig $ do + v <- req + POST + (http "127.0.0.1" /: "api" /: "new" /: "contract" /: "instance" /: pack (show uuid) /: "endpoint" /: "offer") + (ReqBodyJson amt) + (Proxy :: Proxy (JsonResponse ())) + (port 8080) + liftIO $ putStrLn $ if responseStatusCode v == 200 + then "offered swap of " ++ show amt ++ " lovelace" + else "error offering swap" + where + h :: HttpException -> IO () + h _ = threadDelay 1_000_000 >> offer uuid amt + +retrieve :: UUID -> IO () +retrieve uuid = handle h $ runReq defaultHttpConfig $ do + v <- req + POST + (http "127.0.0.1" /: "api" /: "new" /: "contract" /: "instance" /: pack (show uuid) /: "endpoint" /: "retrieve") + (ReqBodyJson ()) + (Proxy :: Proxy (JsonResponse ())) + (port 8080) + liftIO $ putStrLn $ if responseStatusCode v == 200 + then "retrieved swaps" + else "error retrieving swaps" + where + h :: HttpException -> IO () + h _ = threadDelay 1_000_000 >> retrieve uuid + +use :: UUID -> IO () +use uuid = handle h $ runReq defaultHttpConfig $ do + v <- req + POST + (http "127.0.0.1" /: "api" /: "new" /: "contract" /: "instance" /: pack (show uuid) /: "endpoint" /: "use") + (ReqBodyJson ()) + (Proxy :: Proxy (JsonResponse ())) + (port 8080) + liftIO $ putStrLn $ if responseStatusCode v == 200 + then "used swap" + else "error using swap" + where + h :: HttpException -> IO () + h _ = threadDelay 1_000_000 >> use uuid + + diff --git a/code/week06/cabal.project b/code/week06/cabal.project new file mode 100644 index 0000000..37f9276 --- /dev/null +++ b/code/week06/cabal.project @@ -0,0 +1,195 @@ +index-state: 2021-07-07T00:00:00Z + +packages: ./. + +-- You never, ever, want this. +write-ghc-environment-files: never + +-- Always build tests and benchmarks. +tests: true +benchmarks: true + +source-repository-package + type: git + location: https://github.com/input-output-hk/plutus.git + subdir: + freer-extras + playground-common + plutus-chain-index + plutus-core + plutus-contract + plutus-ledger + plutus-ledger-api + plutus-pab + plutus-tx + plutus-tx-plugin + plutus-use-cases + prettyprinter-configurable + quickcheck-dynamic + word-array + tag: 8a20664f00d8f396920385947903761a9a897fe0 + +-- The following sections are copied from the 'plutus' repository cabal.project at the revision +-- given above. +-- This is necessary because the 'plutus' libraries depend on a number of other libraries which are +-- not on Hackage, and so need to be pulled in as `source-repository-package`s themselves. Make sure to +-- re-update this section from the template when you do an upgrade. + +-- This is also needed so evenful-sql-common will build with a +-- newer version of persistent. See stack.yaml for the mirrored +-- configuration. +package eventful-sql-common + ghc-options: -XDerivingStrategies -XStandaloneDeriving -XUndecidableInstances -XDataKinds -XFlexibleInstances -XMultiParamTypeClasses + +allow-newer: + -- Pins to an old version of Template Haskell, unclear if/when it will be updated + size-based:template-haskell + + -- The following two dependencies are needed by plutus. + , eventful-sql-common:persistent + , eventful-sql-common:persistent-template + , ouroboros-consensus-byron:formatting + , beam-core:aeson + , beam-sqlite:aeson + , beam-sqlite:dlist + , beam-migrate:aeson + +constraints: + -- big breaking change here, inline-r doens't have an upper bound + singletons < 3.0 + -- breaks eventful even more than it already was + , persistent-template < 2.12 + -- bizarre issue: in earlier versions they define their own 'GEq', in newer + -- ones they reuse the one from 'some', but there isn't e.g. a proper version + -- constraint from dependent-sum-template (which is the library we actually use). + , dependent-sum > 0.6.2.0 + +-- See the note on nix/pkgs/default.nix:agdaPackages for why this is here. +-- (NOTE this will change to ieee754 in newer versions of nixpkgs). +extra-packages: ieee, filemanip + +-- Drops an instance breaking our code. Should be released to Hackage eventually. +source-repository-package + type: git + location: https://github.com/Quid2/flat.git + tag: 95e5d7488451e43062ca84d5376b3adcc465f1cd + +-- Needs some patches, but upstream seems to be fairly dead (no activity in > 1 year) +source-repository-package + type: git + location: https://github.com/shmish111/purescript-bridge.git + tag: 6a92d7853ea514be8b70bab5e72077bf5a510596 + +source-repository-package + type: git + location: https://github.com/shmish111/servant-purescript.git + tag: a76104490499aa72d40c2790d10e9383e0dbde63 + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-crypto.git + tag: ce8f1934e4b6252084710975bd9bbc0a4648ece4 + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-base + tag: a715c7f420770b70bbe95ca51d3dec83866cb1bd + subdir: + binary + binary/test + slotting + cardano-crypto-class + cardano-crypto-praos + cardano-crypto-tests + strict-containers + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-prelude + tag: fd773f7a58412131512b9f694ab95653ac430852 + subdir: + cardano-prelude + cardano-prelude-test + +source-repository-package + type: git + location: https://github.com/input-output-hk/ouroboros-network + tag: e338f2cf8e1078fbda9555dd2b169c6737ef6774 + subdir: + monoidal-synchronisation + typed-protocols + typed-protocols-examples + ouroboros-network + ouroboros-network-testing + ouroboros-network-framework + ouroboros-consensus + ouroboros-consensus-byron + ouroboros-consensus-cardano + ouroboros-consensus-shelley + io-sim + io-classes + network-mux + +source-repository-package + type: git + location: https://github.com/input-output-hk/iohk-monitoring-framework + tag: 34abfb7f4f5610cabb45396e0496472446a0b2ca + subdir: + iohk-monitoring + tracer-transformers + contra-tracer + plugins/backend-aggregation + plugins/backend-ekg + plugins/backend-monitoring + plugins/backend-trace-forwarder + plugins/scribe-systemd + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-ledger-specs + tag: 6b0fca7a73c317f3af7c14dd4dc38178cc78a6c8 + subdir: + byron/chain/executable-spec + byron/crypto + byron/crypto/test + byron/ledger/executable-spec + byron/ledger/impl + byron/ledger/impl/test + semantics/executable-spec + semantics/small-steps-test + shelley/chain-and-ledger/dependencies/non-integer + shelley/chain-and-ledger/executable-spec + shelley/chain-and-ledger/shelley-spec-ledger-test + shelley-ma/impl + cardano-ledger-core + alonzo/impl + +-- A lot of plutus dependencies have to be synchronized with the dependencies of +-- cardano-node. If you update cardano-node, please make sure that all dependencies +-- of cardano-node are also updated. +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-node.git + tag: f3ef4ed72894499160f2330b91572a159005c148 + subdir: + cardano-api + cardano-node + cardano-cli + cardano-config + +source-repository-package + type: git + location: https://github.com/input-output-hk/Win32-network + tag: 94153b676617f8f33abe8d8182c37377d2784bd1 + +source-repository-package + type: git + location: https://github.com/input-output-hk/hedgehog-extras + tag: 8bcd3c9dc22cc44f9fcfe161f4638a384fc7a187 + +-- The following dependencies are not mirrored in the +-- stack.yaml file, but they are needed regardless by cabal. +source-repository-package + type: git + location: https://github.com/input-output-hk/goblins + tag: cde90a2b27f79187ca8310b6549331e59595e7ba diff --git a/code/week06/hie.yaml b/code/week06/hie.yaml new file mode 100644 index 0000000..105b4e1 --- /dev/null +++ b/code/week06/hie.yaml @@ -0,0 +1,10 @@ +cradle: + cabal: + - path: "./src" + component: "lib:plutus-pioneer-program-week06" + - path: "./app/oracle-pab.hs" + component: "exe:oracle-pab" + - path: "./app/oracle-client.hs" + component: "exe:oracle-client" + - path: "./app/swap-client.hs" + component: "exe:swap-client" diff --git a/code/week06/plutus-pioneer-program-week06.cabal b/code/week06/plutus-pioneer-program-week06.cabal new file mode 100644 index 0000000..5767ae8 --- /dev/null +++ b/code/week06/plutus-pioneer-program-week06.cabal @@ -0,0 +1,73 @@ +Cabal-Version: 2.4 +Name: plutus-pioneer-program-week06 +Version: 0.1.0.0 +Author: Lars Bruenjes +Maintainer: brunjlar@gmail.com +Build-Type: Simple +Copyright: © 2021 Lars Bruenjes +License: Apache-2.0 +License-files: LICENSE + +library + hs-source-dirs: src + exposed-modules: Week06.Oracle.Core + Week06.Oracle.Funds + Week06.Oracle.PAB + Week06.Oracle.Swap + Week06.Oracle.Test + build-depends: aeson + , base ^>=4.14.1.0 + , containers + , data-default + , freer-extras + , playground-common + , plutus-contract + , plutus-ledger + , plutus-ledger-api + , plutus-tx-plugin + , plutus-tx + , plutus-use-cases + , prettyprinter + , text + default-language: Haskell2010 + ghc-options: -Wall -fobject-code -fno-ignore-interface-pragmas -fno-omit-interface-pragmas -fno-strictness -fno-spec-constr -fno-specialise + +executable oracle-pab + main-is: oracle-pab.hs + hs-source-dirs: app + ghc-options: -Wall -threaded + build-depends: aeson + , base ^>= 4.14.1.0 + , data-default + , freer-extras + , freer-simple + , plutus-contract + , plutus-ledger + , plutus-pab + , plutus-pioneer-program-week06 + , plutus-use-cases + , text + +executable oracle-client + main-is: oracle-client.hs + hs-source-dirs: app + ghc-options: -Wall + build-depends: base ^>= 4.14.1.0 + , bytestring + , regex-tdfa ^>= 1.3.1.0 + , req ^>= 3.9.0 + , text + , uuid + +executable swap-client + main-is: swap-client.hs + hs-source-dirs: app + ghc-options: -Wall + build-depends: aeson + , base ^>= 4.14.1.0 + , plutus-ledger + , plutus-pab + , plutus-pioneer-program-week06 + , req ^>= 3.9.0 + , text + , uuid diff --git a/code/week06/src/Week06/Oracle/Core.hs b/code/week06/src/Week06/Oracle/Core.hs new file mode 100644 index 0000000..c27aa56 --- /dev/null +++ b/code/week06/src/Week06/Oracle/Core.hs @@ -0,0 +1,200 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week06.Oracle.Core + ( Oracle (..) + , OracleRedeemer (..) + , oracleTokenName + , oracleValue + , oracleAsset + , typedOracleValidator + , oracleValidator + , oracleAddress + , OracleSchema + , OracleParams (..) + , runOracle + , findOracle + ) where + +import Control.Monad hiding (fmap) +import Data.Aeson (FromJSON, ToJSON) +import qualified Data.Map as Map +import Data.Monoid (Last (..)) +import Data.Text (Text, pack) +import GHC.Generics (Generic) +import Plutus.Contract as Contract +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Value as Value +import Ledger.Ada as Ada +import Plutus.Contracts.Currency as Currency +import Prelude (Semigroup (..), Show (..), String) +import qualified Prelude + +data Oracle = Oracle + { oSymbol :: !CurrencySymbol + , oOperator :: !PubKeyHash + , oFee :: !Integer + , oAsset :: !AssetClass + } deriving (Show, Generic, FromJSON, ToJSON, Prelude.Eq, Prelude.Ord) + +PlutusTx.makeLift ''Oracle + +data OracleRedeemer = Update | Use + deriving Show + +PlutusTx.unstableMakeIsData ''OracleRedeemer + +{-# INLINABLE oracleTokenName #-} +oracleTokenName :: TokenName +oracleTokenName = TokenName emptyByteString + +{-# INLINABLE oracleAsset #-} +oracleAsset :: Oracle -> AssetClass +oracleAsset oracle = AssetClass (oSymbol oracle, oracleTokenName) + +{-# INLINABLE oracleValue #-} +oracleValue :: TxOut -> (DatumHash -> Maybe Datum) -> Maybe Integer +oracleValue o f = do + dh <- txOutDatum o + Datum d <- f dh + PlutusTx.fromBuiltinData d + +{-# INLINABLE mkOracleValidator #-} +mkOracleValidator :: Oracle -> Integer -> OracleRedeemer -> ScriptContext -> Bool +mkOracleValidator oracle x r ctx = + traceIfFalse "token missing from input" inputHasToken && + traceIfFalse "token missing from output" outputHasToken && + case r of + Update -> traceIfFalse "operator signature missing" (txSignedBy info $ oOperator oracle) && + traceIfFalse "invalid output datum" validOutputDatum + Use -> traceIfFalse "oracle value changed" (outputDatum == Just x) && + traceIfFalse "fees not paid" feesPaid + where + info :: TxInfo + info = scriptContextTxInfo ctx + + ownInput :: TxOut + ownInput = case findOwnInput ctx of + Nothing -> traceError "oracle input missing" + Just i -> txInInfoResolved i + + inputHasToken :: Bool + inputHasToken = assetClassValueOf (txOutValue ownInput) (oracleAsset oracle) == 1 + + ownOutput :: TxOut + ownOutput = case getContinuingOutputs ctx of + [o] -> o + _ -> traceError "expected exactly one oracle output" + + outputHasToken :: Bool + outputHasToken = assetClassValueOf (txOutValue ownOutput) (oracleAsset oracle) == 1 + + outputDatum :: Maybe Integer + outputDatum = oracleValue ownOutput (`findDatum` info) + + validOutputDatum :: Bool + validOutputDatum = isJust outputDatum + + feesPaid :: Bool + feesPaid = + let + inVal = txOutValue ownInput + outVal = txOutValue ownOutput + in + outVal `geq` (inVal <> Ada.lovelaceValueOf (oFee oracle)) + +data Oracling +instance Scripts.ValidatorTypes Oracling where + type instance DatumType Oracling = Integer + type instance RedeemerType Oracling = OracleRedeemer + +typedOracleValidator :: Oracle -> Scripts.TypedValidator Oracling +typedOracleValidator oracle = Scripts.mkTypedValidator @Oracling + ($$(PlutusTx.compile [|| mkOracleValidator ||]) `PlutusTx.applyCode` PlutusTx.liftCode oracle) + $$(PlutusTx.compile [|| wrap ||]) + where + wrap = Scripts.wrapValidator @Integer @OracleRedeemer + +oracleValidator :: Oracle -> Validator +oracleValidator = Scripts.validatorScript . typedOracleValidator + +oracleAddress :: Oracle -> Ledger.Address +oracleAddress = scriptAddress . oracleValidator + +data OracleParams = OracleParams + { opFees :: !Integer + , opSymbol :: !CurrencySymbol + , opToken :: !TokenName + } deriving (Show, Generic, FromJSON, ToJSON) + +startOracle :: forall w s. OracleParams -> Contract w s Text Oracle +startOracle op = do + pkh <- pubKeyHash <$> Contract.ownPubKey + osc <- mapError (pack . show) (mintContract pkh [(oracleTokenName, 1)] :: Contract w s CurrencyError OneShotCurrency) + let cs = Currency.currencySymbol osc + oracle = Oracle + { oSymbol = cs + , oOperator = pkh + , oFee = opFees op + , oAsset = AssetClass (opSymbol op, opToken op) + } + logInfo @String $ "started oracle " ++ show oracle + return oracle + +updateOracle :: forall w s. Oracle -> Integer -> Contract w s Text () +updateOracle oracle x = do + m <- findOracle oracle + let c = Constraints.mustPayToTheScript x $ assetClassValue (oracleAsset oracle) 1 + case m of + Nothing -> do + ledgerTx <- submitTxConstraints (typedOracleValidator oracle) c + awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "set initial oracle value to " ++ show x + Just (oref, o, _) -> do + let lookups = Constraints.unspentOutputs (Map.singleton oref o) <> + Constraints.typedValidatorLookups (typedOracleValidator oracle) <> + Constraints.otherScript (oracleValidator oracle) + tx = c <> Constraints.mustSpendScriptOutput oref (Redeemer $ PlutusTx.toBuiltinData Update) + ledgerTx <- submitTxConstraintsWith @Oracling lookups tx + awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "updated oracle value to " ++ show x + +findOracle :: forall w s. Oracle -> Contract w s Text (Maybe (TxOutRef, TxOutTx, Integer)) +findOracle oracle = do + utxos <- Map.filter f <$> utxoAt (oracleAddress oracle) + return $ case Map.toList utxos of + [(oref, o)] -> do + x <- oracleValue (txOutTxOut o) $ \dh -> Map.lookup dh $ txData $ txOutTxTx o + return (oref, o, x) + _ -> Nothing + where + f :: TxOutTx -> Bool + f o = assetClassValueOf (txOutValue $ txOutTxOut o) (oracleAsset oracle) == 1 + +type OracleSchema = Endpoint "update" Integer + +runOracle :: OracleParams -> Contract (Last Oracle) OracleSchema Text () +runOracle op = do + oracle <- startOracle op + tell $ Last $ Just oracle + go oracle + where + go :: Oracle -> Contract (Last Oracle) OracleSchema Text a + go oracle = do + x <- endpoint @"update" + updateOracle oracle x + go oracle diff --git a/code/week06/src/Week06/Oracle/Funds.hs b/code/week06/src/Week06/Oracle/Funds.hs new file mode 100644 index 0000000..96584fe --- /dev/null +++ b/code/week06/src/Week06/Oracle/Funds.hs @@ -0,0 +1,41 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week06.Oracle.Funds + ( ownFunds + , ownFunds' + ) where + +import Control.Monad hiding (fmap) +import qualified Data.Map as Map +import Data.Monoid (Last (..)) +import Data.Text (Text) +import Plutus.Contract as Contract +import PlutusTx.Prelude hiding ((<$>)) +import Prelude (Show (..), String, (<$>)) +import Ledger hiding (singleton) +import Ledger.Value as Value + +ownFunds :: Contract w s Text Value +ownFunds = do + pk <- ownPubKey + utxos <- utxoAt $ pubKeyAddress pk + let v = mconcat $ Map.elems $ txOutValue . txOutTxOut <$> utxos + logInfo @String $ "own funds: " ++ show (Value.flattenValue v) + return v + +ownFunds' :: Contract (Last Value) Empty Text () +ownFunds' = do + handleError logError $ ownFunds >>= tell . Last . Just + void $ Contract.waitNSlots 1 + ownFunds' diff --git a/code/week06/src/Week06/Oracle/PAB.hs b/code/week06/src/Week06/Oracle/PAB.hs new file mode 100644 index 0000000..432d259 --- /dev/null +++ b/code/week06/src/Week06/Oracle/PAB.hs @@ -0,0 +1,19 @@ +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} + +module Week06.Oracle.PAB + ( OracleContracts (..) + ) where + +import Data.Aeson (FromJSON, ToJSON) +import Data.Text.Prettyprint.Doc (Pretty (..), viaShow) +import GHC.Generics (Generic) +import Ledger + +import qualified Week06.Oracle.Core as Oracle + +data OracleContracts = Init | Oracle CurrencySymbol | Swap Oracle.Oracle + deriving (Eq, Ord, Show, Generic, FromJSON, ToJSON) + +instance Pretty OracleContracts where + pretty = viaShow diff --git a/code/week06/src/Week06/Oracle/Swap.hs b/code/week06/src/Week06/Oracle/Swap.hs new file mode 100644 index 0000000..7856a64 --- /dev/null +++ b/code/week06/src/Week06/Oracle/Swap.hs @@ -0,0 +1,226 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week06.Oracle.Swap + ( SwapSchema + , swap + ) where + +import Control.Monad hiding (fmap) +import Data.List (find) +import qualified Data.Map as Map +import Data.Maybe (mapMaybe) +import Data.Monoid (Last (..)) +import Data.Text (Text) +import Plutus.Contract as Contract +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), (<$>), unless, mapMaybe, find) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Ada as Ada hiding (divide) +import Ledger.Value as Value +import Prelude (Semigroup (..), Show (..), String, (<$>)) + +import Week06.Oracle.Core +import Week06.Oracle.Funds + +{-# INLINABLE price #-} +price :: Integer -> Integer -> Integer +price lovelace exchangeRate = (lovelace * exchangeRate) `divide` 1000000 + +{-# INLINABLE lovelaces #-} +lovelaces :: Value -> Integer +lovelaces = Ada.getLovelace . Ada.fromValue + +{-# INLINABLE mkSwapValidator #-} +mkSwapValidator :: Oracle -> Address -> PubKeyHash -> () -> ScriptContext -> Bool +mkSwapValidator oracle addr pkh () ctx = + txSignedBy info pkh || + (traceIfFalse "expected exactly two script inputs" hasTwoScriptInputs && + traceIfFalse "price not paid" sellerPaid) + + where + info :: TxInfo + info = scriptContextTxInfo ctx + + oracleInput :: TxOut + oracleInput = + let + ins = [ o + | i <- txInfoInputs info + , let o = txInInfoResolved i + , txOutAddress o == addr + ] + in + case ins of + [o] -> o + _ -> traceError "expected exactly one oracle input" + + oracleValue' = case oracleValue oracleInput (`findDatum` info) of + Nothing -> traceError "oracle value not found" + Just x -> x + + hasTwoScriptInputs :: Bool + hasTwoScriptInputs = + let + xs = filter (isJust . toValidatorHash . txOutAddress . txInInfoResolved) $ txInfoInputs info + in + length xs == 2 + + minPrice :: Integer + minPrice = + let + lovelaceIn = case findOwnInput ctx of + Nothing -> traceError "own input not found" + Just i -> lovelaces $ txOutValue $ txInInfoResolved i + in + price lovelaceIn oracleValue' + + sellerPaid :: Bool + sellerPaid = + let + pricePaid :: Integer + pricePaid = assetClassValueOf (valuePaidTo info pkh) (oAsset oracle) + in + pricePaid >= minPrice + +data Swapping +instance Scripts.ValidatorTypes Swapping where + type instance DatumType Swapping = PubKeyHash + type instance RedeemerType Swapping = () + +typedSwapValidator :: Oracle -> Scripts.TypedValidator Swapping +typedSwapValidator oracle = Scripts.mkTypedValidator @Swapping + ($$(PlutusTx.compile [|| mkSwapValidator ||]) + `PlutusTx.applyCode` PlutusTx.liftCode oracle + `PlutusTx.applyCode` PlutusTx.liftCode (oracleAddress oracle)) + $$(PlutusTx.compile [|| wrap ||]) + where + wrap = Scripts.wrapValidator @PubKeyHash @() + +swapValidator :: Oracle -> Validator +swapValidator = Scripts.validatorScript . typedSwapValidator + +swapAddress :: Oracle -> Ledger.Address +swapAddress = scriptAddress . swapValidator + +offerSwap :: forall w s. Oracle -> Integer -> Contract w s Text () +offerSwap oracle amt = do + pkh <- pubKeyHash <$> Contract.ownPubKey + let tx = Constraints.mustPayToTheScript pkh $ Ada.lovelaceValueOf amt + ledgerTx <- submitTxConstraints (typedSwapValidator oracle) tx + awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "offered " ++ show amt ++ " lovelace for swap" + +findSwaps :: Oracle -> (PubKeyHash -> Bool) -> Contract w s Text [(TxOutRef, TxOutTx, PubKeyHash)] +findSwaps oracle p = do + utxos <- utxoAt $ swapAddress oracle + return $ mapMaybe g $ Map.toList utxos + where + f :: TxOutTx -> Maybe PubKeyHash + f o = do + dh <- txOutDatumHash $ txOutTxOut o + (Datum d) <- Map.lookup dh $ txData $ txOutTxTx o + PlutusTx.fromBuiltinData d + + g :: (TxOutRef, TxOutTx) -> Maybe (TxOutRef, TxOutTx, PubKeyHash) + g (oref, o) = do + pkh <- f o + guard $ p pkh + return (oref, o, pkh) + +retrieveSwaps :: Oracle -> Contract w s Text () +retrieveSwaps oracle = do + pkh <- pubKeyHash <$> ownPubKey + xs <- findSwaps oracle (== pkh) + case xs of + [] -> logInfo @String "no swaps found" + _ -> do + let lookups = Constraints.unspentOutputs (Map.fromList [(oref, o) | (oref, o, _) <- xs]) <> + Constraints.otherScript (swapValidator oracle) + tx = mconcat [Constraints.mustSpendScriptOutput oref $ Redeemer $ PlutusTx.toBuiltinData () | (oref, _, _) <- xs] + ledgerTx <- submitTxConstraintsWith @Swapping lookups tx + awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "retrieved " ++ show (length xs) ++ " swap(s)" + +useSwap :: forall w s. Oracle -> Contract w s Text () +useSwap oracle = do + funds <- ownFunds + let amt = assetClassValueOf funds $ oAsset oracle + logInfo @String $ "available assets: " ++ show amt + + m <- findOracle oracle + case m of + Nothing -> logInfo @String "oracle not found" + Just (oref, o, x) -> do + logInfo @String $ "found oracle, exchange rate " ++ show x + pkh <- pubKeyHash <$> Contract.ownPubKey + swaps <- findSwaps oracle (/= pkh) + case find (f amt x) swaps of + Nothing -> logInfo @String "no suitable swap found" + Just (oref', o', pkh') -> do + let v = txOutValue (txOutTxOut o) <> lovelaceValueOf (oFee oracle) + p = assetClassValue (oAsset oracle) $ price (lovelaces $ txOutValue $ txOutTxOut o') x + lookups = Constraints.otherScript (swapValidator oracle) <> + Constraints.otherScript (oracleValidator oracle) <> + Constraints.unspentOutputs (Map.fromList [(oref, o), (oref', o')]) + tx = Constraints.mustSpendScriptOutput oref (Redeemer $ PlutusTx.toBuiltinData Use) <> + Constraints.mustSpendScriptOutput oref' (Redeemer $ PlutusTx.toBuiltinData ()) <> + Constraints.mustPayToOtherScript + (validatorHash $ oracleValidator oracle) + (Datum $ PlutusTx.toBuiltinData x) + v <> + Constraints.mustPayToPubKey pkh' p + ledgerTx <- submitTxConstraintsWith @Swapping lookups tx + awaitTxConfirmed $ txId ledgerTx + logInfo @String $ "made swap with price " ++ show (Value.flattenValue p) + where + getPrice :: Integer -> TxOutTx -> Integer + getPrice x o = price (lovelaces $ txOutValue $ txOutTxOut o) x + + f :: Integer -> Integer -> (TxOutRef, TxOutTx, PubKeyHash) -> Bool + f amt x (_, o, _) = getPrice x o <= amt + +type SwapSchema = + Endpoint "offer" Integer + .\/ Endpoint "retrieve" () + .\/ Endpoint "use" () + .\/ Endpoint "funds" () + +swap :: Oracle -> Contract (Last Value) SwapSchema Text () +swap oracle = (offer `select` retrieve `select` use `select` funds) >> swap oracle + where + offer :: Contract (Last Value) SwapSchema Text () + offer = h $ do + amt <- endpoint @"offer" + offerSwap oracle amt + + retrieve :: Contract (Last Value) SwapSchema Text () + retrieve = h $ do + endpoint @"retrieve" + retrieveSwaps oracle + + use :: Contract (Last Value) SwapSchema Text () + use = h $ do + endpoint @"use" + useSwap oracle + + funds :: Contract (Last Value) SwapSchema Text () + funds = h $ do + endpoint @"funds" + v <- ownFunds + tell $ Last $ Just v + + h :: Contract (Last Value) SwapSchema Text () -> Contract (Last Value) SwapSchema Text () + h = handleError logError diff --git a/code/week06/src/Week06/Oracle/Test.hs b/code/week06/src/Week06/Oracle/Test.hs new file mode 100644 index 0000000..4cd44fb --- /dev/null +++ b/code/week06/src/Week06/Oracle/Test.hs @@ -0,0 +1,111 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE NumericUnderscores #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week06.Oracle.Test where + +import Control.Monad hiding (fmap) +import Control.Monad.Freer.Extras as Extras +import Data.Default (Default (..)) +import qualified Data.Map as Map +import Data.Monoid (Last (..)) +import Data.Text (Text) +import Ledger +import Ledger.Value as Value +import Ledger.Ada as Ada +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Prelude (IO, Semigroup(..), Show (..)) +import Wallet.Emulator.Wallet + +import Week06.Oracle.Core +import Week06.Oracle.Funds +import Week06.Oracle.Swap + +assetSymbol :: CurrencySymbol +assetSymbol = "ff" + +assetToken :: TokenName +assetToken = "USDT" + +test :: IO () +test = runEmulatorTraceIO' def emCfg def myTrace + where + emCfg :: EmulatorConfig + emCfg = EmulatorConfig $ Left $ Map.fromList [(Wallet i, v) | i <- [1 .. 10]] + + v :: Value + v = Ada.lovelaceValueOf 100_000_000 <> + Value.singleton assetSymbol assetToken 100_000_000 + +checkOracle :: Oracle -> Contract () Empty Text a +checkOracle oracle = do + m <- findOracle oracle + case m of + Nothing -> return () + Just (_, _, x) -> Contract.logInfo $ "Oracle value: " ++ show x + Contract.waitNSlots 1 >> checkOracle oracle + +myTrace :: EmulatorTrace () +myTrace = do + let op = OracleParams + { opFees = 1_000_000 + , opSymbol = assetSymbol + , opToken = assetToken + } + + h1 <- activateContractWallet (Wallet 1) $ runOracle op + void $ Emulator.waitNSlots 1 + oracle <- getOracle h1 + + void $ activateContractWallet (Wallet 2) $ checkOracle oracle + + callEndpoint @"update" h1 1_500_000 + void $ Emulator.waitNSlots 3 + + void $ activateContractWallet (Wallet 1) ownFunds' + void $ activateContractWallet (Wallet 3) ownFunds' + void $ activateContractWallet (Wallet 4) ownFunds' + void $ activateContractWallet (Wallet 5) ownFunds' + + h3 <- activateContractWallet (Wallet 3) $ swap oracle + h4 <- activateContractWallet (Wallet 4) $ swap oracle + h5 <- activateContractWallet (Wallet 5) $ swap oracle + + callEndpoint @"offer" h3 10_000_000 + callEndpoint @"offer" h4 20_000_000 + void $ Emulator.waitNSlots 3 + + callEndpoint @"use" h5 () + void $ Emulator.waitNSlots 3 + + callEndpoint @"update" h1 1_700_000 + void $ Emulator.waitNSlots 3 + + callEndpoint @"use" h5 () + void $ Emulator.waitNSlots 3 + + callEndpoint @"update" h1 1_800_000 + void $ Emulator.waitNSlots 3 + + callEndpoint @"retrieve" h3 () + callEndpoint @"retrieve" h4 () + void $ Emulator.waitNSlots 3 + where + getOracle :: ContractHandle (Last Oracle) OracleSchema Text -> EmulatorTrace Oracle + getOracle h = do + l <- observableState h + case l of + Last Nothing -> Emulator.waitNSlots 1 >> getOracle h + Last (Just oracle) -> Extras.logInfo (show oracle) >> return oracle From 01ed74dc2d10b64ea9a6b03018679f14dc45658c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Br=C3=BCnjes?= Date: Tue, 27 Jul 2021 00:14:05 +0200 Subject: [PATCH 2/4] fixed regular expression in oracle-client --- code/week06/app/oracle-client.hs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/week06/app/oracle-client.hs b/code/week06/app/oracle-client.hs index b003f87..9ec08fe 100644 --- a/code/week06/app/oracle-client.hs +++ b/code/week06/app/oracle-client.hs @@ -51,7 +51,7 @@ getExchangeRate = runReq defaultHttpConfig $ do NoReqBody bsResponse mempty - let priceRegex = "priceValue___11gHJ\">\\$([\\.0-9]*)" :: ByteString + let priceRegex = "priceValue___11gHJ \">\\$([\\.0-9]*)" :: ByteString (_, _, _, [bs]) = responseBody v =~ priceRegex :: (ByteString, ByteString, ByteString, [ByteString]) d = read $ unpack bs :: Double x = round $ 1_000_000 * d From 8620b47b8cce738433377dd24d180a1fd51749c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Br=C3=BCnjes?= Date: Wed, 28 Jul 2021 21:07:01 +0200 Subject: [PATCH 3/4] small reformatting --- code/week06/src/Week06/Oracle/Swap.hs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/week06/src/Week06/Oracle/Swap.hs b/code/week06/src/Week06/Oracle/Swap.hs index 7856a64..39b33c5 100644 --- a/code/week06/src/Week06/Oracle/Swap.hs +++ b/code/week06/src/Week06/Oracle/Swap.hs @@ -143,7 +143,7 @@ findSwaps oracle p = do retrieveSwaps :: Oracle -> Contract w s Text () retrieveSwaps oracle = do pkh <- pubKeyHash <$> ownPubKey - xs <- findSwaps oracle (== pkh) + xs <- findSwaps oracle (== pkh) case xs of [] -> logInfo @String "no swaps found" _ -> do @@ -180,7 +180,7 @@ useSwap oracle = do Constraints.mustPayToOtherScript (validatorHash $ oracleValidator oracle) (Datum $ PlutusTx.toBuiltinData x) - v <> + v <> Constraints.mustPayToPubKey pkh' p ledgerTx <- submitTxConstraintsWith @Swapping lookups tx awaitTxConfirmed $ txId ledgerTx From 773a982d4f651037a193a2b85ef8ca73c7043915 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Br=C3=BCnjes?= Date: Wed, 28 Jul 2021 23:14:23 +0200 Subject: [PATCH 4/4] updated README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d0c89b5..1c11d61 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,11 @@ - Native Tokens. - NFT's. +- [Lecture #6](https://youtu.be/24SHPHEc3zo) + + - Oracles. + - Using the PAB. + ## Code Examples - Lecture #1: [English Auction](code/week01) @@ -43,6 +48,7 @@ - Lecture #3: [Script Context & Parameterized Contracts](code/week03) - Lecture #4: [Monad, Traces & Contracts](code/week04) - Lecture #5: [Native Tokens](code/week05) +- Lecture #6: [Oracles](code/week06) ## Exercises @@ -80,6 +86,10 @@ - Add a deadline to the minting policy in the [Homework1](code/week05/src/Week05/Homework1.hs) module. - Fix the token name to the empty ByteString in the NFT contract in the [Homework2](code/week05/src/Week05/Homework2.hs) module. +- Week #6 + + - Get the Oracle demo running and extend it in some way. + ## Some Plutus Modules - [`Language.Marlowe.Semantics`](https://github.com/input-output-hk/plutus/blob/master/marlowe/src/Language/Marlowe/Semantics.hs), contains Marlowe types and semantics.