Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add some IS and CL clarifications #105

Merged
merged 2 commits into from
Mar 27, 2024
Merged

docs: add some IS and CL clarifications #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4cba79
docs(rpc): update instantlock descriptions
thephez Mar 27, 2024
a1fd704
docs: update glossary entries for IS and CL
thephez Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/api/remote-procedure-calls-blockchain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,8 @@ Name | Type | Presence | Description
→ → → → → →<br>Address | string | Required<br>(1 or more) | A P2PKH or P2SH address
→ →<br>`extraPayloadSize` | number (int) | Optional<br>(0 or 1) | *Added in Dash Core 0.13.0.0*<br><br>Size of the DIP2 extra payload. Only present if it's a DIP2 special transaction
→ →<br>`extraPayload` | string (hex) | Optional<br>(0 or 1) | *Added in Dash Core 0.13.0.0*<br><br>Hex encoded DIP2 extra payload data. Only present if it's a DIP2 special transaction
→ →<br>`instantlock` | bool | Required<br>(exactly 1) | If set to `true`, this transaction is locked (by InstantSend or a ChainLock)
→ →<br>`instantlock_internal` | bool | Required<br>(exactly 1) | If set to `true`, this transaction has an InstantSend lock
→ →<br>`instantlock` | bool | Required<br>(exactly 1) | If set to `true`, this transaction is either protected by an [InstantSend](../resources/glossary.md#instantsend) lock or it is in a block that has received a [ChainLock](../resources/glossary.md#chainlock)
→ →<br>`instantlock_internal` | bool | Required<br>(exactly 1) | If set to `true`, this transaction has an [InstantSend](../resources/glossary.md#instantsend) lock
→<br>`cbTx` | object | Required<br>(exactly 1) | Coinbase special transaction details
→ →<br>`version` | number (int) | Required<br>(exactly 1) | The version of the Coinbase special transaction (CbTx)
→ →<br>`height` | number (int) | Required<br>(exactly 1) | The height of this block on its block chain
Expand Down Expand Up @@ -1254,7 +1254,7 @@ Name | Type | Presence | Description
→ →<br>`spentby` | array | Required<br>(exactly 1) | **Added in Dash Core 20.0.0**<br>An array of unconfirmed transactions spending outputs from this transaction
→ → →<br>TXID | string | Optional (0 or more) | The TXIDs of any unconfirmed transactions spending from this transaction
→ →<br>`unbroadcast` | bool | Required<br>(exactly 1) | **Added in Dash Core 20.0.0**<br>True if this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)
→ →<br>`instantlock` | bool | Required<br>(exactly 1) | Set to `true` if this transaction was locked via InstantSend
→ →<br>`instantlock` | bool | Required<br>(exactly 1) | Set to `true` if this transaction was locked via [InstantSend](../resources/glossary.md#instantsend)

*Examples from Dash Core 20.0.0*

Expand Down Expand Up @@ -1372,7 +1372,7 @@ Name | Type | Presence | Description
→ →<br>`spentby` | array | Required<br>(exactly 1) | **Added in Dash Core 20.0.0**<br>An array of unconfirmed transactions spending outputs from this transaction
→ → →<br>TXID | string | Optional (0 or more) | The TXIDs of any unconfirmed transactions spending from this transaction
→ →<br>`unbroadcast` | bool | Required<br>(exactly 1) | **Added in Dash Core 20.0.0**<br>True if this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)
→ →<br>`instantlock` | bool | Required<br>(exactly 1) | Set to `true` if this transaction was locked via InstantSend
→ →<br>`instantlock` | bool | Required<br>(exactly 1) | Set to `true` if this transaction was locked via [InstantSend](../resources/glossary.md#instantsend)

*Examples from Dash Core 20.0.0*

Expand Down Expand Up @@ -1476,7 +1476,7 @@ Name | Type | Presence | Description
→<br>`spentby` | array | Required<br>(exactly 1) | **Added in Dash Core 20.0.0**<br>An array of unconfirmed transactions spending outputs from this transaction
→ →<br>TXID | string | Optional (0 or more) | The TXIDs of any unconfirmed transactions spending from this transaction
→<br>`unbroadcast` | bool | Required<br>(exactly 1) | **Added in Dash Core 20.0.0**<br>True if this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)
→<br>`instantlock` | bool | Required<br>(exactly 1) | True if this transaction was locked via InstantSend
→<br>`instantlock` | bool | Required<br>(exactly 1) | Set to `true` if this transaction was locked via [InstantSend](../resources/glossary.md#instantsend)

*Example from Dash Core 20.0.0*

Expand Down Expand Up @@ -1621,7 +1621,7 @@ Name | Type | Presence | Description
→ →<br>`spentby` | array | Required<br>(exactly 1) | _Added in Dash Core 0.17.0_<br>An array of unconfirmed transactions spending outputs from this transaction
→ → →<br>TXID | string | Optional (0 or more) | The TXIDs of any unconfirmed transactions spending from this transaction
→ →<br>`unbroadcast` | bool | Required<br>(exactly 1) | **Added in Dash Core 20.0.0**<br>True if this transaction is currently unbroadcast (initial broadcast not yet acknowledged by any peers)
→ →<br>`instantlock` | bool | Required<br>(exactly 1) | *Added in Dash Core 0.12.3*<br><br>Set to `true` for locked InstantSend transactions (masternode quorum has locked the transaction inputs via `isdlock` message). Set to `false` if the masternodes have not approved the InstantSend transaction
→ →<br>`instantlock` | bool | Required<br>(exactly 1) | *Added in Dash Core 0.12.3*<br><br>Set to `true` for locked [InstantSend](../resources/glossary.md#instantsend) transactions (masternode quorum has locked the transaction inputs via `isdlock` message). Set to `false` if the masternodes have not approved the [InstantSend](../resources/glossary.md#instantsend) transaction

*Examples from Dash Core 20.0.0*

Expand Down
4 changes: 2 additions & 2 deletions docs/api/remote-procedure-calls-raw-transactions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -998,8 +998,8 @@ _Result (if verbose=`true`)---the decoded transaction_
| →<br>`confirmations` | number (int) | Optional<br>(0 or 1) | If the transaction has been included in a block on the local best block chain, this is how many confirmations it has. Otherwise, this is `0`. Not shown for mempool transactions. |
| →<br>`time` | number (int) | Optional<br>(0 or 1) | If the transaction has been included in a block on the local best block chain, this is the block header time of that block (may be in the future) |
| →<br>`blocktime` | number (int) | Optional<br>(0 or 1) | This field is currently identical to the time field described above |
| →<br>`instantlock` | bool | Required<br>(exactly 1) | If set to `true`, this transaction is locked (by InstantSend or a ChainLock) |
| →<br>`instantlock_internal` | bool | Required<br>(exactly 1) | If set to `true`, this transaction has an InstantSend lock |
| →<br>`instantlock` | bool | Required<br>(exactly 1) | If set to `true`, this transaction is either protected by an [InstantSend](../resources/glossary.md#instantsend) lock or it is in a block that has received a [ChainLock](../resources/glossary.md#chainlock) |
| →<br>`instantlock_internal` | bool | Required<br>(exactly 1) | If set to `true`, this transaction has an [InstantSend](../resources/glossary.md#instantsend) lock |
| →<br>`chainlock` | bool | Required<br>(exactly 1) | _Added in Dash Core 0.14.0_<br><br>If set to `true`, this transaction is in a block that is locked (not susceptible to a chain re-org) |

_Examples from Dash Core 0.14.0_
Expand Down
12 changes: 6 additions & 6 deletions docs/api/remote-procedure-calls-wallet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -938,8 +938,8 @@ _Result---a description of the transaction_
| →<br>`amount` | number (dash) | Required<br>(exactly 1) | A positive number of dash if this transaction increased the total wallet balance; a negative number of dash if this transaction decreased the total wallet balance, or `0` if the transaction had no net effect on wallet balance |
| →<br>`fee` | number (dash) | Optional<br>(0 or 1) | If an outgoing transaction, this is the fee paid by the transaction reported as negative dash |
| → <br>`confirmations` | number (int) | Required<br>(exactly 1) | The number of confirmations the transaction has received. Will be `0` for unconfirmed and `-1` for conflicted |
| → <br>`instantlock` | bool | Required<br>(exactly 1) | Current transaction lock state (InstantSend and/or ChainLock) |
| → <br>`instantlock_internal` | bool | Required<br>(exactly 1) | Current InstantSend transaction lock state |
| →<br>`instantlock` | bool | Required<br>(exactly 1) | If set to `true`, this transaction is either protected by an [InstantSend](../resources/glossary.md#instantsend) lock or it is in a block that has received a [ChainLock](../resources/glossary.md#chainlock) |
| →<br>`instantlock_internal` | bool | Required<br>(exactly 1) | If set to `true`, this transaction has an [InstantSend](../resources/glossary.md#instantsend) lock |
| → <br>`chainlock` | bool | Required<br>(exactly 1) | _Added in Dash Core 0.14.0_<br><br> If set to `true`, this transaction is in a block that is locked (not susceptible to a chain re-org) |
| → <br>`generated` | bool | Optional<br>(0 or 1) | Set to `true` if the transaction is a coinbase. Not returned for regular transactions |
| → <br>`blockhash` | string (hex) | Optional<br>(0 or 1) | The hash of the block on the local best block chain which includes this transaction, encoded as hex in RPC byte order. Only returned for confirmed transactions |
Expand Down Expand Up @@ -1931,8 +1931,8 @@ _Parameter #4---include_removed_
| → <br>`vout` | number (int) | Required<br>(exactly 1) | For an output, the output index (vout) for this output in this transaction. For an input, the output index for the output being spent in its transaction. Because inputs list the output indexes from previous transactions, more than one entry in the details array may have the same output index |
| → <br>`fee` | number (dash) | Optional<br>(0 or 1) | If sending payment, the fee paid as a negative dash value. May be `0`. Not returned if receiving payment |
| → <br>`confirmations` | number (int) | Required<br>(exactly 1) | The number of confirmations the transaction has received. Will be `0` for unconfirmed and `-1` for conflicted |
| → <br>`instantlock` | bool | Required<br>(exactly 1) | Current transaction lock state (InstantSend and/or ChainLock) |
| → <br>`instantlock_internal` | bool | Required<br>(exactly 1) | Current InstantSend transaction lock state |
| →<br>`instantlock` | bool | Required<br>(exactly 1) | If set to `true`, this transaction is either protected by an [InstantSend](../resources/glossary.md#instantsend) lock or it is in a block that has received a [ChainLock](../resources/glossary.md#chainlock) |
| →<br>`instantlock_internal` | bool | Required<br>(exactly 1) | If set to `true`, this transaction has an [InstantSend](../resources/glossary.md#instantsend) lock |
| → <br>`chainlock` | bool | Required<br>(exactly 1) | _Added in Dash Core 0.14.0_<br><br> If set to `true`, this transaction is in a block that is locked (not susceptible to a chain re-org) |
| → <br>`generated` | bool | Optional<br>(0 or 1) | Set to `true` if the transaction is a coinbase. Not returned for regular transactions |
| → <br>`blockhash` | string (hex) | Optional<br>(0 or 1) | The hash of the block on the local best block chain which includes this transaction, encoded as hex in RPC byte order. Only returned for confirmed transactions |
Expand Down Expand Up @@ -2065,8 +2065,8 @@ _Result---payment details_
| → →<br>`vout` | number (int) | Optional<br>(0 or 1) | For an output, the output index (vout) for this output in this transaction. For an input, the output index for the output being spent in its transaction. Because inputs list the output indexes from previous transactions, more than one entry in the details array may have the same output index. Not returned for _move_ category payments |
| → →<br>`fee` | number (dash) | Optional<br>(0 or 1) | If sending payment, the fee paid as a negative dash value. May be `0`. Not returned if receiving payment or for _move_ category payments |
| → →<br>`confirmations` | number (int) | Optional<br>(0 or 1) | The number of confirmations the transaction has received. Will be `0` for unconfirmed and `-1` for conflicted. Not returned for _move_ category payments |
| →<br>`instantlock` | bool | Required<br>(exactly 1) | Current transaction lock state (InstantSend and/or ChainLock) |
| →<br>`instantlock_internal` | bool | Required<br>(exactly 1) | Current InstantSend transaction lock state |
| →<br>`instantlock` | bool | Required<br>(exactly 1) | If set to `true`, this transaction is either protected by an [InstantSend](../resources/glossary.md#instantsend) lock or it is in a block that has received a [ChainLock](../resources/glossary.md#chainlock) |
| →<br>`instantlock_internal` | bool | Required<br>(exactly 1) | If set to `true`, this transaction has an [InstantSend](../resources/glossary.md#instantsend) lock |
| <br>`chainlock` | bool | Required<br>(exactly 1) | _Added in Dash Core 0.14.0_<br><br> If set to `true`, this transaction is in a block that is locked (not susceptible to a chain re-org) |
| → →<br>`generated` | bool | Optional<br>(0 or 1) | Set to `true` if the transaction is a coinbase. Not returned for regular transactions or _move_ category payments |
| → →<br>`trusted` | bool | Optional<br>(0 or 1) | Indicates whether we consider the outputs of this unconfirmed transaction safe to spend. Only returned for unconfirmed transactions |
Expand Down
Loading
Loading