Developers.md

Developer's Guide

• Securing Your Apps With DNSChain
• Contributing to DNSChain development
• Adding support for your favorite blockchain
• Running Tests

Securing Your Apps With DNSChain

Developers of secure communications applications looking to improve the usability and security of their apps should familiarizing themselves with the following documentation:

• How to use DNSChain
• How to run a DNSChain server
• RESTful API specification

Developer-friendly libraries in various languages for interacting with DNSChain in a MITM-proof manner are coming:

• DNSChain for Python
• Your favorite language here!

#### Contributing to DNSChain development

Make sure you did everything in the requirements and then play with these commands from your clone of the DNSChain repository:

• sudo grunt example (runs on privileged ports by default)
• grunt example (runs on non-privileged ports by default)

Grunt will automatically lint your code to the style used in this project, and when files are saved it will automatically re-load and restart the server (as long as you're editing code under src/lib).

When forking DNSChain: work on feature branches, not master, then submit a PR.

Adding support for your favorite blockchain

1. Copy the file src/lib/blockchain.coffee and place it in src/lib/blockchains.
2. Rename it after your blockchain (no spaces).
3. Edit it by following the advice offered by the comments. Look at how the other files in the blockchains folder have done it.

That's it! Send us a pull request and we'll be happy to include support for your favorite blockchain. :)

Running Tests

From within the DNSChain repo, make sure you've run npm install, and then:

npm test