From dd3104ea778064b539f6a2d9b760a1e70a9a651f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Br=C3=BCnjes?= Date: Tue, 30 Mar 2021 23:39:38 +0200 Subject: [PATCH] initial commit --- .../.devcontainer/devcontainer.json | 21 ++ code/english-auction/.gitignore | 1 + code/english-auction/LICENSE | 201 ++++++++++++++++++ code/english-auction/cabal.project | 136 ++++++++++++ code/english-auction/english-auction.cabal | 23 ++ code/english-auction/hie.yaml | 4 + code/english-auction/src/EnglishAuction.hs | 144 +++++++++++++ 7 files changed, 530 insertions(+) create mode 100644 code/english-auction/.devcontainer/devcontainer.json create mode 100644 code/english-auction/.gitignore create mode 100644 code/english-auction/LICENSE create mode 100644 code/english-auction/cabal.project create mode 100644 code/english-auction/english-auction.cabal create mode 100644 code/english-auction/hie.yaml create mode 100644 code/english-auction/src/EnglishAuction.hs diff --git a/code/english-auction/.devcontainer/devcontainer.json b/code/english-auction/.devcontainer/devcontainer.json new file mode 100644 index 0000000..68c9010 --- /dev/null +++ b/code/english-auction/.devcontainer/devcontainer.json @@ -0,0 +1,21 @@ +{ + "name": "Plutus Starter Project", + "image": "plutus-devcontainer:latest", + + "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=/root/.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/english-auction/.gitignore b/code/english-auction/.gitignore new file mode 100644 index 0000000..c33954f --- /dev/null +++ b/code/english-auction/.gitignore @@ -0,0 +1 @@ +dist-newstyle/ diff --git a/code/english-auction/LICENSE b/code/english-auction/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/code/english-auction/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/english-auction/cabal.project b/code/english-auction/cabal.project new file mode 100644 index 0000000..280e67f --- /dev/null +++ b/code/english-auction/cabal.project @@ -0,0 +1,136 @@ +index-state: 2021-02-24T00: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-core + plutus-contract + plutus-ledger + plutus-ledger-api + plutus-tx + plutus-tx-plugin + prettyprinter-configurable + tag: 49ebc9e874212c9e81ae82305eddd7518970dc0a + +-- 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. + +package eventful-sql-common + ghc-options: -XDerivingStrategies -XStandaloneDeriving -XUndecidableInstances -XDataKinds -XFlexibleInstances + +allow-newer: + -- Has a commit to allow newer aeson, not on Hackage yet + monoidal-containers:aeson + -- 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 + +constraints: + -- aws-lambda-haskell-runtime-wai doesn't compile with newer versions + aws-lambda-haskell-runtime <= 3.0.3 + +-- 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: f73079303f663e028288f9f4a9e08bcca39a923e + +-- Needs a fix (https://github.com/wenkokke/unlit/pull/11) and a Hackage release +source-repository-package + type: git + location: https://github.com/michaelpj/unlit.git + tag: 9ca1112093c5ffd356fc99c7dafa080e686dd748 + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-base + tag: 4251c0bb6e4f443f00231d28f5f70d42876da055 + subdir: + binary + binary/test + slotting + cardano-crypto-class + cardano-crypto-praos + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-prelude + tag: ee4e7b547a991876e6b05ba542f4e62909f4a571 + subdir: + cardano-prelude + cardano-prelude-test + +source-repository-package + type: git + location: https://github.com/input-output-hk/ouroboros-network + tag: 6cb9052bde39472a0555d19ade8a42da63d3e904 + subdir: + typed-protocols + typed-protocols-examples + ouroboros-network + ouroboros-network-testing + ouroboros-network-framework + io-sim + io-sim-classes + network-mux + Win32-network + +source-repository-package + type: git + location: https://github.com/input-output-hk/iohk-monitoring-framework + tag: a89c38ed5825ba17ca79fddb85651007753d699d + subdir: + iohk-monitoring + tracer-transformers + contra-tracer + plugins/backend-ekg + +source-repository-package + type: git + location: https://github.com/input-output-hk/cardano-ledger-specs + tag: 097890495cbb0e8b62106bcd090a5721c3f4b36f + 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-ma/impl + +source-repository-package + type: git + location: https://github.com/input-output-hk/goblins + tag: cde90a2b27f79187ca8310b6549331e59595e7ba diff --git a/code/english-auction/english-auction.cabal b/code/english-auction/english-auction.cabal new file mode 100644 index 0000000..d8beef7 --- /dev/null +++ b/code/english-auction/english-auction.cabal @@ -0,0 +1,23 @@ +Cabal-Version: 2.4 +Name: english-auction +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: EnglishAuction + build-depends: aeson + , base ^>=4.14.1.0 + , playground-common + , plutus-contract + , plutus-ledger + , 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/english-auction/hie.yaml b/code/english-auction/hie.yaml new file mode 100644 index 0000000..261cc3b --- /dev/null +++ b/code/english-auction/hie.yaml @@ -0,0 +1,4 @@ +cradle: + cabal: + - path: "./src" + component: "lib:english-auction" diff --git a/code/english-auction/src/EnglishAuction.hs b/code/english-auction/src/EnglishAuction.hs new file mode 100644 index 0000000..773c2fb --- /dev/null +++ b/code/english-auction/src/EnglishAuction.hs @@ -0,0 +1,144 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE DerivingStrategies #-} +{-# LANGUAGE FlexibleContexts #-} +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE MultiParamTypeClasses #-} +{-# LANGUAGE NoImplicitPrelude #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE TypeFamilies #-} +{-# LANGUAGE TypeOperators #-} + +module EnglishAuction + ( Auction (..) + , StartParams (..) + , AuctionSchema + , start + , endpoints + , schemas + , ensureKnownCurrencies + , printJson + , printSchemas + , registeredKnownCurrencies + , stage + ) where + +import Control.Monad hiding (fmap) +import Data.Aeson (ToJSON, FromJSON) +import Data.List.NonEmpty (NonEmpty (..)) +import Data.Text (Text) +import GHC.Generics (Generic) +import Plutus.Contract hiding (when) +import qualified PlutusTx as PlutusTx +import PlutusTx.Prelude hiding (unless) +import Ledger hiding (singleton) +import Ledger.Constraints as Constraints +import qualified Ledger.Scripts as Scripts +import qualified Ledger.Typed.Scripts as Scripts +import Ledger.Value as Value +import Playground.Contract (ensureKnownCurrencies, printSchemas, stage, printJson) +import Playground.TH (mkKnownCurrencies, mkSchemaDefinitions) +import Playground.Types (KnownCurrency (..)) +import Schema (ToSchema) +import Text.Printf (printf) + +data Auction = Auction + { aSeller :: !PubKeyHash + , aDeadline :: !Slot + , aMinBid :: !Integer + } deriving (Show, Generic, ToJSON, FromJSON, ToSchema) + +PlutusTx.unstableMakeIsData ''Auction +PlutusTx.makeLift ''Auction + +data Bid = MkBid !PubKeyHash !Integer + deriving Show + +PlutusTx.unstableMakeIsData ''Bid +PlutusTx.makeLift ''Bid + +data AuctionAction = Start Auction | Bid Bid | Success | Failure + deriving Show + +PlutusTx.unstableMakeIsData ''AuctionAction +PlutusTx.makeLift ''AuctionAction + +data AuctionDatum = AuctionDatum + { adAuction :: !Auction + , adHighestBid :: !(Maybe Bid) + } deriving Show + +PlutusTx.unstableMakeIsData ''AuctionDatum +PlutusTx.makeLift ''AuctionDatum + +data Auctioning +instance Scripts.ScriptType Auctioning where + type instance RedeemerType Auctioning = AuctionAction + type instance DatumType Auctioning = AuctionDatum + +{-# INLINABLE mkAuctionValidator #-} +mkAuctionValidator :: AuctionDatum -> AuctionAction -> ValidatorCtx -> Bool +mkAuctionValidator _ _ _ = True + +auctionInstance :: Scripts.ScriptInstance Auctioning +auctionInstance = Scripts.validator @Auctioning + $$(PlutusTx.compile [|| mkAuctionValidator ||]) + $$(PlutusTx.compile [|| wrap ||]) + where + wrap = Scripts.wrapValidator @AuctionDatum @AuctionAction + +auctionValidator :: Validator +auctionValidator = Scripts.validatorScript auctionInstance + +auctionHash :: Ledger.ValidatorHash +auctionHash = Scripts.validatorHash auctionValidator + +auctionAddress :: Ledger.Address +auctionAddress = ScriptAddress auctionHash + +data StartParams = StartParams + { spDeadline :: !Slot + , spMinBid :: !Integer + , spCurrency :: !CurrencySymbol + , spToken :: !TokenName + } deriving (Generic, ToJSON, FromJSON, ToSchema) + +type AuctionSchema = + BlockchainActions + .\/ Endpoint "start" StartParams + +start :: HasBlockchainActions s => StartParams -> Contract w s Text () +start StartParams{..} = do + pkh <- pubKeyHash <$> ownPubKey + let a = Auction + { aSeller = pkh + , aDeadline = spDeadline + , aMinBid = spMinBid + } + d = AuctionDatum + { adAuction = a + , adHighestBid = Nothing + } + v = Value.singleton spCurrency spToken 1 + tx = mustPayToTheScript d v + ledgerTx <- submitTxConstraints auctionInstance tx + void $ awaitTxConfirmed $ txId ledgerTx + logInfo @String $ printf "started auction %s for token %s" (show a) (show v) + +endpoints :: Contract () AuctionSchema Text () +endpoints = start' >> endpoints + where + start' = endpoint @"start" >>= start + +mkSchemaDefinitions ''AuctionSchema + +myToken :: KnownCurrency +myToken = KnownCurrency (ValidatorHash "ffff") "Token" (TokenName "T" :| []) + +mkKnownCurrencies ['myToken]