Skip to content

Commit e52ad03

Browse files
mvadarimvadari
committed
respond to comments
1 parent ad012fe commit e52ad03

File tree

1 file changed

+5
-78
lines changed
  • XLS-0068-sponsored-fees-and-reserves

1 file changed

+5
-78
lines changed

‎XLS-0068-sponsored-fees-and-reserves/README.md‎

Lines changed: 5 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -292,39 +292,7 @@ An [`AccountRoot` ledger entry](https://xrpl.org/docs/references/protocol/ledger
292292

293293
### 6.1. Fields
294294

295-
<details>
296-
<summary>
297-
298-
As a reference, [here](https://xrpl.org/docs/references/protocol/ledger-data/ledger-entry-types/accountroot/#accountroot-fields) are the fields that the `AccountRoot` ledger object currently has.
299-
300-
</summary>
301-
302-
| Field Name | Constant? | Required? | Default Value | JSON Type | Internal Type | Description |
303-
| ---------------------- | --------- | --------- | ------------- | --------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
304-
| `Account` | ✔️ | ✔️ | N/A | `string` | `AccountID` | The identifying (classic) address of this account. |
305-
| `AccountTxnID` | | | N/A | `string` | `Hash256` | The identifying hash of the transaction most recently sent by this account. |
306-
| `AMMID` | ✔️ | | N/A | `string` | `Hash256` | The ledger entry ID of the corresponding AMM ledger entry, if this is an AMM pseudo-account. |
307-
| `Balance` | | | N/A | `string` | `Amount` | The account's current XRP balance. |
308-
| `BurnedNFTokens` | | | `0` | `number` | `UInt32` | How many total of this account's issued NFTs have been burned. |
309-
| `Domain` | | | N/A | `string` | `Blob` | A domain associated with this account. |
310-
| `EmailHash` | | | N/A | `string` | `Hash128` | The md5 hash of an email address. |
311-
| `FirstNFTokenSequence` | ✔️ | | N/A | `number` | `UInt32` | The account's Sequence Number at the time it minted its first non-fungible-token. |
312-
| `LedgerEntryType` | ✔️ | ✔️ | N/A | `string` | `UInt16` | The value `0x0061`, mapped to the string `AccountRoot`, indicates that this is an `AccountRoot `object. |
313-
| `MessageKey` | | | N/A | `string` | `Blob` | A public key that may be used to send encrypted messages to this account. |
314-
| `MintedNFTokens` | | | `0` | `number` | `UInt32` | How many total non-fungible tokens have been minted by/on behalf of this account. |
315-
| `NFTokenMinter` | | | N/A | `string` | `AccountID` | Another account that can mint NFTs on behalf of this account. |
316-
| `OwnerCount` | | ✔️ | N/A | `number` | `UInt32` | The number of objects this account owns in the ledger, which contributes to its owner reserve. |
317-
| `PreviousTxnID` | | ✔️ | N/A | `string` | `Hash256` | The identifying hash of the transaction that most recently modified this object. |
318-
| `PreviousTxnLgrSeq` | | ✔️ | N/A | `number` | `UInt32` | The ledger index that contains the transaction that most recently modified this object. |
319-
| `RegularKey` | | | N/A | `string` | `AccountID` | The address of a key pair that can be used to sign transactions for this account instead of the master key. |
320-
| `Sequence` | | ✔️ | N/A | `number` | `UInt32` | The [sequence number](https://xrpl.org/docs/references/protocol/data-types/basic-data-types/#account-sequence) of the next valid transaction for this account. |
321-
| `TicketCount` | | | N/A | `number` | `UInt32` | How many Tickets this account owns in the ledger. |
322-
| `TickSize` | | | N/A | `number` | `UInt8` | [How many significant digits to use for exchange rates of Offers involving currencies issued by this address.](https://xrpl.org/resources/known-amendments/#ticksize) |
323-
| `TransferRate` | | | N/A | `number` | `UInt32` | A [transfer fee](https://xrpl.org/docs/concepts/tokens/transfer-fees/) to charge other users for sending currency issued by this account to each other. |
324-
| `WalletLocator` | | | N/A | `string` | `Hash256` | An arbitrary 256-bit value that users can set. |
325-
| `WalletSize` | | | N/A | `number` | `UInt32` | Unused. |
326-
327-
</details>
295+
As a reference, [here](https://xrpl.org/docs/references/protocol/ledger-data/ledger-entry-types/accountroot#accountroot-fields) are the fields that the `AccountRoot` ledger object currently has.
328296

329297
This spec proposes these additional fields:
330298

@@ -353,7 +321,7 @@ The total account reserve should now be calculated as:
353321

354322
$$
355323
\displaylines{
356-
(acct.Sponsor ext{ ? } 0 : acctReserve) +
324+
(acct.Sponsor \text{ ? } 0 : acctReserve) +
357325
objReserve * (acct.OwnerCount + acct.SponsoringOwnerCount - acct.SponsoredOwnerCount) +
358326
acctReserve * acct.SponsoringAccountCount
359327
}
@@ -398,33 +366,8 @@ A `RippleState` ledger entry represents a [trust line](https://xrpl.org/docs/con
398366

399367
### 7.1. Fields
400368

401-
<details>
402-
<summary>
403-
404369
As a reference, [here](https://xrpl.org/docs/references/protocol/ledger-data/ledger-entry-types/ripplestate#ripplestate-fields) are the fields that the `RippleState` ledger object currently has.
405370

406-
</summary>
407-
408-
| Field Name | Constant? | Required? | Default Value | JSON Type | Internal Type | Description |
409-
| ------------------- | --------- | --------- | ------------- | -------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
410-
| `Balance` | No | Yes | N/A | `object` | `Amount` | The balance of the trust line, from the perspective of the low account. A negative balance indicates that the high account holds tokens issued by the low account. The issuer in this is always set to the neutral value [ACCOUNT_ONE](https://xrpl.org/docs/concepts/accounts/addresses#special-addresses). |
411-
| `Flags` | No | Yes | N/A | `number` | `UInt32` | A bit-map of boolean options enabled for this entry. |
412-
| `HighLimit` | No | Yes | N/A | `object` | `Amount` | The limit that the high account has set on the trust line. The `issuer` is the address of the high account that set this limit. |
413-
| `HighNode` | Yes | Yes | N/A | `string` | `UInt64` | (Omitted in some historical ledgers) A hint indicating which page of the high account's owner directory links to this entry, in case the directory consists of multiple pages. |
414-
| `HighQualityIn` | No | No | N/A | `number` | `UInt32` | The inbound quality set by the high account, as an integer in the implied ratio `HighQualityIn`:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value. |
415-
| `HighQualityOut` | No | No | N/A | `number` | `UInt32` | The outbound quality set by the high account, as an integer in the implied ratio `HighQualityOut`:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value. |
416-
| `LedgerEntryType` | Yes | Yes | `RippleState` | `string` | `UInt16` | The value `0x0072`, mapped to the string `RippleState`, indicates that this is a RippleState entry. |
417-
| `LockCount` | No | No | N/A | `object` | `Amount` | The total number of lock balances on a `RippleState` ledger object. |
418-
| `LockedBalance` | No | No | N/A | `object` or `string` | `Amount` | The total number of locked tokens on a `RippleState` ledger object. |
419-
| `LowLimit` | No | Yes | N/A | `object` | `Amount` | The limit that the low account has set on the trust line. The `issuer` is the address of the low account that set this limit. |
420-
| `LowNode` | No | Yes | N/A | `string` | `UInt64` | (Omitted in some historical ledgers) A hint indicating which page of the low account's owner directory links to this entry, in case the directory consists of multiple pages. |
421-
| `LowQualityIn` | No | No | N/A | `number` | `UInt32` | The inbound quality set by the low account, as an integer in the implied ratio `LowQualityIn`:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value. |
422-
| `LowQualityOut` | No | No | N/A | `number` | `UInt32` | The outbound quality set by the low account, as an integer in the implied ratio `LowQualityOut`:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value. |
423-
| `PreviousTxnID` | No | Yes | N/A | `string` | `Hash256` | The identifying hash of the transaction that most recently modified this entry. |
424-
| `PreviousTxnLgrSeq` | No | Yes | N/A | `number` | `UInt32` | The ledger index that contains the transaction that most recently modified this entry. |
425-
426-
</details>
427-
428371
This spec proposes these additional fields:
429372

430373
| Field Name | Constant? | Required? | Default Value | JSON Type | Internal Type | Description |
@@ -480,8 +423,6 @@ _NOTE: The invariants in [4.3](#43-invariant-checks) also apply to `RippleState`
480423

481424
As a reference, [here](https://xrpl.org/docs/references/protocol/transactions/common-fields/) are the fields that all transactions currently have.
482425

483-
<!--There are too many and I didn't want to list them all, it cluttered up the spec - but maybe it can be a collapsed section?-->
484-
485426
We propose these modifications:
486427

487428
| Field Name | Required? | JSON Type | Internal Type | Description |
@@ -977,25 +918,11 @@ When a transaction includes a `SponsorFlags` field with the `tfSponsorReserve` f
977918

978919
## 15. RPC: `account_objects`
979920

980-
### 15.1. Request Fields
981-
982-
The [`account_objects` RPC method](https://xrpl.org/account_objects.html) already exists on the XRPL. As a reference, here are the fields that `account_objects` currently accepts:
921+
The [`account_objects` RPC method](https://xrpl.org/account_objects.html) already exists on the XRPL. This spec proposes an addition to the `account_objects` RPC method, to better support sponsored accounts.
983922

984-
| Field Name | Required? | JSON Type | Description |
985-
| ------------------------ | --------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
986-
| `account` | ✔️ | `string` | Get ledger entries associated with this account. |
987-
| `deletion_blockers_only` | | `boolean` | If `true`, only return ledger entries that would block this account from being deleted. The default is `false`. |
988-
| `ledger_hash` | | `string` | The unique hash of the ledger version to use. |
989-
| `ledger_index` | | `number` or `string` | The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically. |
990-
| `limit` | | `number` | The maximum number of ledger entries to include in the results. Must be within the inclusive range `10` to `400` on non-admin connections. The default is `200`. |
991-
| `marker` | | `any` | Value from a previous paginated response. Resume retrieving data where that response left off. |
992-
| `type` | | `string` | Filter results to a specific type of ledger entry. This field accepts canonical names of ledger entry types (case insensitive) or short names. Ledger entry types that can't appear in an owner directory are not allowed. If omitted, return ledger entries of all types. |
993-
994-
We propose this additional field:
923+
### 15.1. Request Fields
995924

996-
| Field Name | Required? | JSON Type | Description |
997-
| ----------- | --------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
998-
| `sponsored` | | `boolean` | If `true`, only return ledger entries that are sponsored. If `false`, only return ledger entries that are not sponsored. If omitted, return all objects. |
925+
As a reference, [here](https://xrpl.org/account_objects.html#request-format) are the fields that `account_objects` currently accepts.
999926

1000927
### 15.2. Response Fields
1001928

0 commit comments

Comments
 (0)