diff --git a/docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/validation_create.md b/docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/validation_create.md index e508bb358aa..ff85d2b14eb 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/validation_create.md +++ b/docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/validation_create.md @@ -1,14 +1,12 @@ --- -html: validation_create.html -parent: key-generation-methods.html seo: description: Generate keys for a rippled server to identify itself to the network. labels: - - Security - - Core Server + - Security + - Core Server --- # validation_create -[[Source]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/ValidationCreate.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/ValidationCreate.cpp "Source") Use the `validation_create` command to generate [cryptographic keys a `rippled` server can use to identify itself to the network](../../../../concepts/networks-and-servers/peer-protocol.md#node-key-pair). Similar to the [wallet_propose method][], this method only generates a set of keys in the proper format. It does not any makes changes to the XRP Ledger data or server configuration. @@ -16,7 +14,7 @@ _The `validation_create` method is an [admin method](../index.md) that cannot be You can configure your server to use the generated key pair to sign validations (validation key pair) or regular peer-to-peer communications ([node key pair](../../../../concepts/networks-and-servers/peer-protocol.md#node-key-pair)). -{% admonition type="success" name="Tip" %}For configuring a robust validator, you should use the `validator-keys` tool (included in the `rippled` RPM) to generate validator tokens (which can be rotated) with an offline master key. For more information, see [Validator Setup](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-enable-validation-on-your-rippled-server).{% /admonition %} +{% admonition type="success" name="Tip" %}For configuring a robust validator, you should use the `validator-keys` tool (included in the `rippled` package build) to generate validator tokens (which can be rotated) with an offline master key. For more information, see [Validator Setup](../../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-enable-validation-on-your-rippled-server).{% /admonition %} ### Request Format diff --git a/docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/wallet_propose.md b/docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/wallet_propose.md index d12159fea75..9f981692d4d 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/wallet_propose.md +++ b/docs/references/http-websocket-apis/admin-api-methods/key-generation-methods/wallet_propose.md @@ -1,21 +1,17 @@ --- -html: wallet_propose.html -parent: key-generation-methods.html seo: description: Generate keys for a new account. labels: - - Security - - Accounts + - Security + - Accounts --- # wallet_propose -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/WalletPropose.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/WalletPropose.cpp "Source") -Use the `wallet_propose` method to generate a key pair and XRP Ledger address. This command only generates key and address values, and does not affect the XRP Ledger itself in any way. To become a funded address stored in the ledger, the address must [receive a Payment transaction](../../../../concepts/accounts/index.md#creating-accounts) that provides enough XRP to meet the [reserve requirement](../../../../concepts/accounts/reserves.md). +Use the `wallet_propose` method to generate a key pair and XRP Ledger address. This command only generates key and address values, and does not affect the XRP Ledger itself in any way. To become a funded account in the ledger, the address must [receive a Payment transaction](../../../../concepts/accounts/index.md#creating-accounts) that provides enough XRP to meet the [reserve requirement](../../../../concepts/accounts/reserves.md). *The `wallet_propose` method is an [admin method](../index.md) that cannot be run by unprivileged users!* (This command is restricted to protect against people sniffing network traffic for account secrets, since admin commands are not usually transmitted over the outside network.) -{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.31.0" %}Updated in: rippled 0.31.0{% /badge %} - ### Request Format An example of the request format: diff --git a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/can_delete.md b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/can_delete.md index 381d4783bca..08a27594aad 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/can_delete.md +++ b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/can_delete.md @@ -1,13 +1,11 @@ --- -html: can_delete.html -parent: logging-and-data-management-methods.html seo: description: Allow online deletion of ledgers up to a specific ledger. labels: - - Data Retention + - Data Retention --- # can_delete -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/CanDelete.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/CanDelete.cpp "Source") The `can_delete` method informs the `rippled` server of the latest ledger version which may be deleted when using [online deletion with advisory deletion enabled](../../../../infrastructure/configuration/data-retention/online-deletion.md#advisory-deletion). If advisory deletion is not enabled, this method does nothing. diff --git a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_cleaner.md b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_cleaner.md index 58fcea0fcdb..00bb10cfb99 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_cleaner.md +++ b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_cleaner.md @@ -1,15 +1,13 @@ --- -html: ledger_cleaner.html -parent: logging-and-data-management-methods.html seo: description: Configure the ledger cleaner service to check for corrupted data. labels: - - Data Retention + - Data Retention --- # ledger_cleaner -[[Source]](https://github.com/XRPLF/rippled/blob/df54b47cd0957a31837493cd69e4d9aade0b5055/src/ripple/rpc/handlers/LedgerCleaner.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerCleanerHandler.cpp "Source") -The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/XRPLF/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in `rippled`'s database of ledgers. +The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/XRPLF/rippled/tree/master/src/xrpld/app/ledger#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in `rippled`'s database of ledgers. _The `ledger_cleaner` method is an [admin method](../index.md) that cannot be run by unprivileged users._ diff --git a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_request.md b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_request.md index add2a683032..5af86066f0f 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_request.md +++ b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/ledger_request.md @@ -1,13 +1,11 @@ --- -html: ledger_request.html -parent: logging-and-data-management-methods.html seo: description: Query peer servers for a specific ledger version. labels: - - Data Retention + - Data Retention --- # ledger_request -[[Source]](https://github.com/XRPLF/rippled/blob/e980e69eca9ea843d200773eb1f43abe3848f1a0/src/ripple/rpc/handlers/LedgerRequest.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerRequest.cpp "Source") The `ledger_request` command tells server to fetch a specific ledger version from its connected peers. This only works if one of the server's immediately-connected peers has that ledger. You may need to run the command several times to completely fetch a ledger. @@ -61,7 +59,7 @@ Loading: "/etc/rippled.cfg" Connecting to 127.0.0.1:5005 { - "result" : { + "result" : { "acquiring" : { "hash" : "01DDD89B6605E20338B8EEB8EB2B0E0DD2F685A2B164F3790C4D634B5734CC26", "have_header" : false, @@ -76,7 +74,7 @@ Connecting to 127.0.0.1:5005 "ledger_index" : 18851277 }, "status" : "error" - } + } } ``` {% /tab %} @@ -87,43 +85,43 @@ Loading: "/etc/rippled.cfg" Connecting to 127.0.0.1:5005 { - "result" : { - "hash" : "EB68B5B4F6F06BF59B6D7532BCB98BB98E2F10C2435D895217AA0AA7E910FBD5", - "have_header" : true, - "have_state" : false, - "have_transactions" : false, - "needed_state_hashes" : [ - "C46F7B9E795135447AF24BAF999AB8FC1612A997F6EAAF8B784C226FF0BD8E25", - "E48F528E4FC2A1DC492C6264B27B420E2285B2A3ECF3A253DB480DA5BFB7F858", - "B62CD0B2E1277F78BC279FA037F3F747587299B60D23A551C3F63DD137DC0CF8", - "30014C55701FB8426E496A47B297BEC9E8F5BFA47763CC22DBD9024CC81D39DD", - "7EB59A853913898FCEA7B701637F33B1054BD36C32A0B910B612EFB9CDFF6334", - "07ECAD3066D62583883979A2FADAADC8F7D89FA07375843C8A47452639AB2421", - "97A87E5246AF78463485CB27E08D561E22AAF33D5E2F08FE2FACAE0D05CB5478", - "50A0525E238629B32324C9F59B4ECBEFE3C21DC726DB9AB3B6758BD1838DFF68", - "8C541B1ED47C9282E2A28F0B7F3DDFADF06644CAB71B15A3E67D04C5FAFE9BF4", - "2C6CC536C778D8C0F601E35DA7DD9888C288897E4F603E76357CE2F47E8A7A9F", - "309E78DEC67D5725476A59E114850556CC693FB6D92092997ADE97E3EFF473CC", - "8EFF61B6A636AF6B4314CAC0C08F4FED0759E1F782178A822EDE98275E5E4B10", - "9535645E5D249AC0B6126005B79BB981CBA00286E00154D20A3BCF65743EA3CA", - "69F5D6FCB41D1E6CEA5ADD42CBD194086B45E957D497DF7AEE62ADAD485660CE", - "07E93A95DBB0B8A00925DE0DF6D27E41CACC77EF75055A89815006109D82EAD3", - "7FDF25F660235DCAD649676E3E6729DF920A9B0B4B6A3B090A3C64D7BDE2FB20" - ], - "needed_transaction_hashes" : [ - "BA914854F2F5EDFCBD6E3E0B168E5D4CD0FC92927BEE408C6BD38D4F52505A34", - "AE3A2DB537B01EB33BB3A677242DE52C9AE0A64BD9222EE55E52855276E7EA2A", - "E145F737B255D93769673CBA6DEBA4F6AC7387A309DAACC72EA5B07ECF03C215", - "073A118552AA60E1D3C6BE6F65E4AFA01C582D9C41CCC2887244C19D9BFA7741", - "562DB8580CD3FE19AF5CEA61C2858C10091151B924DBF2AEB7CBB8722E683204", - "437C0D1C2391057079E9539CF028823D29E6437A965284F6E54CEBF1D25C5D56", - "1F069486AF5533883609E5C8DB907E97273D9A782DF26F5E5811F1C42ED63A3D", - "CAA6B7DA68EBA71254C218C81A9EA029A179694BDD0D75A49FB03A7D57BCEE49" - ], - "peers" : 6, - "status" : "success", - "timeouts" : 1 - } + "result" : { + "hash" : "EB68B5B4F6F06BF59B6D7532BCB98BB98E2F10C2435D895217AA0AA7E910FBD5", + "have_header" : true, + "have_state" : false, + "have_transactions" : false, + "needed_state_hashes" : [ + "C46F7B9E795135447AF24BAF999AB8FC1612A997F6EAAF8B784C226FF0BD8E25", + "E48F528E4FC2A1DC492C6264B27B420E2285B2A3ECF3A253DB480DA5BFB7F858", + "B62CD0B2E1277F78BC279FA037F3F747587299B60D23A551C3F63DD137DC0CF8", + "30014C55701FB8426E496A47B297BEC9E8F5BFA47763CC22DBD9024CC81D39DD", + "7EB59A853913898FCEA7B701637F33B1054BD36C32A0B910B612EFB9CDFF6334", + "07ECAD3066D62583883979A2FADAADC8F7D89FA07375843C8A47452639AB2421", + "97A87E5246AF78463485CB27E08D561E22AAF33D5E2F08FE2FACAE0D05CB5478", + "50A0525E238629B32324C9F59B4ECBEFE3C21DC726DB9AB3B6758BD1838DFF68", + "8C541B1ED47C9282E2A28F0B7F3DDFADF06644CAB71B15A3E67D04C5FAFE9BF4", + "2C6CC536C778D8C0F601E35DA7DD9888C288897E4F603E76357CE2F47E8A7A9F", + "309E78DEC67D5725476A59E114850556CC693FB6D92092997ADE97E3EFF473CC", + "8EFF61B6A636AF6B4314CAC0C08F4FED0759E1F782178A822EDE98275E5E4B10", + "9535645E5D249AC0B6126005B79BB981CBA00286E00154D20A3BCF65743EA3CA", + "69F5D6FCB41D1E6CEA5ADD42CBD194086B45E957D497DF7AEE62ADAD485660CE", + "07E93A95DBB0B8A00925DE0DF6D27E41CACC77EF75055A89815006109D82EAD3", + "7FDF25F660235DCAD649676E3E6729DF920A9B0B4B6A3B090A3C64D7BDE2FB20" + ], + "needed_transaction_hashes" : [ + "BA914854F2F5EDFCBD6E3E0B168E5D4CD0FC92927BEE408C6BD38D4F52505A34", + "AE3A2DB537B01EB33BB3A677242DE52C9AE0A64BD9222EE55E52855276E7EA2A", + "E145F737B255D93769673CBA6DEBA4F6AC7387A309DAACC72EA5B07ECF03C215", + "073A118552AA60E1D3C6BE6F65E4AFA01C582D9C41CCC2887244C19D9BFA7741", + "562DB8580CD3FE19AF5CEA61C2858C10091151B924DBF2AEB7CBB8722E683204", + "437C0D1C2391057079E9539CF028823D29E6437A965284F6E54CEBF1D25C5D56", + "1F069486AF5533883609E5C8DB907E97273D9A782DF26F5E5811F1C42ED63A3D", + "CAA6B7DA68EBA71254C218C81A9EA029A179694BDD0D75A49FB03A7D57BCEE49" + ], + "peers" : 6, + "status" : "success", + "timeouts" : 1 + } } ``` {% /tab %} @@ -134,26 +132,26 @@ Loading: "/etc/rippled.cfg" Connecting to 127.0.0.1:5005 { - "result" : { - "ledger" : { - "accepted" : true, - "account_hash" : "84EBB27D9510AD5B9A3A328201921B3FD418D4A349E85D3DC69E33C7B506407F", - "close_time" : 486691300, - "close_time_human" : "2015-Jun-04 00:01:40", - "close_time_resolution" : 10, - "closed" : true, - "hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863", - "ledger_hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863", - "ledger_index" : "13840000", - "parent_hash" : "8A3F6FBC62C11DE4538D969F9C7966234635FE6CEB1133DDC37220978F8100A9", - "seqNum" : "13840000", - "totalCoins" : "99999022883526403", - "total_coins" : "99999022883526403", - "transaction_hash" : "3D759EF3AF1AE2F78716A8CCB2460C3030F82687E54206E883703372B9E1770C" - }, - "ledger_index" : 13840000, - "status" : "success" - } + "result" : { + "ledger" : { + "accepted" : true, + "account_hash" : "84EBB27D9510AD5B9A3A328201921B3FD418D4A349E85D3DC69E33C7B506407F", + "close_time" : 486691300, + "close_time_human" : "2015-Jun-04 00:01:40", + "close_time_resolution" : 10, + "closed" : true, + "hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863", + "ledger_hash" : "DCF5D723ECEE1EF56D2B0024CD9BDFF2D8E3DC211BD2B9460165922564ACD863", + "ledger_index" : "13840000", + "parent_hash" : "8A3F6FBC62C11DE4538D969F9C7966234635FE6CEB1133DDC37220978F8100A9", + "seqNum" : "13840000", + "totalCoins" : "99999022883526403", + "total_coins" : "99999022883526403", + "transaction_hash" : "3D759EF3AF1AE2F78716A8CCB2460C3030F82687E54206E883703372B9E1770C" + }, + "ledger_index" : 13840000, + "status" : "success" + } } ``` diff --git a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/log_level.md b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/log_level.md index 9dfddb02aa9..e26eea70581 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/log_level.md +++ b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/log_level.md @@ -1,13 +1,11 @@ --- -html: log_level.html -parent: logging-and-data-management-methods.html seo: - description: Get or modify log verbosity. + description: Get or modify log verbosity. labels: - - Data Retention + - Data Retention --- # log_level -[[Source]](https://github.com/XRPLF/rippled/blob/155fcdbcd0b4927152892c8c8be01d9cf62bed68/src/ripple/rpc/handlers/LogLevel.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LogLevel.cpp "Source") The `log_level` command changes the `rippled` server's logging verbosity, or returns the current logging level for each category (called a _partition_) of log messages. @@ -21,10 +19,10 @@ An example of the request format: {% tab label="WebSocket" %} ```json { - "id": "ll1", - "command": "log_level", - "severity": "debug", - "partition": "PathRequest" + "id": "ll1", + "command": "log_level", + "severity": "debug", + "partition": "PathRequest" } ``` {% /tab %} diff --git a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/logrotate.md b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/logrotate.md index e61f870f6f2..cb72ac2dd8c 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/logrotate.md +++ b/docs/references/http-websocket-apis/admin-api-methods/logging-and-data-management-methods/logrotate.md @@ -1,13 +1,11 @@ --- -html: logrotate.html -parent: logging-and-data-management-methods.html seo: - description: Reopen the log file. + description: Reopen the log file. labels: - - Data Retention + - Data Retention --- # logrotate -[[Source]](https://github.com/XRPLF/rippled/blob/743bd6c9175c472814448ea889413be79dfd1c07/src/ripple/rpc/handlers/LogRotate.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LogRotate.cpp "Source") The `logrotate` command closes and reopens the log file. This is intended to help with log rotation on Linux file systems. @@ -49,8 +47,8 @@ An example of the request format: {% tab label="WebSocket" %} ```json { - "id": "lr1", - "command": "logrotate" + "id": "lr1", + "command": "logrotate" } ``` {% /tab %} diff --git a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/connect.md b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/connect.md index 949188fb3c2..9bd3dbd3a48 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/connect.md +++ b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/connect.md @@ -1,15 +1,13 @@ --- -html: connect.html -parent: peer-management-methods.html seo: description: Force the rippled server to connect to a specific peer. labels: - - Core Server + - Core Server --- # connect -[[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/Connect.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Connect.cpp "Source") -The `connect` command forces the `rippled` server to connect to a specific peer `rippled` server. +The `connect` command forces the `rippled` server to connect to a specific peer server. *The `connect` method is an [admin method](../index.md) that cannot be run by unprivileged users!* diff --git a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_add.md b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_add.md index 26ae510e61a..3a1ff0e9aca 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_add.md +++ b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_add.md @@ -1,13 +1,11 @@ --- -html: peer_reservations_add.html -parent: peer-management-methods.html seo: description: Add a reserved slot for a specific peer server. labels: - - Core Server + - Core Server --- # peer_reservations_add -[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L36 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Reservations.cpp "Source") The {% code-page-name /%} method adds or updates a reserved slot for a specific peer server in the XRP Ledger [peer-to-peer network](../../../../concepts/networks-and-servers/peer-protocol.md). diff --git a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_del.md b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_del.md index 3616d3a3562..96d1aff5218 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_del.md +++ b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_del.md @@ -1,13 +1,11 @@ --- -html: peer_reservations_del.html -parent: peer-management-methods.html seo: description: Remove a reserved slot for a specific peer server. labels: - - Core Server + - Core Server --- # peer_reservations_del -[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L89 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Reservations.cpp "Source") The {% code-page-name /%} method removes a specific [peer reservation][], if one exists. @@ -83,13 +81,13 @@ An example of a successful response: {% tab label="JSON-RPC" %} ```json { - "result" : { - "previous" : { - "description" : "Ripple s1 server 'WOOL'", - "node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99" - }, - "status" : "success" - } + "result" : { + "previous" : { + "description" : "Ripple s1 server 'WOOL'", + "node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99" + }, + "status" : "success" + } } ``` {% /tab %} @@ -100,13 +98,13 @@ Loading: "/etc/rippled.cfg" Connecting to 127.0.0.1:5005 { - "result" : { - "previous" : { - "description" : "Ripple s1 server 'WOOL'", - "node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99" - }, - "status" : "success" - } + "result" : { + "previous" : { + "description" : "Ripple s1 server 'WOOL'", + "node" : "n9Jt8awsPzWLjBCNKVEEDQnw4bQEPjezfcQ4gttD1UzbLT1FoG99" + }, + "status" : "success" + } } ``` {% /tab %} diff --git a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_list.md b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_list.md index 89a70ae45c5..b425d86a945 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_list.md +++ b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peer_reservations_list.md @@ -1,13 +1,11 @@ --- -html: peer_reservations_list.html -parent: peer-management-methods.html seo: description: List reserved slots for specific peer servers. labels: - - Core Server + - Core Server --- # peer_reservations_list -[[Source]](https://github.com/XRPLF/rippled/blob/4a1148eb2849513dd1e7ae080288fd47ab57a376/src/ripple/rpc/handlers/Reservations.cpp#L116 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Reservations.cpp "Source") The {% code-page-name /%} method lists [peer reservations][]. @@ -32,7 +30,7 @@ An example of the request format: {% tab label="JSON-RPC" %} ```json { - "method": "{% $frontmatter.seo.title %}" + "method": "{% $frontmatter.seo.title %}" } ``` {% /tab %} diff --git a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peers.md b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peers.md index 9adff2a793a..a730eb57c6e 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peers.md +++ b/docs/references/http-websocket-apis/admin-api-methods/peer-management-methods/peers.md @@ -1,13 +1,11 @@ --- -html: peers.html -parent: peer-management-methods.html seo: description: Get information about the peer servers connected. labels: - - Core Server + - Core Server --- # peers -[[Source]](https://github.com/XRPLF/rippled/blob/52f298f150fc1530d201d3140c80d3eaf781cb5f/src/ripple/rpc/handlers/Peers.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Peers.cpp "Source") The `peers` command returns a list of all other `rippled` servers currently connected to this one over the [Peer Protocol](../../../../concepts/networks-and-servers/peer-protocol.md), including information on their connection and sync status. @@ -183,90 +181,90 @@ An example of a successful response: {% tab label="JSON-RPC" %} ```json { - "result" : { - "cluster" : {}, - "peers" : [ - { - "address" : "50.22.123.222:51235", - "complete_ledgers" : "32570 - 51815097", - "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", - "load" : 7, - "metrics" : { - "avg_bps_recv" : "1152", - "avg_bps_sent" : "332", - "total_bytes_recv" : "96601", - "total_bytes_sent" : "45322" - }, - "public_key" : "n9LbkoB9ReSbaA9SGL317fm6CvjLcFG8hGoierLYfwiCDsEXHcP3", - "uptime" : 1, - "version" : "rippled-1.3.1" - }, - { - "address" : "212.83.147.67:51235", - "complete_ledgers" : "51815014 - 51815040", - "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", - "load" : 1, - "metrics" : { - "avg_bps_recv" : "0", - "avg_bps_sent" : "1490", - "total_bytes_recv" : "18348", - "total_bytes_sent" : "46013" - }, - "public_key" : "n94s5V53w1g4HdEdHdUU1FVrqHTVDbcb7bt44ib9JcM3c281LoDr", - "sanity" : "unknown", - "uptime" : 2, - "version" : "rippled-1.3.1" - }, - { - "address" : "158.69.24.50:51235", - "complete_ledgers" : "51478098 - 51815098", - "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", - "load" : 55, - "metrics" : { - "avg_bps_recv" : "88080", - "avg_bps_sent" : "2703", - "total_bytes_recv" : "2786780", - "total_bytes_sent" : "89368" - }, - "public_key" : "n9KfEhmmdxmjJdpbpRHGJ9ezoNzdyUepA11cT71jmq1fMDsZAcSh", - "uptime" : 3, - "version" : "rippled-1.3.1" - }, - { - "address" : "[::ffff:174.64.99.193]:51235", - "complete_ledgers" : "51813091 - 51815091", - "latency" : 16000, - "ledger" : "CF72319DC762355C92BDD29E4CE066CEB03FF2A077A511D586B9FD7B74F55D94", - "load" : 325, - "metrics" : { - "avg_bps_recv" : "19012", - "avg_bps_sent" : "52053", - "total_bytes_recv" : "586809", - "total_bytes_sent" : "1678192" - }, - "public_key" : "n9MH4Xu8FYPPoUFs679NQp7F6epFznM7x6bF4sAJWQvKkPBUHgd3", - "uptime" : 26, - "version" : "rippled-1.4.0-b8" - }, - { - "address" : "[::ffff:94.237.45.66]:51235", - "complete_ledgers" : "51814966 - 51815093", - "latency" : 8773, - "ledger" : "61CF015A709122917B001367EE81E5E0D56E485A0BCAB53785A1CB830E0F9589", - "load" : 3522, - "metrics" : { - "avg_bps_recv" : "368875", - "avg_bps_sent" : "59308", - "total_bytes_recv" : "11558753", - "total_bytes_sent" : "2257872" - }, - "public_key" : "n9Lg83FYh8YDivG9TcgXhq5Y3PwunmRqVfvibd19Ko9uu3DtqLBM", - "uptime" : 37, - "version" : "rippled-1.3.1" - } - ], - "status" : "success" - } + "result" : { + "cluster" : {}, + "peers" : [ + { + "address" : "50.22.123.222:51235", + "complete_ledgers" : "32570 - 51815097", + "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", + "load" : 7, + "metrics" : { + "avg_bps_recv" : "1152", + "avg_bps_sent" : "332", + "total_bytes_recv" : "96601", + "total_bytes_sent" : "45322" + }, + "public_key" : "n9LbkoB9ReSbaA9SGL317fm6CvjLcFG8hGoierLYfwiCDsEXHcP3", + "uptime" : 1, + "version" : "rippled-1.3.1" + }, + { + "address" : "212.83.147.67:51235", + "complete_ledgers" : "51815014 - 51815040", + "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", + "load" : 1, + "metrics" : { + "avg_bps_recv" : "0", + "avg_bps_sent" : "1490", + "total_bytes_recv" : "18348", + "total_bytes_sent" : "46013" + }, + "public_key" : "n94s5V53w1g4HdEdHdUU1FVrqHTVDbcb7bt44ib9JcM3c281LoDr", + "sanity" : "unknown", + "uptime" : 2, + "version" : "rippled-1.3.1" + }, + { + "address" : "158.69.24.50:51235", + "complete_ledgers" : "51478098 - 51815098", + "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", + "load" : 55, + "metrics" : { + "avg_bps_recv" : "88080", + "avg_bps_sent" : "2703", + "total_bytes_recv" : "2786780", + "total_bytes_sent" : "89368" + }, + "public_key" : "n9KfEhmmdxmjJdpbpRHGJ9ezoNzdyUepA11cT71jmq1fMDsZAcSh", + "uptime" : 3, + "version" : "rippled-1.3.1" + }, + { + "address" : "[::ffff:174.64.99.193]:51235", + "complete_ledgers" : "51813091 - 51815091", + "latency" : 16000, + "ledger" : "CF72319DC762355C92BDD29E4CE066CEB03FF2A077A511D586B9FD7B74F55D94", + "load" : 325, + "metrics" : { + "avg_bps_recv" : "19012", + "avg_bps_sent" : "52053", + "total_bytes_recv" : "586809", + "total_bytes_sent" : "1678192" + }, + "public_key" : "n9MH4Xu8FYPPoUFs679NQp7F6epFznM7x6bF4sAJWQvKkPBUHgd3", + "uptime" : 26, + "version" : "rippled-1.4.0-b8" + }, + { + "address" : "[::ffff:94.237.45.66]:51235", + "complete_ledgers" : "51814966 - 51815093", + "latency" : 8773, + "ledger" : "61CF015A709122917B001367EE81E5E0D56E485A0BCAB53785A1CB830E0F9589", + "load" : 3522, + "metrics" : { + "avg_bps_recv" : "368875", + "avg_bps_sent" : "59308", + "total_bytes_recv" : "11558753", + "total_bytes_sent" : "2257872" + }, + "public_key" : "n9Lg83FYh8YDivG9TcgXhq5Y3PwunmRqVfvibd19Ko9uu3DtqLBM", + "uptime" : 37, + "version" : "rippled-1.3.1" + } + ], + "status" : "success" + } } ``` @@ -278,90 +276,90 @@ Loading: "/etc/rippled.cfg" Connecting to 127.0.0.1:5005 { - "result" : { - "cluster" : {}, - "peers" : [ - { - "address" : "50.22.123.222:51235", - "complete_ledgers" : "32570 - 51815097", - "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", - "load" : 7, - "metrics" : { - "avg_bps_recv" : "1152", - "avg_bps_sent" : "332", - "total_bytes_recv" : "96601", - "total_bytes_sent" : "45322" - }, - "public_key" : "n9LbkoB9ReSbaA9SGL317fm6CvjLcFG8hGoierLYfwiCDsEXHcP3", - "uptime" : 1, - "version" : "rippled-1.3.1" - }, - { - "address" : "212.83.147.67:51235", - "complete_ledgers" : "51815014 - 51815040", - "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", - "load" : 1, - "metrics" : { - "avg_bps_recv" : "0", - "avg_bps_sent" : "1490", - "total_bytes_recv" : "18348", - "total_bytes_sent" : "46013" - }, - "public_key" : "n94s5V53w1g4HdEdHdUU1FVrqHTVDbcb7bt44ib9JcM3c281LoDr", - "sanity" : "unknown", - "uptime" : 2, - "version" : "rippled-1.3.1" - }, - { - "address" : "158.69.24.50:51235", - "complete_ledgers" : "51478098 - 51815098", - "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", - "load" : 55, - "metrics" : { - "avg_bps_recv" : "88080", - "avg_bps_sent" : "2703", - "total_bytes_recv" : "2786780", - "total_bytes_sent" : "89368" - }, - "public_key" : "n9KfEhmmdxmjJdpbpRHGJ9ezoNzdyUepA11cT71jmq1fMDsZAcSh", - "uptime" : 3, - "version" : "rippled-1.3.1" - }, - { - "address" : "[::ffff:174.64.99.193]:51235", - "complete_ledgers" : "51813091 - 51815091", - "latency" : 16000, - "ledger" : "CF72319DC762355C92BDD29E4CE066CEB03FF2A077A511D586B9FD7B74F55D94", - "load" : 325, - "metrics" : { - "avg_bps_recv" : "19012", - "avg_bps_sent" : "52053", - "total_bytes_recv" : "586809", - "total_bytes_sent" : "1678192" - }, - "public_key" : "n9MH4Xu8FYPPoUFs679NQp7F6epFznM7x6bF4sAJWQvKkPBUHgd3", - "uptime" : 26, - "version" : "rippled-1.4.0-b8" - }, - { - "address" : "[::ffff:94.237.45.66]:51235", - "complete_ledgers" : "51814966 - 51815093", - "latency" : 8773, - "ledger" : "61CF015A709122917B001367EE81E5E0D56E485A0BCAB53785A1CB830E0F9589", - "load" : 3522, - "metrics" : { - "avg_bps_recv" : "368875", - "avg_bps_sent" : "59308", - "total_bytes_recv" : "11558753", - "total_bytes_sent" : "2257872" - }, - "public_key" : "n9Lg83FYh8YDivG9TcgXhq5Y3PwunmRqVfvibd19Ko9uu3DtqLBM", - "uptime" : 37, - "version" : "rippled-1.3.1" - } - ], - "status" : "success" - } + "result" : { + "cluster" : {}, + "peers" : [ + { + "address" : "50.22.123.222:51235", + "complete_ledgers" : "32570 - 51815097", + "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", + "load" : 7, + "metrics" : { + "avg_bps_recv" : "1152", + "avg_bps_sent" : "332", + "total_bytes_recv" : "96601", + "total_bytes_sent" : "45322" + }, + "public_key" : "n9LbkoB9ReSbaA9SGL317fm6CvjLcFG8hGoierLYfwiCDsEXHcP3", + "uptime" : 1, + "version" : "rippled-1.3.1" + }, + { + "address" : "212.83.147.67:51235", + "complete_ledgers" : "51815014 - 51815040", + "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", + "load" : 1, + "metrics" : { + "avg_bps_recv" : "0", + "avg_bps_sent" : "1490", + "total_bytes_recv" : "18348", + "total_bytes_sent" : "46013" + }, + "public_key" : "n94s5V53w1g4HdEdHdUU1FVrqHTVDbcb7bt44ib9JcM3c281LoDr", + "sanity" : "unknown", + "uptime" : 2, + "version" : "rippled-1.3.1" + }, + { + "address" : "158.69.24.50:51235", + "complete_ledgers" : "51478098 - 51815098", + "ledger" : "223DB74FE021AB1A4AA9E1CC588E0DBCC3FC7C080B93C01C30C246D89F951EA2", + "load" : 55, + "metrics" : { + "avg_bps_recv" : "88080", + "avg_bps_sent" : "2703", + "total_bytes_recv" : "2786780", + "total_bytes_sent" : "89368" + }, + "public_key" : "n9KfEhmmdxmjJdpbpRHGJ9ezoNzdyUepA11cT71jmq1fMDsZAcSh", + "uptime" : 3, + "version" : "rippled-1.3.1" + }, + { + "address" : "[::ffff:174.64.99.193]:51235", + "complete_ledgers" : "51813091 - 51815091", + "latency" : 16000, + "ledger" : "CF72319DC762355C92BDD29E4CE066CEB03FF2A077A511D586B9FD7B74F55D94", + "load" : 325, + "metrics" : { + "avg_bps_recv" : "19012", + "avg_bps_sent" : "52053", + "total_bytes_recv" : "586809", + "total_bytes_sent" : "1678192" + }, + "public_key" : "n9MH4Xu8FYPPoUFs679NQp7F6epFznM7x6bF4sAJWQvKkPBUHgd3", + "uptime" : 26, + "version" : "rippled-1.4.0-b8" + }, + { + "address" : "[::ffff:94.237.45.66]:51235", + "complete_ledgers" : "51814966 - 51815093", + "latency" : 8773, + "ledger" : "61CF015A709122917B001367EE81E5E0D56E485A0BCAB53785A1CB830E0F9589", + "load" : 3522, + "metrics" : { + "avg_bps_recv" : "368875", + "avg_bps_sent" : "59308", + "total_bytes_recv" : "11558753", + "total_bytes_sent" : "2257872" + }, + "public_key" : "n9Lg83FYh8YDivG9TcgXhq5Y3PwunmRqVfvibd19Ko9uu3DtqLBM", + "uptime" : 37, + "version" : "rippled-1.3.1" + } + ], + "status" : "success" + } } ``` {% /tab %} diff --git a/docs/references/http-websocket-apis/admin-api-methods/server-control-methods/ledger_accept.md b/docs/references/http-websocket-apis/admin-api-methods/server-control-methods/ledger_accept.md index 9a55de12487..043d134cbc3 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/server-control-methods/ledger_accept.md +++ b/docs/references/http-websocket-apis/admin-api-methods/server-control-methods/ledger_accept.md @@ -1,13 +1,11 @@ --- -html: ledger_accept.html -parent: server-control-methods.html seo: description: Close and advance the ledger in stand-alone mode. labels: - - Core Server + - Core Server --- # ledger_accept -[[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/LedgerAccept.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerAccept.cpp "Source") The `ledger_accept` method forces the server to close the current-working ledger and move to the next ledger number. This method is intended for testing purposes only, and is only available when the `rippled` server is running stand-alone mode. @@ -22,8 +20,8 @@ An example of the request format: {% tab label="WebSocket" %} ```json { - "id": "Accept my ledger!", - "command": "ledger_accept" + "id": "Accept my ledger!", + "command": "ledger_accept" } ``` {% /tab %} diff --git a/docs/references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md b/docs/references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md index 403f7df1370..70e0218bf71 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md +++ b/docs/references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md @@ -1,13 +1,11 @@ --- -html: stop.html -parent: server-control-methods.html seo: description: Shut down the rippled server. labels: - - Core Server + - Core Server --- # stop -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Stop.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Stop.cpp "Source") Gracefully shuts down the server. diff --git a/docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign.md b/docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign.md index b34231f3ae8..767e47f20b0 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign.md +++ b/docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign.md @@ -1,13 +1,11 @@ --- -html: sign.html # watch for clashes w/ this filename -parent: signing-methods.html seo: description: Cryptographically sign a transaction. labels: - - Transaction Sending + - Transaction Sending --- # sign -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/SignHandler.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/SignHandler.cpp "Source") The `sign` method takes a [transaction in JSON format](../../../protocol/transactions/index.md) and a [seed value](../../../../concepts/accounts/cryptographic-keys.md), and returns a signed binary representation of the transaction. To contribute one signature to a [multi-signed transaction](../../../../concepts/accounts/multi-signing.md), use the [sign_for method][] instead. diff --git a/docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign_for.md b/docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign_for.md index cf56a8454dc..0eaaa3952e0 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign_for.md +++ b/docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign_for.md @@ -1,21 +1,16 @@ --- -html: sign_for.html -parent: signing-methods.html seo: description: Contribute to a multi-signature. labels: - - Transaction Sending + - Transaction Sending --- # sign_for -[[Source]](https://github.com/XRPLF/rippled/blob/release/src/ripple/rpc/handlers/SignFor.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/SignFor.cpp "Source") The `sign_for` command provides one signature for a [multi-signed transaction](../../../../concepts/accounts/multi-signing.md). {% partial file="/docs/_snippets/public-signing-note.md" /%} - -This command requires the [MultiSign amendment][] to be enabled. - ## Request Format An example of the request format: @@ -157,33 +152,33 @@ An example of a successful response: 200 OK { - "result" : { - "status" : "success", - "tx_blob" : "1200142200040000240000000263D5038D7EA4C680000000000000000000000000005553440000000000B5F762798A53D543A014CAF8B297CFF8F2F937E868400000000000753073008114A3780F5CB5A44D366520FC44055E8ED44D9A2270F3E010732102B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF744730450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E58114204288D2E47F8EF6C99BCC457966320D12409711E1F1", - "tx_json" : { - "Account" : "rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC", - "Fee" : "30000", - "Flags" : 262144, - "LimitAmount" : { - "currency" : "USD", - "issuer" : "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh", - "value" : "100" - }, - "Sequence" : 2, - "Signers" : [ - { - "Signer" : { - "Account" : "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW", - "SigningPubKey" : "02B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF", - "TxnSignature" : "30450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E5" - } - } - ], - "SigningPubKey" : "", - "TransactionType" : "TrustSet", - "hash" : "A94A6417D1A7AAB059822B894E13D322ED3712F7212CE9257801F96DE6C3F6AE" - } - } + "result" : { + "status" : "success", + "tx_blob" : "1200142200040000240000000263D5038D7EA4C680000000000000000000000000005553440000000000B5F762798A53D543A014CAF8B297CFF8F2F937E868400000000000753073008114A3780F5CB5A44D366520FC44055E8ED44D9A2270F3E010732102B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF744730450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E58114204288D2E47F8EF6C99BCC457966320D12409711E1F1", + "tx_json" : { + "Account" : "rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC", + "Fee" : "30000", + "Flags" : 262144, + "LimitAmount" : { + "currency" : "USD", + "issuer" : "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh", + "value" : "100" + }, + "Sequence" : 2, + "Signers" : [ + { + "Signer" : { + "Account" : "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW", + "SigningPubKey" : "02B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF", + "TxnSignature" : "30450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E5" + } + } + ], + "SigningPubKey" : "", + "TransactionType" : "TrustSet", + "hash" : "A94A6417D1A7AAB059822B894E13D322ED3712F7212CE9257801F96DE6C3F6AE" + } + } } ``` {% /tab %} @@ -194,33 +189,33 @@ Loading: "/etc/rippled.cfg" Connecting to 127.0.0.1:5005 { - "result" : { - "status" : "success", - "tx_blob" : "1200142200040000240000000263D5038D7EA4C680000000000000000000000000005553440000000000B5F762798A53D543A014CAF8B297CFF8F2F937E868400000000000753073008114A3780F5CB5A44D366520FC44055E8ED44D9A2270F3E010732102B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF744730450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E58114204288D2E47F8EF6C99BCC457966320D12409711E1F1", - "tx_json" : { - "Account" : "rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC", - "Fee" : "30000", - "Flags" : 262144, - "LimitAmount" : { - "currency" : "USD", - "issuer" : "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh", - "value" : "100" - }, - "Sequence" : 2, - "Signers" : [ - { - "Signer" : { - "Account" : "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW", - "SigningPubKey" : "02B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF", - "TxnSignature" : "30450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E5" - } - } - ], - "SigningPubKey" : "", - "TransactionType" : "TrustSet", - "hash" : "A94A6417D1A7AAB059822B894E13D322ED3712F7212CE9257801F96DE6C3F6AE" - } - } + "result" : { + "status" : "success", + "tx_blob" : "1200142200040000240000000263D5038D7EA4C680000000000000000000000000005553440000000000B5F762798A53D543A014CAF8B297CFF8F2F937E868400000000000753073008114A3780F5CB5A44D366520FC44055E8ED44D9A2270F3E010732102B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF744730450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E58114204288D2E47F8EF6C99BCC457966320D12409711E1F1", + "tx_json" : { + "Account" : "rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC", + "Fee" : "30000", + "Flags" : 262144, + "LimitAmount" : { + "currency" : "USD", + "issuer" : "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh", + "value" : "100" + }, + "Sequence" : 2, + "Signers" : [ + { + "Signer" : { + "Account" : "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW", + "SigningPubKey" : "02B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF", + "TxnSignature" : "30450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E5" + } + } + ], + "SigningPubKey" : "", + "TransactionType" : "TrustSet", + "hash" : "A94A6417D1A7AAB059822B894E13D322ED3712F7212CE9257801F96DE6C3F6AE" + } + } } ``` {% /tab %} diff --git a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/consensus_info.md b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/consensus_info.md index e3abd66e999..d4041d25d37 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/consensus_info.md +++ b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/consensus_info.md @@ -1,14 +1,12 @@ --- -html: consensus_info.html -parent: status-and-debugging-methods.html seo: - description: Get information about the state of consensus as it happens. + description: Get information about the state of consensus as it happens. labels: - - Blockchain - - Core Server + - Blockchain + - Core Server --- # consensus_info -[[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ConsensusInfo.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/ConsensusInfo.cpp "Source") The `consensus_info` command provides information about the [consensus process](../../../../concepts/consensus-protocol/index.md) for debugging purposes. @@ -59,74 +57,74 @@ An example of a successful response: {% tab label="JSON-RPC" %} ```json { - "result" : { - "info" : { - "acquired" : { - "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" : "acquired" - }, - "close_granularity" : 10, - "close_percent" : 50, - "close_resolution" : 10, - "close_times" : { - "486082972" : 1, - "486082973" : 4 - }, - "current_ms" : 1003, - "have_time_consensus" : false, - "ledger_seq" : 13701086, - "our_position" : { - "close_time" : 486082973, - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "peer_positions" : { - "0A2EAF919033A036D363D4E5610A66209DDBE8EE" : { - "close_time" : 486082972, - "peer_id" : "n9KiYM9CgngLvtRCQHZwgC2gjpdaZcCcbt3VboxiNFcKuwFVujzS", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "1567A8C953A86F8428C7B01641D79BBF2FD508F3" : { - "close_time" : 486082973, - "peer_id" : "n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "202397A81F20B44CF44EA99AF761295E5A8397D2" : { - "close_time" : 486082973, - "peer_id" : "n9MD5h24qrQqiyBC8aeqqCWvpiBiYQ3jxSr91uiDvmrkyHRdYLUj", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "5C29005CF4FB479FC49EEFB4A5B075C86DD963CC" : { - "close_time" : 486082973, - "peer_id" : "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "EFC49EB648E557CC50A72D715249B80E071F7705" : { - "close_time" : 486082973, - "peer_id" : "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - } - }, - "previous_mseconds" : 2005, - "previous_proposers" : 5, - "proposers" : 5, - "proposing" : false, - "state" : "consensus", - "synched" : true, - "validating" : false - }, - "status" : "success" - } + "result" : { + "info" : { + "acquired" : { + "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" : "acquired" + }, + "close_granularity" : 10, + "close_percent" : 50, + "close_resolution" : 10, + "close_times" : { + "486082972" : 1, + "486082973" : 4 + }, + "current_ms" : 1003, + "have_time_consensus" : false, + "ledger_seq" : 13701086, + "our_position" : { + "close_time" : 486082973, + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "peer_positions" : { + "0A2EAF919033A036D363D4E5610A66209DDBE8EE" : { + "close_time" : 486082972, + "peer_id" : "n9KiYM9CgngLvtRCQHZwgC2gjpdaZcCcbt3VboxiNFcKuwFVujzS", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "1567A8C953A86F8428C7B01641D79BBF2FD508F3" : { + "close_time" : 486082973, + "peer_id" : "n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "202397A81F20B44CF44EA99AF761295E5A8397D2" : { + "close_time" : 486082973, + "peer_id" : "n9MD5h24qrQqiyBC8aeqqCWvpiBiYQ3jxSr91uiDvmrkyHRdYLUj", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "5C29005CF4FB479FC49EEFB4A5B075C86DD963CC" : { + "close_time" : 486082973, + "peer_id" : "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "EFC49EB648E557CC50A72D715249B80E071F7705" : { + "close_time" : 486082973, + "peer_id" : "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + } + }, + "previous_mseconds" : 2005, + "previous_proposers" : 5, + "proposers" : 5, + "proposing" : false, + "state" : "consensus", + "synched" : true, + "validating" : false + }, + "status" : "success" + } } ``` {% /tab %} @@ -137,74 +135,74 @@ Loading: "/etc/rippled.cfg" Connecting to 127.0.0.1:5005 { - "result" : { - "info" : { - "acquired" : { - "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" : "acquired" - }, - "close_granularity" : 10, - "close_percent" : 50, - "close_resolution" : 10, - "close_times" : { - "486082972" : 1, - "486082973" : 4 - }, - "current_ms" : 1003, - "have_time_consensus" : false, - "ledger_seq" : 13701086, - "our_position" : { - "close_time" : 486082973, - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "peer_positions" : { - "0A2EAF919033A036D363D4E5610A66209DDBE8EE" : { - "close_time" : 486082972, - "peer_id" : "n9KiYM9CgngLvtRCQHZwgC2gjpdaZcCcbt3VboxiNFcKuwFVujzS", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "1567A8C953A86F8428C7B01641D79BBF2FD508F3" : { - "close_time" : 486082973, - "peer_id" : "n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "202397A81F20B44CF44EA99AF761295E5A8397D2" : { - "close_time" : 486082973, - "peer_id" : "n9MD5h24qrQqiyBC8aeqqCWvpiBiYQ3jxSr91uiDvmrkyHRdYLUj", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "5C29005CF4FB479FC49EEFB4A5B075C86DD963CC" : { - "close_time" : 486082973, - "peer_id" : "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - }, - "EFC49EB648E557CC50A72D715249B80E071F7705" : { - "close_time" : 486082973, - "peer_id" : "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7", - "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", - "propose_seq" : 0, - "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" - } - }, - "previous_mseconds" : 2005, - "previous_proposers" : 5, - "proposers" : 5, - "proposing" : false, - "state" : "consensus", - "synched" : true, - "validating" : false - }, - "status" : "success" - } + "result" : { + "info" : { + "acquired" : { + "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" : "acquired" + }, + "close_granularity" : 10, + "close_percent" : 50, + "close_resolution" : 10, + "close_times" : { + "486082972" : 1, + "486082973" : 4 + }, + "current_ms" : 1003, + "have_time_consensus" : false, + "ledger_seq" : 13701086, + "our_position" : { + "close_time" : 486082973, + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "peer_positions" : { + "0A2EAF919033A036D363D4E5610A66209DDBE8EE" : { + "close_time" : 486082972, + "peer_id" : "n9KiYM9CgngLvtRCQHZwgC2gjpdaZcCcbt3VboxiNFcKuwFVujzS", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "1567A8C953A86F8428C7B01641D79BBF2FD508F3" : { + "close_time" : 486082973, + "peer_id" : "n9LdgEtkmGB9E2h3K4Vp7iGUaKuq23Zr32ehxiU8FWY7xoxbWTSA", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "202397A81F20B44CF44EA99AF761295E5A8397D2" : { + "close_time" : 486082973, + "peer_id" : "n9MD5h24qrQqiyBC8aeqqCWvpiBiYQ3jxSr91uiDvmrkyHRdYLUj", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "5C29005CF4FB479FC49EEFB4A5B075C86DD963CC" : { + "close_time" : 486082973, + "peer_id" : "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + }, + "EFC49EB648E557CC50A72D715249B80E071F7705" : { + "close_time" : 486082973, + "peer_id" : "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7", + "previous_ledger" : "0BB01379B51234BAAF501A71C7AB147F595460B689BB9E8252A0B87B5A483623", + "propose_seq" : 0, + "transaction_hash" : "4BC2CE596CBD1321775320E2067F9C06D3862826212C16EF42ABB6A2B0414306" + } + }, + "previous_mseconds" : 2005, + "previous_proposers" : 5, + "proposers" : 5, + "proposing" : false, + "state" : "consensus", + "synched" : true, + "validating" : false + }, + "status" : "success" + } } ``` {% /tab %} diff --git a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md index 4a94925af86..301cca78bc4 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md +++ b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/feature.md @@ -1,18 +1,16 @@ --- -html: feature.html -parent: status-and-debugging-methods.html seo: description: Get information about protocol amendments. labels: - - Blockchain - - Core Server + - Blockchain + - Core Server --- # feature -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Feature1.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Feature1.cpp "Source") The `feature` command returns information about [amendments](../../../../concepts/networks-and-servers/amendments.md) this server knows about, including whether they are enabled and whether the server is voting in favor of those amendments in the [amendment process](../../../../concepts/networks-and-servers/amendments.md#amendment-process). -You can use the `feature` command to configure the server to vote against or in favor of an amendment. This change persists even if you restart the server. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.7.0" %}Updated in: rippled 1.7.0{% /badge %} +You can use the `feature` command to configure the server to vote against or in favor of an amendment. This change persists even if you restart the server. _The `feature` method documented on this page is an [admin method](../index.md). For the non-admin version, see the [`feature` public API method](../../public-api-methods/server-info-methods/feature.md)._ diff --git a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/fetch_info.md b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/fetch_info.md index 0260268168b..21339053826 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/fetch_info.md +++ b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/fetch_info.md @@ -1,13 +1,11 @@ --- -html: fetch_info.html -parent: status-and-debugging-methods.html seo: description: Get information about the server's sync with the network. labels: - - Core Server + - Core Server --- # fetch_info -[[Source]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/FetchInfo.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/FetchInfo.cpp "Source") The `fetch_info` command returns information about objects that this server is currently fetching from the network, and how many peers have that information. It can also be used to reset current fetches. @@ -65,37 +63,37 @@ An example of a successful response: {% tab label="JSON-RPC" %} ```json { - "result" : { - "info" : { - "348928" : { - "hash" : "C26D432B06F84861BCACD7942EDC3FE0B2E1DEB966A9E516A0FD275A375C2010", - "have_header" : true, - "have_state" : false, - "have_transactions" : true, - "needed_state_hashes" : [ - "BF8DC6B1E10D1D3565BF0649075D22EBFD34F751AFCC0E53E81D74786BC88922", - "34E37A71CB51A12C73A435250E6A6349F7884C7EEBA6B88FA31F0244E967E88F", - "BFB7D3008A7D61FD6A0538D1C2E70CFB94CE8DC66606319C372F278A48629765", - "41C0C61D701FB1EA586F0EF1FC7A91FEC476D979589DA60507F05C13F7C21975", - "6DDE8840A2C3C7FF05E5FFEE4D06408694C16A8357338FE0C4581DC3D8A00BBA", - "6C69D833B582C849917806FA009518832BB50E900E43716FD7CC1966428DD0CF", - "1EDC020CFC4AF19B625C52E20B66D6AE672821CCC461E8A9C457A3B2955657F7", - "FC0616A66A2B0589CA513F3341D4EA51E782C4601E5072308478E3CC19264640", - "19FC607B5DE1B64681A676EC1ED5507B9555B0E098CD9D898320297DE1A64033", - "5E128D3FC990074E35687387A14AA12D9FD287E5AB57CB9B2FD83DE635DF5CA9", - "DE72820F3981770F2AA8770BC233B80661F1A452819D8529008875FF8DED87A9", - "3ACB84BEE2C45556351FF60FD787D235C9CF5623FB8A35B01446B773598E7CC0", - "0DD3A8DF69874148057F1F2BF305442FF2E89A76A08B4CC8C051E2ED69B874F3", - "4AE9A9C4F12A5BD0355037DA40A0B145420A2168A9FEDE43E643BD13062F8ECE", - "08CBF8CFFEC207F5AC4E4F24BC447011FD8C79D25B344281FBFB4732D7058ED4", - "779B2577C5C4BAED6657421448EA506BBF50F86BE363E0924127C4EA17A58BBE" - ], - "peers" : 2, - "timeouts" : 0 - } - }, - "status" : "success" - } + "result" : { + "info" : { + "348928" : { + "hash" : "C26D432B06F84861BCACD7942EDC3FE0B2E1DEB966A9E516A0FD275A375C2010", + "have_header" : true, + "have_state" : false, + "have_transactions" : true, + "needed_state_hashes" : [ + "BF8DC6B1E10D1D3565BF0649075D22EBFD34F751AFCC0E53E81D74786BC88922", + "34E37A71CB51A12C73A435250E6A6349F7884C7EEBA6B88FA31F0244E967E88F", + "BFB7D3008A7D61FD6A0538D1C2E70CFB94CE8DC66606319C372F278A48629765", + "41C0C61D701FB1EA586F0EF1FC7A91FEC476D979589DA60507F05C13F7C21975", + "6DDE8840A2C3C7FF05E5FFEE4D06408694C16A8357338FE0C4581DC3D8A00BBA", + "6C69D833B582C849917806FA009518832BB50E900E43716FD7CC1966428DD0CF", + "1EDC020CFC4AF19B625C52E20B66D6AE672821CCC461E8A9C457A3B2955657F7", + "FC0616A66A2B0589CA513F3341D4EA51E782C4601E5072308478E3CC19264640", + "19FC607B5DE1B64681A676EC1ED5507B9555B0E098CD9D898320297DE1A64033", + "5E128D3FC990074E35687387A14AA12D9FD287E5AB57CB9B2FD83DE635DF5CA9", + "DE72820F3981770F2AA8770BC233B80661F1A452819D8529008875FF8DED87A9", + "3ACB84BEE2C45556351FF60FD787D235C9CF5623FB8A35B01446B773598E7CC0", + "0DD3A8DF69874148057F1F2BF305442FF2E89A76A08B4CC8C051E2ED69B874F3", + "4AE9A9C4F12A5BD0355037DA40A0B145420A2168A9FEDE43E643BD13062F8ECE", + "08CBF8CFFEC207F5AC4E4F24BC447011FD8C79D25B344281FBFB4732D7058ED4", + "779B2577C5C4BAED6657421448EA506BBF50F86BE363E0924127C4EA17A58BBE" + ], + "peers" : 2, + "timeouts" : 0 + } + }, + "status" : "success" + } } ``` {% /tab %} @@ -106,37 +104,37 @@ Loading: "/etc/rippled.cfg" Connecting to 127.0.0.1:5005 { - "result" : { - "info" : { - "348928" : { - "hash" : "C26D432B06F84861BCACD7942EDC3FE0B2E1DEB966A9E516A0FD275A375C2010", - "have_header" : true, - "have_state" : false, - "have_transactions" : true, - "needed_state_hashes" : [ - "BF8DC6B1E10D1D3565BF0649075D22EBFD34F751AFCC0E53E81D74786BC88922", - "34E37A71CB51A12C73A435250E6A6349F7884C7EEBA6B88FA31F0244E967E88F", - "BFB7D3008A7D61FD6A0538D1C2E70CFB94CE8DC66606319C372F278A48629765", - "41C0C61D701FB1EA586F0EF1FC7A91FEC476D979589DA60507F05C13F7C21975", - "6DDE8840A2C3C7FF05E5FFEE4D06408694C16A8357338FE0C4581DC3D8A00BBA", - "6C69D833B582C849917806FA009518832BB50E900E43716FD7CC1966428DD0CF", - "1EDC020CFC4AF19B625C52E20B66D6AE672821CCC461E8A9C457A3B2955657F7", - "FC0616A66A2B0589CA513F3341D4EA51E782C4601E5072308478E3CC19264640", - "19FC607B5DE1B64681A676EC1ED5507B9555B0E098CD9D898320297DE1A64033", - "5E128D3FC990074E35687387A14AA12D9FD287E5AB57CB9B2FD83DE635DF5CA9", - "DE72820F3981770F2AA8770BC233B80661F1A452819D8529008875FF8DED87A9", - "3ACB84BEE2C45556351FF60FD787D235C9CF5623FB8A35B01446B773598E7CC0", - "0DD3A8DF69874148057F1F2BF305442FF2E89A76A08B4CC8C051E2ED69B874F3", - "4AE9A9C4F12A5BD0355037DA40A0B145420A2168A9FEDE43E643BD13062F8ECE", - "08CBF8CFFEC207F5AC4E4F24BC447011FD8C79D25B344281FBFB4732D7058ED4", - "779B2577C5C4BAED6657421448EA506BBF50F86BE363E0924127C4EA17A58BBE" - ], - "peers" : 2, - "timeouts" : 0 - } - }, - "status" : "success" - } + "result" : { + "info" : { + "348928" : { + "hash" : "C26D432B06F84861BCACD7942EDC3FE0B2E1DEB966A9E516A0FD275A375C2010", + "have_header" : true, + "have_state" : false, + "have_transactions" : true, + "needed_state_hashes" : [ + "BF8DC6B1E10D1D3565BF0649075D22EBFD34F751AFCC0E53E81D74786BC88922", + "34E37A71CB51A12C73A435250E6A6349F7884C7EEBA6B88FA31F0244E967E88F", + "BFB7D3008A7D61FD6A0538D1C2E70CFB94CE8DC66606319C372F278A48629765", + "41C0C61D701FB1EA586F0EF1FC7A91FEC476D979589DA60507F05C13F7C21975", + "6DDE8840A2C3C7FF05E5FFEE4D06408694C16A8357338FE0C4581DC3D8A00BBA", + "6C69D833B582C849917806FA009518832BB50E900E43716FD7CC1966428DD0CF", + "1EDC020CFC4AF19B625C52E20B66D6AE672821CCC461E8A9C457A3B2955657F7", + "FC0616A66A2B0589CA513F3341D4EA51E782C4601E5072308478E3CC19264640", + "19FC607B5DE1B64681A676EC1ED5507B9555B0E098CD9D898320297DE1A64033", + "5E128D3FC990074E35687387A14AA12D9FD287E5AB57CB9B2FD83DE635DF5CA9", + "DE72820F3981770F2AA8770BC233B80661F1A452819D8529008875FF8DED87A9", + "3ACB84BEE2C45556351FF60FD787D235C9CF5623FB8A35B01446B773598E7CC0", + "0DD3A8DF69874148057F1F2BF305442FF2E89A76A08B4CC8C051E2ED69B874F3", + "4AE9A9C4F12A5BD0355037DA40A0B145420A2168A9FEDE43E643BD13062F8ECE", + "08CBF8CFFEC207F5AC4E4F24BC447011FD8C79D25B344281FBFB4732D7058ED4", + "779B2577C5C4BAED6657421448EA506BBF50F86BE363E0924127C4EA17A58BBE" + ], + "peers" : 2, + "timeouts" : 0 + } + }, + "status" : "success" + } } ``` {% /tab %} diff --git a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/get_counts.md b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/get_counts.md index 2a49b13f5f9..263f7fd4307 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/get_counts.md +++ b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/get_counts.md @@ -1,13 +1,11 @@ --- -html: get_counts.html -parent: status-and-debugging-methods.html seo: description: Get statistics about the server's internals and memory usage. labels: - - Core Server + - Core Server --- # get_counts -[[Source]](https://github.com/XRPLF/rippled/blob/c7118a183a660648aa88a3546a6b2c5bce858440/src/ripple/rpc/handlers/GetCounts.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/GetCounts.cpp "Source") The `get_counts` command provides various stats about the health of the server, mostly the number of objects of different types that it currently holds in memory. diff --git a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/print.md b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/print.md index 95cfe674aa8..eaee5cda3d0 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/print.md +++ b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/print.md @@ -1,13 +1,11 @@ --- -html: print.html -parent: status-and-debugging-methods.html seo: description: Get information about internal subsystems. labels: - - Core Server + - Core Server --- # print -[[Source]](https://github.com/XRPLF/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/Print.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Print.cpp "Source") The `print` command returns the current status of various internal subsystems, including peers, the ledger cleaner, and the resource manager. @@ -49,183 +47,183 @@ Loading: "/etc/rippled.cfg" Connecting to 127.0.0.1:5005 { - "result" : { - "app" : { - "ledgercleaner" : { - "status" : "idle" - }, - "peers" : { - "peerfinder" : { - "bootcache" : { - "entries" : 109 - }, - "config" : { - "auto_connect" : "true", - "features" : "", - "max_peers" : 21, - "out_peers" : 10, - "port" : 51235, - "want_incoming" : "true" - }, - "counts" : { - "accept" : 0, - "close" : 0, - "cluster" : "0", - "connect" : 0, - "fixed" : "0", - "in" : "0/11", - "out" : "10/10", - "total" : "10" - }, - "fixed" : 0, - "livecache" : { - "entries" : [ - { - "address" : "23.239.3.247:51235", - "expires" : "30000000000 nanoseconds", - "hops" : 2 - }, - { - "address" : "192.170.145.88:51235", - "expires" : "30000000000 nanoseconds", - "hops" : 1 - }, - { - "address" : "198.204.238.130:51235", - "expires" : "26000024558 nanoseconds", - "hops" : 1 - }, - { - "address" : "203.127.12.115:51235", - "expires" : "26000024558 nanoseconds", - "hops" : 2 - }, - { - "address" : "212.83.147.67:51235", - "expires" : "26000024558 nanoseconds", - "hops" : 2 - } - ], - "hist" : "0, 10, 74, 10, 0, 0, 0, 0", - "size" : "94" - }, - "peers" : [ - { - "local_address" : "10.1.10.78:48923", - "remote_address" : "52.24.43.83:51235", - "state" : "active" - }, - { - "local_address" : "10.1.10.78:50004", - "remote_address" : "52.26.205.197:51235", - "state" : "active" - }, - { - "local_address" : "10.1.10.78:37019", - "remote_address" : "168.1.60.132:51235", - "state" : "active" - }, - { - "local_address" : "10.1.10.78:38775", - "remote_address" : "192.170.145.88:51235", - "state" : "active" - }, - { - "local_address" : "10.1.10.78:34793", - "remote_address" : "198.204.238.130:51235", - "state" : "active" - } - ] - } - }, - "resource" : { - "admin" : [ - { - "balance" : 0, - "count" : 1, - "name" : "\"127.0.0.1\"" - } - ], - "inactive" : [], - "inbound" : [], - "outbound" : [ - { - "balance" : 23, - "count" : 1, - "name" : "93.190.138.234:51235" - }, - { - "balance" : 35, - "count" : 1, - "name" : "198.204.238.130:51235" - }, - { - "balance" : 31, - "count" : 1, - "name" : "52.26.205.197:51235" - }, - { - "balance" : 32, - "count" : 1, - "name" : "54.186.73.52:51235" - }, - { - "balance" : 15, - "count" : 1, - "name" : "72.251.233.164:51235" - } - ] - }, - "server" : { - "active" : "2", - "hist" : "16", - "history" : [ - { - "bytes_in" : "214", - "bytes_out" : "11688", - "elapsed" : "0 seconds", - "id" : "16", - "requests" : 1, - "when" : "2015-Jun-16 16:33:50" - }, - { - "bytes_in" : "214", - "bytes_out" : "11431", - "elapsed" : "0 seconds", - "id" : "15", - "requests" : 1, - "when" : "2015-Jun-16 16:11:59" - }, - { - "bytes_in" : "227", - "bytes_out" : "337", - "elapsed" : "0 seconds", - "id" : "3", - "requests" : 1, - "when" : "2015-Jun-16 14:57:23" - }, - { - "bytes_in" : "214", - "bytes_out" : "2917", - "elapsed" : "0 seconds", - "id" : "2", - "requests" : 1, - "when" : "2015-Jun-16 12:39:29" - }, - { - "bytes_in" : "220", - "bytes_out" : "1426", - "elapsed" : "0 seconds", - "id" : "1", - "requests" : 1, - "when" : "2015-Jun-16 12:39:13" - } - ] - }, - "validators" : {} - }, - "status" : "success" - } + "result" : { + "app" : { + "ledgercleaner" : { + "status" : "idle" + }, + "peers" : { + "peerfinder" : { + "bootcache" : { + "entries" : 109 + }, + "config" : { + "auto_connect" : "true", + "features" : "", + "max_peers" : 21, + "out_peers" : 10, + "port" : 51235, + "want_incoming" : "true" + }, + "counts" : { + "accept" : 0, + "close" : 0, + "cluster" : "0", + "connect" : 0, + "fixed" : "0", + "in" : "0/11", + "out" : "10/10", + "total" : "10" + }, + "fixed" : 0, + "livecache" : { + "entries" : [ + { + "address" : "23.239.3.247:51235", + "expires" : "30000000000 nanoseconds", + "hops" : 2 + }, + { + "address" : "192.170.145.88:51235", + "expires" : "30000000000 nanoseconds", + "hops" : 1 + }, + { + "address" : "198.204.238.130:51235", + "expires" : "26000024558 nanoseconds", + "hops" : 1 + }, + { + "address" : "203.127.12.115:51235", + "expires" : "26000024558 nanoseconds", + "hops" : 2 + }, + { + "address" : "212.83.147.67:51235", + "expires" : "26000024558 nanoseconds", + "hops" : 2 + } + ], + "hist" : "0, 10, 74, 10, 0, 0, 0, 0", + "size" : "94" + }, + "peers" : [ + { + "local_address" : "10.1.10.78:48923", + "remote_address" : "52.24.43.83:51235", + "state" : "active" + }, + { + "local_address" : "10.1.10.78:50004", + "remote_address" : "52.26.205.197:51235", + "state" : "active" + }, + { + "local_address" : "10.1.10.78:37019", + "remote_address" : "168.1.60.132:51235", + "state" : "active" + }, + { + "local_address" : "10.1.10.78:38775", + "remote_address" : "192.170.145.88:51235", + "state" : "active" + }, + { + "local_address" : "10.1.10.78:34793", + "remote_address" : "198.204.238.130:51235", + "state" : "active" + } + ] + } + }, + "resource" : { + "admin" : [ + { + "balance" : 0, + "count" : 1, + "name" : "\"127.0.0.1\"" + } + ], + "inactive" : [], + "inbound" : [], + "outbound" : [ + { + "balance" : 23, + "count" : 1, + "name" : "93.190.138.234:51235" + }, + { + "balance" : 35, + "count" : 1, + "name" : "198.204.238.130:51235" + }, + { + "balance" : 31, + "count" : 1, + "name" : "52.26.205.197:51235" + }, + { + "balance" : 32, + "count" : 1, + "name" : "54.186.73.52:51235" + }, + { + "balance" : 15, + "count" : 1, + "name" : "72.251.233.164:51235" + } + ] + }, + "server" : { + "active" : "2", + "hist" : "16", + "history" : [ + { + "bytes_in" : "214", + "bytes_out" : "11688", + "elapsed" : "0 seconds", + "id" : "16", + "requests" : 1, + "when" : "2015-Jun-16 16:33:50" + }, + { + "bytes_in" : "214", + "bytes_out" : "11431", + "elapsed" : "0 seconds", + "id" : "15", + "requests" : 1, + "when" : "2015-Jun-16 16:11:59" + }, + { + "bytes_in" : "227", + "bytes_out" : "337", + "elapsed" : "0 seconds", + "id" : "3", + "requests" : 1, + "when" : "2015-Jun-16 14:57:23" + }, + { + "bytes_in" : "214", + "bytes_out" : "2917", + "elapsed" : "0 seconds", + "id" : "2", + "requests" : 1, + "when" : "2015-Jun-16 12:39:29" + }, + { + "bytes_in" : "220", + "bytes_out" : "1426", + "elapsed" : "0 seconds", + "id" : "1", + "requests" : 1, + "when" : "2015-Jun-16 12:39:13" + } + ] + }, + "validators" : {} + }, + "status" : "success" + } } ``` diff --git a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_info.md b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_info.md index 11c5087e994..c3ac1a34974 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_info.md +++ b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_info.md @@ -1,14 +1,12 @@ --- -html: validator_info.html -parent: status-and-debugging-methods.html seo: description: Get the server's validation settings, if configured as a validator. labels: - - コアサーバ - - ブロックチェーン + - Core Server + - Blockchain --- # validator_info -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ValidatorInfo.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/ValidatorInfo.cpp "Source") The {% code-page-name /%} method returns the current validator settings of the server, if it is configured as a validator. diff --git a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_list_sites.md b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_list_sites.md index 6eb34869c28..838ef29a864 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_list_sites.md +++ b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validator_list_sites.md @@ -1,14 +1,12 @@ --- -html: validator_list_sites.html -parent: status-and-debugging-methods.html seo: description: Get information about sites that publish validator lists. labels: - - Core Server - - Blockchain + - Core Server + - Blockchain --- # validator_list_sites -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ValidatorListSites.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/ValidatorListSites.cpp "Source") The `validator_list_sites` command returns status information of sites serving validator lists. diff --git a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validators.md b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validators.md index 34b97729978..c23bcba26ed 100644 --- a/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validators.md +++ b/docs/references/http-websocket-apis/admin-api-methods/status-and-debugging-methods/validators.md @@ -1,14 +1,12 @@ --- -html: validators.html -parent: status-and-debugging-methods.html seo: description: Get information about the current validators. labels: - - Core Server - - Blockchain + - Core Server + - Blockchain --- # validators -[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Validators.cpp "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/Validators.cpp "Source") The `validators` command returns human readable information about the current list of published and [trusted validators](../../../../concepts/consensus-protocol/index.md#trust-based-validation) used by the server. diff --git a/docs/references/http-websocket-apis/peer-port-methods/health-check.md b/docs/references/http-websocket-apis/peer-port-methods/health-check.md index 9b1a8ae3450..2ac80627e1c 100644 --- a/docs/references/http-websocket-apis/peer-port-methods/health-check.md +++ b/docs/references/http-websocket-apis/peer-port-methods/health-check.md @@ -1,13 +1,11 @@ --- -html: health-check.html -parent: peer-port-methods.html seo: description: Special API method for reporting server health. labels: - - Core Server + - Core Server --- # Health Check -[[Source]](https://github.com/XRPLF/rippled/blob/de0c52738785de8bf837f9124da65c7905e7bb5a/src/ripple/overlay/impl/OverlayImpl.cpp#L1084-L1168 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/xrpld/overlay/detail/OverlayImpl.cpp#L943-L1038 "Source") The Health Check is a special [peer port method](index.md) for reporting on the health of an individual `rippled` server. This method is intended for use in automated monitoring to recognize outages and prompt automated or manual interventions such as restarting the server. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.6.0" %}New in: rippled 1.6.0{% /badge %} diff --git a/docs/references/http-websocket-apis/peer-port-methods/validator-list.md b/docs/references/http-websocket-apis/peer-port-methods/validator-list.md index 69873f3739c..a43ead6fc97 100644 --- a/docs/references/http-websocket-apis/peer-port-methods/validator-list.md +++ b/docs/references/http-websocket-apis/peer-port-methods/validator-list.md @@ -1,13 +1,12 @@ --- -html: validator-list.html -parent: peer-port-methods.html seo: description: Special API method for sharing recommended validator lists. labels: - - Core Server - - Blockchain + - Core Server + - Blockchain --- # Validator List Method +[[Source]](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/xrpld/overlay/detail/OverlayImpl.cpp#L875-L940 "Source") The validator list method is a special API endpoint that fetches a current, trusted validator list a `rippled` server is using. This often represents the exact list of validators a server trusts. @@ -45,7 +44,7 @@ The JSON object has the following fields: | `public_key` | String | The public key used to verify this validator list data, in hexadecimal. This is a 32-byte Ed25519 public key prefixed with the byte `0xED`. | ### Manifest Data -[[Source]](https://github.com/XRPLF/rippled/blob/97712107b71a8e2089d2e3fcef9ebf5362951110/src/ripple/app/misc/impl/Manifest.cpp#L43-L66 "Source") +[[Source]](https://github.com/XRPLF/rippled/blob/8d1b3b39940eca2735a0e9279bdd92b0748fd84c/src/xrpld/app/misc/detail/Manifest.cpp#L54-L82 "Source") A "manifest" contains information uniquely identifying a person or organization involved in the consensus process, either a **validator** or a **list publisher**. A validator's manifest contains the _public_ information from that [validator's token](../../../infrastructure/configuration/server-modes/run-rippled-as-a-validator.md#3-enable-validation-on-your-rippled-server). A list publisher's manifest provides information about the list publisher. Both are typically encoded to binary in the XRP Ledger's standard [binary serialization format](../../protocol/binary-format.md). (There is no standard JSON representation of a manifest.) diff --git a/docs/tutorials/javascript/amm/trade-with-auction-slot.md b/docs/tutorials/javascript/amm/trade-with-auction-slot.md index 13a86f32e01..8f2ef2c7c0d 100644 --- a/docs/tutorials/javascript/amm/trade-with-auction-slot.md +++ b/docs/tutorials/javascript/amm/trade-with-auction-slot.md @@ -240,7 +240,7 @@ Save the taker pays and taker gets fields; use these values to get the total amo } ``` -Use [AMM helper functions](https://github.com/XRPLF/rippled/blob/2d1854f354ff8bb2b5671fd51252c5acd837c433/src/ripple/app/misc/impl/AMMHelpers.cpp) to estimate values for: +Implement [AMM formulas](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/misc/detail/AMMHelpers.cpp) to estimate values for: - Cost to swap token without an auction slot. - Cost to swap token with an auction slot. @@ -534,7 +534,7 @@ Report the results. ## Code Walkthrough (ripplex13b-amm-formulas.js) -You can open `ripplex13b-amm-formulas.js` from the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples/quickstart/js/) to view the source code. This tutorial uses three of the available [AMM helper functions](https://github.com/XRPLF/rippled/blob/2d1854f354ff8bb2b5671fd51252c5acd837c433/src/ripple/app/misc/impl/AMMHelpers.cpp). +You can open `ripplex13b-amm-formulas.js` from the [Quickstart Samples](https://github.com/XRPLF/xrpl-dev-portal/tree/master/_code-samples/quickstart/js/) to view the source code. This code implements several core [AMM formulas](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/misc/detail/AMMHelpers.cpp) defined by the protocol. ### swapOut() diff --git a/resources/contribute-code/create-custom-transactors.md b/resources/contribute-code/create-custom-transactors.md index c0a80ff2154..2ebf90b9292 100644 --- a/resources/contribute-code/create-custom-transactors.md +++ b/resources/contribute-code/create-custom-transactors.md @@ -1,11 +1,9 @@ --- -html: create-custom-transactors.html -parent: contribute-code.html seo: description: Create custom transactors to interact with the XRP Ledger. labels: - - Development - - Blockchain + - Development + - Blockchain --- # Create Custom Transactors @@ -78,8 +76,8 @@ The `preflight` function checks for errors in the transaction itself before acce {% admonition type="info" name="Note" %}The `~` symbol returns an optional type.{% /admonition %} - You can view ledger and transaction schemas here: - - [`LedgerFormats.cpp`](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/LedgerFormats.cpp) - - [`TxFormats.cpp`](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TxFormats.cpp) + - [`ledger_entries.macro`](https://github.com/XRPLF/rippled/blob/master/include/xrpl/protocol/detail/ledger_entries.macro) + - [`transactions.macro`](https://github.com/XRPLF/rippled/blob/master/include/xrpl/protocol/detail/transactions.macro) - `rippled` summarizes transaction results with result codes. See: [Transaction Results](../../docs/references/protocol/transactions/transaction-results/index.md) @@ -344,7 +342,7 @@ EscrowFinish::calculateBaseFee(ReadView const& view, STTx const& tx) ### `makeTxConsequences` -`rippled` uses a [`TxConsequences`](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/applySteps.h#L41-L44) class to describe the outcome to an account when applying a transaction. It tracks the fee, maximum possible XRP spent, and how many sequence numbers are consumed by the transaction. There are three types of consequences: +`rippled` uses a [`TxConsequences`](https://github.com/XRPLF/rippled/blob/70d5c624e8cf732a362335642b2f5125ce4b43c1/src/xrpld/app/tx/applySteps.h#L58) class to describe the outcome to an account when applying a transaction. It tracks the fee, maximum possible XRP spent, and how many sequence numbers are consumed by the transaction. There are three types of consequences: - **Normal:** The transactor doesn't affect transaction signing and _only_ consumes an XRP fee. Transactions that spend XRP beyond the fee aren't considered normal. - **Blocker:** The transactor affects transaction signing, preventing valid transactions from queueing behind it.