Keysets

Use define-keyset to define a keyset with the specified name and keyset guard. I you don't specify a keyset guard, the functions reads the specified keyset name from the message payload to define its keyset guard, which is similar to using the read-keyset function. If the keyset name already exists, the existing keyset is enforced before updating to the new value.

To define a keyset as name with keyset, use the following syntax:

To read keyset information from the transaction message payload, use the following syntax:

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 example demonstrates how to use the define-keyset function to define a keyset named "admin-keyset" to use the keys and predicate function from the specified "my-keyset" object:

The following example demonstrates how to read the keyset from the message payload and associate it with admin-keyset:

The following example illustrates how to define a keyset by reading an existing keyset:

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

To execute a guard to enforce desired predicate logic, use the following syntax:

To require a specified keyset to enforce desired predicate logic, use the following syntax:

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 specified guard or keyset predicate logic was enforced.

The following example demonstrates how to use the enforce-keyset function to enforce logic defined in the "admin-keyset" predicate function:

If the condition specified by the admin-keyset predicate function is satisfied, the enforce-keyset function returns a boolean value of true.

The following example enforces the logic defined in the row-guard predicate logic:

If the condition specified by the row-guard predicate function is satisfied, the enforce-keyset function returns a boolean value of true.

Use keys-2 as a keyset predicate function to determine if there are at least two keys that match the keys defined in a keyset.

To check whether there are at least two keys that match the keys defined in a keyset, use the following syntax:

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

The keys-2 function returns a boolean value indicating whether there are at least two keys that match the keys defined in the keyset.

The following example demonstrates how to use the keys-2 to check if at least two keys are matched in a keyset where the total number of keys defined in a keyset is three and only one key is matched:

The function returns false because the condition of having at least two keys matched is not met.

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

To check whether all of the keys defined in a keyset are matched, use the following syntax:

Use the following arguments to specify the count of keys in the keyset and the number 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 how to use the keys-all function to check whether all of the keys are matched in a keyset where the total number of keys defined is three:

The function returns true because 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:

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 how to use the keys function to retrieve all of the keys present in the "accounts" table:

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