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

Add/gas fee estimator docs #293

Closed
wants to merge 14 commits into from
Closed

Add/gas fee estimator docs #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
9e4b446
Added documentation for Gas Fee Estimator RPC methods
harsenyan3 Jul 18, 2024
07c3a09
.
harsenyan3 Jul 22, 2024
9e51768
example subheading set
harsenyan3 Jul 22, 2024
c6d055a
fixed common structures
harsenyan3 Jul 22, 2024
af9242a
fixed trailing comma in json request
harsenyan3 Jul 22, 2024
9bec386
link to star_gas_fee_estimator fixed
harsenyan3 Jul 22, 2024
3424c3a
fixed url x2
harsenyan3 Jul 22, 2024
9b8c59a
Merge branch 'dev' into add/gas-fee-estimator-docs
smk762 Sep 9, 2024
ee5304d
linting
smk762 Sep 9, 2024
5db1c3b
linting
smk762 Sep 9, 2024
1004ff2
fix commas in jsons
gcharang Sep 9, 2024
6694a88
gas estimate methods renamed
smk762 Sep 13, 2024
1b397d4
Merge branch 'dev' into add/gas-fee-estimator-docs
smk762 Oct 16, 2024
f38819e
rename methods, fix lint errors
smk762 Oct 16, 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
13 changes: 13 additions & 0 deletions filepathSlugs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3119,6 +3119,11 @@
"command",
"response-success"
],
"src/pages/komodo-defi-framework/api/v20-dev/get_eth_estimated_fee_per_gas/index.mdx": [
"get-eth-estimated-fee-per-gas",
"request",
"response"
],
"src/pages/komodo-defi-framework/api/v20-dev/get_locked_amount/index.mdx": [
"get-locked-amount",
"arguments",
Expand Down Expand Up @@ -3398,6 +3403,14 @@
"transport-error-unable-to-estimate-gas",
"not-enough-nfts-amount-trying-to-send-more-nfts-than-you-have"
],
"src/pages/komodo-defi-framework/api/v20-dev/start_eth_fee_estimator/index.mdx": [
"start-eth-fee-estimator",
"response"
],
"src/pages/komodo-defi-framework/api/v20-dev/stop_eth_fee_estimator/index.mdx": [
"stop-eth-fee-estimator",
"response"
],
"src/pages/komodo-defi-framework/api/v20-dev/task_account_balance/index.mdx": [
"account-balance-tasks",
"init",
Expand Down
12 changes: 12 additions & 0 deletions src/data/sidebar.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,18 @@
{
"title": "Utility",
"links": [
{
"title": "get_eth_estimated_fee_per_gas",
"href": "/komodo-defi-framework/api/v20-dev/get_eth_estimated_fee_per_gas/"
},
{
"title": "start_eth_fee_estimator",
"href": "/komodo-defi-framework/api/v20-dev/start_eth_fee_estimator/"
},
{
"title": "stop_eth_fee_estimator",
"href": "/komodo-defi-framework/api/v20-dev/stop_eth_fee_estimator/"
},
{
"title": "get_current_mtp",
"href": "/komodo-defi-framework/api/v20-dev/get_current_mtp/"
Expand Down
36 changes: 22 additions & 14 deletions src/pages/komodo-defi-framework/api/common_structures/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,23 +438,31 @@ The `WithdrawFee` object varies depending on the coin or token type. Refer to th

### FilterCriteria

The `FilterCriteria` object includes different criteria to filter from the different recent swaps:
The 'FilterCriteria' object allows you to filter the results based on specific parameters.

| Parameter | Type | Description |
| --------------- | ------ | ---------------------------------------------- |
| status | string | Status of the transactions (e.g., "completed") |
| date\_from | string | \`Start date in ISO 8601 format |
| date\_to | string | End date in ISO 8601 format |
| my\_coin | string | Coin being used by you for the swap/trade. |
| other\_coin | string | Coin you are trading against |
| from\_timestamp | number | Start timestamp in UNIX format |
| to\_timestamp | number | End timestamp in UNIX format |

| Parameter | Type | Description |
| ---------- | ------------------------ | ---------------------------------------------------------------------- |
| status | object | Return only swaps that match the specified status (e.g., "completed"). |
| date\_from | string (ISO 8601 format) | Return only swaps that started on or after this date. |
| date\_to | string (ISO 8601 format) | Return only swaps that started before this date. |

<CollapsibleSection expandedText="Hide Examples" collapsedText="Show Examples">
<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
#### Example

```json
{
"filter": {
"status": "completed",
"date_from": "2024-01-01T00:00:00Z",
"date_to": "2024-07-01T00:00:00Z"
"status": "completed",
"date_from": "2024-01-01T00:00:00Z",
"date_to": "2024-07-01T00:00:00Z",
"my_coin": "BTC",
"other_coin": "ETH",
"from_timestamp": 1672531200,
"to_timestamp": 1704067200
}
}
```
Expand All @@ -476,9 +484,9 @@ The `PagingOptions` object includes options of page selection to consult when lo
```json
{
"paging_options": {
"from_uuid": null,
"limit": 10,
"page_number": 1
"from_uuid": null,
"limit": 10,
"page_number": 1
}
}
```
Expand Down
Loading
Loading