From 5c31042602ca8529d848f99a49e0c2da2419a9ec Mon Sep 17 00:00:00 2001 From: smk762 Date: Thu, 31 Oct 2024 01:51:03 +0800 Subject: [PATCH] update binary name mm2 -> kdf --- src/data/sidebar.json | 6 ++-- .../v20/add_node_to_version_stat/index.mdx | 4 +-- .../remove_node_from_version_stat/index.mdx | 4 +-- .../setup/configure-mm2-json/index.mdx | 8 ++--- .../komodo-defi-framework/setup/index.mdx | 2 +- .../tutorials/api-walkthrough/index.mdx | 4 +-- .../tutorials/coins-file-update/index.mdx | 8 ++--- .../index.mdx | 6 ++-- .../query-the-mm2-database/index.mdx | 4 +-- .../setup-komodefi-api-aws/index.mdx | 10 +++--- .../using-komodefi-cli-in-console/index.mdx | 34 +++++++++---------- .../desktop/access-log-files/index.mdx | 2 +- src/pages/notary/index.mdx | 2 +- .../qa/komodefi-api-quickstart/index.mdx | 10 +++--- .../index.mdx | 16 ++++----- 15 files changed, 60 insertions(+), 60 deletions(-) diff --git a/src/data/sidebar.json b/src/data/sidebar.json index 9bdda563..a4e524ab 100644 --- a/src/data/sidebar.json +++ b/src/data/sidebar.json @@ -138,11 +138,11 @@ "href": "/komodo-defi-framework/tutorials/api-docker-telegram/" }, { - "title": "Compile MM2 from Source", + "title": "Compile KDF from Source", "href": "/komodo-defi-framework/tutorials/how-to-compile-mm2-from-source/" }, { - "title": "How to Query the MM2 SQLite Database", + "title": "How to Query the KDF SQLite Database", "href": "/komodo-defi-framework/tutorials/query-the-mm2-database/" }, { @@ -331,7 +331,7 @@ "href": "/komodo-wallet/desktop/access-log-files/" }, { - "title": "Send Commands to an MM2 Instance Being Run by Komodo Wallet using Postman", + "title": "Send Commands to an KDF Instance Being Run by Komodo Wallet using Postman", "href": "/komodo-wallet/desktop/send-commands-to-mm2-instance/" } ] diff --git a/src/pages/komodo-defi-framework/api/v20/add_node_to_version_stat/index.mdx b/src/pages/komodo-defi-framework/api/v20/add_node_to_version_stat/index.mdx index ea0eb474..b811ccf0 100644 --- a/src/pages/komodo-defi-framework/api/v20/add_node_to_version_stat/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/add_node_to_version_stat/index.mdx @@ -1,9 +1,9 @@ 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 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 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 KDF 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") ` diff --git a/src/pages/komodo-defi-framework/api/v20/remove_node_from_version_stat/index.mdx b/src/pages/komodo-defi-framework/api/v20/remove_node_from_version_stat/index.mdx index adb624b5..0bb3fa15 100644 --- a/src/pages/komodo-defi-framework/api/v20/remove_node_from_version_stat/index.mdx +++ b/src/pages/komodo-defi-framework/api/v20/remove_node_from_version_stat/index.mdx @@ -1,9 +1,9 @@ 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 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 it is running. The name parameter is an arbitrary identifying string, such as "seed\_alpha" or "dragonhound\_DEV". ## Arguments diff --git a/src/pages/komodo-defi-framework/setup/configure-mm2-json/index.mdx b/src/pages/komodo-defi-framework/setup/configure-mm2-json/index.mdx index 90c9c8c6..4a1f0d06 100644 --- a/src/pages/komodo-defi-framework/setup/configure-mm2-json/index.mdx +++ b/src/pages/komodo-defi-framework/setup/configure-mm2-json/index.mdx @@ -4,11 +4,11 @@ export const description = # Komodo DeFi API configuration -Komodo DeFi-API configuration parameters, along with additional runtime flags, and per-process environment variables are [listed in the source code](https://github.com/KomodoPlatform/komodo-defi-framework/blob/main/mm2src/mm2_main/src/mm2.rs#L151-L205), and can be viewed by running the `./mm2 --help`. +Komodo DeFi-API configuration parameters, along with additional runtime flags, and per-process environment variables are [listed in the source code](https://github.com/KomodoPlatform/komodo-defi-framework/blob/main/mm2src/mm2_main/src/mm2.rs#L151-L205), and can be viewed by running the `./kdf --help`. ## MM2.json -When running the Komodo DeFi API via commandline with the `mm2` binary, some basic configuration parameters need to be defined in either an `MM2.json` file, or at runtime. +When running the Komodo DeFi API via commandline with the `kdf` binary, some basic configuration parameters need to be defined in either an `MM2.json` file, or at runtime. ### Configuration Parameters @@ -19,7 +19,7 @@ When running the Komodo DeFi API via commandline with the `mm2` binary, some bas | passphrase | string | Your passphrase; this is the source of each of your coins private keys. [**KEEP IT SAFE!**](https://www.youtube.com/watch?v=WFpxVbTqhB8) | | rpc\_password | string | For RPC requests that need authentication, this will need to match the `userpass` value in the request body. | | allow\_weak\_password | boolean | Optional, defaults to `false`. If `true`, will allow low entropy rpc\_password. If `false` rpc\_password must not have 3 of the same characters in a row, must be between 8-32 characters in length, must contain at least one of each of the following: numeric, uppercase, lowercase, special character (e.g. !#$\*). It also can not contain the word "password", or the chars `<`, `>`, or `&`. | -| dbdir | string | Optional, defaults to a subfolder named `DB` in the path of your `mm2` binary. This path will store the Komodo DeFi-API database data. | +| dbdir | string | Optional, defaults to a subfolder named `DB` in the path of your `kdf` binary. This path will store the Komodo DeFi-API database data. | | rpcip | string | Optional, defaults to `127.0.0.1`. IP address to bind to for RPC server. | | rpcport | integer | Optional, defaults to `7783`. Port to use for RPC communication. | | rpc\_local\_only | boolean | Optional, defaults to `true`. If `false` the Komodo DeFi Framework API will allow rpc methods sent from external IP addresses. **Warning:** Only use this if you know what you are doing, and have put the appropriate security measures in place. | @@ -111,7 +111,7 @@ The structure for adding additional coins can vary, please refer to the [listing | Variable | Type | Description | | ------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| MM2\_CONF\_PATH | string | A file path to load the `MM2.json` configuration file. Defaults to `MM2.json` in the same folder as the `mm2` binary. | +| MM2\_CONF\_PATH | string | A file path to load the `MM2.json` configuration file. Defaults to `MM2.json` in the same folder as the `kdf` binary. | | MM\_COINS\_PATH | string | A file path to load the `coins` configuration file. A comprehensive version for public use is maintained in the [Komodo Platform coins github repository](https://github.com/KomodoPlatform/coins/blob/master/coins) | | MM\_LOG | string | A file path to store the Komodo DeFi-API logs. | | USERPASS | string | For convenience, this variable can store the value of your `rpc_password` to be referenced in any shell scripts | diff --git a/src/pages/komodo-defi-framework/setup/index.mdx b/src/pages/komodo-defi-framework/setup/index.mdx index 55d5b3ff..206e58be 100644 --- a/src/pages/komodo-defi-framework/setup/index.mdx +++ b/src/pages/komodo-defi-framework/setup/index.mdx @@ -179,4 +179,4 @@ If everything installed successfully, a response that is similar to the followin “Finished dev [optimized + debuginfo] target(s) in 3m 33s” ``` -The Komodo DeFi Framework API executable is now built and available here: `~/komodo-defi-framework/target/debug/mm2` +The Komodo DeFi Framework API executable is now built and available here: `~/komodo-defi-framework/target/debug/kdf` diff --git a/src/pages/komodo-defi-framework/tutorials/api-walkthrough/index.mdx b/src/pages/komodo-defi-framework/tutorials/api-walkthrough/index.mdx index 29e5e875..e143432a 100644 --- a/src/pages/komodo-defi-framework/tutorials/api-walkthrough/index.mdx +++ b/src/pages/komodo-defi-framework/tutorials/api-walkthrough/index.mdx @@ -92,7 +92,7 @@ We also need to create an MM2.json file in the same directory as the `coins` fil The MM2.json configuration commands can also be supplied at runtime, as below: ```bash -stdbuf -oL ./mm2 "{\"gui\":\"Docs_Walkthru\",\"netid\":8762, \"passphrase\":\"YOUR_PASSPHRASE_HERE\", \"rpc_password\":\"YOUR_PASSWORD_HERE\"}" & +stdbuf -oL ./kdf "{\"gui\":\"Docs_Walkthru\",\"netid\":8762, \"passphrase\":\"YOUR_PASSPHRASE_HERE\", \"rpc_password\":\"YOUR_PASSWORD_HERE\"}" & ``` Replace `YOUR_PASSPHRASE_HERE` and `YOUR_PASSWORD_HERE` with your actual passphrase and password, and then execute the command in the terminal. @@ -167,7 +167,7 @@ You should now see your userpass printed to the console. The `userpass` environment variable will remain in memory until the session is closed. When you open up a new session later, you'll need to create the `userpass` environment variable again. Additional environment variables for - the Komodo DeFi Framework API can be found in the [configure mm2 + the Komodo DeFi Framework API can be found in the [configure KDF guide](/komodo-defi-framework/setup/configure-mm2-json/). diff --git a/src/pages/komodo-defi-framework/tutorials/coins-file-update/index.mdx b/src/pages/komodo-defi-framework/tutorials/coins-file-update/index.mdx index 3f221944..af6df10a 100644 --- a/src/pages/komodo-defi-framework/tutorials/coins-file-update/index.mdx +++ b/src/pages/komodo-defi-framework/tutorials/coins-file-update/index.mdx @@ -5,10 +5,10 @@ export const description = "This guide describes how to update a coins file in a ## Instructions -* Compile the latest `mm2` binary following [these instructions](/komodo-defi-framework/setup/) -* Place the `coins` file in the old format in the same directory as the compiled `mm2` binary +* Compile the latest `kdf` binary following [these instructions](/komodo-defi-framework/setup/) +* Place the `coins` file in the old format in the same directory as the compiled `kdf` binary * Open a terminal and navigate to the directory with both the files -* Run the following command `./mm2 update_config coins coins_new` +* Run the following command `./kdf update_config coins coins_new` `mm2` can accept any valid paths as the arguments for the source and destination files @@ -23,7 +23,7 @@ Success * You will find a new file named `coins_new` in the same directory with the new format expected by Komodo DeFi Framework * Rename the file named `coins` to `coins_old` and then `coins_new` to `coins` -* `mm2` will use the `coins` file in the new format the next time it is launched +* `kdf` will use the `coins` file in the new format the next time it is launched ## Examples diff --git a/src/pages/komodo-defi-framework/tutorials/how-to-become-a-liquidity-provider/index.mdx b/src/pages/komodo-defi-framework/tutorials/how-to-become-a-liquidity-provider/index.mdx index f5ec0e8b..2eb0c123 100644 --- a/src/pages/komodo-defi-framework/tutorials/how-to-become-a-liquidity-provider/index.mdx +++ b/src/pages/komodo-defi-framework/tutorials/how-to-become-a-liquidity-provider/index.mdx @@ -40,8 +40,8 @@ For example: ```bash mkdir -p ~/komodo-defi-framework/target/debug cd ~/komodo-defi-framework/target/debug -wget https://github.com/KomodoPlatform/komodo-defi-framework/releases/download/beta-2.1.4315/mm2-9fe6e9402-Linux-Release.zip -unzip mm2-9fe6e9402-Linux-Release.zip +wget $(curl --silent https://api.github.com/repos/KomodoPlatform/komodo-defi-framework/releases | jq -r '.[0].assets[] | select(.name | endswith("Linux-Release.zip")).browser_download_url') +unzip *Linux-Release.zip ``` Then you can proceed to [download the coins configuration file](/komodo-defi-framework/tutorials/how-to-become-a-liquidity-provider/#step-2-download-the-coins-configuration-file). @@ -187,7 +187,7 @@ We now have basic scripts to use the Komodo DeFi Framework API as a liquidity pr To start the Komodo DeFi Framework API: ```bash - stdbuf -oL nohup ./mm2 + stdbuf -oL nohup ./kdf ``` diff --git a/src/pages/komodo-defi-framework/tutorials/query-the-mm2-database/index.mdx b/src/pages/komodo-defi-framework/tutorials/query-the-mm2-database/index.mdx index 401c755f..b978b465 100644 --- a/src/pages/komodo-defi-framework/tutorials/query-the-mm2-database/index.mdx +++ b/src/pages/komodo-defi-framework/tutorials/query-the-mm2-database/index.mdx @@ -3,7 +3,7 @@ export const description = "This guide describes how to query the MM2 SQLite dat # How to Query the MM2 SQLite Database -The Komodo DeFi Framework API stores historical information such as swaps and orders within an SQLite database, located under the DB user data folder (e.g. {'{folder continaing mm2 binary}'}/DB/{'{wallet identifying hex string}'}/MM2.db'). +The Komodo DeFi Framework API stores historical information such as swaps and orders within an SQLite database, located under the DB user data folder (e.g. {'{folder continaing kdf binary}'}/DB/{'{wallet identifying hex string}'}/MM2.db'). There are a variety of methods to query sqlite databases. Examples below show how to do a sqlite query in Linux terminal, but first you might need to install sqlite with `sudo apt install sqlite3`. @@ -124,7 +124,7 @@ This table stores a record of results returned by registered nodes [tracked for | -- | --------- | ------------ | -------------------------------------------- | | 0 | id | INTEGER | Primary Key | | 1 | name | VARCHAR(255) | Node name | -| 2 | version | VARCHAR(255) | Node Komodo DeFi Framework API (mm2) version | +| 2 | version | VARCHAR(255) | Node Komodo DeFi Framework API (kdf) version | | 3 | timestamp | INTEGER | Timestamp | | 4 | error | VARCHAR(255) | Error details | diff --git a/src/pages/komodo-defi-framework/tutorials/setup-komodefi-api-aws/index.mdx b/src/pages/komodo-defi-framework/tutorials/setup-komodefi-api-aws/index.mdx index 4c52ef59..2ccddb27 100644 --- a/src/pages/komodo-defi-framework/tutorials/setup-komodefi-api-aws/index.mdx +++ b/src/pages/komodo-defi-framework/tutorials/setup-komodefi-api-aws/index.mdx @@ -19,7 +19,7 @@ apt-get install -y unzip jq curl wget $(curl --silent https://api.github.com/repos/KomodoPlatform/komodo-defi-framework/releases | jq -r '.[0].assets[] | select(.name | endswith("Linux-Release.zip")).browser_download_url') wget https://raw.githubusercontent.com/KomodoPlatform/coins/master/coins unzip *Linux-Release.zip -./mm2 "{\"netid\":8762,\"gui\":\"aws_cli\",\"passphrase\":\"SEED_WORDS_PLEASE_REPLACE\",\"rpc_password\":\"RPC_PASS_PLEASE_REPLACE\",\"myipaddr\":\"0.0.0.0\"}" +./kdf "{\"netid\":8762,\"gui\":\"aws_cli\",\"passphrase\":\"SEED_WORDS_PLEASE_REPLACE\",\"rpc_password\":\"RPC_PASS_PLEASE_REPLACE\",\"myipaddr\":\"0.0.0.0\"}" ``` ## Install AWS CLI , get AWS access credentials @@ -47,9 +47,9 @@ In the terminal commands below, note that you must first change the texts `REPLA ```bash export AWS_ACCESS_KEY_ID=REPLACE_ACCESS_KEY_ID export AWS_SECRET_ACCESS_KEY=REPLACE_SECRET_ACCESS_KEY -aws ec2 create-key-pair --region us-east-1 --key-name mm2Keypair | jq -r .KeyMaterial > ~/.ssh/mm2.pem -chmod 400 ~/.ssh/mm2.pem -sgID=$(aws ec2 create-security-group --region us-east-1 --group-name sgMM2 --description "sg-mm2"| jq -r '.GroupId') +aws ec2 create-key-pair --region us-east-1 --key-name mm2Keypair | jq -r .KeyMaterial > ~/.ssh/kdf.pem +chmod 400 ~/.ssh/kdf.pem +sgID=$(aws ec2 create-security-group --region us-east-1 --group-name sgMM2 --description "sg-kdf"| jq -r '.GroupId') aws ec2 authorize-security-group-ingress --region us-east-1 --group-name sgMM2 --protocol all --cidr 0.0.0.0/0 aws ec2 run-instances --region us-east-1 --image-id ami-083d24fb90054e5f0 --count 1 --instance-type t3.micro --key-name mm2Keypair --security-group-ids $sgID --user-data file://komodo_defi_framework_setup.txt ``` @@ -69,7 +69,7 @@ From the linked page above, copy the "IPv4 Public IP" of the instance and use it ```bash nodeIp=REPLACE_PUBLIC_IP -ssh -o IdentitiesOnly=yes -i ~/.ssh/mm2.pem admin@$nodeIp 'curl -s --url "http://127.0.0.1:7783" --data "{\"userpass\":\"RPC_UserP@SSW0RD\",\"method\":\"version\"}"' +ssh -o IdentitiesOnly=yes -i ~/.ssh/kdf.pem admin@$nodeIp 'curl -s --url "http://127.0.0.1:7783" --data "{\"userpass\":\"RPC_UserP@SSW0RD\",\"method\":\"version\"}"' ``` Edit the command above as necessary to exchange one curl command for another from [the Komodo DeFi Framework API.](/komodo-defi-framework/api/) diff --git a/src/pages/komodo-defi-framework/tutorials/using-komodefi-cli-in-console/index.mdx b/src/pages/komodo-defi-framework/tutorials/using-komodefi-cli-in-console/index.mdx index 835675b2..7d817d5e 100644 --- a/src/pages/komodo-defi-framework/tutorials/using-komodefi-cli-in-console/index.mdx +++ b/src/pages/komodo-defi-framework/tutorials/using-komodefi-cli-in-console/index.mdx @@ -36,7 +36,7 @@ export KOMODEFI_CLI_ROOT=$HOME/komodefi-cli Before using the `komodefi-cli` binary, you need to download the Core API binary. Running the following command to download the latest release: ```bash -komodefi-cli mm2 download +komodefi-cli kdf download ``` #### Configuring the Core API @@ -51,13 +51,13 @@ Which will return ```bash Config is not set -Initialize a predefined coin set and configuration to start mm2 instance with +Initialize a predefined coin set and configuration to start kdf instance with Usage: komodefi-cli init [OPTIONS] Options: --mm-coins-path Coin set file path [default: coins] [aliases: coins] - --mm-conf-path mm2 configuration file path [default: MM2.json] [aliases: conf] + --mm-conf-path kdf configuration file path [default: MM2.json] [aliases: conf] -h, --help Print help ``` @@ -74,7 +74,7 @@ $ komodefi-cli init Config is not set Start collecting mm2_cfg into: /home/smk762/komodefi-cli/MM2.json > gui is set by default: komodefi-cli - > What is the network `mm2` is going to be a part, netid: 8762 + > What is the network `kdf` is going to be a part, netid: 8762 > What is the seed phrase: before device quantum scan agent gift sauce flame devote tiny ripple west > Allow weak password: No > What is the rpc_password: mm2 configuration file path [aliases: conf] + --mm-conf-path kdf configuration file path [aliases: conf] --mm-coins-path Coin set file path [aliases: coins] --mm-log Log file path [aliases: log] -h, --help Print help ``` -For example, to start the Core API and save its runtime logs to \~/logs/mm2.log, you can run the following command: +For example, to start the Core API and save its runtime logs to \~/logs/kdf.log, you can run the following command: ```bash -$ komodefi-cli mm2 start --mm-log ~/logs/mm2.log -> Set env MM_LOG as: ~/logs/mm2.log -> Started child process: "mm2", pid: 459264 +$ komodefi-cli kdf start --mm-log ~/logs/kdf.log +> Set env MM_LOG as: ~/logs/kdf.log +> Started child process: "kdf", pid: 459264 ``` ## Usage @@ -127,14 +127,14 @@ From here, you are ready to use the `komodefi-cli` binary to interact with the K ```bash komodefi-cli --help Config is not set -Provides a CLI interface and facilitates interoperating to komodo defi platform through the mm2 service +Provides a CLI interface and facilitates interoperating to komodo defi platform through the kdf service Usage: komodefi-cli Commands: - init Initialize a predefined coin set and configuration to start mm2 instance with - config Manage rpc_password and mm2 RPC URL - mm2 Manage mm2 instance commands + init Initialize a predefined coin set and configuration to start kdf instance with + config Manage rpc_password and kdf RPC URL + kdf Manage kdf instance commands coin Coin commands: enable, disable etc. wallet Wallet commands: balance, withdraw etc. sell Put a selling request diff --git a/src/pages/komodo-wallet/desktop/access-log-files/index.mdx b/src/pages/komodo-wallet/desktop/access-log-files/index.mdx index 78228f0f..593f9578 100644 --- a/src/pages/komodo-wallet/desktop/access-log-files/index.mdx +++ b/src/pages/komodo-wallet/desktop/access-log-files/index.mdx @@ -23,7 +23,7 @@ For each session of Komodo Wallet, two log files are created -Each file starts with a date and time, which helps to find the most recent logs or filter for a specific time period. The file ending in .log contains the desktop application debug log messages, and the file ending in .mm2.log contains the backend Komodo DeFi Framework (mm2) debug log messages. +Each file starts with a date and time, which helps to find the most recent logs or filter for a specific time period. The file ending in .log contains the desktop application debug log messages, and the file ending in .kdf.log contains the backend Komodo DeFi Framework (kdf) debug log messages. If the app has crashed, the most relevant logs will be at the end of the file. For other bugs, you might be able to find a related log entry by searching for the word error, or if you suspect it is related to [an Komodo Wallet API method](/komodo-defi-framework/api/legacy/coin_activation/), you can search for the method name, such as [my\_balance](/komodo-defi-framework/api/legacy/my_balance/). If you're not sure where to look, just send the complete log files. diff --git a/src/pages/notary/index.mdx b/src/pages/notary/index.mdx index cc841baa..de8cb0e9 100644 --- a/src/pages/notary/index.mdx +++ b/src/pages/notary/index.mdx @@ -519,7 +519,7 @@ This will return a JSON object with the address details. If the address is valid ## Komodo DeFi Framework Seed node setup (optional, but recommended) -Simple scripts to setup and configure MM2 as a seednode on your 3P server are available at [https://github.com/smk762/nn\_mm2\_seed](https://github.com/smk762/nn_mm2_seed). The mm2 seed node will also need ports `38890` and `38900` opened on the 3p server. +Simple scripts to setup and configure MM2 as a seednode on your 3P server are available at [https://github.com/smk762/nn\_mm2\_seed](https://github.com/smk762/nn_mm2_seed). The kdf seed node will also need ports `38890` and `38900` opened on the 3p server. **This may be included in the 3P dockerised setup in the future.** diff --git a/src/pages/qa/komodefi-api-quickstart/index.mdx b/src/pages/qa/komodefi-api-quickstart/index.mdx index c4c51f22..c8d93a2a 100644 --- a/src/pages/qa/komodefi-api-quickstart/index.mdx +++ b/src/pages/qa/komodefi-api-quickstart/index.mdx @@ -7,9 +7,9 @@ Download the latest release of Komodo DeFi Framework API for your OS from [https * If the latest release tag is `beta-2.0.1683`, the download links should be available at [https://github.com/KomodoPlatform/komodo-defi-framework/releases/tag/beta-2.0.1683](https://github.com/KomodoPlatform/komodo-defi-framework/releases/tag/beta-2.0.1683) * Scroll down to the bottom of the page and expand the "Assets" section by clicking on it -* To download, click on the link that has the words "mm2", "Release" and the name of your OS in it +* To download, click on the link that has the words "kdf", "Release" and the name of your OS in it * Extract the downloaded file into a new folder named `KomoDeFi` - * The directory structure should be something like `KomoDeFi/mm2` i.e., the `mm2` binary should be present in a directory named `KomoDeFi` + * The directory structure should be something like `KomoDeFi/kdf` i.e., the `kdf` binary should be present in a directory named `KomoDeFi` * Open a Terminal and `cd` into the KomoDeFi directory * Download the `coins` file; it contains the configuration information for all the supported coins @@ -17,7 +17,7 @@ Download the latest release of Komodo DeFi Framework API for your OS from [https wget https://raw.githubusercontent.com/komodoplatform/coins/master/coins ``` -* Download the sample mm2 config file +* Download the sample kdf config file ```bash wget https://raw.githubusercontent.com/gcharang/mm2scripts/master/MM2_sample.json @@ -29,10 +29,10 @@ wget https://raw.githubusercontent.com/gcharang/mm2scripts/master/MM2_sample.jso * Start Komodo DeFi Framework API by issuing the following command in a terminal window ```bash -stdbuf -oL nohup ./mm2 +stdbuf -oL nohup ./kdf ``` -* Komodo DeFi Framework (mm2) is up and running +* Komodo DeFi Framework (kdf) is up and running * You can find all the possible methods accepted by it: [here](/komodo-defi-framework/api/) diff --git a/src/pages/qa/recover-komodo-mobile-wallet-swap-on-desktop/index.mdx b/src/pages/qa/recover-komodo-mobile-wallet-swap-on-desktop/index.mdx index be739d55..bdf1a8b1 100644 --- a/src/pages/qa/recover-komodo-mobile-wallet-swap-on-desktop/index.mdx +++ b/src/pages/qa/recover-komodo-mobile-wallet-swap-on-desktop/index.mdx @@ -6,29 +6,29 @@ export const description = "This guide describes a step-by-step process to recov If for any reason, you don't want to/can't recover a stuck/timed out/failed swap in Komodo mobile wallet and wants to use the CLI on a desktop, follow this guide. * First, export the log file from your Komodo mobile wallet (Settings -> "Share log File") and transfer it to your Desktop. -* Follow the instructions in [this linked guide](/qa/extract-swap-data-komodo-wallet-log/) to extract the swap data from the log file into a format usable by `mm2` +* Follow the instructions in [this linked guide](/qa/extract-swap-data-komodo-wallet-log/) to extract the swap data from the log file into a format usable by `kdf` * It should create two directories named "MAKER" and "TAKER" and files named `.json` in the appropriate directory. `uuid` is the swap id from the Komodo mobile wallet app * Find the file named after your stuck swap's id and save it in a accessible location. Also note if it was in the directory named "MAKER" or "TAKER" * Follow the instructions in [this linked guide](/qa/komodefi-api-quickstart/) to download, configure and setup Komodo DeFi Framework on your desktop. When creating the file `MM2.json` as described in the guide, use the seed words from Komodo mobile wallet as the value for the key `"passphrase"` -* Once `mm2` is up and running, open a new terminal window and export the `rpc_password` as value to the environment variable named `userpass`. +* Once `kdf` is up and running, open a new terminal window and export the `rpc_password` as value to the environment variable named `userpass`. ```bash export userpass="" ``` -* Stop `mm2` by issuing the `stop` command in the same terminal +* Stop `kdf` by issuing the `stop` command in the same terminal ```bash curl --url "http://127.0.0.1:7783" --data "{\"method\":\"stop\",\"userpass\":\"$userpass\"}" ``` -* Navigate to the directory where `mm2` is located . You should find a directory named `DB`. Inside it, there should be a directory with a long hex (similar to `514fa660fa9976c87bb08e5636653ac75be9f606`) as its name. Navigate into it, then into "SWAPS", then "MY". +* Navigate to the directory where `kdf` is located . You should find a directory named `DB`. Inside it, there should be a directory with a long hex (similar to `514fa660fa9976c87bb08e5636653ac75be9f606`) as its name. Navigate into it, then into "SWAPS", then "MY". * the directory structure should look similar to `DB/514fa660fa9976c87bb08e5636653ac75be9f606/SWAPS/MY` * now, place the swap file in the above mentioned directory -* Now start `mm2` again using the command +* Now start `kdf` again using the command ```bash -stdbuf -oL nohup ./mm2 +stdbuf -oL nohup ./kdf ``` * Enable the coins involved in the swap using the [electrum](/komodo-defi-framework/api/legacy/coin_activation/#electrum-method) command @@ -56,10 +56,10 @@ curl --url "http://127.0.0.1:7783" --data "{\"userpass\":\"$userpass\",\"method\ } ``` -* Make sure the address and balance in the above response match the values shown in Komodo mobile wallet. If the address does not match, the `"passphrase"` (seed words) in `MM2.json` is incorrect. Stop `mm2`, delete the directory named `DB`, correct the passphrase and repeat all the steps from before. If the balance is `0`, either the electrum server's addresses you are using are incorrect or your connection might have an issue. Likely a firewall is blocking it. +* Make sure the address and balance in the above response match the values shown in Komodo mobile wallet. If the address does not match, the `"passphrase"` (seed words) in `MM2.json` is incorrect. Stop `kdf`, delete the directory named `DB`, correct the passphrase and repeat all the steps from before. If the balance is `0`, either the electrum server's addresses you are using are incorrect or your connection might have an issue. Likely a firewall is blocking it. - Don't delete the DB if you have been using the `mm2` on your desktop before + Don't delete the DB if you have been using the `kdf` on your desktop before opening this guide. It contains information on your past/ongoing/stuck swaps. Deleting it may cause you to lose access to your locked coins. Instead of deleting the entire DB, simply delete the directory inside the DB that