Add example with wait action between transactions

Author: gege251

examples/plutus-transfer/README.md

@@ -1,7 +1,5 @@
-### plutus-helloworld
+### plutus-transfer
 
-This directory contains a simple "Hello World" script.  There are two versions: one using an integer literal (needed because the Plutus interpreter doesn't currently accept byte string literals) and a slighly more complicated one using a bytestring parameter.
-
-``plutus-helloworld'' -- very simple numeric version
-
-``plutus-helloworld-bytestring'' -- more compex version using bytestring constant
+Simple value transfer from an address to multiple addresses. With the tfpOutputPerTx option,
+payment tx outputs can be grouped together into separate txs, the Contract waits for at least one
+block in between.

examples/plutus-transfer/ada-transfer.sh

@@ -2,11 +2,14 @@
 CONTRACT_INST_ID=$(curl --location --request POST 'localhost:9080/api/contract/activate' \
   --header 'Content-Type: application/json' \
   --data-raw '{
-      "caID": [
-        [ {"getPubKeyHash": "981fc565bcf0c95c0cfa6ee6693875b60d529d87ed7082e9bf03c6a4"},
-          {"getValue": [[{"unCurrencySymbol":""},[[{"unTokenName": ""}, 1500000]]]]}
-        ]
+      "caID": {
+        "tfpOutputPerTx": 50,
+        "tfpPayments": [
+          [ {"getPubKeyHash": "981fc565bcf0c95c0cfa6ee6693875b60d529d87ed7082e9bf03c6a4"},
+            {"getValue": [[{"unCurrencySymbol":""},[[{"unTokenName": ""}, 1500000]]]]}
+          ]
         ]
+      }
   }' | jq -r .unContractInstanceId )
 
 echo $CONTRACT_INST_ID

examples/plutus-transfer/app/Main.hs

@@ -6,14 +6,13 @@ module Main (main) where
 import Cardano.Api (NetworkId (Testnet), NetworkMagic (..))
 import Cardano.PlutusExample.Transfer (
   TransferSchema,
+  TransferParams,
   transfer,
  )
 import Data.Aeson qualified as JSON
 import Data.Aeson.TH (defaultOptions, deriveJSON)
 import Data.ByteString.Lazy qualified as LazyByteString
 import Data.Maybe (fromMaybe)
-import Ledger.Crypto (PubKeyHash)
-import Ledger.Value (Value)
 import BotPlutusInterface qualified
 import BotPlutusInterface.Types (
   CLILocation (Local),
@@ -40,7 +39,7 @@ instance HasDefinitions TransferContracts where
     Transfer payments ->
       SomeBuiltin $ transfer payments
 
-newtype TransferContracts = Transfer [(PubKeyHash, Value)]
+newtype TransferContracts = Transfer TransferParams
   deriving stock (Show)
 
 $(deriveJSON defaultOptions ''TransferContracts)

examples/plutus-transfer/src/Cardano/PlutusExample/Transfer.hs

@@ -1,20 +1,46 @@
-module Cardano.PlutusExample.Transfer (TransferSchema, transfer) where
+{-# LANGUAGE DeriveAnyClass #-}
+{-# LANGUAGE TemplateHaskell #-}
 
-import Control.Monad (void)
+module Cardano.PlutusExample.Transfer (
+  TransferParams (TransferParams),
+  TransferSchema,
+  transfer,
+) where
+
+import Control.Monad (forM_)
+import Data.Aeson.TH (defaultOptions, deriveJSON)
 import Data.Bifunctor (first)
 import Data.Monoid (Last (Last))
 import Data.Text (Text)
+import GHC.Generics (Generic)
 import Ledger hiding (singleton)
 import Ledger.Constraints as Constraints
-import Plutus.Contract (Contract, Endpoint, submitTx, tell)
-import PlutusTx.Prelude hiding (Semigroup (..), unless)
+import Plutus.Contract (Contract, Endpoint, submitTx, tell, waitNSlots)
+import Schema (ToSchema)
+import Prelude
 
 type TransferSchema =
-  Endpoint "transfer" [(PubKeyHash, Value)]
+  Endpoint "transfer" TransferParams
+
+data TransferParams = TransferParams
+  { tfpOutputPerTx :: Int
+  , tfpPayments :: [(PubKeyHash, Value)]
+  }
+  deriving stock (Show, Eq, Generic)
+  deriving anyclass (ToSchema)
 
-transfer :: [(PubKeyHash, Value)] -> Contract (Last Text) TransferSchema Text ()
-transfer payments = do
+$(deriveJSON defaultOptions ''TransferParams)
+
+transfer :: TransferParams -> Contract (Last Text) TransferSchema Text ()
+transfer (TransferParams outputPerTx allPayments) = do
   tell $ Last $ Just "Contract started"
-  let tx = mconcat $ map (uncurry Constraints.mustPayToPubKey . first PaymentPubKeyHash) payments
-  void $ submitTx tx
+  let txs =
+        map (mconcat . map (uncurry Constraints.mustPayToPubKey . first PaymentPubKeyHash)) $
+          group outputPerTx $ allPayments
+  forM_ txs $ \tx -> submitTx tx >> waitNSlots 1
   tell $ Last $ Just "Finished"
+
+group :: Int -> [a] -> [[a]]
+group n list
+  | length list <= n = [list]
+  | otherwise = let (xs, xss) = splitAt n list in xs : group n xss

examples/plutus-transfer/token-transfer.sh

@@ -2,17 +2,20 @@
 CONTRACT_INST_ID=$(curl --location --request POST 'localhost:9080/api/contract/activate' \
   --header 'Content-Type: application/json' \
   --data-raw '{
-      "caID": [
-        [ {"getPubKeyHash": "981fc565bcf0c95c0cfa6ee6693875b60d529d87ed7082e9bf03c6a4"},
-          {"getValue": [[{"unCurrencySymbol":"1d6445ddeda578117f393848e685128f1e78ad0c4e48129c5964dc2e"},[[{"unTokenName": "testToken"}, 15]]]]}
-        ],
-        [ {"getPubKeyHash": "6696936bb8ae24859d0c2e4d05584106601f58a5e9466282c8561b88"},
-          {"getValue": [[{"unCurrencySymbol":"1d6445ddeda578117f393848e685128f1e78ad0c4e48129c5964dc2e"},[[{"unTokenName": "testToken"}, 18]]]]}
-        ],
-        [ {"getPubKeyHash": "a11767a73ea3f59fb11f17c1627706115de75e2d2c444b0e43789567"},
-          {"getValue": [[{"unCurrencySymbol":"1d6445ddeda578117f393848e685128f1e78ad0c4e48129c5964dc2e"},[[{"unTokenName": "testToken"}, 20]]]]}
-        ]
+      "caID": {
+        "tfpOutputPerTx": 2,
+        "tfpPayments": [
+          [ {"getPubKeyHash": "981fc565bcf0c95c0cfa6ee6693875b60d529d87ed7082e9bf03c6a4"},
+            {"getValue": [[{"unCurrencySymbol":"1d6445ddeda578117f393848e685128f1e78ad0c4e48129c5964dc2e"},[[{"unTokenName": "testToken"}, 15]]]]}
+          ],
+          [ {"getPubKeyHash": "6696936bb8ae24859d0c2e4d05584106601f58a5e9466282c8561b88"},
+            {"getValue": [[{"unCurrencySymbol":"1d6445ddeda578117f393848e685128f1e78ad0c4e48129c5964dc2e"},[[{"unTokenName": "testToken"}, 18]]]]}
+          ],
+          [ {"getPubKeyHash": "a11767a73ea3f59fb11f17c1627706115de75e2d2c444b0e43789567"},
+            {"getValue": [[{"unCurrencySymbol":"1d6445ddeda578117f393848e685128f1e78ad0c4e48129c5964dc2e"},[[{"unTokenName": "testToken"}, 20]]]]}
+          ]
         ]
+      }
   }' | jq -r .unContractInstanceId )
 
 echo $CONTRACT_INST_ID