Skip to content

Commit ac9f972

Browse files
danieljperrydanieljperry
authored
Merge pull request #669 from Chia-Network/update-sort-key-info
update rpc sort_key information
2 parents 36be67f + 6e35269 commit ac9f972

File tree

4 files changed

+56
-56
lines changed

4 files changed

+56
-56
lines changed

‎docs/rpc-reference/offers.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -697,16 +697,16 @@ Options:
697697

698698
Request Parameters:
699699

700-
| Flag | Type | Required | Description |
701-
| :------------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------- |
702-
| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] |
703-
| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] |
704-
| exclude_my_offers | BOOLEAN | False | If `true`, don't show Offers that originated from this wallet [Default: `false`] |
705-
| exclude_taken_offers | BOOLEAN | False | If `true`, don't show any Offers with a status of `CONFIRMED` [Default: `false`] |
706-
| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] |
707-
| sort_key | STRING | False | Optionally change the sort order of the results [Default: none] |
708-
| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] |
709-
| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] |
700+
| Flag | Type | Required | Description |
701+
| :------------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
702+
| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] |
703+
| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] |
704+
| exclude_my_offers | BOOLEAN | False | If `true`, don't show Offers that originated from this wallet [Default: `false`] |
705+
| exclude_taken_offers | BOOLEAN | False | If `true`, don't show any Offers with a status of `CONFIRMED` [Default: `false`] |
706+
| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] |
707+
| sort_key | STRING | False | Optionally change the sort order of the results, [sort_keys members](https://github.com/Chia-Network/chia-blockchain/blob/5f6c336e757534d3a36b1a03612e05b412a18c61/chia/wallet/transaction_sorting.py#L6) [Default: `confirmed_at_height`] |
708+
| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] |
709+
| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] |
710710

711711
<details>
712712
<summary>Example</summary>

‎docs/rpc-reference/wallet.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1772,14 +1772,14 @@ Options:
17721772

17731773
Request Parameters:
17741774

1775-
| Flag | Type | Required | Description |
1776-
| :--------- | :------ | :------- | :------------------------------------------------------------------ |
1777-
| wallet_id | NUMBER | True | The Wallet ID of the wallet from which to obtain transactions |
1778-
| start | NUMBER | False | The sequence number of the first transaction to show [Default: 0] |
1779-
| end | NUMBER | False | The sequence number of the last transaction to show [Default: 50] |
1780-
| sort_key | NUMBER | False | Specify the key for sorting [Default: None] |
1781-
| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] |
1782-
| to_address | STRING | False | Only include transactions with this `to_address` [Default: None] |
1775+
| Flag | Type | Required | Description |
1776+
| :--------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1777+
| wallet_id | NUMBER | True | The Wallet ID of the wallet from which to obtain transactions |
1778+
| start | NUMBER | False | The sequence number of the first transaction to show [Default: 0] |
1779+
| end | NUMBER | False | The sequence number of the last transaction to show [Default: 50] |
1780+
| sort_key | NUMBER | False | Specify the key for sorting, [sort_keys members](https://github.com/Chia-Network/chia-blockchain/blob/5f6c336e757534d3a36b1a03612e05b412a18c61/chia/wallet/transaction_sorting.py#L6) [Default: `confirmed_at_height`] |
1781+
| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] |
1782+
| to_address | STRING | False | Only include transactions with this `to_address` [Default: None] |
17831783

17841784
<details>
17851785
<summary>Notes about transactions</summary>
@@ -3543,16 +3543,16 @@ Options:
35433543

35443544
Request Parameters:
35453545

3546-
| Flag | Type | Required | Description |
3547-
| :------------------- | :------ | :------- | :---------------------------------------------------------------------------- |
3548-
| start | NUMBER | False | The sequence number of the first offer to show [Default: 0] |
3549-
| end | NUMBER | False | The sequence number of the last offer to show [Default: 10] |
3550-
| exclude_my_offers | BOOLEAN | False | Set to `true` to exclude offers you originated [Default: false] |
3551-
| exclude_taken_offers | BOOLEAN | False | Set to `true` to exclude offers that have already been taken [Default: false] |
3552-
| include_completed | BOOLEAN | False | Set to `true` to include offers that have been taken [Default: false] |
3553-
| sort_key | NUMBER | False | Specify the key for sorting [Default: None] |
3554-
| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] |
3555-
| file_contents | BOOLEAN | False | Set to `true` to display the contents of each offer [Default: false] |
3546+
| Flag | Type | Required | Description |
3547+
| :------------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3548+
| start | NUMBER | False | The sequence number of the first offer to show [Default: 0] |
3549+
| end | NUMBER | False | The sequence number of the last offer to show [Default: 10] |
3550+
| exclude_my_offers | BOOLEAN | False | Set to `true` to exclude offers you originated [Default: false] |
3551+
| exclude_taken_offers | BOOLEAN | False | Set to `true` to exclude offers that have already been taken [Default: false] |
3552+
| include_completed | BOOLEAN | False | Set to `true` to include offers that have been taken [Default: false] |
3553+
| sort_key | NUMBER | False | Specify the key for sorting, [sort_keys members](https://github.com/Chia-Network/chia-blockchain/blob/5f6c336e757534d3a36b1a03612e05b412a18c61/chia/wallet/transaction_sorting.py#L6) [Default: `confirmed_at_height`] |
3554+
| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] |
3555+
| file_contents | BOOLEAN | False | Set to `true` to display the contents of each offer [Default: false] |
35563556

35573557
<details>
35583558
<summary>Example</summary>

‎i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/offers.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -728,16 +728,16 @@ Options:
728728

729729
Request Parameters:
730730

731-
| Flag | Type | Required | Description |
732-
| :------------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------- |
733-
| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] |
734-
| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] |
735-
| exclude_my_offers | BOOLEAN | False | If `true`, don't show Offers that originated from this wallet [Default: `false`] |
736-
| exclude_taken_offers | BOOLEAN | False | If `true`, don't show any Offers with a status of `CONFIRMED` [Default: `false`] |
737-
| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] |
738-
| sort_key | STRING | False | Optionally change the sort order of the results [Default: none] |
739-
| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] |
740-
| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] |
731+
| Flag | Type | Required | Description |
732+
| :------------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
733+
| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] |
734+
| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] |
735+
| exclude_my_offers | BOOLEAN | False | If `true`, don't show Offers that originated from this wallet [Default: `false`] |
736+
| exclude_taken_offers | BOOLEAN | False | If `true`, don't show any Offers with a status of `CONFIRMED` [Default: `false`] |
737+
| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] |
738+
| sort_key | STRING | False | Optionally change the sort order of the results, [sort_keys members](https://github.com/Chia-Network/chia-blockchain/blob/5f6c336e757534d3a36b1a03612e05b412a18c61/chia/wallet/transaction_sorting.py#L6) [Default: `confirmed_at_height`] |
739+
| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] |
740+
| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] |
741741

742742
<details>
743743
<summary>Example</summary>

0 commit comments

Comments
 (0)