mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-21 04:05:49 +00:00
[MERGE] REST docs & tool following pull request #94, including more fixes
This commit is contained in:
@@ -40,6 +40,7 @@ Installation instructions and source code can be found in the [Ripple-REST repos
|
|||||||
#### Utilities ####
|
#### Utilities ####
|
||||||
|
|
||||||
* [Retrieve Ripple Transaction - `GET /v1/transactions/{:id}`](#retrieve-ripple-transaction)
|
* [Retrieve Ripple Transaction - `GET /v1/transactions/{:id}`](#retrieve-ripple-transaction)
|
||||||
|
* [Retrieve Transaction Fee - `GET /v1/transaction-fee`](#retrieve-transaction-fee)
|
||||||
* [Generate UUID - `GET /v1/uuid`](#create-client-resource-id)
|
* [Generate UUID - `GET /v1/uuid`](#create-client-resource-id)
|
||||||
|
|
||||||
|
|
||||||
@@ -188,7 +189,7 @@ When errors occur, the server returns an HTTP status code in the 400-599 range,
|
|||||||
|
|
||||||
In general, the HTTP status code is indicative of where the problem occurred:
|
In general, the HTTP status code is indicative of where the problem occurred:
|
||||||
|
|
||||||
* Codes in the 200-299 range indicate success. (*Note:* This behavior is new in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/v1.3.0-rc4). Previous versions sometimes return 200 OK for some types of errors.)
|
* Codes in the 200-299 range indicate success. (*Note:* This behavior is new in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/1.3.0). Previous versions sometimes return 200 OK for some types of errors.)
|
||||||
* Unless otherwise specified, methods are expected to return `200 OK` on success.
|
* Unless otherwise specified, methods are expected to return `200 OK` on success.
|
||||||
* Codes in the 400-499 range indicate that the request was invalid or incorrect somehow. For example:
|
* Codes in the 400-499 range indicate that the request was invalid or incorrect somehow. For example:
|
||||||
* `400 Bad Request` occurs if the JSON body is malformed. This includes syntax errors as well as when invalid or mutually-exclusive options are selected.
|
* `400 Bad Request` occurs if the JSON body is malformed. This includes syntax errors as well as when invalid or mutually-exclusive options are selected.
|
||||||
@@ -344,7 +345,7 @@ Submitted transactions can have additional fields reflecting the current status
|
|||||||
|
|
||||||
### Memo Objects ###
|
### Memo Objects ###
|
||||||
|
|
||||||
(New in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/v1.3.0-rc4))
|
(New in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/1.3.0))
|
||||||
|
|
||||||
Memo objects represent arbitrary data that can be included in a transaction. The overall size of the `memos` field cannot exceed 1KB after serialization.
|
Memo objects represent arbitrary data that can be included in a transaction. The overall size of the `memos` field cannot exceed 1KB after serialization.
|
||||||
|
|
||||||
@@ -404,7 +405,7 @@ Accounts are the core unit of authentication in the Ripple Network. Each account
|
|||||||
|
|
||||||
## Generate Wallet ##
|
## Generate Wallet ##
|
||||||
|
|
||||||
(New in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/v1.3.0-rc4))
|
(New in [Ripple-REST v1.3.0](https://github.com/ripple/ripple-rest/releases/tag/1.3.0))
|
||||||
|
|
||||||
Randomly generate keys for a potential new Ripple account.
|
Randomly generate keys for a potential new Ripple account.
|
||||||
|
|
||||||
@@ -1842,6 +1843,32 @@ The result is a JSON object, whose `transaction` field has the requested transac
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Retrieve Transaction Fee ##
|
||||||
|
|
||||||
|
(New in [Ripple-REST v1.3.1](https://github.com/ripple/ripple-rest/releases/tag/1.3.1-rc1))
|
||||||
|
|
||||||
|
Retrieve the current transaction fee for the rippled server `ripple-rest` is connected to. If `ripple-rest` is connected to multiple rippled servers, the median fee between the connected servers is calculated.
|
||||||
|
|
||||||
|
<div class='multicode'>
|
||||||
|
*REST*
|
||||||
|
|
||||||
|
```
|
||||||
|
GET /v1/transaction-fee
|
||||||
|
```
|
||||||
|
</div>
|
||||||
|
|
||||||
|
[Try it! >](rest-api-tool.html#retrieve-transaction-fee)
|
||||||
|
|
||||||
|
#### Response ####
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"success": true,
|
||||||
|
"fee": "12000"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Create Client Resource ID ##
|
## Create Client Resource ID ##
|
||||||
|
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ var DEFAULT_HASH = "9D591B18EDDD34F0B6CF4223A2940AEA2C3CC778925BABF289E0011CD8FA
|
|||||||
Request('Generate Wallet', {
|
Request('Generate Wallet', {
|
||||||
method: GET,
|
method: GET,
|
||||||
path: "/v1/wallet/new",
|
path: "/v1/wallet/new",
|
||||||
description: 'Generate the keys for a potential new account',
|
description: 'Randomly generate keys for a potential new Ripple account',
|
||||||
link: '#generate-wallet'
|
link: '#generate-wallet'
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -129,7 +129,7 @@ Request('Prepare Payment', {
|
|||||||
|
|
||||||
Request('Submit Payment', {
|
Request('Submit Payment', {
|
||||||
method: POST,
|
method: POST,
|
||||||
path: '/v1/payments',
|
path: '/v1/accounts/{:source_address}/payments',
|
||||||
description: 'Send a prepared payment to the network.',
|
description: 'Send a prepared payment to the network.',
|
||||||
link: '#submit-payment',
|
link: '#submit-payment',
|
||||||
test_only: true,
|
test_only: true,
|
||||||
@@ -157,6 +157,9 @@ Request('Submit Payment', {
|
|||||||
"partial_payment": false,
|
"partial_payment": false,
|
||||||
"no_direct_ripple": false
|
"no_direct_ripple": false
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
params: {
|
||||||
|
"{:source_address}": DEFAULT_ADDRESS_1
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -240,7 +243,7 @@ Request("Get Server Status", {
|
|||||||
|
|
||||||
Request("Retrieve Ripple Transaction", {
|
Request("Retrieve Ripple Transaction", {
|
||||||
method: GET,
|
method: GET,
|
||||||
path: "/v1/transactions/{:hash}",
|
path: "/v1/transactions/{:id}",
|
||||||
description: "Retrieve a raw Ripple transaction",
|
description: "Retrieve a raw Ripple transaction",
|
||||||
link: "#retrieve-ripple-transaction",
|
link: "#retrieve-ripple-transaction",
|
||||||
params: {
|
params: {
|
||||||
@@ -248,6 +251,13 @@ Request("Retrieve Ripple Transaction", {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
Request("Retrieve Transaction Fee", {
|
||||||
|
method: GET,
|
||||||
|
path: "/v1/transaction-fee",
|
||||||
|
description: "Retrieve the current transaction fee for the connected rippled server(s)",
|
||||||
|
link: "#retrieve-transaction-fee",
|
||||||
|
});
|
||||||
|
|
||||||
Request("Generate UUID", {
|
Request("Generate UUID", {
|
||||||
method: GET,
|
method: GET,
|
||||||
path: "/v1/uuid",
|
path: "/v1/uuid",
|
||||||
|
|||||||
@@ -129,6 +129,7 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
|
|||||||
<li>Get Server Status</li>
|
<li>Get Server Status</li>
|
||||||
<br/>
|
<br/>
|
||||||
<li>Retrieve Ripple Transaction</li>
|
<li>Retrieve Ripple Transaction</li>
|
||||||
|
<li>Retrieve Transaction Fee</li>
|
||||||
<li>Generate UUID</li>
|
<li>Generate UUID</li>
|
||||||
</ul>
|
</ul>
|
||||||
<div id='command_table'>
|
<div id='command_table'>
|
||||||
|
|||||||
Reference in New Issue
Block a user