Skip to content

Commit

Permalink
Merge pull request #669 from Chia-Network/update-sort-key-info
Browse files Browse the repository at this point in the history 
update rpc sort_key information
  • Loading branch information
@danieljperry
danieljperry authored Oct 8, 2024
2 parents 36be67f + 6e35269 commit ac9f972
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 56 deletions.
20 changes: 10 additions & 10 deletions docs/rpc-reference/offers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -697,16 +697,16 @@ Options:

Request Parameters:

| Flag | Type | Required | Description |
| :------------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------- |
| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] |
| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] |
| exclude_my_offers | BOOLEAN | False | If `true`, don't show Offers that originated from this wallet [Default: `false`] |
| exclude_taken_offers | BOOLEAN | False | If `true`, don't show any Offers with a status of `CONFIRMED` [Default: `false`] |
| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] |
| sort_key | STRING | False | Optionally change the sort order of the results [Default: none] |
| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] |
| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] |
| Flag | Type | Required | Description |
| :------------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] |
| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] |
| exclude_my_offers | BOOLEAN | False | If `true`, don't show Offers that originated from this wallet [Default: `false`] |
| exclude_taken_offers | BOOLEAN | False | If `true`, don't show any Offers with a status of `CONFIRMED` [Default: `false`] |
| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] |
| 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`] |
| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] |
| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] |

<details>
<summary>Example</summary>
Expand Down
36 changes: 18 additions & 18 deletions docs/rpc-reference/wallet.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1772,14 +1772,14 @@ Options:

Request Parameters:

| Flag | Type | Required | Description |
| :--------- | :------ | :------- | :------------------------------------------------------------------ |
| wallet_id | NUMBER | True | The Wallet ID of the wallet from which to obtain transactions |
| start | NUMBER | False | The sequence number of the first transaction to show [Default: 0] |
| end | NUMBER | False | The sequence number of the last transaction to show [Default: 50] |
| sort_key | NUMBER | False | Specify the key for sorting [Default: None] |
| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] |
| to_address | STRING | False | Only include transactions with this `to_address` [Default: None] |
| Flag | Type | Required | Description |
| :--------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| wallet_id | NUMBER | True | The Wallet ID of the wallet from which to obtain transactions |
| start | NUMBER | False | The sequence number of the first transaction to show [Default: 0] |
| end | NUMBER | False | The sequence number of the last transaction to show [Default: 50] |
| 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`] |
| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] |
| to_address | STRING | False | Only include transactions with this `to_address` [Default: None] |

<details>
<summary>Notes about transactions</summary>
Expand Down Expand Up @@ -3543,16 +3543,16 @@ Options:

Request Parameters:

| Flag | Type | Required | Description |
| :------------------- | :------ | :------- | :---------------------------------------------------------------------------- |
| start | NUMBER | False | The sequence number of the first offer to show [Default: 0] |
| end | NUMBER | False | The sequence number of the last offer to show [Default: 10] |
| exclude_my_offers | BOOLEAN | False | Set to `true` to exclude offers you originated [Default: false] |
| exclude_taken_offers | BOOLEAN | False | Set to `true` to exclude offers that have already been taken [Default: false] |
| include_completed | BOOLEAN | False | Set to `true` to include offers that have been taken [Default: false] |
| sort_key | NUMBER | False | Specify the key for sorting [Default: None] |
| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] |
| file_contents | BOOLEAN | False | Set to `true` to display the contents of each offer [Default: false] |
| Flag | Type | Required | Description |
| :------------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start | NUMBER | False | The sequence number of the first offer to show [Default: 0] |
| end | NUMBER | False | The sequence number of the last offer to show [Default: 10] |
| exclude_my_offers | BOOLEAN | False | Set to `true` to exclude offers you originated [Default: false] |
| exclude_taken_offers | BOOLEAN | False | Set to `true` to exclude offers that have already been taken [Default: false] |
| include_completed | BOOLEAN | False | Set to `true` to include offers that have been taken [Default: false] |
| 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`] |
| reverse | BOOLEAN | False | Set to `true` to sort the results in reverse order [Default: false] |
| file_contents | BOOLEAN | False | Set to `true` to display the contents of each offer [Default: false] |

<details>
<summary>Example</summary>
Expand Down
20 changes: 10 additions & 10 deletions i18n/zh-Hans/docusaurus-plugin-content-docs/current/rpc-reference/offers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -728,16 +728,16 @@ Options:

Request Parameters:

| Flag | Type | Required | Description |
| :------------------- | :------ | :------- | :--------------------------------------------------------------------------------------------------------------- |
| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] |
| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] |
| exclude_my_offers | BOOLEAN | False | If `true`, don't show Offers that originated from this wallet [Default: `false`] |
| exclude_taken_offers | BOOLEAN | False | If `true`, don't show any Offers with a status of `CONFIRMED` [Default: `false`] |
| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] |
| sort_key | STRING | False | Optionally change the sort order of the results [Default: none] |
| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] |
| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] |
| Flag | Type | Required | Description |
| :------------------- | :------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| start | NUMBER | False | The first Offer to display, inclusive [Default: `0`] |
| end | NUMBER | False | The last Offer to display, exclusive [Default: `10`] |
| exclude_my_offers | BOOLEAN | False | If `true`, don't show Offers that originated from this wallet [Default: `false`] |
| exclude_taken_offers | BOOLEAN | False | If `true`, don't show any Offers with a status of `CONFIRMED` [Default: `false`] |
| include_completed | BOOLEAN | False | If `true`, show completed Offers [Default: `false`] |
| 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`] |
| reverse | BOOLEAN | False | If `true`, reverse the results [Default: `false`] |
| file_contents | BOOLEAN | False | If `true`, return a summary for the Offer. If `false`, only return the Offer's basic metadata [Default: `false`] |

<details>
<summary>Example</summary>
Expand Down
Loading

0 comments on commit ac9f972

Please sign in to comment.