Start fixing up Permission Delegation docs

2025-11-29 16:15:48 +00:00 · 2025-07-23 16:48:23 -07:00
parent 30b5ba68f1
commit a2d754b40f
5 changed files with 139 additions and 39 deletions
--- a/docs/references/protocol/ledger-data/ledger-entry-types/delegate.md
+++ b/docs/references/protocol/ledger-data/ledger-entry-types/delegate.md
@@ -0,0 +1,52 @@
+---
+seo:
+    description: A record of which permissions have been granted to another account.
+labels:
+  - Accounts
+  - Permissions
+---
+# Delegate
+[[Source]](https://github.com/XRPLF/rippled/blob/1e01cd34f7a216092ed779f291b43324c167167a/include/xrpl/protocol/detail/ledger_entries.macro#L475-L482 "Source")
+
+A `Delegate` ledger entry stores a set of permissions that an account has delegated to another account. You create a `Delegate` entry by sending a [DelegateSet transaction][].
+
+_(Requires the [PermissionDelegation amendment][] {% not-enabled /%}.)_
+
+## Example {% $frontmatter.seo.title %} JSON
+
+```json
+TODO
+```
+
+## {% $frontmatter.seo.title %} Fields
+
+In addition to the [common fields](../common-fields.md), {% code-page-name /%} entries have the following fields:
+
+| Field               | JSON Type            | [Internal Type][] | Required? | Description  |
+|:--------------------|:---------------------|:------------------|:----------|:-------------|
+| `Account`           | String - [Address][] | AccountID         | Yes       | The account delegating permissions to another, also called the _delegating account_. |
+| `Authorize`         | String - [Address][] | AccountID         | Yes       | The account receiving permissions, also called the _delegate account_. |
+| `Permissions`       | Array                | Array             | Yes       | A list of permissions granted, with at least 1 and at most 10 items. Each item in the list is a [Permission Object](#permissions-objects). |
+| `OwnerNode`         | String - Hexadecimal | UInt64            | Yes       | A hint indicating which page of the delegating account's owner directory links to this object, in case the directory consists of multiple pages. 
+| `PreviousTxnID`     | String - Hexadecimal | UInt256           | Yes       | The identifying hash of the transaction that most recently modified this object. |
+| `PreviousTxnLgrSeq` | Number               | UInt32            | Yes       |The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this object. |
+
+### Permissions Objects
+
+Each item in the `Permissions` array is an inner object with the following nested fields:
+
+| Field             | JSON Type            | [Internal Type][] | Required? | Description     |
+|:------------------|:---------------------|:------------------|:----------|:----------------|
+| `PermissionValue` | String               | UInt32            | Yes       | A permission that has been delegated to this account, which can be either a transaction type or a granular permission. See ***TODO: link*** for a full list. |
+
+## {% $frontmatter.seo.title %} Flags
+
+There are no flags defined for {% code-page-name /%} entries.
+
+## {% $frontmatter.seo.title %} Reserve
+
+{% code-page-name /%} entries count as one item towards the owner reserve of the delegating account, as long as the entry is in the ledger, regardless of how many permissions are delegating. Removing all permissions deletes the entry and frees up the reserve.
+
+{% code-page-name /%} entries are not deletion blockers. If the owner (delegating) account is deleted, all such ledger entries are deleted along with them. However, the `Authorize`
+
+{% raw-partial file="/docs/_snippets/common-links.md" /%}