Merge branch 'main' into marlowe-run-development

cabal.project

@@ -7,6 +7,7 @@ packages: doc
           marlowe-playground-server
           marlowe-dashboard-server
           marlowe-symbolic
+          marlowe-cli
 
 -- We never, ever, want this.
 write-ghc-environment-files: never

default.nix

@@ -39,6 +39,8 @@ rec {
 
   inherit (haskell.packages.marlowe.components.exes) marlowe-pab;
 
+  inherit (haskell.packages.marlowe-cli.components.exes) marlowe-cli;
+
   # TODO This stuff should probably be exposed as an overlay in the plutus-apps if
   # we switch to flakes.
   webCommonPlayground = pkgs.callPackage (sources.plutus-apps + "/web-common-playground") { inherit (marlowe.lib) gitignore-nix; };

marlowe-cli/LICENSE

@@ -0,0 +1,53 @@
+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:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+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
+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

marlowe-cli/NOTICE

@@ -0,0 +1,14 @@
+Copyright 2019 Input Output (Hong Kong) Ltd.
+
+   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.
+

marlowe-cli/ReadMe.md

@@ -0,0 +1,267 @@
+# Marlowe CLI Tool
+
+The `marlowe-cli` tool provides several utilities for serialising Marlowe contracts to validators, datums, and redeemers. It also computes hashes and addresses. It can be used in conjunction with [`cardano-cli`](https://github.com/input-output-hk/cardano-node/blob/master/cardano-cli/README.md) to submit Marlowe transactions to the Cardano blockchain.
+
+
+## Examples
+
+*   [simple contract](examples/simple/ReadMe.md)
+*   [escrow](examples/escrow/ReadMe.md)
+*   [swap](examples/swap/ReadMe.md)
+*   [zero-coupon bond](examples/zcb/ReadMe.md)
+
+
+## Available Commands
+
+    $ marlowe-cli --help
+
+    Usage: marlowe-cli [--version] COMMAND
+      Utilities for Marlowe.
+
+    marlow-cli : a command-line tool for Marlowe contracts
+
+    Usage: marlowe-cli [--version] (COMMAND | COMMAND)
+      Utilities for Marlowe.
+
+    Available options:
+      -h,--help                Show this help text
+      --version                Show version.
+
+    High-level commands:
+      run                      Run a contract.
+      template                 Create a contract from a template.
+
+    Low-level commands:
+      contract                 Export contract address, validator, datum, or redeemer.
+      input                    Create inputs to a contract.
+      role                     Export role address, validator, datum, or redeemer.
+      transaction              Create and submit transactions.
+      util                     Miscellaneous utilities.
+
+Help for subcommands:
+
+*   high-level commands
+    *   [`marlowe-cli run`](#run-commands)
+    *   [`marlowe-cli template`](#template-commands)
+*   low-level commands
+    *   [`marlowe-cli contract`](#contract-commands)
+    *   [`marlowe-cli input`](#input-commands)
+    *   [`marlowe-cli role`](#role-commands)
+    *   [`marlowe-cli transaction`](#transaction-commands)
+    *   [`marlowe-cli util`](#util-commands)
+
+
+### High-Level Commands
+
+
+#### "Run" Commands
+
+    $ marlowe-cli run --help
+
+    Usage: marlowe-cli run COMMAND
+      Run a contract.
+
+    Available options:
+      -h,--help                Show this help text
+
+    Commands for running contracts:
+      execute                  Run a Marlowe transaction.
+      initialize               Initialize the first transaction of a Marlowe contract and write output to a JSON file.
+      prepare                  Prepare the next step of a Marlowe contract and write the output to a JSON file.
+      withdraw                 Withdraw funds from the Marlowe role address.
+
+Individual help pages:
+
+*   [`marlowe-cli run execute`](doc/run-execute.md)
+*   [`marlowe-cli run initialize`](doc/run-initialize.md)
+*   [`marlowe-cli run prepare`](doc/run-prepare.md)
+*   [`marlowe-cli run withdraw`](doc/run-withdraw.md)
+
+
+#### "Template" Commands
+
+    $ marlowe-cli template --help
+
+    Usage: marlowe-cli template COMMAND
+      Create a contract from a template.
+
+    Available options:
+      -h,--help                Show this help text
+
+    Commands for creating Marlowe contracts from templates:
+      escrow                   Create an escrow contract.
+      simple                   Create a simple example contract.
+      swap                     Create a swap contract.
+      zcb                      Create a zero-coupon bond.
+
+
+### Low-Level Commands
+
+
+#### "Contract" Commands
+
+    $ marlowe-cli contract --help
+
+    Usage: marlowe-cli contract COMMAND
+      Export contract address, validator, datum, or redeemer.
+
+    Available options:
+      -h,--help                Show this help text
+
+    Low-level commands for exporting Marlowe contract information:
+      address                  Print a contract validator address.
+      datum                    Export a contract datum to a JSON file.
+      marlowe                  Export a Marlowe contract to a JSON file.
+      redeemer                 Export a contract redeemer to a JSON file.
+      validator                Export a contract validator to a JSON file.
+
+Individual help pages:
+
+*   [`marlowe-cli contract marlowe`](doc/export-marlowe.md)
+*   [`marlowe-cli contract address`](doc/export-address.md)
+*   [`marlowe-cli contract validator`](doc/export-validator.md)
+*   [`marlowe-cli contract datum`](doc/export-datum.md)
+*   [`marlowe-cli contract redeemer`](doc/export-redeemer.md)
+
+
+#### "Input" Commands
+
+    $ marlowe-cli input --help
+
+    Usage: marlowe-cli input COMMAND
+      Create inputs to a contract.
+
+    Available options:
+      -h,--help                Show this help text
+
+    Low-level commands for creating inputs to a contract:
+      choose                   Create Marlowe input for a choice.
+      deposit                  Create Marlowe input for a deposit.
+      notify                   Create Marlowe input for a notification.
+
+Individual help pages:
+
+*   [`marlowe-cli input deposit`](doc/input-deposit.md)
+*   [`marlowe-cli input choose`](doc/input-choose.md)
+*   [`marlowe-cli input notify`](doc/input-notify.md)
+
+
+#### "Role" Commands
+
+    $ marlowe-cli role --help
+
+    Usage: marlowe-cli role COMMAND
+      Export role address, validator, datum, or redeemer. [low-level]
+
+    Available options:
+      -h,--help                Show this help text
+
+    Low-level commands for exporting Marlowe role information:
+      address                  Print a role validator address.
+      datum                    Export a role datum to a JSON file.
+      redeemer                 Export a role redeemer to a JSON file.
+      validator                Export a role validator to a JSON file.
+
+
+#### "Transaction" Commands
+
+    $ marlowe-cli transaction --help
+
+    Usage: marlowe-cli transaction COMMAND
+      Create and submit transactions. [low-level]
+
+    Available options:
+      -h,--help                Show this help text
+
+    Low-level commands for creating and submitting transactions:
+      advance                  Build a transaction that both spends from and pays to a Marlowe script.
+      close                    Build a transaction that spends from a Marlowe script.
+      create                   Build a transaction that pays to a Marlowe script.
+      simple                   Build a non-Marlowe transaction.
+      submit                   Submit a transaction body.
+
+Individual help pages:
+
+*   [`marlowe-cli transaction simple`](doc/transaction-simple.md)
+*   [`marlowe-cli transaction create`](doc/transaction-create.md)
+*   [`marlowe-cli transaction advance`](doc/transaction-advance.md)
+*   [`marlowe-cli transaction close`](doc/transaction-close.md)
+*   [`marlowe-cli transaction submit`](doc/transaction-submit.md)
+
+
+#### "Util" Commands
+
+    $ marlowe-cli util --help
+
+    Usage: marlowe-cli util COMMAND
+      Miscellaneous utilities.
+
+    Available options:
+      -h,--help                Show this help text
+
+    Miscellaneous low-level commands:
+      clean                    Reorganize the UTxOs at an address, separating tokens.
+
+Individual help pages:
+
+*   [`marlowe-cli util clean`](doc/util-clean.md)
+
+
+## Installation
+
+Either install via using Nix and Cabal:
+
+    git clone https://github.com/input-output-hk/marlowe-cardano.git
+    nix-shell
+    cabal install exe:marlowe-cli
+
+or just using Cabal, if Cabal and GHC are already installed:
+
+    git clone https://github.com/input-output-hk/marlowe-cardano.git
+    cabal install exe:marlowe-cli
+
+
+## Low-Level Workflows for Building Marlowe Scripts, Datums, and Redeemers
+
+The `marlowe-cli` tools supports both granular and monolithic workflows for creating the files and hashes needed to submit Marlowe contracts with `cardano-cli`.
+
+
+### Monolithic Workflow
+
+The [`export-marlowe`](doc/export.md) command writes a JSON file with sufficient information to run the contract on the blockchain. It contains the following information.
+
+*   Script address
+*   Validator hash
+*   Datum hash
+*   CBOR for Plutus script
+*   JSON and CBOR for datum.
+*   JSON and CBOR for redeemer.
+*   Size of the above CBOR in bytes
+*   Execution cost
+
+The diagram below illusrates how the `export` command can be used in conjunction with [`jq`](https://stedolan.github.io/jq/manual/) and `cardano-cli`.
+
+![Marlowe workflow using `marlowe-cli`, `jq`, and `cardano-cli`.](doc/diagrams/workflow-jq.svg)
+
+See [example.marlowe](doc/example.marlowe) for an example file containing this information for a simple contract, and see [example-jq.sh](doc/example-jq.sh) for an example bash script embodying this workflow. A tutorial for this workflow is available [here](doc/tutorial-jq.md).
+
+
+### Granular Workflow
+
+The [`address`](doc/address.md), [`validator`](doc/validator.md), [`datum`](doc/datum.md), and [`redeemer`](doc/redeemer.md) commands write the corresponding subset of information to a JSON file or to the console. These allows finer-grain access to the capabilities of the `export` command. The diagram below illustrates how these commands can be used in conjunction with `cardano-cli`.
+
+![Marlowe workflow using `marlowe-cli` and `cardano-cli`.](doc/diagrams/workflow.svg)
+
+See [example.sh](doc/example.sh) for an example bash script embodying this workflow. A tutorial for this workflow is available [here](doc/tutorial.md).
+
+
+## Testing
+
+*   [simple contract](examples/simple/run-test.sh)
+*   escrow
+    *   ["everything is alright"](examples/escrow/run-everything-is-alright.sh)
+    *   ["confirm problem"](examples/escrow/run-confirm-problem.sh)
+    *   ["dismiss claim"](examples/escrow/run-dimiss-claim.sh)
+    *   ["confirm claim"](examples/escrow/run-confirm-claim.sh)
+*   [swap](examples/swap/run-swap.sh)
+*   [zero-coupon bond](examples/zcb/run-zcb.sh)