Redo commit

docs/en/pact-functions.md

@@ -5,14 +5,14 @@
 
 Constant denoting the ASCII charset
 
-Constant:
+Constant: 
   `CHARSET_ASCII:integer = 0`
 
 ### CHARSET_LATIN1 {#CHARSET_LATIN1}
 
 Constant denoting the Latin-1 charset ISO-8859-1
 
-Constant:
+Constant: 
   `CHARSET_LATIN1:integer = 1`
 
 ### at {#at}
@@ -461,7 +461,7 @@ Return ID if called during current pact execution, failing if not.
 Obtain current pact build version.
 ```lisp
 pact> (pact-version)
-"4.9"
+"4.10"
 ```
 
 Top level only: this function will fail if used in module code.
@@ -765,7 +765,7 @@ Top level only: this function will fail if used in module code.
 
 Select rows from TABLE using QRY as a predicate with both key and value, and then accumulate results of the query in CONSUMER. Output is sorted by the ordering of keys.
 ```lisp
-(let*
+(let* 
  ((qry (lambda (k obj) true)) ;; select all rows
   (f (lambda (k obj) [(at 'firstName obj), (at 'b obj)]))
  )
@@ -924,7 +924,7 @@ pact> (add-time (time "2016-07-22T12:00:00Z") 15)
 *n* `integer` *→* `decimal`
 
 
-N days, for use with 'add-time'
+N days, for use with 'add-time' 
 ```lisp
 pact> (add-time (time "2016-07-22T12:00:00Z") (days 1))
 "2016-07-23T12:00:00Z"
@@ -962,7 +962,7 @@ pact> (format-time "%F" (time "2016-07-22T12:00:00Z"))
 *n* `integer` *→* `decimal`
 
 
-N hours, for use with 'add-time'
+N hours, for use with 'add-time' 
 ```lisp
 pact> (add-time (time "2016-07-22T12:00:00Z") (hours 1))
 "2016-07-22T13:00:00Z"
@@ -976,7 +976,7 @@ pact> (add-time (time "2016-07-22T12:00:00Z") (hours 1))
 *n* `integer` *→* `decimal`
 
 
-N minutes, for use with 'add-time'.
+N minutes, for use with 'add-time'. 
 ```lisp
 pact> (add-time (time "2016-07-22T12:00:00Z") (minutes 1))
 "2016-07-22T12:01:00Z"
@@ -1000,7 +1000,7 @@ pact> (parse-time "%F" "2016-09-12")
 *utcval* `string` *→* `time`
 
 
-Construct time from UTCVAL using ISO8601 format (%Y-%m-%dT%H:%M:%SZ).
+Construct time from UTCVAL using ISO8601 format (%Y-%m-%dT%H:%M:%SZ). 
 ```lisp
 pact> (time "2016-07-22T11:26:35Z")
 "2016-07-22T11:26:35Z"
@@ -1498,6 +1498,17 @@ Execute GUARD, or defined keyset KEYSETNAME, to enforce desired predicate logic.
 ```
 
 
+### enforce-verifier {#enforce-verifier}
+
+*verifiername* `string` *→* `bool`
+
+
+Enforce that a verifier is in scope.
+```lisp
+(enforce-verifier 'COOLZK)
+```
+
+
 ### keys-2 {#keys-2}
 
 *count* `integer` *matched* `integer` *→* `bool`
@@ -1947,7 +1958,7 @@ Retreive any accumulated events and optionally clear event state. Object returne
  *→* `[string]`
 
 
-Queries, or with arguments, sets execution config flags. Valid flags: ["AllowReadInLocal","DisableHistoryInTransactionalMode","DisableInlineMemCheck","DisableModuleInstall","DisableNewTrans","DisablePact40","DisablePact410","DisablePact42","DisablePact43","DisablePact431","DisablePact44","DisablePact45","DisablePact46","DisablePact47","DisablePact48","DisablePact49","DisablePactEvents","DisableRuntimeReturnTypeChecking","EnforceKeyFormats","OldReadOnlyBehavior","PreserveModuleIfacesBug","PreserveModuleNameBug","PreserveNsModuleInstallBug","PreserveShowDefs"]
+Queries, or with arguments, sets execution config flags. Valid flags: ["AllowReadInLocal","DisableHistoryInTransactionalMode","DisableInlineMemCheck","DisableModuleInstall","DisableNewTrans","DisablePact40","DisablePact410","DisablePact42","DisablePact43","DisablePact431","DisablePact44","DisablePact45","DisablePact46","DisablePact47","DisablePact48","DisablePact49","DisablePactEvents","DisableRuntimeReturnTypeChecking","DisableVerifiers","EnforceKeyFormats","OldReadOnlyBehavior","PreserveModuleIfacesBug","PreserveModuleNameBug","PreserveNsModuleInstallBug","PreserveShowDefs"]
 ```lisp
 pact> (env-exec-config ['DisableHistoryInTransactionalMode]) (env-exec-config)
 ["DisableHistoryInTransactionalMode"]

pact.cabal

@@ -181,6 +181,7 @@ library
     Pact.Types.Type
     Pact.Types.Typecheck
     Pact.Types.Util
+    Pact.Types.Verifier
     Pact.Types.Version
     Pact.Utils.Servant
 

src/Pact/ApiReq.hs

@@ -79,6 +79,7 @@ import Pact.Types.RPC
 import Pact.Types.Runtime
 import Pact.Types.SigData
 import Pact.Types.SPV
+import Pact.Types.Verifier
 import qualified Pact.JSON.Encode as J
 import Pact.JSON.Legacy.Value
 import Pact.JSON.Yaml
@@ -92,7 +93,7 @@ data ApiKeyPair = ApiKeyPair {
   _akpPublic :: Maybe PublicKeyBS,
   _akpAddress :: Maybe Text,
   _akpScheme :: Maybe PPKScheme,
-  _akpCaps :: Maybe [SigCapability]
+  _akpCaps :: Maybe [UserCapability]
   } deriving (Eq, Show, Generic)
 
 instance FromJSON ApiKeyPair where parseJSON = lensyParseJSON 4
@@ -123,7 +124,7 @@ data ApiSigner = ApiSigner {
   _asPublic :: Text,
   _asAddress :: Maybe Text,
   _asScheme :: Maybe PPKScheme,
-  _asCaps :: Maybe [SigCapability]
+  _asCaps :: Maybe [UserCapability]
   } deriving (Eq, Show, Generic)
 
 instance FromJSON ApiSigner where parseJSON = lensyParseJSON 3
@@ -196,6 +197,7 @@ data ApiReq = ApiReq {
   _ylCodeFile :: Maybe FilePath,
   _ylKeyPairs :: Maybe [ApiKeyPair],
   _ylSigners :: Maybe [ApiSigner],
+  _ylVerifiers :: Maybe [Verifier ParsedVerifierArgs],
   _ylNonce :: Maybe Text,
   _ylPublicMeta :: Maybe ApiPublicMeta,
   _ylNetworkId :: Maybe NetworkId
@@ -211,6 +213,7 @@ instance J.Encode ApiReq where
     , "networkId" J..= _ylNetworkId o
     , "rollback" J..= _ylRollback o
     , "signers" J..= fmap J.Array (_ylSigners o)
+    , "verifiers" J..= fmap J.Array (_ylVerifiers o)
     , "step" J..= fmap J.Aeson (_ylStep o)
     , "code" J..= _ylCode o
     , "pactTxHash" J..= _ylPactTxHash o
@@ -228,7 +231,7 @@ instance Arbitrary ApiReq where
     <*> arbitrary <*> arbitraryValue <*> arbitrary
     <*> arbitrary <*> arbitrary <*> arbitrary
     <*> arbitrary <*> arbitrary <*> arbitrary
-    <*> arbitrary <*> arbitrary
+    <*> arbitrary <*> arbitrary <*> arbitrary
    where
     arbitraryValue = suchThat arbitrary (/= Just Null)
 
@@ -475,7 +478,7 @@ signCmd keyFiles bs = do
 withKeypairsOrSigner
   :: Bool
   -> ApiReq
-  -> ([(DynKeyPair, [SigCapability])] -> IO a)
+  -> ([(DynKeyPair, [UserCapability])] -> IO a)
   -> ([Signer] -> IO a)
   -> IO a
 withKeypairsOrSigner unsignedReq ApiReq{..} keypairAction signerAction =
@@ -508,8 +511,8 @@ mkApiReqExec unsignedReq ar@ApiReq{..} fp = do
     return (code,cdata)
   pubMeta <- mkPubMeta _ylPublicMeta
   cmd <- withKeypairsOrSigner unsignedReq ar
-    (\ks -> mkExec code cdata pubMeta ks _ylNetworkId _ylNonce)
-    (\ss -> mkUnsignedExec code cdata pubMeta ss _ylNetworkId _ylNonce)
+    (\ks -> mkExec code cdata pubMeta ks (fromMaybe [] _ylVerifiers) _ylNetworkId _ylNonce)
+    (\ss -> mkUnsignedExec code cdata pubMeta ss (fromMaybe [] _ylVerifiers) _ylNetworkId _ylNonce)
   return ((ar,code,cdata,pubMeta), cmd)
 
 mkPubMeta :: Maybe ApiPublicMeta -> IO PublicMeta
@@ -543,17 +546,20 @@ mkExec
     -- ^ optional environment data
   -> PublicMeta
     -- ^ public metadata
-  -> [(DynKeyPair, [SigCapability])]
+  -> [(DynKeyPair, [UserCapability])]
     -- ^ signing keypairs + caplists
+  -> [Verifier ParsedVerifierArgs]
+    -- ^ verifiers
   -> Maybe NetworkId
     -- ^ optional 'NetworkId'
   -> Maybe Text
     -- ^ optional nonce
   -> IO (Command Text)
-mkExec code mdata pubMeta kps nid ridm = do
+mkExec code mdata pubMeta kps ves nid ridm = do
   rid <- mkNonce ridm
   cmd <- mkCommandWithDynKeys
          kps
+         ves
          pubMeta
          rid
          nid
@@ -571,15 +577,18 @@ mkUnsignedExec
     -- ^ public metadata
   -> [Signer]
     -- ^ payload signers
+  -> [Verifier ParsedVerifierArgs]
+    -- ^ payload verifiers
   -> Maybe NetworkId
     -- ^ optional 'NetworkId'
   -> Maybe Text
     -- ^ optional nonce
   -> IO (Command Text)
-mkUnsignedExec code mdata pubMeta kps nid ridm = do
+mkUnsignedExec code mdata pubMeta kps ves nid ridm = do
   rid <- mkNonce ridm
   cmd <- mkUnsignedCommand
          kps
+         ves
          pubMeta
          rid
          nid
@@ -613,8 +622,8 @@ mkApiReqCont unsignedReq ar@ApiReq{..} fp = do
   let pactId = toPactId apiPactId
   pubMeta <- mkPubMeta _ylPublicMeta
   cmd <- withKeypairsOrSigner unsignedReq ar
-    (\ks -> mkCont pactId step rollback cdata pubMeta ks _ylNonce _ylProof _ylNetworkId)
-    (\ss -> mkUnsignedCont pactId step rollback cdata pubMeta ss _ylNonce _ylProof _ylNetworkId)
+    (\ks -> mkCont pactId step rollback cdata pubMeta ks (fromMaybe [] _ylVerifiers) _ylNonce _ylProof _ylNetworkId)
+    (\ss -> mkUnsignedCont pactId step rollback cdata pubMeta ss (fromMaybe [] _ylVerifiers) _ylNonce _ylProof _ylNetworkId)
   return ((ar,"",cdata,pubMeta), cmd)
 
 -- | Construct a Cont request message
@@ -630,19 +639,22 @@ mkCont
     -- ^ environment data
   -> PublicMeta
     -- ^ command public metadata
-  -> [(DynKeyPair, [SigCapability])]
+  -> [(DynKeyPair, [UserCapability])]
     -- ^ signing keypairs
+  -> [Verifier ParsedVerifierArgs]
+    -- ^ verifiers
   -> Maybe Text
     -- ^ optional nonce
   -> Maybe ContProof
     -- ^ optional continuation proof (required for cross-chain)
   -> Maybe NetworkId
     -- ^ optional network id
   -> IO (Command Text)
-mkCont txid step rollback mdata pubMeta kps ridm proof nid = do
+mkCont txid step rollback mdata pubMeta kps ves ridm proof nid = do
   rid <- mkNonce ridm
   cmd <- mkCommandWithDynKeys
          kps
+         ves
          pubMeta
          rid
          nid
@@ -665,17 +677,20 @@ mkUnsignedCont
     -- ^ command public metadata
   -> [Signer]
     -- ^ payload signers
+  -> [Verifier ParsedVerifierArgs]
+    -- ^ verifiers
   -> Maybe Text
     -- ^ optional nonce
   -> Maybe ContProof
     -- ^ optional continuation proof (required for cross-chain)
   -> Maybe NetworkId
     -- ^ optional network id
   -> IO (Command Text)
-mkUnsignedCont txid step rollback mdata pubMeta kps ridm proof nid = do
+mkUnsignedCont txid step rollback mdata pubMeta kps ves ridm proof nid = do
   rid <- mkNonce ridm
   cmd <- mkUnsignedCommand
          kps
+         ves
          pubMeta
          (pack $ show rid)
          nid
@@ -685,15 +700,15 @@ mkUnsignedCont txid step rollback mdata pubMeta kps ridm proof nid = do
 -- Parse `APIKeyPair`s into Ed25519 keypairs and WebAuthn keypairs.
 -- The keypairs must not be prefixed with "WEBAUTHN-", it accepts
 -- only the raw (unprefixed) keys.
-mkKeyPairs :: [ApiKeyPair] -> IO [(DynKeyPair, [SigCapability])]
+mkKeyPairs :: [ApiKeyPair] -> IO [(DynKeyPair, [UserCapability])]
 mkKeyPairs keyPairs = traverse mkPair keyPairs
   where
 
         importValidKeyPair
           :: Maybe PublicKeyBS
           -> PrivateKeyBS
-          -> Maybe [SigCapability]
-          -> Either String (Ed25519KeyPair, [SigCapability])
+          -> Maybe [UserCapability]
+          -> Either String (Ed25519KeyPair, [UserCapability])
         importValidKeyPair pubEd25519 privEd25519 caps = fmap (,maybe [] id caps) $
           importEd25519KeyPair pubEd25519 privEd25519
 
@@ -703,7 +718,7 @@ mkKeyPairs keyPairs = traverse mkPair keyPairs
           Just ED25519 -> True
           _ -> False
 
-        mkPair :: ApiKeyPair -> IO (DynKeyPair, [SigCapability])
+        mkPair :: ApiKeyPair -> IO (DynKeyPair, [UserCapability])
         mkPair akp = case (_akpScheme akp, _akpPublic akp, _akpSecret akp, _akpAddress akp) of
           (scheme, pub, priv, Nothing) | isEd25519 scheme ->
             either dieAR (return . first DynEd25519KeyPair) (importValidKeyPair pub priv (_akpCaps akp))

src/Pact/Bench.hs

@@ -158,6 +158,7 @@ loadBenchModule db = do
            Nothing
            pactInitialHash
            [Signer Nothing pk Nothing []]
+           []
   let ec = ExecutionConfig $ S.fromList [FlagDisablePact44]
   e <- setupEvalEnv db entity Transactional md (versionedNativesRefStore ec)
           freeGasEnv permissiveNamespacePolicy noSPVSupport def ec
@@ -185,7 +186,7 @@ benchNFIO bname = bench bname . nfIO
 runPactExec :: Advice -> String -> [Signer] -> Value -> Maybe (ModuleData Ref) ->
                PactDbEnv e -> ParsedCode -> IO [PactValue]
 runPactExec pt msg ss cdata benchMod dbEnv pc = do
-  let md = MsgData (toLegacyJson cdata) Nothing pactInitialHash ss
+  let md = MsgData (toLegacyJson cdata) Nothing pactInitialHash ss []
       ec = ExecutionConfig $ S.fromList [FlagDisablePact44]
   e <- set eeAdvice pt <$> setupEvalEnv dbEnv entity Transactional md (versionedNativesRefStore ec)
           prodGasEnv permissiveNamespacePolicy noSPVSupport def ec
@@ -197,7 +198,7 @@ runPactExec pt msg ss cdata benchMod dbEnv pc = do
 
 execPure :: Advice -> PactDbEnv e -> (String,[Term Name]) -> IO [Term Name]
 execPure pt dbEnv (n,ts) = do
-  let md = MsgData (toLegacyJson Null) Nothing pactInitialHash []
+  let md = MsgData (toLegacyJson Null) Nothing pactInitialHash [] []
       ec = ExecutionConfig $ S.fromList [FlagDisablePact44]
   env <- set eeAdvice pt <$> setupEvalEnv dbEnv entity Local md (versionedNativesRefStore ec)
             prodGasEnv permissiveNamespacePolicy noSPVSupport def ec
@@ -238,7 +239,7 @@ mkBenchCmd :: [Ed25519KeyPairCaps] -> (String, Text) -> IO (String, Command Byte
 mkBenchCmd kps (str, t) = do
   cmd <- mkCommand' kps
     $ J.encodeStrict
-    $ Payload payload "nonce" (J.Aeson ()) ss Nothing
+    $ Payload payload "nonce" (J.Aeson ()) ss Nothing Nothing
   return (str, cmd)
   where
     payload = Exec $ ExecMsg t (toLegacyJson Null)
@@ -300,8 +301,8 @@ main = do
   !bench10Cmds <- parseCode (intercalate " " (replicate 10 "(bench.bench)"))
   let
     !params = [PLiteral $ LString "Acct1",PLiteral $ LString "Acct2", PLiteral $ LDecimal 1.0]
-    !mcaps = [SigCapability (QualifiedName "bench" "MTRANSFER" def) params
-             ,SigCapability (QualifiedName "bench" "TRANSFER" def) params]
+    !mcaps = [UserCapability (QualifiedName "bench" "MTRANSFER" def) params
+             ,UserCapability (QualifiedName "bench" "TRANSFER" def) params]
 
     !signer = [Signer Nothing pk Nothing []]
     !msigner = [Signer Nothing pk Nothing mcaps]

src/Pact/Eval.hs

@@ -163,7 +163,7 @@ enforceGuard i g = case g of
   GCapability CapabilityGuard{..} -> do
     traverse_ (enforcePactId True) _cgPactId
     args <- traverse enforcePactValue _cgArgs
-    acquired <- capabilityAcquired $ SigCapability _cgName args
+    acquired <- capabilityAcquired $ UserCapability _cgName args
     unless acquired $ failTx' i "Capability not acquired"
   where
     enforcePactId doFail pid = do
@@ -173,7 +173,7 @@ enforceGuard i g = case g of
           evalError' i $ "Pact guard failed, intended: " <> pretty pid <> ", active: " <> pretty currPid
 
 getSizeOfVersion :: Eval e SizeOfVersion
-getSizeOfVersion = 
+getSizeOfVersion =
   ifExecutionFlagSet' FlagDisablePact45 SizeOfV0 SizeOfV1
 {-# INLINABLE getSizeOfVersion #-}
 

src/Pact/Gas/Table.hs

@@ -130,6 +130,7 @@ defaultGasTable =
   ,("enforce-keyset", 8)
   ,("enforce-one", 6)
   ,("enforce-pact-version", 1)
+  ,("enforce-verifier", 10)
   ,("enumerate", 1)
   ,("exp", 5)
   ,("filter", 3)

src/Pact/GasModel/GasTests.hs

@@ -370,7 +370,7 @@ requireCapabilityTests = tests
     requireCapExpr =
       defPactExpression [text| (require-capability ($acctModuleNameText.GOV)) |]
 
-    cap = SigCapability (QualifiedName acctModuleName "GOV" def) []
+    cap = UserCapability (QualifiedName acctModuleName "GOV" def) []
     capSlot = CapSlot CapCallStack cap []
     updateGrantedCap = setState (set (evalCapabilities . capStack) [capSlot])