Manage declarative rules

Declarative rules are in early access and are not enabled by default. Talk to us if you’d like to participate.

These helpers write declarative rules to the wallet layer and to the caller’s own signer layer. They run with the signed-in end user’s session (the wallet owner, or a business-account owner or admin), not an API token. For the legacy PolicyRules helpers, see Manage Policies.

Before you start

Create and initialize a Dynamic client (see Creating a Dynamic Client, Initializing the Dynamic Client).
Use @dynamic-labs-sdk/client and @dynamic-labs-sdk/react-hooks 1.42.0 or later. The helpers are exported from @dynamic-labs-sdk/client/waas, and the hooks from @dynamic-labs-sdk/react-hooks.
walletAccount below is the WaaS wallet account, for example one returned by getWalletAccounts().
A layer holds legacy rules or declarative rules, never both. A write that would mix them is refused, and until declarative rules are enabled for your environment a declarative write is refused with rule_syntax_disabled.

The examples use this rule from Rule examples:

import {
  WaasPolicyAction,
  WaasPolicyDeclarativeRuleInputPhaseEnum,
} from '@dynamic-labs/sdk-api-core';

const rule = {
  ruleId: '00000000-0000-4000-8000-000000000004',
  name: 'Blocked address',
  phase: WaasPolicyDeclarativeRuleInputPhaseEnum.Transaction,
  then: WaasPolicyAction.Deny,
  when: {
    exists: {
      in: 'counterparties',
      where: { field: 'address', op: 'in', value: ['0x0000000000000000000000000000000000000bad'] },
    },
  },
};

Read rules

getWalletPolicyLayer and getSignerPolicyLayer return the layer. readPolicyLayerRules returns its entries, and isDeclarativePolicyRule tells declarative rules apart from legacy ones.

JavaScript
React

import {
  getWalletPolicyLayer,
  isDeclarativePolicyRule,
  readPolicyLayerRules,
} from '@dynamic-labs-sdk/client/waas';

const layer = await getWalletPolicyLayer({ walletAccount });
const rules = readPolicyLayerRules(layer).filter(isDeclarativePolicyRule);

import { isDeclarativePolicyRule, readPolicyLayerRules } from '@dynamic-labs-sdk/client/waas';
import { useGetWalletPolicyLayer } from '@dynamic-labs-sdk/react-hooks';

const { data: layer } = useGetWalletPolicyLayer({ walletAccount });
const rules = layer ? readPolicyLayerRules(layer).filter(isDeclarativePolicyRule) : [];

For the caller’s own signer layer, use getSignerPolicyLayer({ walletAccount }) or useGetSignerPolicyLayer({ walletAccount }).

Add or update a rule

An upsert creates the rule, or updates it when its ruleId already exists on the layer. Leave ruleId out to create a rule, and the returned layer contains the generated id.

JavaScript
React

import { upsertWalletPolicyRule } from '@dynamic-labs-sdk/client/waas';

const layer = await upsertWalletPolicyRule({ walletAccount, rule });

import { useUpsertWalletPolicyRule } from '@dynamic-labs-sdk/react-hooks';

const { mutate: upsertRule, isPending } = useUpsertWalletPolicyRule();

<button onClick={() => upsertRule({ walletAccount, rule })} disabled={isPending}>
  Save rule
</button>;

For the caller’s own signer layer, use upsertSignerPolicyRule({ walletAccount, rule }) or useUpsertSignerPolicyRule.

Remove a rule

JavaScript
React

import { removeWalletPolicyRule } from '@dynamic-labs-sdk/client/waas';

const layer = await removeWalletPolicyRule({
  walletAccount,
  ruleId: '00000000-0000-4000-8000-000000000004',
});

import { useRemoveWalletPolicyRule } from '@dynamic-labs-sdk/react-hooks';

const { mutate: removeRule } = useRemoveWalletPolicyRule();

<button onClick={() => removeRule({ walletAccount, ruleId: '00000000-0000-4000-8000-000000000004' })}>
  Remove rule
</button>;

For the caller’s own signer layer, use removeSignerPolicyRule({ walletAccount, ruleId }) or useRemoveSignerPolicyRule.

Replace the layer’s rules

replacePolicyLayerRules sets the layer’s full rule list, so any rule you leave out is removed. Keep the ruleId of every rule you are keeping. Use scope: { walletId } for the wallet layer, where walletId is the wallet’s verifiedCredentialId, or scope: { shareSetId } for the caller’s own signer layer. Only environment admins and business-account admins can replace a layer.

JavaScript
React

import { replacePolicyLayerRules } from '@dynamic-labs-sdk/client/waas';

const layer = await replacePolicyLayerRules({
  scope: { walletId: walletAccount.verifiedCredentialId },
  rules: [rule],
});

import { useReplacePolicyLayerRules } from '@dynamic-labs-sdk/react-hooks';

const { mutate: replaceRules } = useReplacePolicyLayerRules();

<button
  onClick={() =>
    replaceRules({ scope: { walletId: walletAccount.verifiedCredentialId }, rules: [rule] })
  }
>
  Save rules
</button>;

Errors

The write helpers throw an APIError when the request is refused. Its code tells you why, for example rule_syntax_disabled when declarative rules are not enabled for the environment, or composition_layer_edit_mixed_rule_syntax when the write would mix legacy and declarative rules.

Next steps

Rule examples

Ready-made declarative rules.

Manage Policies

The legacy PolicyRules helpers.

Learn

Implement

Manage declarative rules

Before you start

Read rules

Add or update a rule

Remove a rule

Replace the layer’s rules

Errors

Next steps

Rule examples

Manage Policies

​Before you start

​Read rules

​Add or update a rule

​Remove a rule

​Replace the layer’s rules

​Errors

​Next steps

Rule examples

Manage Policies

Before you start

Read rules

Add or update a rule

Remove a rule

Replace the layer’s rules

Errors

Next steps