Skip to content

Commit 17566f6

Browse files
smk762smk762
committed
linting and fix broken links
1 parent 87d8a7c commit 17566f6

File tree

14 files changed

+220
-281
lines changed

14 files changed

+220
-281
lines changed

‎filepathSlugs.json

+18-55
Original file line numberDiff line numberDiff line change
@@ -2006,20 +2006,20 @@
20062006
],
20072007
"src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx": [
20082008
"activation-structures",
2009-
"activation-params",
2009+
"account-address-info",
20102010
"activation-mode",
2011+
"activation-params",
20112012
"activation-rpc-data",
20122013
"activation-servers",
20132014
"zhtlc-example",
20142015
"hd-utxo-activation-v2",
2016+
"address-derivation-path",
2017+
"address-info",
2018+
"example-with-balances",
2019+
"example-without-balances",
20152020
"coin-protocol",
20162021
"coin-protocol-data",
20172022
"evm-node",
2018-
"v2-1-0-current-release",
2019-
"v2-2-0",
2020-
"tendermint-node",
2021-
"v2-1-0-current-release-2",
2022-
"v2-2-0-2",
20232023
"swap-v2-contracts",
20242024
"tokens-request",
20252025
"utxo-merge-params"
@@ -2028,10 +2028,7 @@
20282028
"komodo-de-fi-sdk-common-structures",
20292029
"address-format",
20302030
"example",
2031-
"address-info",
2032-
"example-with-balances",
2033-
"example-without-balances",
2034-
"balance-infos",
2031+
"balance-info",
20352032
"derivation-method",
20362033
"event-stream-config",
20372034
"numeric-formats-value",
@@ -2173,9 +2170,16 @@
21732170
],
21742171
"src/pages/komodo-defi-framework/api/common_structures/wallet/index.mdx": [
21752172
"wallet-operations-structures",
2176-
"raw-tx-info",
2173+
"history-target",
2174+
"example",
21772175
"input-txns",
2178-
"pay-for-gas"
2176+
"new-address-info",
2177+
"pay-for-gas",
2178+
"raw-tx-info",
2179+
"scan-addresses-info",
2180+
"wallet-balance-info",
2181+
"withdraw-from-info",
2182+
"wallet-account-info"
21792183
],
21802184
"src/pages/komodo-defi-framework/api/index.mdx": [
21812185
"komodo-de-fi-framework-rpc-methods"
@@ -2792,12 +2796,10 @@
27922796
"request-parameters",
27932797
"response-parameters",
27942798
"examples",
2795-
"request-using-rpc-urls-parameter-kdf-version-2-2-0",
2796-
"response",
27972799
"request-with-get-balances-set-to-false",
2800+
"response",
2801+
"request-with-get-balances-as-true",
27982802
"response-2",
2799-
"request-using-nodes-parameter-kdf-version-2-2-0",
2800-
"response-3",
28012803
"error-types",
28022804
"platform-config-is-not-found-error",
28032805
"platform-is-already-activated-error",
@@ -2897,45 +2899,6 @@
28972899
"response-success-2",
28982900
"response-error-2",
28992901
"common-komodo-de-fi-sdk-request-response-objects",
2900-
"activation-params",
2901-
"activation-mode",
2902-
"activation-rpc-data",
2903-
"activation-servers",
2904-
"zhtlc-example",
2905-
"hd-utxo-activation-v2",
2906-
"hd-utxo-activation-v2-2",
2907-
"address-derivation-path",
2908-
"address-infos",
2909-
"example-with-balances",
2910-
"example-without-balances",
2911-
"balance-info",
2912-
"derivation-method",
2913-
"coin-protocol",
2914-
"coin-protocol-data",
2915-
"confirmation-targets",
2916-
"counterparty-channel-config",
2917-
"fee-info",
2918-
"lightning-activation-params",
2919-
"lightning-channel-amount",
2920-
"lightning-channel-config",
2921-
"lightning-channel-options",
2922-
"lightning-closed-channels-filter",
2923-
"lightning-open-channels-filter",
2924-
"lightning-payment",
2925-
"lightning-payment-filter",
2926-
"lightning-payment-type",
2927-
"pagination",
2928-
"example",
2929-
"history-target",
2930-
"example-2",
2931-
"tokens-request",
2932-
"wallet-balance-info",
2933-
"withdraw-from-info",
2934-
"fee-info-2",
2935-
"scan-addresses-info",
2936-
"new-address-info",
2937-
"wallet-account-info",
2938-
"account-address-info",
29392902
"error-types",
29402903
"not-sufficient-balance",
29412904
"response-not-sufficient-balance-error",

‎src/pages/komodo-defi-framework/api/common_structures/activation/index.mdx

+12-15
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The `AccountAddressInfo` object includes the following items for active addresse
1212
| address | string | The account address for a specific derivation path under the `account_index`. |
1313
| derivation\_path | string | The [BIP44 derivation path](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) of the address. |
1414
| chain | string | `External` or `Internal`, as defined in the activation request. |
15-
| balance | object | A standard [balanceInfo](/komodo-defi-framework/api/v20/#balance-info) object. |
15+
| balance | object | A standard [balanceInfo](/komodo-defi-framework/api/common_structures/#balance-info) object. |
1616

1717
<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
1818
```json
@@ -65,15 +65,15 @@ The `ActivationParams` object defines additional parameters used for activation.
6565
| ---------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
6666
| required\_confirmations | integer | Optional. Confirmations to wait for steps in swap. Defaults to value in the coins file if not set. |
6767
| requires\_notarization | boolean | Optional, defaults to `false`. For [dPoW](https://komodoplatform.com/en/blog/dpow-demystified/) protected coins, a `true` value will wait for transactions to be notarised when doing swaps. Overrides value if set in `coins` file. |
68-
| mode | object | QTUM, UTXO & ZHTLC coins only. A standard [ActivationMode](/komodo-defi-framework/api/v20/#activation-mode) object. |
68+
| mode | object | QTUM, UTXO & ZHTLC coins only. A standard [ActivationMode](/komodo-defi-framework/api/common_structures/activation/#activation-mode) object. |
6969
| zcash\_params\_path | string | ZHTLC coins only. Path to folder containing [Zcash parameters](https://z.cash/learn/). Optional, defaults to standard location as defined in [this guide](https://forum.komodoplatform.com/t/installing-zcash-params/603) |
7070
| scan\_blocks\_per\_iteration | integer | ZHTLC coins only. Sets the number of scanned blocks per iteration during `BuildingWalletDb` state. Optional, default value is 1000. |
7171
| scan\_interval\_ms | integer | ZHTLC coins only. Sets the interval in milliseconds between iterations of `BuildingWalletDb` state. Optional, default value is 0. |
7272
| tx\_history | boolean | Optional. Enable transaction history scanning. When active, the Komodo DeFi Framework API will collect transaction history data for local storage, and allow use of the [my\_tx\_history (v2)](/komodo-defi-framework/api/v20/wallet/tx/my_tx_history/) method. |
7373
| min\_addresses\_number | integer | Optional, HD wallets only. Number of addresses to generate. If not specified, addresses will be generated up to `path_to_address::address_index`. |
7474
| scan\_policy | string | Optional, HD wallets only. Whether or not to scan for new addresses. Select from `do_not_scan`, `scan_if_new_wallet` or `scan`. Defaults to `scan_if_new_wallet`. Note that `scan` will result in multple requests to the Komodo DeFi API and may take some time to complete. |
7575
| gap\_limit | integer | Optional, HD wallets only. The max number of empty addresses in a row. Transactions sent to an address outside the `gap_limit`, will not be identified when scanning. Defaults to `20`. |
76-
| path\_to\_address | object | Optional, HD wallets only. A standard [AddressDerivationPath](/komodo-defi-framework/api/v20/#address-derivation-path) object. |
76+
| path\_to\_address | object | Optional, HD wallets only. A standard [AddressDerivationPath](/komodo-defi-framework/api/common_structures/activation/#address-derivation-path) object. |
7777
| get\_balances | boolean | Optional, defaults to `true`. If `false`, coin and token balances will not be returned in the response, and the response will be returned more quickly. |
7878

7979
<Note>
@@ -172,7 +172,6 @@ Contains information electrum servers for coins being used in `Electrum` or `Lig
172172
```
173173
</CollapsibleSection>
174174

175-
176175
### AddressDerivationPath
177176

178177
The `AddressDerivationPath` object defines the account / change / address\_index of the [derivation path](https://medium.com/mycrypto/wtf-is-a-derivation-path-c3493ca2eb52) used for your wallet. Using different values for `account_id` or `address_id` parameters will result in a different address and private key for each combination. The `chain` parameter is used to specify if the change from a transaction. Set to `External` for addresses that are intended to be visible outside of the wallet (e.g. for receiving payments). `Internal` is used for addresses which are not meant to be visible outside of the wallet and is used to return the leftover change from a transaction.
@@ -195,17 +194,16 @@ The `AddressDerivationPath` object defines the account / change / address\_index
195194
```
196195
</CollapsibleSection>
197196

198-
199197
### AddressInfo
200198

201199
The `AddressInfo` object includes the following items for a given address:
202200

203-
| Parameter | Type | Description |
204-
| ------------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
205-
| balances | object | A standard [balanceInfos](/komodo-defi-framework/api/common_structures/#balance-infos) object. Not included in responses where `get_balances` is `false` |
206-
| derivation\_method | object | A standard [DerivationMethod](/komodo-defi-framework/api/common_structures/#derivation-method) object |
207-
| pubkey | string | The public key associated with the seed used to launch Komodo DeFi Framework |
208-
| tickers | array | A list of tokens which were successfully activated. Only included in responses where `get_balances` is `false` |
201+
| Parameter | Type | Description |
202+
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
203+
| balances | object | A standard [balanceInfo](/komodo-defi-framework/api/common_structures/#balance-info) object. Not included in responses where `get_balances` is `false` |
204+
| derivation\_method | object | A standard [DerivationMethod](/komodo-defi-framework/api/common_structures/#derivation-method) object |
205+
| pubkey | string | The public key associated with the seed used to launch Komodo DeFi Framework |
206+
| tickers | array | A list of tokens which were successfully activated. Only included in responses where `get_balances` is `false` |
209207

210208
<CollapsibleSection expandedText="Hide Examples" collapsedText="Show Examples">
211209
#### Example with balances
@@ -255,9 +253,9 @@ The `AddressInfo` object includes the following items for a given address:
255253

256254
The `EvmNode` object includes the following items for a given coin or token:
257255

258-
| Parameter | Type | Description |
259-
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------- |
260-
| url | string | URL of an RPC node |
256+
| Parameter | Type | Description |
257+
| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
258+
| url | string | URL of an RPC node |
261259
| komodo\_proxy | boolean | Optional, defaults to `false`. Must be set to `true` to access RPC nodes run officially by the Komodo Platform team |
262260

263261
<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
@@ -307,7 +305,6 @@ The `TokensRequest` object includes the following items for a given coin or toke
307305
```
308306
</CollapsibleSection>
309307

310-
311308
### UtxoMergeParams
312309

313310
The `UtxoMergeParams` object defines how often and at which thresholds to merge UTXOs. This is useful for wallets which have been used for a long time, and have many small UTXOs from mining activity.

‎src/pages/komodo-defi-framework/api/common_structures/index.mdx

-18
Original file line numberDiff line numberDiff line change
@@ -55,24 +55,6 @@ The `balanceInfo` object includes the following items for a given coin or token:
5555
```
5656
</CollapsibleSection>
5757

58-
### BalanceInfos
59-
60-
The `balanceInfos` object includes the following items for a given coin or token:
61-
62-
| Parameter | Type | Description |
63-
| ----------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ |
64-
| spendable | string (numeric) | The available amount of a coin or token which is ready to be traded or withdrawn. |
65-
| unspendable | string (numeric) | The amount of a coin or token which is awaiting confirmation on the block chain for an incoming or outgoing transaction. |
66-
67-
<CollapsibleSection expandedText="Hide Example" collapsedText="Show Example">
68-
```json
69-
{
70-
"spendable": "12.11398301",
71-
"unspendable": "0.53"
72-
}
73-
```
74-
</CollapsibleSection>
75-
7658
### DerivationMethod
7759

7860
The `DerivationMethod` object includes the following items for a given coin or token:

0 commit comments

Comments
 (0)