Improve documentation of sendTransaction (#14770)

* Improve documentation of sendTransaction

* Apply suggestions from code review

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>

* Word wrap and improve terminology

* Tweak

* Oops

* Apply suggestions from code review

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
This commit is contained in:
Ryo Onodera
2021-01-23 18:51:25 +09:00
committed by GitHub
parent 66fd187f16
commit 1d87091d51
2 changed files with 31 additions and 5 deletions

View File

@@ -141,6 +141,7 @@ A sequence of [validator](terminology.md#validator) [public keys](terminology.md
## ledger
A list of [entries](terminology.md#entry) containing [transactions](terminology.md#transaction) signed by [clients](terminology.md#client).
Conceptually, this can be traced back to the [genesis block](terminology.md#genesis-block), but actual [validators](terminology.md#validator)'s ledger may have only newer [blocks](terminology.md#block) to save storage usage as older ones not needed for validation of future blocks by design.
## ledger vote
@@ -213,6 +214,8 @@ A fraction of a [block](terminology.md#block); the smallest unit sent between [v
## signature
A 64-byte ed25519 signature of R (32-bytes) and S (32-bytes). With the requirement that R is a packed Edwards point not of small order and S is a scalar in the range of 0 <= S < L.
This requirement ensures no signature malleability. Each transaction must have at least one signature for [fee account](terminology#fee-account).
Thus, the first signature in transaction can be treated as [transacton id](terminology.md#transaction-id)
## slot
@@ -260,7 +263,11 @@ A scarce, fungible member of a set of tokens.
## transaction
One or more [instructions](terminology.md#instruction) signed by the [client](terminology.md#client) and executed atomically.
One or more [instructions](terminology.md#instruction) signed by the [client](terminology.md#client) using one or more [keypairs](terminology.md#keypair) and executed atomically with only two possible outcomes: success or failure.
## transaction id
The first [signature](terminology.md#signature) in a [transaction](terminology.md#transaction), which can be used to uniquely identify the transaction across the complete [ledger](terminology.md#ledger).
## transaction confirmations