REPL-only functions

The following functions are loaded automatically into the interactive REPL, or within script files with a .repl extension. They are not available for blockchain-based execution.

→ string

name string → string

Begin transaction with optional NAME.

exprs * → string

Benchmark execution of EXPRS.

→ string

Commit transaction.

step integer → string

step integer rollback bool → string

step integer rollback bool pact-id string → string

step integer rollback bool pact-id string yielded object:<{y}> → string

Continue previously-initiated pact identified STEP, optionally specifying ROLLBACK (default is false), PACT-ID of the pact to be continued (defaults to the pact initiated in the current transaction, if one is present), and YIELDED value to be read with 'resume' (if not specified, uses yield in most recent pact exec, if any).

new-data object:~{public-chain-data} → string

Update existing entries of 'chain-data' with NEW-DATA, replacing those items only.

json <a[integer,string,time,decimal,bool,[<l>],object:<{o}>,keyset]> → string

Set transaction JSON data, either as encoded string, or as pact types coerced to JSON.

iface module impl module{} → string

→ string

Substitute module IMPL in any dynamic usages of IFACE in typechecking and analysis. With no arguments, remove all substitutions.

enable bool → string

Control whether REPL native functions are allowed in module code. When enabled, fixture functions like 'env-sigs' are allowed in module code.

→ string

entity string → string

Set environment confidential ENTITY id, or unset with no argument.

clear bool → [object:*]

Retreive any accumulated events and optionally clear event state. Object returned has fields 'name' (fully-qualified event name), 'params' (event parameters), 'module-hash' (hash of emitting module).

flags [string] → [string]

→ [string]

Queries, or with arguments, sets execution config flags. Valid flags: ["AllowReadInLocal","DisableHistoryInTransactionalMode","DisableInlineMemCheck","DisableModuleInstall","DisableNewTrans","DisablePact40","DisablePact420","DisablePact43","DisablePact431","DisablePact44","DisablePact45","DisablePact46","DisablePact47","DisablePact48","DisablePact49","DisablePactEvents","DisableRuntimeReturnTypeChecking","EnforceKeyFormats","OldReadOnlyBehavior","PreserveModuleIfacesBug","PreserveModuleNameBug","PreserveNsModuleInstallBug","PreserveShowDefs"]

→ integer

gas integer → string

Query gas state, or set it to GAS. Note that certain plaforms may charge additional gas that is not captured by the interpreter gas model, such as an overall transaction-size cost.

limit integer → string

Set environment gas limit to LIMIT.

→ string

Enable and obtain gas logging. Bracket around the code whose gas logs you want to inspect.

model string → string

→ string

model string rate integer → string

Update or query current gas model. With just MODEL, "table" is supported; with MODEL and RATE, 'fixed' is supported. With no args, output current model.

price decimal → string

Set environment gas price to PRICE.

rate integer → string

Update gas model to charge constant RATE.

hash string → string

Set current transaction hash. HASH must be an unpadded base64-url encoded BLAKE2b 256-bit hash.

keys [string] → string

DEPRECATED in favor of 'env-sigs'. Set transaction signer KEYS. See 'env-sigs' for setting keys with associated capabilities.

allow-root bool ns-policy-fun ns:string ns-admin:guard -> bool → string

Install a managed namespace policy specifying ALLOW-ROOT and NS-POLICY-FUN.

sigs [object:*] → string

Set transaction signature keys and capabilities. SIGS is a list of objects with "key" specifying the signer key, and "caps" specifying a list of associated capabilities.

on-chain bool → string

Set a flag to simulate on-chain behavior that differs from the repl, in particular for observing things like errors and stack traces.

doc string expected <a> actual <a> → string

Evaluate ACTUAL and verify that it equals EXPECTED.

doc string exp <a> → string

doc string err string exp <a> → string

Evaluate EXP and succeed only if it throws an error.

doc string pred value:<a> -> bool exp <a> → string

Evaluate EXP and succeed if value passes predicate PRED.

scheme string public-key string → string

Transform PUBLIC-KEY into an address (i.e. a Pact Runtime Public Key) depending on its SCHEME.

file string → string

file string reset bool → string

Load and evaluate FILE, resetting repl state beforehand if optional RESET is true.

type string payload object:* output object:* → string

Mock a successful call to 'spv-verify' with TYPE and PAYLOAD to return OUTPUT.

→ object:*

clear bool → object:*

Inspect state from most recent pact execution. Returns object with fields 'pactId': pact ID; 'yield': yield result or 'false' if none; 'step': executed step; 'executed': indicates if step was skipped because entity did not match. With CLEAR argument, erases pact from repl state.

value <a> → string

Output VALUE to terminal as unquoted, unescaped text.

→ string

Rollback transaction.

→ keyset

Convenience function to build a keyset from keys present in message signatures, using 'keys-all' as the predicate.

capability  -> bool → string

Acquire (if unmanaged) or install (if managed) CAPABILITY. CAPABILITY and any composed capabilities are in scope for the rest of the transaction.

module string → string

module string debug bool → string

Typecheck MODULE, optionally enabling DEBUG output.

module string debug bool → string

Verify MODULE, checking that all properties hold. Optionally, if DEBUG is set to true, write debug output to "pact-verify-MODULE" directory.

exec <a> → <a>

Evaluate EXEC with any pending environment changes applied. Normally, environment changes must execute at top-level for the change to take effect. This allows scoped application of non-toplevel environment changes.