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

[wip] Update/binary kdf #364

Merged
merged 12 commits into from
Jan 30, 2025
Merged

[wip] Update/binary kdf #364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5c31042
update binary name mm2 -> kdf
smk762 Oct 30, 2024
b634ed9
Merge branch 'dev' into update/binary-kdf
smk762 Nov 14, 2024
cb313db
[Bot] File and author data updated, validated and updated internal li…
smk762 Nov 14, 2024
f4e23d5
Merge pull request #381 from KomodoPlatform/lint-fix-patches/update/b…
gcharang Nov 17, 2024
1f180ba
Merge branch 'dev' into update/binary-kdf
smk762 Jan 30, 2025
8a59492
linting
smk762 Jan 30, 2025
8389139
update links and filenames mm2 -> kdf
smk762 Jan 30, 2025
3bbd02d
Merge branch 'dev' into update/binary-kdf
smk762 Jan 30, 2025
2a50eaa
linting
smk762 Jan 30, 2025
d19dff7
hexidecimal -> hexadecimal
smk762 Jan 30, 2025
030d59e
revert redirect source url
smk762 Jan 30, 2025
3a50e29
revert redirect source url
smk762 Jan 30, 2025
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
58 changes: 29 additions & 29 deletions data-for-gpts/all-content.txt
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions data-for-gpts/komodefi-api/all-api-content.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,7 +749,7 @@ Using the recommended values in the above table with a coin that has a block tim
| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | string | The name of the node that will be used in [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) |
| listening port | integer | Optional, defaults to `9735`. The port that this node listens for incoming connections on. |
| 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) |
| 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) |
| payment\_retries | integer | Optional, defaults to `5`. Number of times a payment will be retried if it fails. |
| backup\_path | string | Optional. The backup path for channel backups, preferably on an external drive. |

Expand Down Expand Up @@ -793,7 +793,7 @@ For GUIs and wallet apps, it is recommended to set `announced_channel` to `false
| Parameter | Type | Description |
| ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| channel\_id | string | Optional. Unique string identifying a channel by its ID. |
| counterparty\_node\_id | string | Optional. A hexidecimal string identifying a counterparty node. |
| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. |
| funding\_tx | string | Optional. A transaction ID which added funds. |
| from\_funding\_value | integer | Optional. The minimum value of channel funding in satoshis. |
| to\_funding\_value | integer | Optional. The maximum value of channel funding in satoshis. |
Expand All @@ -813,7 +813,7 @@ Response may change to be more consistent in future.
| Parameter | Type | Description |
| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| channel\_id | string | Optional. Unique string identifying a channel by its ID. |
| counterparty\_node\_id | string | Optional. A hexidecimal string identifying a counterparty node. |
| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. |
| funding\_tx | string | Optional. A transaction ID which added funds. |
| from\_funding\_value\_sats | integer | Optional. The minimum value of channel funding in satoshis. |
| to\_funding\_value\_sats | integer | Optional. The maximum value of channel funding in satoshis. |
Expand Down Expand Up @@ -14076,7 +14076,7 @@ The `FeeInfo` response object includes the following items for [withdraw (v2)](/
| ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | string | The name of the node that will be used in [lightning explorers](https://mempool.space/testnet/lightning/node/024e2a940e0cbeda84a0d5e00fa8e83b3f4e7f98382eedb488d058e0f5636dd164/r/n) |
| listening port | integer | Optional, defaults to `9735`. The port that this node listens for incoming connections on. |
| 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) |
| 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) |
| payment\_retries | integer | Optional, defaults to `5`. Number of times a payment will be retried if it fails. |
| backup\_path | string | Optional. The backup path for channel backups, preferably on an external drive. |

Expand Down Expand Up @@ -14120,7 +14120,7 @@ For GUIs and wallet apps, it is recommended to set `announced_channel` to `false
| Parameter | Type | Description |
| ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| channel\_id | string | Optional. Unique string identifying a channel by its ID. |
| counterparty\_node\_id | string | Optional. A hexidecimal string identifying a counterparty node. |
| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. |
| funding\_tx | string | Optional. A transaction ID which added funds. |
| from\_funding\_value | integer | Optional. The minimum value of channel funding in satoshis. |
| to\_funding\_value | integer | Optional. The maximum value of channel funding in satoshis. |
Expand All @@ -14140,7 +14140,7 @@ Response may change to be more consistent in future.
| Parameter | Type | Description |
| ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| channel\_id | string | Optional. Unique string identifying a channel by its ID. |
| counterparty\_node\_id | string | Optional. A hexidecimal string identifying a counterparty node. |
| counterparty\_node\_id | string | Optional. A hexadecimal string identifying a counterparty node. |
| funding\_tx | string | Optional. A transaction ID which added funds. |
| from\_funding\_value\_sats | integer | Optional. The minimum value of channel funding in satoshis. |
| to\_funding\_value\_sats | integer | Optional. The maximum value of channel funding in satoshis. |
Expand Down Expand Up @@ -16290,7 +16290,7 @@ The `lightning::payments::get_payment_details` method returns details about a li
| Parameter | Type | Description |
| ------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| coin | string | Ticker of the coin to query. |
| 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. |
| 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. |

#### 📌 Example

Expand Down Expand Up @@ -21037,11 +21037,11 @@ The request was failed due to a Komodo DeFi Framework API internal error.
}
```
export const title = "Komodo DeFi Framework Method: Add Node to Version Stat";
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.";
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.";

# add\_node\_to\_version\_stat

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:
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:

`07 09:33:58, atomicdex_behaviour:610] INFO Local peer id: PeerId("12D3KooWReXsTVCKGAna1tzrD1jaUttTSs17ULFuvvzoGD9bqmmA")
`
Expand Down Expand Up @@ -21723,11 +21723,11 @@ The `peer_connection_healthcheck` method checks if a peer is connected to the KD
}
```
export const title = "Komodo DeFi Framework Method: Remove Node from Version Stat";
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.";
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.";

# remove\_node\_from\_version\_stat

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".
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".

## Arguments

Expand Down
Loading