diff --git a/assets/js/apitool-methods-ws.js b/assets/js/apitool-methods-ws.js index 09bb194876d..e83ab66e6e4 100644 --- a/assets/js/apitool-methods-ws.js +++ b/assets/js/apitool-methods-ws.js @@ -22,7 +22,6 @@ Request('account_currencies', { body: { "command": "account_currencies", "account": DEFAULT_ADDRESS_1, - "strict": true, "ledger_index": "validated" } }) @@ -34,7 +33,6 @@ Request('account_info', { "id": 2, "command": "account_info", "account": DEFAULT_ADDRESS_1, - "strict": true, "ledger_index": "current", "queue": true } @@ -106,7 +104,6 @@ Request('gateway_balances', { "id": "example_gateway_balances_1", "command": "gateway_balances", "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", // btc2ripple - "strict": true, "hotwallet": [ "rKm4uWpg9tfwbVSeATv4KxDe6mpE9yPkgJ", "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt" diff --git a/content/_snippets/rippled-api-links.md b/content/_snippets/rippled-api-links.md index 78363849a75..7f6f15fd6ce 100644 --- a/content/_snippets/rippled-api-links.md +++ b/content/_snippets/rippled-api-links.md @@ -216,6 +216,7 @@ "fixCheckThreading", "fixMasterKeyAsRegularKey", "fixNFTokenDirV1", + "fixNFTokenRemint", "fixPayChanRecipientOwnerDir", "fixRemoveNFTokenAutoTrustLine", "fixQualityUpperBound", diff --git a/content/_snippets/rippled_versions.md b/content/_snippets/rippled_versions.md index 90bd034fa71..37debc0ac69 100644 --- a/content/_snippets/rippled_versions.md +++ b/content/_snippets/rippled_versions.md @@ -42,6 +42,7 @@ "1.7.2", "1.8.1", "1.10.0", + "1.11.0", ] %} {% for v in rippled_versions %} diff --git a/content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md b/content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md index 577a3f97e53..0c8c5cb6967 100644 --- a/content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md +++ b/content/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md @@ -68,7 +68,7 @@ The request includes the following parameters: | `Field` | Type | Description | |:----------|:--------|:-------------------------------------------------------| | `feature` | String | _(Optional)_ The unique ID of an amendment, as hexadecimal; or the short name of the amendment. If provided, limits the response to one amendment. Otherwise, the response lists all amendments. | -| `vetoed` | Boolean | (Optional; ignored unless `feature` also specified) If true, instructs the server to vote against the amendment specified by `feature`. If false, instructs the server to vote in favor of the amendment. On the commandline, use 'accept' or 'reject rather than 'true' or 'false'. | +| `vetoed` | Boolean | _(Optional; ignored unless `feature` also specified)_ If `true`, instructs the server to vote against the amendment specified by `feature`. If false, instructs the server to vote in favor of the amendment. On the commandline, use 'accept' or 'reject rather than 'true' or 'false'. You cannot vote in favor of an amendment that is marked as _obsolete_ in the server's source code. [Updated in: rippled 1.11.0][] | **Note:** You can configure your server to vote in favor of a new amendment, even if the server does not currently know how to apply that amendment, by specifying the amendment ID in the `feature` field. For example, you might want to do this if you plan to upgrade soon to a new `rippled` version that _does_ support the amendment. @@ -188,7 +188,7 @@ The response follows the [standard format][], with a successful result containin | `enabled` | Boolean | Whether this amendment is currently enabled in the latest ledger. | | `name` | String | (May be omitted) The human-readable name for this amendment, if known. | | `supported` | Boolean | Whether the server knows how to apply this amendment. If this field is set to `false` (the server does not know how to apply this amendment) and `enabled` is set to `true` (this amendment is enabled in the latest ledger), this amendment may cause your server to be [amendment blocked](amendments.html#amendment-blocked-servers). | -| `vetoed` | Boolean | Whether the server has been instructed to vote against this amendment. | +| `vetoed` | Boolean or String | For most amendments, this is a boolean value indicating whether the server has been instructed to vote against this amendment. For amendments that are marked as obsolete in the code, this is the string `Obsolete` instead. [Updated in: rippled 1.11.0][] | **Caution:** The `name` for an amendment does not strictly indicate what that amendment does. The name is not guaranteed to be unique or consistent across servers. diff --git a/content/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md b/content/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md index a3a44c5e0fa..2a16a35621e 100644 --- a/content/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md +++ b/content/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md @@ -55,14 +55,14 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK The request includes the following parameters: -| Field | Type | Description | -|:----------------------|:---------------------------|:------------------------| -| `account` | String | The unique identifier of an account, typically the account's [Address][]. The request returns channels where this account is the channel's owner/source. | -| `destination_account` | String | _(Optional)_ The unique identifier of an account, typically the account's [Address][]. If provided, filter results to payment channels whose destination is this account. | -| `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][]) | -| `limit` | Integer | _(Optional)_ Limit the number of transactions to retrieve. Cannot be less than 10 or more than 400. The default is 200. | -| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. [Updated in: rippled 1.5.0][] | +| Field | Type | Required? | Description | +|:----------------------|:---------------------|:----------|-------------| +| `account` | String - [Address][] | Yes | Look up channels where this account is the channel's owner/source. | +| `destination_account` | String - [Address][] | No | A second account; if provided, filter results to payment channels whose destination is this account. | +| `ledger_hash` | String | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | +| `ledger_index` | Number or String | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `limit` | Number | No | Limit the number of transactions to retrieve. Cannot be less than 10 or more than 400. The default is 200. | +| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. | ## Response Format diff --git a/content/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md b/content/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md index 4b45fc314b6..f39cef509a8 100644 --- a/content/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md +++ b/content/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md @@ -21,7 +21,6 @@ An example of the request format: { "command": "account_currencies", "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", - "strict": true, "ledger_index": "validated" } ``` @@ -35,8 +34,7 @@ An example of the request format: { "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "account_index": 0, - "ledger_index": "validated", - "strict": true + "ledger_index": "validated" } ] } @@ -45,8 +43,8 @@ An example of the request format: *Commandline* ```sh -#Syntax: account_currencies account [ledger_index|ledger_hash] [strict] -rippled account_currencies rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated strict +#Syntax: account_currencies account [ledger_index|ledger_hash] +rippled account_currencies rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated ``` @@ -55,14 +53,13 @@ rippled account_currencies rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated strict The request includes the following parameters: -| `Field` | Type | Description | -|:---------------|:---------------------------|:-------------------------------| -| `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | -| `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][]) | -| `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`. | +| `Field` | Type | Required? | Description | +|:---------------|:---------------------|:----------|-------------| +| `account` | String - [Address][] | Yes | Look up currencies this account can send or receive. [Updated in: rippled 1.11.0][] | +| `ledger_hash` | String | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | +| `ledger_index` | Number or String | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | -The following field is deprecated and should not be provided: `account_index`. +The following fields are deprecated and should not be provided: `account_index`, `strict`. ## Response Format @@ -178,3 +175,4 @@ The response follows the [standard format][], with a successful result containin {% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/rippled_versions.md' %} 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 72546acbdc3..e678200b57d 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 @@ -24,7 +24,6 @@ An example of an account_info request: "id": 2, "command": "account_info", "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn", - "strict": true, "ledger_index": "current", "queue": true } @@ -38,7 +37,6 @@ An example of an account_info request: "params": [ { "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn", - "strict": true, "ledger_index": "current", "queue": true } @@ -49,8 +47,8 @@ An example of an account_info request: *Commandline* ```sh -#Syntax: account_info account [ledger_index|ledger_hash] [strict] -rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated strict +#Syntax: account_info account [ledger_index|ledger_hash] +rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated ``` @@ -59,16 +57,15 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated strict The request contains the following parameters: -| `Field` | Type | Description | -|:---------------|:---------------------------|:-------------------------------| -| `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | -| `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`. | +| `Field` | Type | Required? | Description | +|:---------------|:---------------------|:----------|-------------| +| `account` | String - [Address][] | Yes | The account to look up. [Updated in: rippled 1.11.0][] | +| `ledger_hash` | String | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | +| `ledger_index` | Number or String | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `queue` | Boolean | No | 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 | No | If `true`, return any [SignerList objects](signerlist.html) associated with this account. | -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 +203,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. _(Requires the [DisallowIncoming amendment][])_ | +| `disallowIncomingNFTokenOffer` | Boolean | If `true`, the account does not allow others to make [NFT buy or sell offers](non-fungible-token-transfers.html) to it. _(Requires the [DisallowIncoming amendment][])_ | +| `disallowIncomingPayChan` | Boolean | If `true`, the account does not allow others to make [Payment Channels](payment-channels.html) to it. _(Requires the [DisallowIncoming amendment][])_ | +| `disallowIncomingTrustline` | Boolean | If `true`, the account does not allow others to make [trust lines](trust-lines-and-issuing.html) to it. _(Requires the [DisallowIncoming amendment][])_ | +| `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 +239,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 | |:------------------|:--------|:-----------------------------------------------| diff --git a/content/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md b/content/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md index 2de2adefd03..281ad9467b8 100644 --- a/content/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md +++ b/content/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md @@ -52,14 +52,14 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 The request accepts the following parameters: -| `Field` | Type | Description | -|:---------------|:-------------------------------------------|:---------------| -| `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | -| `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][]) | -| `peer` | String | _(Optional)_ The [Address][] of a second account. If provided, show only lines of trust connecting the two accounts. | -| `limit` | Integer | (Optional, default varies) Limit the number of trust lines to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. [New in: rippled 0.26.4][] | -| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. [New in: rippled 0.26.4][] | +| `Field` | Type | Description | +|:---------------|:---------------------|:---------------| +| `account` | String - [Address][] | Look up trust lines connected to this account. | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | +| `ledger_index` | Number or String | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `peer` | String - [Address][] | _(Optional)_ A second account; if provided, filter results to trust lines connecting the two accounts. | +| `limit` | Number | _(Optional)_ Limit the number of trust lines to retrieve. The server may return less than the specified limit, even if there are more pages of results. Must be within the inclusive range 10 to 400. The default is 200. | +| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. | The following parameters are deprecated and may be removed without further notice: `ledger` and `peer_index`. diff --git a/content/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md b/content/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md index 008835d96d7..563e450fe13 100644 --- a/content/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md +++ b/content/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md @@ -9,19 +9,20 @@ labels: # account_objects [[Source]](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/AccountObjects.cpp "Source") -The `account_objects` command returns the raw [ledger format][] for all objects owned by an account. For a higher-level view of an account's trust lines and balances, see the [account_lines method][] instead. +The `account_objects` command returns the raw [ledger format][] for all ledger entries owned by an account. For a higher-level view of an account's trust lines and balances, see the [account_lines method][] instead. -The types of objects that may appear in the `account_objects` response for an account include: +The types of objects that may appear in the `account_objects` response include: -- [Offer objects](offer.html) for orders that are currently live, unfunded, or expired but not yet removed. (See [Lifecycle of an Offer](offers.html#lifecycle-of-an-offer) for more information.) -- [RippleState objects](ripplestate.html) for trust lines where this account's side is not in the default state. +- [Offer entries](offer.html) for orders that are currently live, unfunded, or expired but not yet removed. (See [Lifecycle of an Offer](offers.html#lifecycle-of-an-offer) for more information.) +- [RippleState entries](ripplestate.html) for trust lines where this account's side is not in the default state. - The account's [SignerList](signerlist.html), if the account has [multi-signing](multi-signing.html) enabled. -- [Escrow objects](escrow.html) for held payments that have not yet been executed or canceled. -- [PayChannel objects](paychannel.html) for open payment channels. -- [Check objects](check.html) for pending Checks. -- [DepositPreauth objects](depositpreauth-object.html) for deposit preauthorizations. [New in: rippled 1.1.0][] -- [Ticket objects](known-amendments.html#tickets) for Tickets. -- [NFTokenPage objects](nftokenpage.html) for collections of NFTs. +- [Escrow entries](escrow.html) for held payments that have not yet been executed or canceled. +- [PayChannel entries](paychannel.html) for open payment channels. +- [Check entries](check.html) for pending Checks. +- [DepositPreauth entries](depositpreauth-object.html) for deposit preauthorizations. +- [Ticket entries](tickets.html) for Tickets. +- [NFTokenOffer entries](nftokenoffer.html) for offers to buy or sell an NFT. +- [NFTokenPage entries](nftokenpage.html) for collections of NFTs. [New in: rippled 1.11.0][] ## Request Format @@ -80,7 +81,7 @@ The request includes the following parameters: | `ledger_index` | [Ledger Index][] | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `limit` | Number | No | The maximum number of objects to include in the results. Must be within the inclusive range `10` to `400` on non-admin connections. The default is `200`. | | `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. | -| `type` | String | No | Filter results by a ledger entry type. The valid types are: `check`, `deposit_preauth`, `escrow`, `nft_offer`, `offer`, `payment_channel`, `signer_list`, `state` (trust line), and `ticket`. | +| `type` | String | No | Filter results by a ledger entry type. The valid types are: `check`, `deposit_preauth`, `escrow`, `nft_offer`, `nft_page`, `offer`, `payment_channel`, `signer_list`, `state` (trust line), and `ticket`. | ## Response Format diff --git a/content/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md b/content/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md index 34c0d1909f7..7e8bf611078 100644 --- a/content/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md +++ b/content/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md @@ -42,8 +42,8 @@ An example of the request format: *Commandline* ```sh -#Syntax: account_offers account [ledger_index] [strict] -rippled account_offers rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM current strict +#Syntax: account_offers account [ledger_index] +rippled account_offers rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM current ``` @@ -52,16 +52,15 @@ rippled account_offers rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM current strict A request can include the following parameters: -| `Field` | Type | Description | -|:---------------|:----------------------------|:------------------------------| -| `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | -| `ledger_hash` | String - [Hash][] | _(Optional)_ A 20-byte hex string identifying the ledger version to use. | -| `ledger_index` | Number - [Ledger Index][] | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | -| `limit` | Integer | _(Optional)_ Limit the number of Offers to retrieve. The server may return fewer than this number of results. Must be within the inclusive range 10 to 400. The default is 200. [New in: rippled 0.26.4][] | -| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. [New in: rippled 0.26.4][] | -| `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`. | +| Field | Type | Required? | Description | +|:---------------|:---------------------|:----------|-------------| +| `account` | String - [Address][] | Yes | Look up Offers placed by this account. | +| `ledger_hash` | String | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | +| `ledger_index` | Number or String | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | +| `limit` | Number | No | Limit the number of Offers to retrieve. The server may return fewer than this number of results. Must be within the inclusive range 10 to 400. The default is 200. | +| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. | -The following parameter is deprecated and may be removed without further notice: `ledger`. +The following parameters are deprecated should not be provided: `ledger`, `strict`. ## Response Format diff --git a/content/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md b/content/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md index 8e86e3a3ef0..896eba5535d 100644 --- a/content/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md +++ b/content/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md @@ -11,6 +11,8 @@ labels: The `gateway_balances` command calculates the total balances issued by a given account, optionally excluding amounts held by [operational addresses](issuing-and-operational-addresses.html). [New in: rippled 0.28.2][] +**Caution:** Some public servers disable this API method because it can require a large amount of processing. + ## Request Format An example of the request format: diff --git a/content/references/protocol-reference/ledger-data/ledger-object-types/accountroot.md b/content/references/protocol-reference/ledger-data/ledger-object-types/accountroot.md index 7afa0e89c18..718c94baadc 100644 --- a/content/references/protocol-reference/ledger-data/ledger-object-types/accountroot.md +++ b/content/references/protocol-reference/ledger-data/ledger-object-types/accountroot.md @@ -7,7 +7,7 @@ labels: - XRP --- # AccountRoot -[[Source]](https://github.com/xrplf/rippled/blob/5d2d88209f1732a0f8d592012094e345cbe3e675/src/ripple/protocol/impl/LedgerFormats.cpp#L27 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/264280edd79b7f764536e02459f33f66a59c0531/src/ripple/protocol/impl/LedgerFormats.cpp#L36-L60 "Source") An `AccountRoot` ledger entry type describes a single [account](accounts.html), its settings, and XRP balance. @@ -44,6 +44,7 @@ An `AccountRoot` object has the following fields: | `BurnedNFTokens` | Number | UInt32 | No | How many total of this account's issued [non-fungible tokens](non-fungible-tokens.html) have been burned. This number is always equal or less than `MintedNFTokens`. | | `Domain` | String | Blob | No | A domain associated with this account. In JSON, this is the hexadecimal for the ASCII representation of the domain. [Cannot be more than 256 bytes in length.](https://github.com/xrplf/rippled/blob/55dc7a252e08a0b02cd5aa39e9b4777af3eafe77/src/ripple/app/tx/impl/SetAccount.h#L34) | | `EmailHash` | String | Hash128 | No | The md5 hash of an email address. Clients can use this to look up an avatar through services such as [Gravatar](https://en.gravatar.com/). | +| `FirstNFTokenSequence` | Number | UInt32 | No | The account's [Sequence Number][] at the time it minted its first [non-fungible-token](non-fungible-tokens.html). _(Added by the [fixNFTokenRemint amendment][] :not_enabled:)_ | | [`Flags`](#accountroot-flags) | Number | UInt32 | Yes | A bit-map of boolean flags enabled for this account. | | `LedgerEntryType` | String | UInt16 | Yes | The value `0x0061`, mapped to the string `AccountRoot`, indicates that this is an AccountRoot object. | | `MessageKey` | String | Blob | No | A public key that may be used to send encrypted messages to this account. In JSON, uses hexadecimal. Must be exactly 33 bytes, with the first byte indicating the key type: `0x02` or `0x03` for secp256k1 keys, `0xED` for Ed25519 keys. | diff --git a/content/references/protocol-reference/transactions/transaction-common-fields.md b/content/references/protocol-reference/transactions/transaction-common-fields.md index b3b1c932623..7878c8e2ff4 100644 --- a/content/references/protocol-reference/transactions/transaction-common-fields.md +++ b/content/references/protocol-reference/transactions/transaction-common-fields.md @@ -19,6 +19,7 @@ Every transaction has the same set of common fields, plus additional fields base | [`Flags`](#flags-field) | Number | UInt32 | _(Optional)_ Set of bit-flags for this transaction. | | `LastLedgerSequence` | Number | UInt32 | _(Optional; strongly recommended)_ Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected. See [Reliable Transaction Submission](reliable-transaction-submission.html) for more details. | | [`Memos`](#memos-field) | Array of Objects | Array | _(Optional)_ Additional arbitrary information used to identify this transaction. | +| [`NetworkID`](#networkid-field) | Number | UInt32 | _(Network-specific)_ The network ID of the chain this transaction is intended for. **MUST BE OMITTED** for Mainnet and some test networks. **REQUIRED** on chains whose network ID is 1025 or higher. | | [`Signers`](#signers-field) | Array | Array | _(Optional)_ Array of objects that represent a [multi-signature](multi-signing.html) which authorizes this transaction. | | `SourceTag` | Number | UInt32 | _(Optional)_ Arbitrary integer used to identify the reason for this payment, or a sender on whose behalf this transaction is made. Conventionally, a refund should specify the initial payment's `SourceTag` as the refund payment's `DestinationTag`. | | `SigningPubKey` | String | Blob | _(Automatically added when signing)_ Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in the `Signers` field instead. | @@ -127,6 +128,29 @@ Example of a transaction with a Memos field: } ``` +## NetworkID Field +[New in: rippled 1.11.0][] + +The `NetworkID` field is a protection against "cross-chain" transaction replay attacks, preventing the same transaction from being copied over and executing on a [parallel network](parallel-networks.html) that it wasn't intended for. For compatibility with existing chains, the `NetworkID` field must be omitted on any network with a Network ID of 1024 or less, but must be included on any network with a Network ID of 1025 or greater. The following table shows the status and values for various known networks: + +| Network | ID | `NetworkID` Field | +|---------------|----|-------------------| +| Mainnet | 0 | Disallowed | +| Testnet | 1 | Disallowed | +| Devnet | 2 | Disallowed | +| AMM Devnet | 25 | Disallowed | +| Sidechains Devnet Locking Chain | 2551 | Disallowed, but will become required after an update | +| Sidechains Devnet Issuing Chain | 2552 | Disallowed, but will become required after an update | +| Hooks V3 Testnet | 21338 | Required | + +Transaction replay attacks are theoretically possible, but require specific conditions on the second network. All of the following must be true: + +- The transaction's sender is a funded account on the second network. +- The sender's `Sequence` number on the second network matches the transaction's `Sequence`, or the transaction uses a [Ticket](tickets.html) that's available on the second network. +- Either the transaction does not have a `LastLedgerSequence` field, or it specifies a value that is higher than the current ledger index on the second ledger. + - Mainnet generally has a higher ledger index than test networks or sidechains, so it is easier to replay Mainnet transactions on a sidechain or test network than the other way around, when transactions use `LastLedgerSequence` as intended. +- Either the networks both have IDs of 1024 or less, both networks use the same ID, or the second network does not require the `NetworkID` field. + ## Signers Field diff --git a/dactyl-config.yml b/dactyl-config.yml index 06808ea7f31..510c654df4d 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -2510,6 +2510,7 @@ pages: targets: - ja + # TODO: update translation for rippled v1.11.0 - md: references/protocol-reference/ledger-data/ledger-object-types/accountroot.md targets: - en @@ -2661,6 +2662,7 @@ pages: targets: - en + # TODO: update translation with rippled 1.11.0 changes - md: references/protocol-reference/transactions/transaction-common-fields.ja.md targets: - ja @@ -3249,6 +3251,7 @@ pages: targets: - en + # TODO: update translation for rippled v1.11.0 - md: references/http-websocket-apis/public-api-methods/account-methods/account_currencies.ja.md targets: - ja @@ -3257,6 +3260,7 @@ pages: targets: - en + # TODO: update translation for rippled v1.11.0 - md: references/http-websocket-apis/public-api-methods/account-methods/account_info.ja.md targets: - ja @@ -3265,6 +3269,7 @@ pages: targets: - en + # TODO: update translation for rippled v1.11.0 - md: references/http-websocket-apis/public-api-methods/account-methods/account_lines.ja.md targets: - ja @@ -3279,6 +3284,7 @@ pages: targets: - en + # TODO: update translation for rippled v1.11.0 - md: references/http-websocket-apis/public-api-methods/account-methods/account_objects.ja.md targets: - ja @@ -3287,6 +3293,7 @@ pages: targets: - en + # TODO: update translation for rippled v1.11.0 - md: references/http-websocket-apis/public-api-methods/account-methods/account_offers.ja.md targets: - ja @@ -3978,6 +3985,7 @@ pages: targets: - en + # TODO: update translation for rippled v1.11.0 - md: references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.ja.md targets: - ja