-
Notifications
You must be signed in to change notification settings - Fork 1.1k
74 updates #476
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.
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
Open
mvadari
wants to merge
6
commits into
XRPLF:master
Choose a base branch
from
mvadari:74-updates
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+143
−54
Open
74 updates #476
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
47f8ec8
update specs
mvadari 3491b9f
remove XLS-49 references from XLS-74
mvadari 7014369
update XLS-49 with amendment format
mvadari f6247dc
Merge remote-tracking branch 'upstream/master' into 74-updates
mvadari b9abfa2
Merge branch 'master' into 74-updates
mvadari 230151a
Merge branch 'master' into 74-updates
mvadari File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,24 +6,30 @@ | |
| proposal-from: https://github.com/XRPLF/XRPL-Standards/discussions/144 | ||
| status: Draft | ||
| category: Amendment | ||
| requires: 74 | ||
| created: 2023-11-13 | ||
| updated: 2026-02-20 | ||
| </pre> | ||
|
|
||
| # Multiple Signer Lists | ||
|
|
||
| ## Abstract | ||
| ## 1. Abstract | ||
|
|
||
| The XRP Ledger currently only supports one global signer list per account. However, many users (such as token issuers) require more granularity. For example, they might want to have one signer list with the ability to mint new tokens, and another signer list with the ability to create and edit trustlines. | ||
|
|
||
| This document describes a proposal for supporting multiple signer lists per account. The current system of global signer lists will continue to be supported, but we propose adding **per-transaction-type signer lists**. Accounts can set up signer lists that only have the power to send **transactions of one specific type** on behalf of the account. | ||
|
|
||
| This proposal is related to [XLS-31](https://github.com/XRPLF/XRPL-Standards/discussions/77), but broader in scope. | ||
| ## 2. Motivation | ||
|
|
||
| ## 1. Overview | ||
| Global signer lists provide an "all or nothing" model of access control: any key that can sign for an account can submit all transaction types on its behalf. For complex operational setups, especially for issuers and institutional users, this makes it difficult to separate duties such as minting, trustline management, or account configuration. | ||
|
|
||
| We propose modifying one ledger object and one transaction: | ||
| Supporting multiple signer lists per account, each scoped to a specific transaction type, enables more granular permissioning. This reduces the blast radius of a compromised signer, and allows organizations to delegate narrowly scoped powers (for example, minting only, or trustline management only) without granting full control over the account. | ||
|
|
||
| - `SignerList` ledger object | ||
| ## 3. Overview | ||
|
|
||
| We propose modifying one ledger entry and one transaction: | ||
|
|
||
| - `SignerList` ledger entry | ||
| - `SignerListSet` transaction | ||
|
|
||
| This change will require an amendment. | ||
|
|
@@ -33,63 +39,134 @@ The important considerations to keep in mind are: | |
| - `rippled` must be able to retrieve all possible signer lists for a transaction type quickly and easily, in order to check if a transaction has a valid multisign list. | ||
| - Any signer list that can sign transactions can drain the account's XRP via fees. | ||
|
|
||
| ## 2. On-Ledger Object: **`SignerList`** | ||
| ## 4. Ledger Entry: `SignerList` | ||
|
|
||
| There is no change to the shape of a [`SignerList` ledger object](https://xrpl.org/signerlist.html), only in how it's used. | ||
| There is no change to the shape of a [`SignerList` ledger entry](https://xrpl.org/signerlist.html), only in how it's used. | ||
|
|
||
| ### 2.1. Fields | ||
| This amendment repurposes the `SignerListID` field and generalizes how the ledger index is derived so that multiple signer lists can coexist for a single account. | ||
|
|
||
| As a reference, the **`SignerList`** object currently has the following fields: | ||
| ### 4.1. Object Identifier | ||
|
|
||
| | Field Name | Required? | JSON Type | Internal Type | | ||
| | ------------------- | --------- | --------- | ------------- | | ||
| | `LedgerIndex` | ✔️ | `string` | `HASH256` | | ||
| | `LedgerEntryType` | ✔️ | `string` | `UINT16` | | ||
| | `SignerEntries` | ✔️ | `array` | `STARRAY` | | ||
| | `SignerQuorum` | ✔️ | `number` | `UINT32` | | ||
| | `SignerListID` | ✔️ | `number` | `UINT32` | | ||
| | `OwnerNode` | ✔️ | `string` | `UINT64` | | ||
| | `PreviousTxnID` | ✔️ | `string` | `HASH256` | | ||
| | `PreviousTxnLgrSeq` | ✔️ | `number` | `UINT32` | | ||
| Existing `SignerList` entries use an object identifier derived from the owner's account ID and a selector value of `0`. This amendment preserves that identifier for the global signer list (`SignerListID = 0`) and introduces additional identifiers of the form `account + (1 + TxType)` for per-transaction-type signer lists. The underlying tagged-hash key space for `SignerList` entries is unchanged. | ||
|
|
||
| The ledger index of this object is calculated by hashing together the owner's account ID with the value of `0`. | ||
| ### 4.2. Fields | ||
|
|
||
| The only field whose usage is changing is `SignerListID`. All other fields will be used the same as they are now. | ||
| For the complete list of fields, types, and defaults, see the canonical [`SignerList` ledger entry documentation](https://xrpl.org/docs/references/protocol/ledger-data/ledger-entry-types/signerlist#signerlist-fields). This amendment does not add or remove any `SignerList` fields; it only changes how the existing `SignerListID` field is interpreted, as described in §4.2.1. | ||
|
|
||
| #### 2.1.1. `SignerListID` | ||
| #### 4.2.1. `SignerListID` | ||
|
|
||
| This field is currently always set to `0`. The original [`Multisign` implementation](https://xrpl.org/known-amendments.html#multisign) only allowed for one signer list per account, but left the door open for the possibility of more. | ||
|
|
||
| We propose that this field is instead used for the transaction type that the signer is allowed to sign for, with `0` being the value for the global signer list (to ensure backwards compatibility). There is enough space in `SignerListID` for this field, because `TxType` is a `UInt16` and `SignerListID` is a `UInt32`. Since the `UInt32` is so much larger than the `UInt16`, there is extra room in the valid values for additional signer list usage proposals. The value of this field will also be used in the `index` calculation. | ||
| Under this amendment, `SignerListID` is used to scope signer lists: | ||
|
|
||
| - `SignerListID = 0` denotes the global signer list for an account (backwards compatible with existing behavior). | ||
| - For each transaction type with serialized type code `TxType` (a `UInt16`), the per-transaction-type signer list for that transaction type uses `SignerListID = 1 + TxType`. | ||
|
|
||
| One problem: `Payment` has transaction type `0`, which would conflict with the global signer list. To get around that, we will instead use `1+TxType` in the `SignerListID` field. It is then very easy to check whether a multisign transaction is valid: the code can check the global signer list (look at the signer list with index `account + 0`), and the transaction-type-specific signer list (look at the signer list with index `account + (1+TxType)`). | ||
| There is enough space in `SignerListID` for this mapping because `TxType` is a `UInt16` and `SignerListID` is a `UInt32`. Since the `UInt32` is so much larger than the `UInt16`, there is extra room in the valid values for additional signer list usage proposals. | ||
|
|
||
| One problem: `Payment` has transaction type `0`, which would conflict with the global signer list. Using `1 + TxType` in the `SignerListID` field avoids this collision. It is then very easy to check whether a multisign transaction is valid: the code can check the global signer list (look at the signer list with index `account + 0`), and the transaction-type-specific signer list (look at the signer list with index `account + (1 + TxType)`). | ||
|
|
||
| Each additional `SignerList` that an account owns will, of course, cost an additional owner reserve (2 XRP at the time of writing). | ||
|
|
||
| ## 3. Transaction: **`SignerListSet`** | ||
| ### 4.3. Invariants | ||
|
|
||
| - `<entry>.SignerQuorum > 0` implies `<entry>.SignerEntries` is non-empty and the sum of all `SignerWeight` values in `<entry>.SignerEntries` is greater than or equal to `<entry>.SignerQuorum`, and likewise for `<entry>'`. | ||
| - For any update to an existing `SignerList` entry, `<entry>.SignerListID == <entry>'.SignerListID`; the scope of a signer list (global vs. per-transaction-type) does not change in-place. | ||
|
|
||
| ### 4.4. Example JSON | ||
|
|
||
| ```json | ||
| { | ||
| "LedgerEntryType": "SignerList", | ||
| "Flags": 0, | ||
| "OwnerNode": "0000000000000000", | ||
| "PreviousTxnID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", | ||
| "PreviousTxnLgrSeq": 12345678, | ||
| "SignerQuorum": 3, | ||
| "SignerEntries": [ | ||
| { | ||
| "Account": "rExampleSigner1XXXXXXXXXXXXXXXX", | ||
| "SignerWeight": 1 | ||
| }, | ||
| { | ||
| "Account": "rExampleSigner2XXXXXXXXXXXXXXXX", | ||
| "SignerWeight": 2 | ||
| } | ||
| ], | ||
| "SignerListID": 1 | ||
| } | ||
| ``` | ||
|
|
||
| ## 5. Transaction: `SignerListSet` | ||
|
|
||
| The [`SignerListSet` transaction](https://xrpl.org/signerlistset.html) already exists on the XRPL. This amendment extends it to support per-transaction-type signer lists. | ||
|
|
||
| ### 5.1. Fields | ||
|
|
||
| For the existing fields and validation rules, see the canonical [`SignerListSet` transaction documentation](https://xrpl.org/docs/references/protocol/transactions/types/signerlistset#signerlistset-fields). This amendment adds a single new optional field: | ||
|
|
||
| | Field Name | Required? | JSON Type | Internal Type | Default Value | Description | | ||
| | ------------------------ | --------- | --------- | ------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `TransactionTypeBitmask` | No | `array` | `HASH256` | `N/A` | Bitmask of transaction types this change applies to; JSON is a list of transaction type names. `0` updates the global signer list; other values map to scoped lists as defined in this XLS. | | ||
|
|
||
| #### 5.1.1. `TransactionTypeBitmask` | ||
|
|
||
| This field accepts a bitmask of transaction types, much like the [`HookOn` field](https://xrpl-hooks.readme.io/docs/hookon-field). A `0` bit is "on" and a `1` bit is "off". A value of `0` changes the global signer list (`SignerListID = 0`). All other values change the many signer lists of the transactions they apply to, so that it is easier to modify many signer lists at once. The JSON representation shows this field as a list of transaction types. | ||
|
|
||
| ### 5.2. Failure Conditions | ||
|
|
||
| #### 5.2.1. Data Verification | ||
|
|
||
| 1. `TransactionTypeBitmask` is present but is not an array, contains elements that are not valid transaction type identifiers, or decodes to a malformed bitmask (implementation-defined `tem`-class error code). | ||
|
|
||
| #### 5.2.2. Protocol-Level Failures | ||
|
|
||
| 1. Applying the requested changes would require creating additional `SignerList` entries but the account does not hold enough XRP to meet the resulting owner reserve requirement for all affected lists (implementation-defined `tec`-class error code). | ||
|
|
||
| ### 5.3. State Changes | ||
|
|
||
| On success (`tesSUCCESS`): | ||
|
|
||
| - If `TransactionTypeBitmask` is not present, the transaction behaves as the existing `SignerListSet` transaction: it creates, updates, or removes the global signer list (`SignerListID = 0`) for the account. | ||
| - If `TransactionTypeBitmask` is present, the transaction creates, updates, or removes one or more `SignerList` ledger entries whose `SignerListID` values are derived from the selected transaction types (for example, `SignerListID = 1 + TxType` for each enabled transaction type). | ||
| - The account's owner directory and owner reserve are updated to reflect any newly created or deleted `SignerList` entries. | ||
|
|
||
| ### 5.4. Example JSON | ||
|
|
||
| The [`SignerListSet` transaction](https://xrpl.org/signerlistset.html) already exists on the XRPL. We propose a slight modification to support per-transaction-type signer lists. | ||
| ```json | ||
| { | ||
| "TransactionType": "SignerListSet", | ||
| "Account": "rExampleAccountXXXXXXXXXXXXXXXXX", | ||
| "Fee": "10", | ||
| "Sequence": 12345, | ||
| "SignerQuorum": 3, | ||
| "SignerEntries": [ | ||
| { | ||
| "Account": "rExampleSigner1XXXXXXXXXXXXXXXX", | ||
| "SignerWeight": 1 | ||
| }, | ||
| { | ||
| "Account": "rExampleSigner2XXXXXXXXXXXXXXXX", | ||
| "SignerWeight": 2 | ||
| } | ||
| ], | ||
| "TransactionTypeBitmask": ["Payment", "TrustSet"] | ||
| } | ||
| ``` | ||
|
|
||
| ### 3.1. Fields | ||
| ## 6. Rationale | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Consider renaming this section to be I also prefer an |
||
|
|
||
| As a reference, the **`SignerListSet`** transaction already has the following fields: | ||
| This proposal chooses a straightforward mapping from transaction types to separate `SignerList` entries: `SignerListID = 0` represents the existing global signer list, while `SignerListID = 1 + TxType` represents a signer list scoped to a single transaction type. This design keeps lookup logic simple, preserves existing semantics for the global list, and minimizes UX changes for wallets and other tooling. | ||
|
|
||
| | Field Name | Required? | JSON Type | Internal Type | | ||
| | ----------------- | --------- | --------- | ------------- | | ||
| | `TransactionType` | ✔️ | `string` | `UInt16` | | ||
| | `SignerEntries` | ✔️ | `array` | `STARRAY` | | ||
| | `SignerQuorum` | ✔️ | `number` | `UInt32` | | ||
| Alternative designs, such as encoding permissions via a bitmask in `SignerListID` or implementing per-transaction-type multisign using crypto-conditions, were considered. These alternatives offer additional flexibility but introduce more complexity and larger changes to transaction formats and signing workflows. They are described in more detail in Appendix B and Appendix C. | ||
|
|
||
| We propose adding a new optional field: | ||
| | Field Name | Required? | JSON Type | Internal Type | | ||
| |------------|-----------|-----------|---------------| | ||
| |`TransactionTypeBitmask` | |`array`|`HASH256` | ||
| ## 7. Backwards Compatibility | ||
|
|
||
| #### 3.1.1. `TransactionTypeBitmask` | ||
| Existing signer lists with `SignerListID = 0` continue to function as global signer lists and retain their current behavior. No changes are required for accounts that only use a single global signer list. | ||
|
|
||
| This field accepts a bitmask of transaction types, much like the [`HookOn` field](https://xrpl-hooks.readme.io/docs/hookon-field). A `0` bit is "on" and a `1` bit is "off". A value of `0` changes the global signer list. All other values change the many signer lists of the transactions they apply to, so that it is easier to modify many signer lists at once. The JSON will show a list of transactions. | ||
| Per-transaction-type signer lists are added in a backward-compatible way by assigning nonzero `SignerListID` values derived from `1 + TxType`. Existing ledger entries and transactions remain valid, and transactions that do not use the new functionality behave exactly as before. Each additional signer list still consumes an owner reserve, as described above. | ||
|
|
||
| ## 4. Security | ||
| ## 8. Security Considerations | ||
|
|
||
| One important fact to remember is that any signer list that can sign transactions can drain the account's XRP via fees. This was why multiple signer lists were never implemented originally. There is [an open issue](https://github.com/XRPLF/rippled/issues/4476) proposing potential ways to prevent accidental high fees on transactions. | ||
|
|
||
|
|
@@ -127,7 +204,7 @@ Another design we developed (and seriously considered) was using a bitmask to de | |
|
|
||
| The ledger modifications necessary for this design: | ||
|
|
||
| - The ledger object hash (`index`) is now derived from the sequence of the transaction that created the signer list (similar to how escrow hashes are derived). This sequence is stored in the `SignerListID` field. | ||
| - The ledger entry hash (`index`) is now derived from the sequence of the transaction that created the signer list (similar to how escrow hashes are derived). This sequence is stored in the `SignerListID` field. | ||
| - Modifying or deleting a signer list that isn't the global one (instead of creating a new one) requires specifying the `SignerListID` in the `SignerListSet` transaction. | ||
| - Using a signer list that isn't the global one requires specifying the `SignerListID` in the transaction (a new global optional field). | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section feels like it's mostly repeating what's in the abstract. I like a good
Motivationsection in specs though, so maybe consider removing some of the redundancy from the Abstract?