Skip to content

Commit 9239574

Browse files
gcharanggcharang
authored
Merge pull request #364 from KomodoPlatform/update/binary-kdf
2 parents 4a03a49 + 3a50e29 commit 9239574

File tree

57 files changed

+356
-301
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+356
-301
lines changed

‎data-for-gpts/all-content.txt

+29-29
Large diffs are not rendered by default.

‎data-for-gpts/komodefi-api/all-api-content.txt

+11-11
Original file line numberDiff line numberDiff line change
@@ -749,7 +749,7 @@ Using the recommended values in the above table with a coin that has a block tim
749749
| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
750750
| name | string | The name of the node that will be used in [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) |
751751
| listening port | integer | Optional, defaults to `9735`. The port that this node listens for incoming connections on. |
752-
| color | string | Optional, defaults to `2b6680`. A hexidecimal color string which will be used in network graphs on [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) |
752+
| color | string | Optional, defaults to `2b6680`. A hexadecimal color string which will be used in network graphs on [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) |
753753
| payment\_retries | integer | Optional, defaults to `5`. Number of times a payment will be retried if it fails. |
754754
| backup\_path | string | Optional. The backup path for channel backups, preferably on an external drive. |
755755

@@ -793,7 +793,7 @@ For GUIs and wallet apps, it is recommended to set `announced_channel` to `false
793793
| Parameter | Type | Description |
794794
| ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
795795
| channel\_id | string | Optional. Unique string identifying a channel by its ID. |
796-
| counterparty\_node\_id | string | Optional. A hexidecimal string identifying a counterparty node. |
796+
| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. |
797797
| funding\_tx | string | Optional. A transaction ID which added funds. |
798798
| from\_funding\_value | integer | Optional. The minimum value of channel funding in satoshis. |
799799
| to\_funding\_value | integer | Optional. The maximum value of channel funding in satoshis. |
@@ -813,7 +813,7 @@ Response may change to be more consistent in future.
813813
| Parameter | Type | Description |
814814
| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
815815
| channel\_id | string | Optional. Unique string identifying a channel by its ID. |
816-
| counterparty\_node\_id | string | Optional. A hexidecimal string identifying a counterparty node. |
816+
| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. |
817817
| funding\_tx | string | Optional. A transaction ID which added funds. |
818818
| from\_funding\_value\_sats | integer | Optional. The minimum value of channel funding in satoshis. |
819819
| to\_funding\_value\_sats | integer | Optional. The maximum value of channel funding in satoshis. |
@@ -14076,7 +14076,7 @@ The `FeeInfo` response object includes the following items for [withdraw (v2)](/
1407614076
| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1407714077
| name | string | The name of the node that will be used in [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) |
1407814078
| listening port | integer | Optional, defaults to `9735`. The port that this node listens for incoming connections on. |
14079-
| color | string | Optional, defaults to `2b6680`. A hexidecimal color string which will be used in network graphs on [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) |
14079+
| color | string | Optional, defaults to `2b6680`. A hexadecimal color string which will be used in network graphs on [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) |
1408014080
| payment\_retries | integer | Optional, defaults to `5`. Number of times a payment will be retried if it fails. |
1408114081
| backup\_path | string | Optional. The backup path for channel backups, preferably on an external drive. |
1408214082

@@ -14120,7 +14120,7 @@ For GUIs and wallet apps, it is recommended to set `announced_channel` to `false
1412014120
| Parameter | Type | Description |
1412114121
| ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
1412214122
| channel\_id | string | Optional. Unique string identifying a channel by its ID. |
14123-
| counterparty\_node\_id | string | Optional. A hexidecimal string identifying a counterparty node. |
14123+
| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. |
1412414124
| funding\_tx | string | Optional. A transaction ID which added funds. |
1412514125
| from\_funding\_value | integer | Optional. The minimum value of channel funding in satoshis. |
1412614126
| to\_funding\_value | integer | Optional. The maximum value of channel funding in satoshis. |
@@ -14140,7 +14140,7 @@ Response may change to be more consistent in future.
1414014140
| Parameter | Type | Description |
1414114141
| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1414214142
| channel\_id | string | Optional. Unique string identifying a channel by its ID. |
14143-
| counterparty\_node\_id | string | Optional. A hexidecimal string identifying a counterparty node. |
14143+
| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. |
1414414144
| funding\_tx | string | Optional. A transaction ID which added funds. |
1414514145
| from\_funding\_value\_sats | integer | Optional. The minimum value of channel funding in satoshis. |
1414614146
| to\_funding\_value\_sats | integer | Optional. The maximum value of channel funding in satoshis. |
@@ -16290,7 +16290,7 @@ The `lightning::payments::get_payment_details` method returns details about a li
1629016290
| Parameter | Type | Description |
1629116291
| ------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1629216292
| coin | string | Ticker of the coin to query. |
16293-
| payment\_hash | string | The hexidecimal string which identifies a invoice. The payment\_hash is returned from a `lightning::payments::send_payment` request if the payment was sent by us, or from a `lightning::payments::generate_invoice` request if the payment is received (or will be received) by us. |
16293+
| payment\_hash | string | The hexadecimal string which identifies a invoice. The payment\_hash is returned from a `lightning::payments::send_payment` request if the payment was sent by us, or from a `lightning::payments::generate_invoice` request if the payment is received (or will be received) by us. |
1629416294

1629516295
#### 📌 Example
1629616296

@@ -21037,11 +21037,11 @@ The request was failed due to a Komodo DeFi Framework API internal error.
2103721037
}
2103821038
```
2103921039
export const title = "Komodo DeFi Framework Method: Add Node to Version Stat";
21040-
export const description = "The add_node_to_version_stat method adds a Node's name, IP address and PeerID to a local database to track which version of MM2 it is running.";
21040+
export const description = "The add_node_to_version_stat method adds a Node's name, IP address and PeerID to a local database to track which version of [KDF](https://github.com/KomodoPlatform/komodo-defi-framework) it is running.";
2104121041

2104221042
# add\_node\_to\_version\_stat
2104321043

21044-
The `add_node_to_version_stat` method adds a Node's name, IP address and PeerID to a local database to track which version of MM2 it is running. The name parameter is an arbitrary identifying string, such as "seed\_alpha" or "dragonhound\_DEV". The address parameter is the node's IP address or domain names. The Peer ID can be found in the MM2 log file after a connection has been initiated, and looks like the below:
21044+
The `add_node_to_version_stat` method adds a Node's name, IP address and PeerID to a local database to track which version of [KDF](https://github.com/KomodoPlatform/komodo-defi-framework) it is running. The name parameter is an arbitrary identifying string, such as "seed\_alpha" or "dragonhound\_DEV". The address parameter is the node's IP address or domain names. The Peer ID can be found in the MM2 log file after a connection has been initiated, and looks like the below:
2104521045

2104621046
`07 09:33:58, atomicdex_behaviour:610] INFO Local peer id: PeerId("12D3KooWReXsTVCKGAna1tzrD1jaUttTSs17ULFuvvzoGD9bqmmA")
2104721047
`
@@ -21723,11 +21723,11 @@ The `peer_connection_healthcheck` method checks if a peer is connected to the KD
2172321723
}
2172421724
```
2172521725
export const title = "Komodo DeFi Framework Method: Remove Node from Version Stat";
21726-
export const description = "The remove_node_from_version_stat method removes a Node from the local database that tracks which version of MM2 it is running.";
21726+
export const description = "The remove_node_from_version_stat method removes a Node from the local database that tracks which version of [KDF](https://github.com/KomodoPlatform/komodo-defi-framework) it is running.";
2172721727

2172821728
# remove\_node\_from\_version\_stat
2172921729

21730-
The `remove_node_from_version_stat` method removes a Node (by name) from the local database which tracks which version of MM2 it is running. The name parameter is an arbitrary identifying string, such as "seed\_alpha" or "dragonhound\_DEV".
21730+
The `remove_node_from_version_stat` method removes a Node (by name) from the local database which tracks which version of [KDF](https://github.com/KomodoPlatform/komodo-defi-framework) it is running. The name parameter is an arbitrary identifying string, such as "seed\_alpha" or "dragonhound\_DEV".
2173121731

2173221732
## Arguments
2173321733

0 commit comments

Comments
 (0)