monero-project/meta
monero-project/meta
1
0
Fork 0
mirror of https://github.com/monero-project/meta.git synced 2024-11-16 15:58:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

correct pluralizations in lightwallet_rest.md

Browse source
This commit is contained in:
Chad Perrin 2021-03-15 08:22:53 -07:00
parent 02c43e3ad3
commit 9afcf4328f
1 changed files with 52 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

104
api/lightwallet_rest.md
View file

@ -68,7 +68,7 @@ Information needed to spend an output.
| tx_prefix_hash | binary | Bytes of tx prefix hash |
| public_key | binary | Bytes of output public key |
| tx_pub_key | binary | Bytes of the tx public key |
| spend_key_images | array of binary's | Bytes of key images |
| spend_key_images | array of binaries | Bytes of key images |
| timestamp | timestamp | Timestamp of containing block |
| height | uint64 | Containing block height |
@ -142,20 +142,20 @@ blockchain timestamps do not have sub-seconds.
**transaction** object
| Field | Type | Description |
|----------------|------------------|---------------------------|
| id | uint64 | Index of tx in blockchain |
| hash | binary | Bytes of tx hash |
| timestamp * | timestamp | Timestamp of block |
| total_received | uint64-string | Total XMR received |
| total_sent | uint64-string | XMR possibly being spent |
| unlock_time | uint64 | Tx unlock time field |
| height * | uint64 | Block height |
| spent_outputs | array of spend's | List of possible spends |
| payment_id * | binary | Bytes of tx payment id |
| coinbase | boolean | True if tx is coinbase |
| mempool | boolean | True if tx is in mempool |
| mixin | uint32 | Mixin of the receive |
| Field | Type | Description |
|----------------|-----------------|---------------------------|
| id | uint64 | Index of tx in blockchain |
| hash | binary | Bytes of tx hash |
| timestamp * | timestamp | Timestamp of block |
| total_received | uint64-string | Total XMR received |
| total_sent | uint64-string | XMR possibly being spent |
| unlock_time | uint64 | Tx unlock time field |
| height * | uint64 | Block height |
| spent_outputs | array of spends | List of possible spends |
| payment_id * | binary | Bytes of tx payment id |
| coinbase | boolean | True if tx is coinbase |
| mempool | boolean | True if tx is in mempool |
| mixin | uint32 | Mixin of the receive |
> `id` is determined by the monero daemon. It is the offset that a
> transaction appears in the blockchain from the genesis block.
@ -200,10 +200,10 @@ exceed 2^53 - all numbers are 64-bit floats in JavaScript.
Randomly selected outputs for use in a ring signature.
| Field | Type | Description |
|-----------|--------------------------|-------------------------|
| amount | uint64-string | XMR amount, 0 if ringct |
| outputs * | array of random_output's | Selected outputs |
| Field | Type | Description |
|-----------|-------------------------|-------------------------|
| amount | uint64-string | XMR amount, 0 if ringct |
| outputs * | array of random_outputs | Selected outputs |
> `outputs` is omitted by the server if the `amount` does not have enough
> mixable outputs.
@ -226,18 +226,18 @@ list of candidate spends is returned.
**Response** object
| Field | Type | Description |
|----------------------|------------------|---------------------------|
| locked_funds | uint64-string | Sum of unspendable XMR |
| total_received | uint64-string | Sum of received XMR |
| total_sent | uint64-string | Sum of possibly spent XMR |
| scanned_height | uint64 | Current tx scan progress |
| scanned_block_height | uint64 | Current scan progress |
| start_height | uint64 | Start height of response |
| transaction_height | uint64 | Total txes sent in Monero |
| blockchain_height | uint64 | Current blockchain height |
| spent_outputs | array of spend's | Possible spend info |
| rates * | rates | Current exchange rates |
| Field | Type | Description |
|----------------------|-----------------|---------------------------|
| locked_funds | uint64-string | Sum of unspendable XMR |
| total_received | uint64-string | Sum of received XMR |
| total_sent | uint64-string | Sum of possibly spent XMR |
| scanned_height | uint64 | Current tx scan progress |
| scanned_block_height | uint64 | Current scan progress |
| start_height | uint64 | Start height of response |
| transaction_height | uint64 | Total txes sent in Monero |
| blockchain_height | uint64 | Current blockchain height |
| spent_outputs | array of spends | Possible spend info |
| rates * | rates | Current exchange rates |
> `rates` is omitted if unavailable.
@ -258,14 +258,14 @@ spends is returned.
**Response** object
| Field | Type | Description |
|----------------------|------------------------|---------------------------|
| total_received | uint64-string | Sum of received outputs |
| scanned_height | uint64 | Current tx scan progress |
| scanned_block_height | uint64 | Current scan progress |
| start_height | uint64 | Start height of response |
| blockchain_height | uint64 | Current blockchain height |
| transactions | array of transaction's | Possible spend info |
| Field | Type | Description |
|----------------------|-----------------------|---------------------------|
| total_received | uint64-string | Sum of received outputs |
| scanned_height | uint64 | Current tx scan progress |
| scanned_block_height | uint64 | Current scan progress |
| start_height | uint64 | Start height of response |
| blockchain_height | uint64 | Current blockchain height |
| transactions | array of transactions | Possible spend info |
#### `get_random_outs`
Selects random outputs to use in a ring signature of a new transaction. If the
@ -278,10 +278,10 @@ locally select outputs using a triangular distribution
**Request** object
| Field | Type | Description |
|------------|---------------------------|----------------------------------|
| count | uint32 | Mixin (name is historical) |
| amounts | array of uint64-strings's | XMR amounts that need mixing |
| Field | Type | Description |
|------------|-------------------------|----------------------------------|
| count | uint32 | Mixin (name is historical) |
| amounts | array of uint64-strings | XMR amounts that need mixing |
> Clients must use amount `0` when computing a ringct output.
@ -292,9 +292,9 @@ locally select outputs using a triangular distribution
**Response** object
| Field | Type | Description |
|-------------|--------------------------|----------------------------------|
| amount_outs | array of random_outputs' | Dummy outputs for each `amounts` |
| Field | Type | Description |
|-------------|-------------------------|----------------------------------|
| amount_outs | array of random_outputs | Dummy outputs for each `amounts` |
> If there are not enough outputs to mix for a specific amount, the server
> shall omit the `outputs` field in `amount_outs`.
@ -319,12 +319,12 @@ was actually spent.
**Response** object
| Field | Type | Description |
|--------------|-------------------|-----------------------------------------|
| per_byte_fee | uint64-string | Estimated network fee |
| fee_mask | uint64-string | Fee quantization mask |
| amount | uint64-string | The total value in outputs |
| outputs | array of output's | Outputs possibly available for spending |
| Field | Type | Description |
|--------------|------------------|-----------------------------------------|
| per_byte_fee | uint64-string | Estimated network fee |
| fee_mask | uint64-string | Fee quantization mask |
| amount | uint64-string | The total value in outputs |
| outputs | array of outputs | Outputs possibly available for spending |
#### `import_request`
Request an account scan from the genesis block.