Keysets

Use define-keyset to define a keyset as name with keyset, or if unspecified, read name from the message payload as a keyset, similarly to read-keyset. If the keyset name already exists, the keyset will be enforced before updating to the new value.

To define a keyset as name with keyset, or read name from the message payload, use the following syntax:

(define-keyset name keyset) (define-keyset name)

Use the following arguments to specify the inputs for the define-keyset Pact function:

The define-keyset function returns a string representing the result of defining the keyset.

The following examples demonstrate the define-keyset function:

Use enforce-keyset to execute a specified GUARD or a defined keyset named KEYSETNAME to enforce the desired predicate logic.

To execute a GUARD or a defined keyset to enforce desired predicate logic, use the following syntax:

(enforce-keyset GUARD) (enforce-keyset KEYSETNAME)

Use the following arguments to specify the GUARD or KEYSETNAME for the enforce-keyset Pact function:

The enforce-keyset function returns a boolean value indicating whether the guard or keyset enforced the desired predicate logic.

The following examples demonstrate the enforce-keyset function:

In these examples, the enforce-keyset function is used to execute the specified guard or keyset to enforce the desired predicate logic. The function returns a boolean value indicating whether the guard or keyset enforced the desired logic successfully.

Use keys-2 as a keyset predicate function to determine if at least two keys are matched in the keyset.

To use keys-2 to check if at least two keys are matched in a keyset, use the following syntax:

keys-2 count matched

Use the following arguments to specify the count of keys in the keyset and the count of matched keys using the keys-2 Pact function.

The keys-2 function returns a boolean value indicating whether at least two keys are matched in the keyset.

The following example demonstrates the use of keys-2 in the Pact REPL:

In this example, keys-2 checks if at least two keys are matched in a keyset where the total count of keys is 3 and only 1 key is matched. The function returns false, indicating that the condition of having at least two keys matched is not met.

Use keys-all as a keyset predicate function to determine if all keys in the keyset are matched.

To use keys-all to check if all keys in a keyset are matched, use the following syntax:

(keys-all count matched)

Use the following arguments to specify the count of keys in the keyset and the count of matched keys using the keys-all Pact function.

The keys-all function returns a boolean value indicating whether all keys in the keyset are matched.

The following example demonstrates the use of keys-all in the Pact REPL:

In this example, keys-all checks if all keys are matched in a keyset where the total count of keys is 3 and all 3 keys are matched. The function returns true, indicating that all keys in the keyset are matched.

Use keys to return all keys present in a specified table.

To retrieve all keys present in a table, use the following syntax:

(keys table)

Use the following argument to specify the table from which you want to retrieve keys using the keys Pact function.

The keys function returns a list of strings containing all keys present in the specified table.

The following example demonstrates the use of keys in the Pact REPL to retrieve all keys present in the "accounts" table:

In this example, all keys present in the "accounts" table are returned as a list of strings.