Skip to content

docs(PolicyRegistry): document activation gating contract #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevieraykatz merged 2 commits into from
Jun 10, 2026
+23 −0
Merged

docs(PolicyRegistry): document activation gating contract #157

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a44ffc9
docs(PolicyRegistry): document activation gating contract
stevieraykatz Jun 10, 2026
47bc384
docs(PolicyRegistry): slim Activation section for builders
stevieraykatz Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/PolicyRegistry/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,29 @@ Custom policy IDs are assigned from a single global counter starting at `2`. The

> **Precondition for consumers.** `isAuthorized` never reverts on a non-existent or malformed `policyId` — it collapses to empty-member-set semantics (ALLOWLIST → `false`, BLOCKLIST → `true`). Consumers that store policy IDs (notably `IB20.updatePolicy`) MUST validate `policyExists(policyId)` at write time, since a typo'd BLOCKLIST ID would silently behave as `ALWAYS_ALLOW`.

## Activation

The `PolicyRegistry` is gated by the [`ActivationRegistry`](../ActivationRegistry/README.md). The gate applies only to functions that change state; read-only functions are always callable, whether or not the feature is active.

**Always callable:**

- `isAuthorized`
- `policyExists`
- `policyAdmin`
- `pendingPolicyAdmin`

**Gated** — revert with `FeatureNotActivated` while the feature is inactive:

- `createPolicy`
- `createPolicyWithAccounts`
- `stageUpdateAdmin`
- `finalizeUpdateAdmin`
- `renounceAdmin`
- `updateAllowlist`
- `updateBlocklist`

Because reads are never gated, a consumer — a B20 token calling `isAuthorized` on transfer, or an indexer reading membership and admin state — sees the same behavior whether or not the feature is active.

## User Flows

### Create Policy
Expand Down
Loading