feat: add Account Permission Delegation (XLS-74d, XLS-75d) (#2981)

* enable PermissionDelegation in rippled.cfg

* update HISTORY

* add Delegate to BaseTransaction

* update definitions

* add DelegateSet tx

* fix lint error

* add Delegate ledger entry

* add initial integ test

* clean up test

* catch error in test

* debug test

* debug again

* add missing disable lint desc

* debug 3x

* remove debug lines

* add base case to integ test

* update base case

* fix Permissions array type

* add log

* another log

* more logs

* logs

* logs

* logs

* debug test

* more logs

* progress

* update STObject.toJSON

* remove empty array check

* add granularPermissions to XrplDefinitionsBase

* fix conditional

* add conditional in toJSON

* parse as hex

* remove logs

* debug tx not found error

* include -1

* uncomment line in integ test

* debug tx not found

* update integ test

* add log

* add missing .toJSON

* fix increment/decrement to only apply to non-granular permissions

* test delegate ledger entry

* fix ledger entry request

* add codec-fixture

* refactor binary-codec parsing

* cleanup

* add non-delegatable transaction check

* update HISTORY

* refactor permissionsSet

* cleanup

* cleanup

* use Permission interface in Delegate

* use testContext.wallet

* refactor Permissions array check

* include non-delegatable transaction in error message

* revert st-object.ts, do PermissionValue serialization using associatedType

* add debug logs

* verify DelegateSet tx submit works in integ test

* comment another test

* resolve lint error

* change ordinal width to 4

* add comments to width vars

* verify ledger data in integ test

* add missing comment

* remove ledger_data check

* remove unused imports

* test error

* refactor testTransaction to accept expected errCode

* improve errCode param check

* try another errCode check

* refactor test

* Revert "refactor test"

This reverts commit a192433.

* remove redundant no permission check

Author: khancode

.ci-config/rippled.cfg

@@ -184,6 +184,7 @@ fixReducedOffersV2
 DeepFreeze
 DynamicNFT
 PermissionedDomains
+PermissionDelegation
 
 # This section can be used to simulate various FeeSettings scenarios for rippled node in standalone mode
 [voting]

packages/ripple-binary-codec/HISTORY.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+### Added
+* Support for `Account Permissions` and `Account Permission Delegation` (XLS-74d, XLS-75d)
+
 ### Fixed
 * add `MPTCurrency` support in `Issue` (rippled internal type)
 * Throw an error during serialization if a field is unknown, rather than silently throwing it away.

packages/ripple-binary-codec/src/enums/constants.ts

@@ -1,4 +1,5 @@
-export const TYPE_WIDTH = 2
-export const LEDGER_ENTRY_WIDTH = 2
-export const TRANSACTION_TYPE_WIDTH = 2
-export const TRANSACTION_RESULT_WIDTH = 1
+export const TYPE_WIDTH = 2 // UInt16
+export const LEDGER_ENTRY_WIDTH = 2 // UInt16
+export const TRANSACTION_TYPE_WIDTH = 2 // UInt16
+export const TRANSACTION_RESULT_WIDTH = 1 // UInt8
+export const DELEGATABLE_PERMISSIONS_WIDTH = 4 // UInt32

packages/ripple-binary-codec/src/enums/definitions.json

@@ -670,6 +670,16 @@
         "type": "UInt32"
       }
     ],
+    [
+      "PermissionValue",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 52,
+        "type": "UInt32"
+      }
+    ],
     [
       "IndexNext",
       {
@@ -1950,6 +1960,16 @@
         "type": "AccountID"
       }
     ],
+    [
+      "Delegate",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": true,
+        "nth": 12,
+        "type": "AccountID"
+      }
+    ],
     [
       "HookAccount",
       {
@@ -2170,6 +2190,16 @@
         "type": "STObject"
       }
     ],
+    [
+      "Permission",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 15,
+        "type": "STObject"
+      }
+    ],
     [
       "Signer",
       {
@@ -2560,6 +2590,16 @@
         "type": "STArray"
       }
     ],
+    [
+      "Permissions",
+      {
+        "isSerialized": true,
+        "isSigningField": true,
+        "isVLEncoded": false,
+        "nth": 29,
+        "type": "STArray"
+      }
+    ],
     [
       "CloseResolution",
       {
@@ -2879,6 +2919,7 @@
     "Check": 67,
     "Credential": 129,
     "DID": 73,
+    "Delegate": 131,
     "DepositPreauth": 112,
     "DirectoryNode": 100,
     "Escrow": 117,
@@ -3107,6 +3148,7 @@
     "CredentialDelete": 60,
     "DIDDelete": 50,
     "DIDSet": 49,
+    "DelegateSet": 64,
     "DepositPreauth": 19,
     "EnableAmendment": 100,
     "EscrowCancel": 4,

packages/ripple-binary-codec/src/enums/xrpl-definitions-base.ts

@@ -6,6 +6,7 @@ import {
   LEDGER_ENTRY_WIDTH,
   TRANSACTION_TYPE_WIDTH,
   TRANSACTION_RESULT_WIDTH,
+  DELEGATABLE_PERMISSIONS_WIDTH,
 } from './constants'
 
 interface DefinitionsData {
@@ -35,6 +36,10 @@ class XrplDefinitionsBase {
   transactionNames: string[]
   // Maps serializable types to their TypeScript class implementation
   dataTypes: Record<string, typeof SerializedType>
+  // Maps granular permissions names to their corresponding integer ids
+  granularPermissions: Record<string, number>
+  // Defined delegatable permissions
+  delegatablePermissions: BytesLookup
 
   /**
    * Present rippled types in a typed and updatable format.
@@ -75,6 +80,36 @@ class XrplDefinitionsBase {
 
     this.dataTypes = {} // Filled in via associateTypes
     this.associateTypes(types)
+
+    this.granularPermissions = {
+      TrustlineAuthorize: 65537,
+      TrustlineFreeze: 65538,
+      TrustlineUnfreeze: 65539,
+      AccountDomainSet: 65540,
+      AccountEmailHashSet: 65541,
+      AccountMessageKeySet: 65542,
+      AccountTransferRateSet: 65543,
+      AccountTickSizeSet: 65544,
+      PaymentMint: 65545,
+      PaymentBurn: 65546,
+      MPTokenIssuanceLock: 65547,
+      MPTokenIssuanceUnlock: 65548,
+    }
+
+    const incrementedTransactionTypes = Object.fromEntries(
+      Object.entries(enums.TRANSACTION_TYPES).map(([key, value]) => [
+        key,
+        value + 1,
+      ]),
+    )
+    const combinedPermissions = {
+      ...this.granularPermissions,
+      ...incrementedTransactionTypes,
+    }
+    this.delegatablePermissions = new BytesLookup(
+      combinedPermissions,
+      DELEGATABLE_PERMISSIONS_WIDTH,
+    )
   }
 
   /**
@@ -94,6 +129,7 @@ class XrplDefinitionsBase {
     this.field['TransactionType'].associatedType = this.transactionType
     this.field['TransactionResult'].associatedType = this.transactionResult
     this.field['LedgerEntryType'].associatedType = this.ledgerEntryType
+    this.field['PermissionValue'].associatedType = this.delegatablePermissions
   }
 
   public getAssociatedTypes(): Record<string, typeof SerializedType> {

packages/ripple-binary-codec/test/fixtures/codec-fixtures.json

@@ -4891,6 +4891,32 @@
         "AssetClass": "63757272656E6379"
       }
     },
+    {
+      "binary": "120040210000F7E0228000000024000009186840000000000000C87321ED510865F867CDFCB944D435812ACF23D231E5C14534B146BCE46A2F794D198B777440D05A89D0B489DEC1CECBE0D33BA656C929CDCCC75D4D41B282B378544975B87A70C3E42147D980D1F6E2E4DC6316C99D7E2D4F6335F147C71C0DAA0D6516150D8114DB9157872FA63FAF7432CD300911A43B981B85A28514EBA79C385B47C50D52445DF2676EEC0231F732CEF01DEF203400000001E1EF203400010004E1F1",
+      "json": {
+        "TransactionType": "DelegateSet",
+        "Account": "rMryaYXZMchTWBovAzEsMzid9FUwmrmcH7",
+        "Authorize": "r4Vp2qvKR59guHDn4Yzw9owTzDVnt6TJZA",
+        "Fee": "200",
+        "Flags": 2147483648,
+        "NetworkID": 63456,
+        "Permissions": [
+          {
+            "Permission": {
+              "PermissionValue": "Payment"
+            }
+          },
+          {
+            "Permission": {
+              "PermissionValue": "AccountDomainSet"
+            }
+          }
+        ],
+        "Sequence": 2328,
+        "SigningPubKey": "ED510865F867CDFCB944D435812ACF23D231E5C14534B146BCE46A2F794D198B77",
+        "TxnSignature": "D05A89D0B489DEC1CECBE0D33BA656C929CDCCC75D4D41B282B378544975B87A70C3E42147D980D1F6E2E4DC6316C99D7E2D4F6335F147C71C0DAA0D6516150D"
+      }
+    },
     {
       "binary": "1200342033000004D2811401476926B590BA3245F63C829116A0A3AF7F382D",
       "json": {

packages/xrpl/HISTORY.md

@@ -6,6 +6,7 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 
 ### Added
 * Support for `NFTokenMintOffer` (XLS-52)
+* Support for `Account Permissions` and `Account Permission Delegation` (XLS-74d, XLS-75d)
 
 ### Fixed
 * `OracleSet` transaction accepts hexadecimal string values for `AssetPrice` field

packages/xrpl/src/models/ledger/Delegate.ts

@@ -0,0 +1,39 @@
+import { Permission } from '../transactions'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * This object represents a set of permissions that an account has delegated to another account.
+ *
+ * @category Ledger Entries
+ */
+export default interface Delegate extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'Delegate'
+
+  /**
+   * The account that wants to authorize another account.
+   */
+  Account: string
+
+  /**
+   * The authorized account.
+   */
+  Authorize: string
+
+  /**
+   * The transaction permissions that the account has access to.
+   */
+  Permissions: Permission[]
+
+  /**
+   * A hint indicating which page of the sender's owner directory links to this object,
+   * in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+
+  /**
+   * A bit-map of boolean flags. No flags are defined for the Delegate object
+   * type, so this value is always 0.
+   */
+  Flags: 0
+}

packages/xrpl/src/models/ledger/LedgerEntry.ts

@@ -4,6 +4,7 @@ import AMM from './AMM'
 import Bridge from './Bridge'
 import Check from './Check'
 import Credential from './Credential'
+import Delegate from './Delegate'
 import DepositPreauth from './DepositPreauth'
 import DirectoryNode from './DirectoryNode'
 import Escrow from './Escrow'
@@ -27,6 +28,7 @@ type LedgerEntry =
   | Bridge
   | Check
   | Credential
+  | Delegate
   | DepositPreauth
   | DirectoryNode
   | Escrow
@@ -50,6 +52,7 @@ type LedgerEntryFilter =
   | 'bridge'
   | 'check'
   | 'credential'
+  | 'delegate'
   | 'deposit_preauth'
   | 'did'
   | 'directory'

packages/xrpl/src/models/ledger/index.ts

@@ -7,6 +7,7 @@ import AMM, { VoteSlot } from './AMM'
 import Bridge from './Bridge'
 import Check from './Check'
 import Credential from './Credential'
+import Delegate from './Delegate'
 import DepositPreauth from './DepositPreauth'
 import DID from './DID'
 import DirectoryNode from './DirectoryNode'
@@ -43,6 +44,7 @@ export {
   Bridge,
   Check,
   Credential,
+  Delegate,
   DepositPreauth,
   DirectoryNode,
   DID,