👨💻-Developers
Last updated
Was this helpful?
Last updated
Was this helpful?
This guide is intended to help developers who want to contribute to opendexd. Developers who want to build services on top of opendexd, should check out the node's .
Be sure to read the before starting to work or opening a Pull Request.
The following development environments are known to be compatible with opendexd and are recommended for developers that are unsure what tools to use.
is a cross-platform code editor that's compatible with most popular programming languages and extensible via a large collection of plug-ins.
Visual Studio Code Plugins
Consider using the following plugins for working with opendexd.
(definitely optional)
Visual Studio Code Environment Config
Adding the two files from into a .vscode folder within the folder where you've cloned opendexd will automatically provide debug configurations and general settings that are helpful when developing opendexd.
opendexd Setupopendexd on file changeAuto restart on every file change under dist folder with nodemon:
With some sample args disabling lndbtc/lndltc:
opendexd to testnetWe recommend to connect the opendexd instance you are developing on to testnet. Combined with above restarting mechanism, this lets you instantly see how your changes behave in a real-world trading environment.
Once the environment is up and running, exit from the cli session by typing exit or open a second terminal.
Stop the opendexd container with docker stop testnet_opendexd_1.
Copy the testnet lndbtc & lndltc folders into some path that you can easily access. E.g. into your home directory:
Ensure that you own the copied folders:
Create/change opendex.conf in ~/.opendexd to contain the following:
Now you can start your local opendexd instance and it should connect to the running testnet docker environment. You can check that everything works with ~/opendexd/bin$ ./opendex-cli -p 18886 getinfo.
Start testnet with default settings as described .