You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| gui | string | Information to identify which app, tool or product is using the API, e.g. `AtomicDEX iOS 1.0.1`. Helps developers identify if an issue is related to specific builds or operating systems etc. |
49291
-
| netid | integer | Nework ID number, telling the AtomicDEX-API which network to join. 7777 is the current main network, though alternative netids can be used for testing or "private" trades as long as seed nodes exist to support it. |
49290
+
| gui | string | Information to identify which app, tool or product is using the API, e.g. `AtomicDEX iOS 2.0.0`. Helps developers identify if an issue is related to specific builds or operating systems etc. |
49291
+
| netid | integer | Nework ID number, telling the AtomicDEX-API which network to join. 8762 is the current main network, though alternative netids can be used for testing or "private" trades as long as seed nodes exist to support it. |
49292
49292
| 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) |
49293
49293
| rpc\_password | string | For RPC requests that need authentication, this will need to match the `userpass` value in the request body. |
49294
49294
| 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 `&`. |
49295
49295
| dbdir | string | Optional, defaults to a subfolder named `DB` in the path of your `mm2` binary. This path will store the AtomicDEX-API database data. |
49296
49296
| rpcip | string | Optional, defaults to `127.0.0.1`. IP address to bind to for RPC server. |
49297
49297
| rpcport | integer | Optional, defaults to `7783`. Port to use for RPC communication. |
49298
49298
| rpc\_local\_only | boolean | Optional, defaults to `true`. If `false` the AtomicDEX 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. |
49299
-
| i\_am\_seed | boolean | Optional, defaults to `false`. Runs AtomicDEX API as a seed node mode (acting as a relay for AtomicDEX API clients). Use of this mode is not reccomended on the main network (7777) as it could result in a pubkey ban if non-compliant. On alternative testing or private networks, at least one seed node is required to relay information to other AtomicDEX API clients using the same netID. |
49299
+
| i\_am\_seed | boolean | Optional, defaults to `false`. Runs AtomicDEX API as a seed node mode (acting as a relay for AtomicDEX API clients). Use of this mode is not reccomended on the main network (8762) as it could result in a pubkey ban if non-compliant. On alternative testing or private networks, at least one seed node is required to relay information to other AtomicDEX API clients using the same netID. |
49300
49300
| seednodes | list of strings | Optional. If operating on a test or private netID, the IP address of at least one seed node is required (on the main network, these are already hardcoded) |
49301
49301
| hd\_account\_id | integer | Optional. If this value is set, the AtomicDEX-API will work in only the [HD derivation mode](/atomicdex/api/v20-dev/hd_wallets_overview/), and coins will need to have a coin derivation path entry in the `coins` file for activation. The `hd_account_id` value effectively takes its place in the full derivation as follows: `m/44'/COIN_ID'/<hd_account_id>'/CHAIN/ADDRESS_ID` |
49302
49302
| message\_service\_cfg | object | Optional. This data is used to configure [Telegram](https://telegram.org/) messenger alerts for swap events when running using the [makerbot functionality](/atomicdex/api/v20/start_simple_market_maker_bot/). For more information check out the [telegram alerts guide](/atomicdex/api/v20/telegram_alerts/) |
@@ -49309,7 +49309,7 @@ When running the AtomicDEX API via commandline with the `mm2` binary, some basic
| gui | string | Information to identify which app, tool or product is using the API, e.g. `AtomicDEX iOS 1.0.1`. Helps developers identify if an issue is related to specific builds or operating systems etc. |
50300
-
| netid | integer | Nework ID number, telling the AtomicDEX API which network to join. 7777 is the current main network, though alternative netids can be used for testing or "private" trades as long as seed nodes exist to support it. |
50300
+
| netid | integer | Nework ID number, telling the AtomicDEX API which network to join. 8762 is the current main network, though alternative netids can be used for testing or "private" trades as long as seed nodes exist to support it. |
50301
50301
| passphrase | string | Your passphrase; this is the source of each of your coins private keys. KEEP IT SAFE! |
50302
50302
| rpc\_password | string | For RPC requests that need authentication, this will need to match the `userpass` value in the request body. |
50303
50303
@@ -50313,7 +50313,7 @@ We also need to create an MM2.json file in the same directory as the `coins` fil
50313
50313
The MM2.json configuration commands can also be supplied at runtime, as below:
Replace `YOUR_PASSPHRASE_HERE` and `YOUR_PASSWORD_HERE` with your actual passphrase and password, and then execute the command in the terminal.
@@ -50358,7 +50358,7 @@ If you see something similar, the AtomicDEX API is up and running!
50358
50358
When using the AtomicDEX API on a VPS without accompanying tools such as `tmux` or `screen`, it is recommended to use [`nohup`](https://www.digitalocean.com/community/tutorials/nohup-command-in-linux) when launching the AtomicDEX-API. This will ensure that the AtomicDEX-API instance is not shutdown when the user logs out.
0 commit comments