Implementation of Secret types with SecretArguments for endpoints. (IntersectMBO#3908)

* Implementation of Secret types with SecretArguments for endpoints.

File plutus-tx/src/PlutusTx/Extensions/Secrets.hs introduces the
types for secrets and secret arguments and
plutus-use-cases/src/Plutus/Contracts/GameStateMachineWithSecretArguments.hs features
an example of how to use them.

File plutus-use-cases/src/Plutus/Contracts/SealedBidAuction.hs features
a more realistic sealed bid auction example whose specification and
tests can be found in plutus-use-cases/test/Spec/SealedBidAuction.hs.

* Fix formatting and add INLINE pragmas to key functions

* Folded the GameStateMachine example into one example instead of two

* Fixed flakyness related to timing in the sealed bid auction example

* move the secrets interface from PlutusTx to Plutus.Contract

* fix build warning

* updated something as a result of running some magic nix incantation

* updated tutorial

* supress intended deprecation error in tests

* Make secret arguments an instance of IsString when the argument type is

* Faster packing of integers into byte-strings

* fix compiler warnings

Author: MaximilianAlgehed

.gitignore

@@ -66,6 +66,7 @@ pkgs/.stack
 .psc-ide-port
 .dir-locals.el
 *.code-workspace
+.*.sw*
 
 # Frontend generated files (NPM/Yarn, Spago, generated PS, etc.)
 # N.B. officially we use NPM; ignoring Yarn files allows the local use of Yarn for those that want
@@ -112,4 +113,4 @@ node.sock
 secrets/*/.gpg-id
 ghcid.txt
 plutus-pab/test-node/testnet/db
-plutus-pab/test-node/alonzo-purple/db
+plutus-pab/test-node/alonzo-purple/db

doc/plutus/tutorials/GameModel.hs

@@ -53,6 +53,11 @@ import qualified Ledger.Typed.Scripts               as Scripts
 import           Plutus.Trace.Emulator              as Trace
 -- END import Emulator
 
+-- START import Contract.Security
+import           Plutus.Contract.Secrets
+-- END import Contract.Security
+
+
 -- * QuickCheck model
 
 -- START GameModel
@@ -94,13 +99,13 @@ instance ContractModel GameModel where
     perform handle s cmd = case cmd of
         Lock w new val -> do
             callEndpoint @"lock" (handle $ WalletKey w)
-                         LockArgs{ lockArgsSecret = new
+                         LockArgs{ lockArgsSecret = secretArg new
                                  , lockArgsValue = Ada.lovelaceValueOf val }
             delay 2
         Guess w old new val -> do
             callEndpoint @"guess" (handle $ WalletKey w)
                 GuessArgs{ guessArgsOldSecret     = old
-                         , guessArgsNewSecret     = new
+                         , guessArgsNewSecret     = secretArg new
                          , guessArgsValueTakenOut = Ada.lovelaceValueOf val }
             delay 1
         GiveToken w' -> do
@@ -383,12 +388,12 @@ v1_model = ()
     perform handle s cmd = case cmd of
         Lock w new val -> do
             callEndpoint @"lock" (handle $ WalletKey w)
-                         LockArgs{ lockArgsSecret = new
+                         LockArgs{ lockArgsSecret = secretArg new
                                  , lockArgsValue = Ada.lovelaceValueOf val}
         Guess w old new val -> do
             callEndpoint @"guess" (handle $ WalletKey w)
                 GuessArgs{ guessArgsOldSecret = old
-                         , guessArgsNewSecret = new
+                         , guessArgsNewSecret = secretArg new
                          , guessArgsValueTakenOut = Ada.lovelaceValueOf val}
         GiveToken w' -> do
             let w = fromJust (s ^. contractState . hasToken)

nix/pkgs/haskell/materialized-darwin/.plan.nix/plutus-contract.nix

@@ -62,6 +62,7 @@ import           Ledger                                   (Ada, AssetClass, Curr
                                                            POSIXTime, POSIXTimeRange, PubKey, PubKeyHash, RedeemerHash,
                                                            Signature, TokenName, TxId, TxOutRef, ValidatorHash, Value)
 import           Ledger.Bytes                             (LedgerBytes)
+import           Plutus.Contract.Secrets                  (SecretArgument (EndpointSide, UserSide))
 import           Plutus.Contract.StateMachine.ThreadToken (ThreadToken)
 import qualified PlutusTx.AssocMap
 import qualified PlutusTx.Prelude                         as P
@@ -423,3 +424,10 @@ deriving anyclass instance ToArgument WalletNumber
 
 instance ToArgument WalletId where
     toArgument = Fix . FormStringF . Just . show
+
+instance forall a. ToSchema a => ToSchema (SecretArgument a) where
+  toSchema = toSchema @a
+
+instance forall a. ToArgument a => ToArgument (SecretArgument a) where
+  toArgument (UserSide a)     = toArgument a
+  toArgument (EndpointSide _) = Fix $ FormUnsupportedF "endpoint side secrets are not supported in toArgument"

nix/pkgs/haskell/materialized-darwin/.plan.nix/plutus-use-cases.nix

@@ -60,6 +60,7 @@ library
         Plutus.Contract.Util
         Plutus.Contract.Wallet
         Plutus.Contract.Typed.Tx
+        Plutus.Contract.Secrets
         Wallet.Emulator
         Wallet.Emulator.Types
         Wallet.Emulator.Chain
@@ -174,6 +175,7 @@ test-suite plutus-contract-test
         Spec.Rows
         Spec.State
         Spec.ThreadToken
+        Spec.Secrets
     build-depends:
         base >=4.9 && <5,
         bytestring -any,
@@ -184,6 +186,7 @@ test-suite plutus-contract-test
         tasty -any,
         tasty-golden -any,
         tasty-hunit -any,
+        tasty-quickcheck -any,
         tasty-hedgehog -any,
         text -any,
         mtl -any,