diff --git a/README.md b/README.md index 52a2c7d..0c9d5af 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,19 @@ - The `EmulatorTrace`-monad. - The `Contract`-monad. +- [Lecture #5](https://youtu.be/SsaVjSsPPcg) + + - Values. + - Native Tokens. + - NFT's. + ## Code Examples - Lecture #1: [English Auction](code/week01) - Lecture #2: [Simple validation](code/week02) - Lecture #3: [Script Context & Parameterized Contracts](code/week03) - Lecture #4: [Monad, Traces & Contracts](code/week04) +- Lecture #5: [Native Tokens](code/week05) ## Exercises @@ -74,6 +81,11 @@ - Implement function `payTrace` in the [Homework](code/week04/src/Week04/Homework.hs) module. - Handle exceptions thrown by `submitTx` in function `payContract` in the same module. +- Week #5 + + - 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. + ## 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. diff --git a/code/week05/.devcontainer/devcontainer.json b/code/week05/.devcontainer/devcontainer.json new file mode 100644 index 0000000..51f7dce --- /dev/null +++ b/code/week05/.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/week05/.gitignore b/code/week05/.gitignore new file mode 100644 index 0000000..c33954f --- /dev/null +++ b/code/week05/.gitignore @@ -0,0 +1 @@ +dist-newstyle/ diff --git a/code/week05/LICENSE b/code/week05/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/code/week05/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/week05/cabal.project b/code/week05/cabal.project new file mode 100644 index 0000000..edb0757 --- /dev/null +++ b/code/week05/cabal.project @@ -0,0 +1,193 @@ +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-tx + plutus-tx-plugin + prettyprinter-configurable + quickcheck-dynamic + word-array + tag: 8f1a47674a99ac9bc2aba3231375d8d6de0641d2 + +-- 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/week05/hie.yaml b/code/week05/hie.yaml new file mode 100644 index 0000000..4faa181 --- /dev/null +++ b/code/week05/hie.yaml @@ -0,0 +1,4 @@ +cradle: + cabal: + - path: "./src" + component: "lib:plutus-pioneer-program-week05" diff --git a/code/week05/plutus-pioneer-program-week05.cabal b/code/week05/plutus-pioneer-program-week05.cabal new file mode 100644 index 0000000..2857bee --- /dev/null +++ b/code/week05/plutus-pioneer-program-week05.cabal @@ -0,0 +1,33 @@ +Cabal-Version: 2.4 +Name: plutus-pioneer-program-week05 +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: Week05.Free + , Week05.Homework1 + , Week05.Homework2 + , Week05.NFT + , Week05.Signed + , Week05.Solution1 + , Week05.Solution2 + 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 + , text + default-language: Haskell2010 + ghc-options: -Wall -fobject-code -fno-ignore-interface-pragmas -fno-omit-interface-pragmas -fno-strictness -fno-spec-constr -fno-specialise diff --git a/code/week05/src/Week05/Free.hs b/code/week05/src/Week05/Free.hs new file mode 100644 index 0000000..d55892e --- /dev/null +++ b/code/week05/src/Week05/Free.hs @@ -0,0 +1,88 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week05.Free where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (mint, singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Value as Value +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Show (..), String) +import Text.Printf (printf) +import Wallet.Emulator.Wallet + +{-# INLINABLE mkPolicy #-} +mkPolicy :: () -> ScriptContext -> Bool +mkPolicy () _ = True + +policy :: Scripts.MintingPolicy +policy = mkMintingPolicyScript $$(PlutusTx.compile [|| Scripts.wrapMintingPolicy mkPolicy ||]) + +curSymbol :: CurrencySymbol +curSymbol = scriptCurrencySymbol policy + +data MintParams = MintParams + { mpTokenName :: !TokenName + , mpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type FreeSchema = Endpoint "mint" MintParams + +mint :: MintParams -> Contract w FreeSchema Text () +mint mp = do + let val = Value.singleton curSymbol (mpTokenName mp) (mpAmount mp) + lookups = Constraints.mintingPolicy policy + tx = Constraints.mustMintValue val + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + Contract.logInfo @String $ printf "forged %s" (show val) + +endpoints :: Contract () FreeSchema Text () +endpoints = mint' >> endpoints + where + mint' = endpoint @"mint" >>= mint + +mkSchemaDefinitions ''FreeSchema + +mkKnownCurrencies [] + +test :: IO () +test = runEmulatorTraceIO $ do + let tn = "ABC" + h1 <- activateContractWallet (Wallet 1) endpoints + h2 <- activateContractWallet (Wallet 2) endpoints + callEndpoint @"mint" h1 $ MintParams + { mpTokenName = tn + , mpAmount = 555 + } + callEndpoint @"mint" h2 $ MintParams + { mpTokenName = tn + , mpAmount = 444 + } + void $ Emulator.waitNSlots 1 + callEndpoint @"mint" h1 $ MintParams + { mpTokenName = tn + , mpAmount = -222 + } + void $ Emulator.waitNSlots 1 diff --git a/code/week05/src/Week05/Homework1.hs b/code/week05/src/Week05/Homework1.hs new file mode 100644 index 0000000..c391be6 --- /dev/null +++ b/code/week05/src/Week05/Homework1.hs @@ -0,0 +1,98 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week05.Homework1 where + +import Control.Monad hiding (fmap) +import Control.Monad.Freer.Extras as Extras +import Data.Aeson (ToJSON, FromJSON) +import Data.Default (Default (..)) +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (mint, singleton) +import Ledger.Constraints as Constraints +import Ledger.TimeSlot +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Value as Value +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show (..), String, undefined) +import Text.Printf (printf) +import Wallet.Emulator.Wallet + +{-# INLINABLE mkPolicy #-} +-- This policy should only allow minting (or burning) of tokens if the owner of the specified PubKeyHash +-- has signed the transaction and if the specified deadline has not passed. +mkPolicy :: PubKeyHash -> POSIXTime -> () -> ScriptContext -> Bool +mkPolicy pkh deadline () ctx = True -- FIX ME! + +policy :: PubKeyHash -> POSIXTime -> Scripts.MintingPolicy +policy pkh deadline = undefined -- IMPLEMENT ME! + +curSymbol :: PubKeyHash -> POSIXTime -> CurrencySymbol +curSymbol pkh deadline = undefined -- IMPLEMENT ME! + +data MintParams = MintParams + { mpTokenName :: !TokenName + , mpDeadline :: !POSIXTime + , mpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type SignedSchema = Endpoint "mint" MintParams + +mint :: MintParams -> Contract w SignedSchema Text () +mint mp = do + pkh <- pubKeyHash <$> Contract.ownPubKey + now <- Contract.currentTime + let deadline = mpDeadline mp + if now > deadline + then Contract.logError @String "deadline passed" + else do + let val = Value.singleton (curSymbol pkh deadline) (mpTokenName mp) (mpAmount mp) + lookups = Constraints.mintingPolicy $ policy pkh deadline + tx = Constraints.mustMintValue val <> Constraints.mustValidateIn (to $ now + 5000) + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + Contract.logInfo @String $ printf "forged %s" (show val) + +endpoints :: Contract () SignedSchema Text () +endpoints = mint' >> endpoints + where + mint' = endpoint @"mint" >>= mint + +mkSchemaDefinitions ''SignedSchema + +mkKnownCurrencies [] + +test :: IO () +test = runEmulatorTraceIO $ do + let tn = "ABC" + deadline = slotToBeginPOSIXTime def 10 + h <- activateContractWallet (Wallet 1) endpoints + callEndpoint @"mint" h $ MintParams + { mpTokenName = tn + , mpDeadline = deadline + , mpAmount = 555 + } + void $ Emulator.waitNSlots 15 + callEndpoint @"mint" h $ MintParams + { mpTokenName = tn + , mpDeadline = deadline + , mpAmount = 555 + } + void $ Emulator.waitNSlots 1 diff --git a/code/week05/src/Week05/Homework2.hs b/code/week05/src/Week05/Homework2.hs new file mode 100644 index 0000000..fbbd61b --- /dev/null +++ b/code/week05/src/Week05/Homework2.hs @@ -0,0 +1,66 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week05.Homework2 where + +import Control.Monad hiding (fmap) +import qualified Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (mint, singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Value as Value +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show (..), String, undefined) +import Text.Printf (printf) +import Wallet.Emulator.Wallet + +{-# INLINABLE mkPolicy #-} +-- Minting policy for an NFT, where the minting transaction must consume the given UTxO as input +-- and where the TokenName will be the empty ByteString. +mkPolicy :: TxOutRef -> () -> ScriptContext -> Bool +mkPolicy oref () ctx = True -- FIX ME! + +policy :: TxOutRef -> Scripts.MintingPolicy +policy oref = undefined -- IMPLEMENT ME! + +curSymbol :: TxOutRef -> CurrencySymbol +curSymbol = undefined -- IMPLEMENT ME! + +type NFTSchema = Endpoint "mint" () + +mint :: Contract w NFTSchema Text () +mint = undefined -- IMPLEMENT ME! + +endpoints :: Contract () NFTSchema Text () +endpoints = mint' >> endpoints + where + mint' = endpoint @"mint" >> mint + +mkSchemaDefinitions ''NFTSchema + +mkKnownCurrencies [] + +test :: IO () +test = runEmulatorTraceIO $ do + h1 <- activateContractWallet (Wallet 1) endpoints + h2 <- activateContractWallet (Wallet 2) endpoints + callEndpoint @"mint" h1 () + callEndpoint @"mint" h2 () + void $ Emulator.waitNSlots 1 diff --git a/code/week05/src/Week05/NFT.hs b/code/week05/src/Week05/NFT.hs new file mode 100644 index 0000000..33885fb --- /dev/null +++ b/code/week05/src/Week05/NFT.hs @@ -0,0 +1,93 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week05.NFT where + +import Control.Monad hiding (fmap) +import qualified Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (mint, singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Value as Value +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show (..), String) +import Text.Printf (printf) +import Wallet.Emulator.Wallet + +{-# INLINABLE mkPolicy #-} +mkPolicy :: TxOutRef -> TokenName -> () -> ScriptContext -> Bool +mkPolicy oref tn () ctx = traceIfFalse "UTxO not consumed" hasUTxO && + traceIfFalse "wrong amount minted" checkMintedAmount + where + info :: TxInfo + info = scriptContextTxInfo ctx + + hasUTxO :: Bool + hasUTxO = any (\i -> txInInfoOutRef i == oref) $ txInfoInputs info + + checkMintedAmount :: Bool + checkMintedAmount = case flattenValue (txInfoForge info) of + [(cs, tn', amt)] -> cs == ownCurrencySymbol ctx && tn' == tn && amt == 1 + _ -> False + +policy :: TxOutRef -> TokenName -> Scripts.MintingPolicy +policy oref tn = mkMintingPolicyScript $ + $$(PlutusTx.compile [|| \oref' tn' -> Scripts.wrapMintingPolicy $ mkPolicy oref' tn' ||]) + `PlutusTx.applyCode` + PlutusTx.liftCode oref + `PlutusTx.applyCode` + PlutusTx.liftCode tn + +curSymbol :: TxOutRef -> TokenName -> CurrencySymbol +curSymbol oref tn = scriptCurrencySymbol $ policy oref tn + +type NFTSchema = Endpoint "mint" TokenName + +mint :: TokenName -> Contract w NFTSchema Text () +mint tn = do + pk <- Contract.ownPubKey + utxos <- utxoAt (pubKeyAddress pk) + case Map.keys utxos of + [] -> Contract.logError @String "no utxo found" + oref : _ -> do + let val = Value.singleton (curSymbol oref tn) tn 1 + lookups = Constraints.mintingPolicy (policy oref tn) <> Constraints.unspentOutputs utxos + tx = Constraints.mustMintValue val <> Constraints.mustSpendPubKeyOutput oref + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + Contract.logInfo @String $ printf "forged %s" (show val) + +endpoints :: Contract () NFTSchema Text () +endpoints = mint' >> endpoints + where + mint' = endpoint @"mint" >>= mint + +mkSchemaDefinitions ''NFTSchema + +mkKnownCurrencies [] + +test :: IO () +test = runEmulatorTraceIO $ do + let tn = "ABC" + h1 <- activateContractWallet (Wallet 1) endpoints + h2 <- activateContractWallet (Wallet 2) endpoints + callEndpoint @"mint" h1 tn + callEndpoint @"mint" h2 tn + void $ Emulator.waitNSlots 1 diff --git a/code/week05/src/Week05/Signed.hs b/code/week05/src/Week05/Signed.hs new file mode 100644 index 0000000..27c6328 --- /dev/null +++ b/code/week05/src/Week05/Signed.hs @@ -0,0 +1,92 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week05.Signed where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (mint, singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Value as Value +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Show (..), String) +import Text.Printf (printf) +import Wallet.Emulator.Wallet + +{-# INLINABLE mkPolicy #-} +mkPolicy :: PubKeyHash -> () -> ScriptContext -> Bool +mkPolicy pkh () ctx = txSignedBy (scriptContextTxInfo ctx) pkh + +policy :: PubKeyHash -> Scripts.MintingPolicy +policy pkh = mkMintingPolicyScript $ + $$(PlutusTx.compile [|| Scripts.wrapMintingPolicy . mkPolicy ||]) + `PlutusTx.applyCode` + (PlutusTx.liftCode pkh) + +curSymbol :: PubKeyHash -> CurrencySymbol +curSymbol = scriptCurrencySymbol . policy + +data MintParams = MintParams + { mpTokenName :: !TokenName + , mpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type SignedSchema = Endpoint "mint" MintParams + +mint :: MintParams -> Contract w SignedSchema Text () +mint mp = do + pkh <- pubKeyHash <$> Contract.ownPubKey + let val = Value.singleton (curSymbol pkh) (mpTokenName mp) (mpAmount mp) + lookups = Constraints.mintingPolicy $ policy pkh + tx = Constraints.mustMintValue val + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + Contract.logInfo @String $ printf "forged %s" (show val) + +endpoints :: Contract () SignedSchema Text () +endpoints = mint' >> endpoints + where + mint' = endpoint @"mint" >>= mint + +mkSchemaDefinitions ''SignedSchema + +mkKnownCurrencies [] + +test :: IO () +test = runEmulatorTraceIO $ do + let tn = "ABC" + h1 <- activateContractWallet (Wallet 1) endpoints + h2 <- activateContractWallet (Wallet 2) endpoints + callEndpoint @"mint" h1 $ MintParams + { mpTokenName = tn + , mpAmount = 555 + } + callEndpoint @"mint" h2 $ MintParams + { mpTokenName = tn + , mpAmount = 444 + } + void $ Emulator.waitNSlots 1 + callEndpoint @"mint" h1 $ MintParams + { mpTokenName = tn + , mpAmount = -222 + } + void $ Emulator.waitNSlots 1 diff --git a/code/week05/src/Week05/Solution1.hs b/code/week05/src/Week05/Solution1.hs new file mode 100644 index 0000000..9fc6cf3 --- /dev/null +++ b/code/week05/src/Week05/Solution1.hs @@ -0,0 +1,104 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week05.Solution1 where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.Default (Default (..)) +import Data.Text (Text) +import Data.Void (Void) +import GHC.Generics (Generic) +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (mint, singleton) +import Ledger.Constraints as Constraints +import Ledger.TimeSlot +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Value as Value +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show (..), String) +import Text.Printf (printf) +import Wallet.Emulator.Wallet + +{-# INLINABLE mkPolicy #-} +mkPolicy :: PubKeyHash -> POSIXTime -> () -> ScriptContext -> Bool +mkPolicy pkh deadline () ctx = + traceIfFalse "signature missing" (txSignedBy info pkh) && + traceIfFalse "deadline missed" (to deadline `contains` txInfoValidRange info) + where + info = scriptContextTxInfo ctx + +policy :: PubKeyHash -> POSIXTime -> Scripts.MintingPolicy +policy pkh deadline = mkMintingPolicyScript $ + $$(PlutusTx.compile [|| \pkh' deadline' -> Scripts.wrapMintingPolicy $ mkPolicy pkh' deadline' ||]) + `PlutusTx.applyCode` + PlutusTx.liftCode pkh + `PlutusTx.applyCode` + PlutusTx.liftCode deadline + +curSymbol :: PubKeyHash -> POSIXTime -> CurrencySymbol +curSymbol pkh deadline = scriptCurrencySymbol $ policy pkh deadline + +data MintParams = MintParams + { mpTokenName :: !TokenName + , mpDeadline :: !POSIXTime + , mpAmount :: !Integer + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type SignedSchema = Endpoint "mint" MintParams + +mint :: MintParams -> Contract w SignedSchema Text () +mint mp = do + pkh <- pubKeyHash <$> Contract.ownPubKey + now <- Contract.currentTime + let deadline = mpDeadline mp + if now > deadline + then Contract.logError @String "deadline passed" + else do + let val = Value.singleton (curSymbol pkh deadline) (mpTokenName mp) (mpAmount mp) + lookups = Constraints.mintingPolicy $ policy pkh deadline + tx = Constraints.mustMintValue val <> Constraints.mustValidateIn (to $ now + 5000) + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + Contract.logInfo @String $ printf "forged %s" (show val) + +endpoints :: Contract () SignedSchema Text () +endpoints = mint' >> endpoints + where + mint' = endpoint @"mint" >>= mint + +mkSchemaDefinitions ''SignedSchema + +mkKnownCurrencies [] + +test :: IO () +test = runEmulatorTraceIO $ do + let tn = "ABC" + deadline = slotToBeginPOSIXTime def 10 + h <- activateContractWallet (Wallet 1) endpoints + callEndpoint @"mint" h $ MintParams + { mpTokenName = tn + , mpDeadline = deadline + , mpAmount = 555 + } + void $ Emulator.waitNSlots 15 + callEndpoint @"mint" h $ MintParams + { mpTokenName = tn + , mpDeadline = deadline + , mpAmount = 555 + } + void $ Emulator.waitNSlots 1 diff --git a/code/week05/src/Week05/Solution2.hs b/code/week05/src/Week05/Solution2.hs new file mode 100644 index 0000000..5610d70 --- /dev/null +++ b/code/week05/src/Week05/Solution2.hs @@ -0,0 +1,94 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module Week05.Solution2 where + +import Control.Monad hiding (fmap) +import qualified Data.Map as Map +import Data.Text (Text) +import Data.Void (Void) +import Plutus.Contract as Contract +import Plutus.Trace.Emulator as Emulator +import qualified PlutusTx +import PlutusTx.Prelude hiding (Semigroup(..), unless) +import Ledger hiding (mint, singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Value as Value +import Playground.Contract (printJson, printSchemas, ensureKnownCurrencies, stage, ToSchema) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Prelude (IO, Semigroup (..), Show (..), String) +import Text.Printf (printf) +import Wallet.Emulator.Wallet + +{-# INLINABLE tn #-} +tn :: TokenName +tn = TokenName emptyByteString + +{-# INLINABLE mkPolicy #-} +mkPolicy :: TxOutRef -> () -> ScriptContext -> Bool +mkPolicy oref () ctx = traceIfFalse "UTxO not consumed" hasUTxO && + traceIfFalse "wrong amount minted" checkMintedAmount + where + info :: TxInfo + info = scriptContextTxInfo ctx + + hasUTxO :: Bool + hasUTxO = any (\i -> txInInfoOutRef i == oref) $ txInfoInputs info + + checkMintedAmount :: Bool + checkMintedAmount = case flattenValue (txInfoForge info) of + [(cs, tn', amt)] -> cs == ownCurrencySymbol ctx && tn' == tn && amt == 1 + _ -> False + +policy :: TxOutRef -> Scripts.MintingPolicy +policy oref = mkMintingPolicyScript $ + $$(PlutusTx.compile [|| Scripts.wrapMintingPolicy . mkPolicy ||]) + `PlutusTx.applyCode` + PlutusTx.liftCode oref + +curSymbol :: TxOutRef -> CurrencySymbol +curSymbol = scriptCurrencySymbol . policy + +type NFTSchema = Endpoint "mint" () + +mint :: Contract w NFTSchema Text () +mint = do + pk <- Contract.ownPubKey + utxos <- utxoAt (pubKeyAddress pk) + case Map.keys utxos of + [] -> Contract.logError @String "no utxo found" + oref : _ -> do + let val = Value.singleton (curSymbol oref) tn 1 + lookups = Constraints.mintingPolicy (policy oref) <> Constraints.unspentOutputs utxos + tx = Constraints.mustMintValue val <> Constraints.mustSpendPubKeyOutput oref + ledgerTx <- submitTxConstraintsWith @Void lookups tx + void $ awaitTxConfirmed $ txId ledgerTx + Contract.logInfo @String $ printf "forged %s" (show val) + +endpoints :: Contract () NFTSchema Text () +endpoints = mint' >> endpoints + where + mint' = endpoint @"mint" >> mint + +mkSchemaDefinitions ''NFTSchema + +mkKnownCurrencies [] + +test :: IO () +test = runEmulatorTraceIO $ do + h1 <- activateContractWallet (Wallet 1) endpoints + h2 <- activateContractWallet (Wallet 2) endpoints + callEndpoint @"mint" h1 () + callEndpoint @"mint" h2 () + void $ Emulator.waitNSlots 1