diff --git a/cabal.project b/cabal.project index ae88256c72e..bfd0d7d5595 100644 --- a/cabal.project +++ b/cabal.project @@ -28,6 +28,7 @@ packages: plutus-benchmark plutus-tx-test-util prettyprinter-configurable stubs/plutus-ghc-stub + doc/docusaurus/docusaurus-examples.cabal -- We never, ever, want this. write-ghc-environment-files: never diff --git a/doc/docusaurus/LICENSE b/doc/docusaurus/LICENSE new file mode 100644 index 00000000000..d6456956733 --- /dev/null +++ b/doc/docusaurus/LICENSE @@ -0,0 +1,202 @@ + + 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/doc/docusaurus/docs/using-plutus-tx/producing-a-blueprint.md b/doc/docusaurus/docs/using-plutus-tx/producing-a-blueprint.md index 264ae19cd7b..d04f7fb0257 100644 --- a/doc/docusaurus/docs/using-plutus-tx/producing-a-blueprint.md +++ b/doc/docusaurus/docs/using-plutus-tx/producing-a-blueprint.md @@ -23,15 +23,15 @@ writeBlueprint In order to demonstrate the usage of the `writeBlueprint` function, let's consider the following example validator function and its interface: - + - + ## Importing required functionality First of all, we need to import required functionality: - + ## Defining a contract blueprint value @@ -75,7 +75,7 @@ data ContractBlueprint where We can construct a value of this type in the following way: - + The `contractId` field is optional and can be used to give a unique identifier to the contract. @@ -102,7 +102,7 @@ data Preamble = MkPreamble Here is an example construction: - + The `contractDefinitions` field is a registry of schema definitions used across the blueprint. It can be constructed using the `deriveDefinitions` function which automatically constructs schema definitions for all the types it is applied to including the types nested within them. @@ -111,15 +111,15 @@ Since every type in the `referencedTypes` list is going to have its derived JSON - An instance of the `GHC.Generics.Generic` type class: - + - An instance of the `AsDefinitionId` type class. Most of the time it could be derived generically with the `anyclass` strategy; for example: - + - An instance of the `HasSchema` type class. If your validator exposes standard supported types like `Integer` or `Bool`, you don't need to define this instance. If your validator uses custom types, then you should be deriving it using the `makeIsDataSchemaIndexed` Template Haskell function, which derives it alongside with the corresponding [ToBuiltinData]/[FromBuiltinData] instances; for example: - + ## Defining a validator blueprint @@ -146,7 +146,7 @@ Our contract can contain one or more validators. For each one we need to provide In our example, this would be: - + The `definitionRef` function is used to reference a schema definition of a given type. It is smart enough to discover the schema definition from the `referencedType` list and fails to compile if the referenced type is not included. @@ -155,7 +155,7 @@ It is smart enough to discover the schema definition from the `referencedType` l With all the pieces in place, we can now write the blueprint to a file: - + ## Annotations @@ -173,7 +173,7 @@ It's possible to add these keywords to a Blueprint type definition by annotating For example, to add a title and description to the `MyParams` type, we can use the `SchemaTitle` and `SchemaDescription` annotations: - + These annotations result in the following JSON schema definition: @@ -192,7 +192,7 @@ These annotations result in the following JSON schema definition: For sum-types, it's possible to annotate constructors: - + These annotations result in the following JSON schema definition: diff --git a/doc/docusaurus/docusaurus-examples.cabal b/doc/docusaurus/docusaurus-examples.cabal new file mode 100644 index 00000000000..40b254009fd --- /dev/null +++ b/doc/docusaurus/docusaurus-examples.cabal @@ -0,0 +1,27 @@ +cabal-version: 3.0 +name: docusaurus-examples +version: 0.1.0.0 +license: Apache-2.0 +license-file: LICENSE +author: Yura Lazaryev +maintainer: Yuriy.Lazaryev@iohk.io +category: Language +build-type: Simple + +common warnings + ghc-options: -Wall + +executable example-cip57 + import: warnings + main-is: Example/Cip57/Blueprint/Main.hs + hs-source-dirs: static/code + default-language: GHC2021 + other-modules: Paths_docusaurus_examples + build-depends: + , base ^>=4.18.2.0 + , bytestring ^>=0.11.5.3 + , containers ^>=0.6.7 + , plutus-ledger-api + , plutus-tx + , plutus-tx-plugin + , text ^>=2.0.2 diff --git a/doc/docusaurus/plutus.json b/doc/docusaurus/plutus.json new file mode 100644 index 00000000000..542a1ed4301 --- /dev/null +++ b/doc/docusaurus/plutus.json @@ -0,0 +1,92 @@ +{ + "$id": "my-contract", + "$schema": "https://cips.cardano.org/cips/cip57/schemas/plutus-blueprint.json", + "$vocabulary": { + "https://cips.cardano.org/cips/cip57": true, + "https://json-schema.org/draft/2020-12/vocab/applicator": true, + "https://json-schema.org/draft/2020-12/vocab/core": true, + "https://json-schema.org/draft/2020-12/vocab/validation": true + }, + "preamble": { + "title": "My Contract", + "description": "A simple contract", + "version": "1.0.0", + "plutusVersion": "v2", + "license": "MIT" + }, + "validators": [ + { + "title": "My Validator", + "description": "An example validator", + "redeemer": { + "title": "My Redeemer", + "description": "A redeemer that does something awesome", + "purpose": { + "oneOf": [ + "spend", + "mint" + ] + }, + "schema": { + "$ref": "#/definitions/MyRedeemer" + } + }, + "datum": { + "title": "My Datum", + "description": "A datum that contains something awesome", + "purpose": "spend", + "schema": { + "$ref": "#/definitions/Integer" + } + }, + "parameters": [ + { + "title": "My Validator Parameters", + "description": "Compile-time validator parameters", + "purpose": "spend", + "schema": { + "$ref": "#/definitions/MyParams" + } + } + ] + } + ], + "definitions": { + "Bool": { + "dataType": "#boolean" + }, + "Integer": { + "dataType": "integer" + }, + "MyParams": { + "title": "Title for the MyParams definition", + "description": "Description for the MyParams definition", + "dataType": "constructor", + "fields": [ + { + "$ref": "#/definitions/Bool" + }, + { + "$ref": "#/definitions/Integer" + } + ], + "index": 0 + }, + "MyRedeemer": { + "oneOf": [ + { + "$comment": "Left redeemer", + "dataType": "constructor", + "fields": [], + "index": 0 + }, + { + "$comment": "Right redeemer", + "dataType": "constructor", + "fields": [], + "index": 1 + } + ] + } + } +} diff --git a/doc/docusaurus/static/code/Cip57Blueprint.hs b/doc/docusaurus/static/code/Example/Cip57/Blueprint/Main.hs similarity index 83% rename from doc/docusaurus/static/code/Cip57Blueprint.hs rename to doc/docusaurus/static/code/Example/Cip57/Blueprint/Main.hs index 838533658c7..c0a857f3245 100644 --- a/doc/docusaurus/static/code/Cip57Blueprint.hs +++ b/doc/docusaurus/static/code/Example/Cip57/Blueprint/Main.hs @@ -6,6 +6,7 @@ {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE GADTs #-} {-# LANGUAGE KindSignatures #-} +{-# LANGUAGE NoImplicitPrelude #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE ScopedTypeVariables #-} @@ -19,23 +20,21 @@ -- END pragmas -module Cip57Blueprint where +module Main where -- BLOCK2 -- BEGIN imports import PlutusTx.Blueprint -import Data.ByteString (ByteString) -import Data.Kind (Type) -import Data.List.NonEmpty (NonEmpty) -import Data.Set (Set) +import PlutusTx.Prelude + import Data.Set qualified as Set -import Data.Text (Text) import GHC.Generics (Generic) -import PlutusLedgerApi.V3 (BuiltinData, ScriptContext, UnsafeFromData (..)) +import Paths_docusaurus_examples (getDataFileName) +import PlutusLedgerApi.V3 (Datum (..), Redeemer (..), ScriptContext (..), + ScriptInfo (SpendingScript), UnsafeFromData (..)) import PlutusTx.Blueprint.TH (makeIsDataSchemaIndexed) -import PlutusTx.Lift (makeLift) -import PlutusTx.Prelude (check) +import Prelude (FilePath, IO) -- END imports -- BLOCK3 @@ -64,8 +63,6 @@ data MyParams = MkMyParams , myInteger :: Integer } -$(makeLift ''MyParams) - -- END interface types -- BLOCK6 -- BEGIN makeIsDataSchemaIndexed MyParams @@ -91,19 +88,22 @@ deriving anyclass instance (AsDefinitionId MyRedeemer) -- BLOCK9 -- BEGIN validator -typedValidator :: MyParams -> MyDatum -> MyRedeemer -> ScriptContext -> Bool -typedValidator MkMyParams{..} datum redeemer _scriptContext = +typedValidator :: MyParams -> MyDatum -> MyRedeemer -> Bool +typedValidator MkMyParams{..} datum redeemer = case redeemer of R1 -> myBool R2 -> myInteger == datum -untypedValidator :: MyParams -> BuiltinData -> BuiltinData -> BuiltinData -> () -untypedValidator params datum redeemer scriptContext = - check $ typedValidator params datum' redeemer' scriptContext' - where - datum' = unsafeFromBuiltinData datum - redeemer' = unsafeFromBuiltinData redeemer - scriptContext' = unsafeFromBuiltinData scriptContext +untypedValidator :: MyParams -> BuiltinData -> BuiltinUnit +untypedValidator params scriptContext = + check + $ case unsafeFromBuiltinData scriptContext of + ScriptContext + _txInfo + (Redeemer redeemer) + (SpendingScript _ (Just (Datum datum))) -> + typedValidator params (unsafeFromBuiltinData datum) (unsafeFromBuiltinData redeemer) + _ -> False -- END validator -- BLOCK10 @@ -176,3 +176,5 @@ writeBlueprintToFile path = writeBlueprint path myContractBlueprint -- END write blueprint to file +main :: IO () +main = writeBlueprintToFile =<< getDataFileName "plutus.json"