From 7113f7f45e8536c404a8c14449b949de42377ff4 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 20 Jun 2023 17:57:43 -0700 Subject: [PATCH] account_info updates for 1.11.0: - the "strict" parameter is now the default; only addresses are allowed in the "account" field now (rippled PR#4404) - now returns account_flags as a map of booleans (rippled PR#4459) --- .../account-methods/account_info.md | 32 +++++++++++++++---- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/content/references/http-websocket-apis/public-api-methods/account-methods/account_info.md b/content/references/http-websocket-apis/public-api-methods/account-methods/account_info.md index 72546acbdc..40d64939fe 100644 --- a/content/references/http-websocket-apis/public-api-methods/account-methods/account_info.md +++ b/content/references/http-websocket-apis/public-api-methods/account-methods/account_info.md @@ -61,14 +61,13 @@ The request contains the following parameters: | `Field` | Type | Description | |:---------------|:---------------------------|:-------------------------------| -| `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | +| `account` | String - [Address][] | The account to look up. [Updated in: rippled 1.11.0][] | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | | `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | -| `queue` | Boolean | _(Optional)_ If `true`, and the [FeeEscalation amendment][] is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger. [New in: rippled 0.33.0][] Not available from servers in [Reporting Mode][]. | -| `signer_lists` | Boolean | _(Optional)_ If `true`, and the [MultiSign amendment][] is enabled, also returns any [SignerList objects](signerlist.html) associated with this account. [New in: rippled 0.31.0][] | -| `strict` | Boolean | _(Optional)_ If `true`, then the `account` field only accepts a public key or XRP Ledger address. Otherwise, `account` can be a secret or passphrase (not recommended). The default is `false`. | +| `queue` | Boolean | _(Optional)_ If `true`, return stats about [queued transactions](transaction-queue.html) sent by this account. Can only be used when querying for the data from the current open ledger. Not available from servers in [Reporting Mode][]. | +| `signer_lists` | Boolean | _(Optional)_ If `true`, return any [SignerList objects](signerlist.html) associated with this account. [New in: rippled 0.31.0][] | -The following fields are deprecated and should not be provided: `ident`, `ledger`. +The following fields are deprecated and should not be provided: `ident`, `ledger`, `strict`. ## Response Format @@ -206,13 +205,32 @@ The response follows the [standard format][], with the result containing the req | `Field` | Type | Description | |:-----------------------|:--------|:------------------------------------------| | `account_data` | Object | The [AccountRoot ledger object](accountroot.html) with this account's information, as stored in the ledger. | +| `account_flags` | Object | The account's flag statuses (see below), based on the `Flags` field of the account. [New in: rippled 1.11.0][] | | `signer_lists` | Array | _(Omitted unless the request specified `signer_lists` and at least one SignerList is associated with the account.)_ Array of [SignerList ledger objects](signerlist.html) associated with this account for [Multi-Signing](multi-signing.html). Since an account can own at most one SignerList, this array must have exactly one member if it is present. [New in: rippled 0.31.0][] | | `ledger_current_index` | Integer | _(Omitted if `ledger_index` is provided instead)_ The [ledger index][] of the current in-progress ledger, which was used when retrieving this information. | | `ledger_index` | Integer | _(Omitted if `ledger_current_index` is provided instead)_ The [ledger index][] of the ledger version used when retrieving this information. The information does not contain any changes from ledger versions newer than this one. | | `queue_data` | Object | _(Omitted unless `queue` specified as `true` and querying the current open ledger.)_ Information about [queued transactions](transaction-cost.html#queued-transactions) sent by this account. This information describes the state of the local `rippled` server, which may be different from other servers in the [peer-to-peer XRP Ledger network](consensus-network.html). Some fields may be omitted because the values are calculated "lazily" by the queuing mechanism. | | `validated` | Boolean | True if this data is from a validated ledger version; if omitted or set to false, this data is not final. [New in: rippled 0.26.0][] | -The `queue_data` parameter, if present, contains the following fields: +The `account_flags` field contains the following nested fields: + +| `Field` | Type | Description | +|:-----------------------|:--------|:------------------------------------------| +| `defaultRipple` | Boolean | If `true`, the account allows [rippling](rippling.html) on its trust lines by default. | +| `depositAuth` | Boolean | If `true`, the account is using [Deposit Authorization](depositauth.html) and does not accept any payments from unknown parties. | +| `disableMasterKey` | Boolean | If `true`, the account's [master key pair](cryptographic-keys.html) is disabled. | +| `disallowIncomingCheck` | Boolean | If `true`, the account does not allow others to send [Checks](checks.html) to it. | +| `disallowIncomingNFTokenOffer` | Boolean | If `true`, the account does not allow others to make [NFT buy or sell offers](non-fungible-token-transfers.html) to it. | +| `disallowIncomingPayChan` | Boolean | If `true`, the account does not allow others to make [Payment Channels](payment-channels.html) to it. | +| `disallowIncomingTrustline` | Boolean | If `true`, the account does not allow others to make [trust lines](trust-lines-and-issuing.html) to it. | +| `disallowIncomingXRP` | Boolean | If `true`, the account does not want to receive XRP from others. (This is advisory, and not enforced at a protocol level.) | +| `globalFreeze` | Boolean | If `true`, all tokens issued by the account are currently frozen. | +| `noFreeze` | Boolean | If `true`, the account has permanently given up the abilities to freeze individual trust lines or end a global freeze. See [No Freeze](freezes.html#no-freeze) for details. | +| `passwordSpent` | Boolean | If `false`, the account can send a special [key reset transaction](transaction-cost.html#key-reset-transaction) with a transaction cost of 0. The protocol turns this flag on and off automatically; it is not controlled by a user-facing setting. | +| `requireAuthorization` | Boolean | If `true`, the account is using [Authorized Trust Lines](authorized-trust-lines.html) to limit who can hold the tokens it issues. | +| `requireDestinationTag` | Boolean | If `true`, the account [requires a destination tag](require-destination-tags.html) on all payments it receives. | + +The `queue_data` field, if present, contains the following nested fields: | `Field` | Type | Description | |:------------------------|:--------|:-----------------------------------------| @@ -223,7 +241,7 @@ The `queue_data` parameter, if present, contains the following fields: | `max_spend_drops_total` | String | (May be omitted) Integer amount of [drops of XRP][] that could be debited from this address if every transaction in the queue consumes the maximum amount of XRP possible. | | `transactions` | Array | (May be omitted) Information about each queued transaction from this address. | -Each object in the `transactions` array, if present, may contain any or all of the following fields: +Each object in the `transactions` array of `queue_data`, if present, may contain any or all of the following fields: | `Field` | Type | Description | |:------------------|:--------|:-----------------------------------------------|