DeVault ID Lookup Server

Requirements

This lookup server is written for NodeJS and fetches data and gets information about new blocks from a full node supporting the DeVault RPC interface configured to index all transactions.

Installation

# git clone https://github.com/devaultcrypto/devaultid-lookup-server.git
# cd devaultid-lookup-server
# npm install

Configuration

Edit the config.example.js file to your desired server and node settings and copy it to config.js.

Server settings:

• port: Which port the server should listen for requests on.
• database: Where to store the servers database file(s).
• storage: What data should be cached by the server.
• metadata: Enables or disables full metadata lookups
• registration: Enables or disables public free registrations.

Node settings:

• address: ip number or domain to an full node.
• port: port to connect to the full node.
• user: username that is allowed to use RPC calls.
• pass: password for the username.

Automatic block notifications

To make the server automatically respond to new blocks, add a line in /etc/bitcoin/bitcoin.conf:

# Update devault id index upon new block.
blocknotify=curl "http://localhost:8585/newblock"

How to use

Before you can use the lookup server you need to start it by running:

# npm start

Server status

• https://hostname:port/status

  Returns a JSON object with information about the indexing process and server configuration.

  {
      status: '',
      block_height: 0,
      block_chain: '0xABCDEF0123456789ABCDEF0123456789',
      registrations: false
  }
  

Look up account registrations

Once the server has indexed an account, the registration transaction(s) and there inclusion proofs can be retrieved with a GET request to the following locations:

• https://hostname:port/lookup/<accountNumber>

  Returns a list of all registrations with the requested account numbers.

• https://hostname:port/lookup/<accountNumber>/<accountName>

  Returns a list of all registrations with the requested name and number.

Look up account metadata

Once the server has indexed an account, the account metadata can be retrieved with a GET request to the following locations:

• https://hostname:port/account/<accountNumber>/<accountName>/<accountHash>

  Returns metadata for a single account.

Register new accounts

If the server is configured to enable registrations, new accounts can be requested by sending a POST request to the following location:

• `https://hostname:port/register/

The request has to be JSON encoded and contain an object with the following fields:

{
    name: '<name to register>',
    payments:
    [
        '<Array with one or more payment fields>'
    ]
}

A request can be simulated with curl like this:

curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X POST -d '{"name": "accountName", "payments": ["qzvxp5vf4g857stc5c6se3vus7upnkn65zz3rsg8g"]}' https://api.cashaccount.info/register