DAppNode Core

BIND

Local DAppNode DNS. Links each package docker IP to a name in the format of my.[package-name].dnp.dappnode.eth. I also redirects .eth domains to the ethforward. All rules can be consulted at eth.hosts.

It runs the native linux bind package with with a configuration specified at named.conf. It attempts resolution and otherwise forwards to the Google Public DNS 8.8.8.8 / 8.8.4.4.

VPN

Provides a basic VPN for users to consume dappnode’s services.

It runs a xl2tpd process alongside a nodejs app, both controlled by a supervisord process. The nodejs app connects with the WAMP to manage VPN users directly editing the /etc/ppp/chap-secrets file, which holds the users credentials.

The user IP is static and set when that user is created. The static IP is used by the WAMP for authentication to allow only admin users to perform certain actions. Currently there are three types of users:

• 172.33.10.1: Super admin. It is created when DAppNode is installed and can never be deleted
• 172.33.10.x: Admin user.
• 172.33.100.x: Non-admin user.

VPN procedures

domain: <event>.vpn.dnp.dappnode.eth

event	kwargs	result
addDevice	id	{}
removeDevice	id	{}
toggleAdmin	id	{}
listDevices	~	[{ deviceObject }] |
getParams	~	{param: paramValue, …}
statusUPnP	~	{openPorts, UPnP, msg} |
statusExternalIp	~	{externalIpResolves, INT_IP, …}

deviceObject = {
    name: 'string',
    password: 'string',
    ip: 'string'
}

ETHCHAIN

Local full mainnet ethereum node. Right now it uses parity, but we are testing Geth against Parity to take a decision based on each client’s efficiency, memory usage, time to use among other parameters.

ETHFORWARD

Resolves .eth domains by intercepting outgoing requests, calling ENS, and redirecting to the local IPFS node.

It is a nodejs http proxy server, which also returns custom 404 pages if the content is not found or available or if the chain is still not synced.

IPFS

Local IFPS node. Its gateaway is available at:

host: my.ipfs.dnp.dappnode.eth
port: 5001
protocol: http

WAMP

Handles inter-package communications. Restricts certain operations to only admin users.

We are using crossbar.io and its javascript client autobahn.js. Please refer to their documentation for more details.

WAMP response specifications

{
    success: <boolean>
    message: <string>
    result: <object, array or string>
}

// Success example

{
    success: true
    message: 'Listing 2 devices'
    result: [{...}, {...}]
}

// Error example

{
    success: false
    message: 'Error: could not list devices'
}

DAPPMANAGER

Installs and manages DAppNode packages (DNPs). It’s a Nodejs app whos procedures are only consumed by the ADMIN, and depends on IPFS and ETHCHAIN to function.

DAPPMANAGER procedures

domain: <event>.dappmanager.dnp.dappnode.eth

event	kwargs	result
installPacakge	id	{}
removePackage	id, deleteVolumes	{}
togglePackage	id, timeout	{}
restartPackage	id	{}
restartPackageVolumes	id	{}
updatePackageEnv	id, envs, restart, isCore	{}
logPackage	id, options	{id, logs}
fetchPackageVersions	id	[{ versionObject }]
fetchPackageData	id	{manifest, avatar}
listPackages	~	[{ pkgDataObject }]
fetchDirectory	~	[{name, status}]

pkgDataObject = {
    id: '927623894...', (string)
    isDNP: true, (boolean)
    created: date (string),
    image: imageName, (string)
    name: otpweb.dnp.dappnode.eth, (string)
    shortName: otpweb, (string)
    version: '0.0.4', (string)
    ports: listOfPorts, (string)
    state: 'exited', (string)
    running: true, (boolean)
    ...
    envs: envVariables (object)
}

versionObject = {
    version: '0.0.4', (string)
    manifest: manifest (object)
}

ADMIN

Handles admin users <-> DAppNode interactions, such as managing packages or VPN users. It is a NGINX process that serves a single-page React app that consumes RPCs of the DAPPMANAGER and the VPN.