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.

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

Add/gas fee estimator docs #293

Draft
wants to merge 12 commits into
base: dev
Choose a base branch
from
27 changes: 26 additions & 1 deletion filepathSlugs.json
Original file line number Diff line number Diff line change
Expand Up @@ -2043,7 +2043,11 @@
"example-of-eth-type",
"example-of-qrc20-type",
"example-of-tendermint-type",
"example-of-utxo-type"
"example-of-utxo-type",
"filter-criteria",
"example-4",
"paging-options",
"example-5"
],
"src/pages/komodo-defi-framework/api/common_structures/lightning/index.mdx": [
"lightning-network-structures",
Expand Down Expand Up @@ -2932,6 +2936,14 @@
"response-not-valid",
"error-types-2"
],
"src/pages/komodo-defi-framework/api/v20/my_recent_swaps_v2/index.mdx": [
"my-recent-swaps",
"arguments",
"response",
"example",
"command",
"response-success"
],
"src/pages/komodo-defi-framework/api/v20/my_tx_history/index.mdx": [
"my-tx-history",
"arguments",
Expand Down Expand Up @@ -3103,6 +3115,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 @@ -3382,6 +3399,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_gas_fee_estimator/index.mdx": [
"start-gas-fee-estimator",
"response"
],
"src/pages/komodo-defi-framework/api/v20-dev/stop_gas_fee_estimator/index.mdx": [
"stop-gas-fee-estimator",
"response"
],
"src/pages/komodo-defi-framework/api/v20-dev/task_account_balance/index.mdx": [
"account-balance-tasks",
"init",
Expand Down
56 changes: 56 additions & 0 deletions src/pages/komodo-defi-framework/api/common_structures/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -395,3 +395,59 @@ The `WithdrawFee` object varies depending on the coin or token type. Refer to th
}
```
</CollapsibleSection>

### FilterCriteria

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 |

<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",
"my_coin": "BTC",
"other_coin": "ETH",
"from_timestamp": 1672531200,
"to_timestamp": 1704067200
}
}
```
</CollapsibleSection>

### PagingOptions

The PagingOptions object allows you to specify pagination details for the results.

| Parameter | Type | Description |
| ------------ | ---------------- | --------------------------------------------- |
| from\_uuid | string (or null) | The UUID from which to start fetching results |
| limit | number | The UUID from which to start fetching results |
| page\_number | number | End date in ISO 8601 format |

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

```json
{
"paging_options": {
"from_uuid": null,
"limit": 10,
"page_number": 1
}
}
```
</CollapsibleSection>
Loading
Loading