Full tests

.gitignore

@@ -5,3 +5,4 @@ node_modules
 coverage/
 package-lock.json
 .DS_Store
+.nyc_output

.travis.yml

@@ -3,3 +3,7 @@ sudo: false
 language: node_js
 node_js:
   - 8
+  - 10
+  - 12
+script:
+  - npm run ci

README.md

@@ -31,14 +31,11 @@ bind-to-address]
 Options:
   -b, --bind                 Listening host                             [string]
   --dp, --dht_port           DHT listening port              [number] [required]
-  --dc, --dht_concurrency    DHT concurrency                            [number]
-  --dht_maxTables            DHT max tables                             [number]
+  --de, --dht_ephemeral      DHT node epemerality                       [number]
   --dht_maxValues            DHT max values                             [number]
   --bn, --bootstrap          Bootstrap nodes                 [string] [required]
   --aph, --api_port          HTTP api port                   [number] [required]
   --dht_peer_maxAge, --dpa   Max age for peers in DHT                   [number]
-  --cache_maxAge             Maximum cache age                          [number]
-  --dnl, --dht_nodeLiveness  Interval in ms to check for dead nodes     [number]
   --check_maxPayloadSize     Limit for max payload size                 [number]
   --help                     Show help                                 [boolean]
   --version                  Show version number                       [boolean]
@@ -76,10 +73,9 @@ g.start()
 
  - `options` <Object> Options for the link
     - `host` <String> IP to bind to. If null, Grape binds to all interfaces
-    - `dht_maxTables` <Number> Maximum number of DHT tables
+    - `dht_ephemeral` <Boolean> Whether to join the DHT (false) or just query it (true). Default is false
     - `dht_maxValues` <Number> Maximum number of DHT values
     - `dht_port` <Number> Port for DHT
-    - `dht_concurrency` <Number> Concurrency for DHT
     - `dht_bootstrap`: <Array> Bootstrap servers
     - `dht_peer_maxAge` <Number> maxAge for DHT peers
     - `api_port` <Number> Grenache API HTTP Port
@@ -103,13 +99,95 @@ Emitted when the DHT finds a new node.
 
 #### Event: 'warning'
 
-Emitted when a peer announces itself in order to be stored in the DHT.
+Emitted when a warning occurs in the DHT.
 
 
 #### Event: 'announce'
 
 Emitted when a peer announces itself in order to be stored in the DHT.
 
+#### Event: 'unannounce'
+
+Emitted when a peer unannounces itself in order to be removed from the DHT.
+
+## RPC API
+
+### Immutable Get
+
+#### `POST /get` `{data: hash}`
+#### `POST /get` `{data: {hash, m: false}}`
+
+`hash`: A hex string of the hash of the stored value. If `hash` is supplied inside an object, supply an `m` property set to false to disambiguate between mutable/immutable storage.
+
+#### `POST /get` `{data: {hash}}` **Deprecated** **Legacy**
+
+A `hash` in an object with no `m` property should be considered legacy and upgraded to one of the above forms. If this form is used, the request will first attempt a to get the value from the mutable store before attempting the immutable store, so this will be the slowest way to reference immutable data.
+
+#### Response Body
+
+The response body of an Immutable Get takes the following form:
+
+```js
+{ id: <hex string of responding node id>,
+  seq: null, // always null for immutable gets
+  sig: null, // always null for immutable gets
+  v: <stored value>,
+  k: <hash hex string>,
+  m: false // always false for immutable gets
+}
+```
+
+### Immutable Put
+
+#### `POST /put` `{data: {v}}`
+
+The `v` property is the value to store. 
+
+#### Response Body
+
+The response body will be a hex string containing a hash of the value. This can be passed to a `POST /get` request to fetch the stored value.
+
+### Mutable Get
+
+#### `POST /get` `{data: {key}}`
+#### `POST /get` `{data: {hash, m: true}}`
+
+`key`: A hex string of the public key for the signed data. 
+
+Mutable data is stored using a public key, so `hash` is a misnomer. However for backwards compatiblity `hash` can also be used to supply the public key for the mutable data. For best results use `hash` with `m: true` (or use `key` instead).
+
+#### `POST /get` `{data: {hash}}` **Deprecated** **Legacy**
+
+A `hash` in an object with no `m` property should be considered legacy and upgraded to one of the above forms.
+
+#### Response Body
+
+The response body of a Mutable Get takes the following form:
+
+```js
+{ id: <hex string of responding node id>,
+  seq: <monotonically increasing sequence number>,
+  sig: <signature hex string>,
+  v: <stored value>,
+  k: <public key hex string>,
+  salt: <salt string - if any>
+  m: true // always true for mutable gets
+}
+```
+
+### Mutable Put
+
+#### `POST /put` `{data: {k, v, sig, [seq, salt]}}`
+
+`k`: The signed public key as a hex string. Required
+`v`: The value to store. Required
+`sig`: The signature as a hex string corresponding to the public key and value (and salt if supplied). Required
+`seq`: The sequence number, used for versioning. Optional
+`salt`: The salt as a string
+
+#### Response Body
+
+The response body will be a hex string representing of the public key.
 
 ## Implementations
 

bin/grape.js

@@ -16,13 +16,9 @@ const program = require('yargs')
     type: 'number',
     demand: true
   })
-  .option('dc', {
-    describe: 'DHT concurrency',
-    alias: 'dht_concurrency',
-    type: 'number'
-  })
-  .option('dht_maxTables', {
-    describe: 'DHT max tables',
+  .option('de', {
+    describe: 'DHT node epemerality',
+    alias: 'dht_ephemeral',
     type: 'number'
   })
   .option('dht_maxValues', {
@@ -46,35 +42,24 @@ const program = require('yargs')
     alias: 'dpa',
     type: 'number'
   })
-  .option('cache_maxAge', {
-    describe: 'Maximum cache age',
-    type: 'number'
-  })
-  .option('dnl', {
-    alias: 'dht_nodeLiveness',
-    describe: 'Interval in ms to check for dead nodes',
-    type: 'number'
-  })
   .option('check_maxPayloadSize', {
     describe: 'Limit for max payload size',
     type: 'number'
   })
   .help('help')
   .version()
-  .example('grape --dp 20001 --dc 32 --aph 30001 --bn \'127.0.0.1:20002,127.0.0.1:20003\'')
-  .example('grape --dp 20002 --dc 32 --b 127.0.0.1 --aph 40001 --bn \'127.0.0.1:20001,127.0.0.1:20003\'')
-  .example('grape --dp 20003 --dc 32 --aph 50001 --bn \'127.0.0.1:20001,127.0.0.1:20002\'')
+  .example('grape --dp 20001 --aph 30001 --bn \'127.0.0.1:20002,127.0.0.1:20003\'')
+  .example('grape --dp 20002 --b 127.0.0.1 --aph 40001 --bn \'127.0.0.1:20001,127.0.0.1:20003\'')
+  .example('grape --dp 20003 --aph 50001 --bn \'127.0.0.1:20001,127.0.0.1:20002\'')
   .usage('Usage: $0 --dp <dht-port> --aph <http-api-port> --bn <nodes> [--b bind-to-address]')
   .argv
 
+const dhtEphemeral = program.de
 const dhtPort = program.dp
 const apiPort = program.aph
 const bind = program.b
 const maxDhtPeerAge = program.dpa
-const maxCacheAge = program.cache_maxAge
-const maxDhtTables = program.dht_maxTables
 const maxDhtValues = program.dht_maxValues
-const maxDhtConcurrency = program.dht_concurrency
 const dhtNodeLiveness = program.dnl
 const maxPayloadSize = program.check_maxPayloadSize
 
@@ -87,15 +72,12 @@ const dhtBoostrap = _.reduce((program.bn || '').split(','), (acc, e) => {
 
 const g = new Grape({
   host: bind,
+  dht_ephemeral: dhtEphemeral,
   dht_port: dhtPort,
   dht_bootstrap: dhtBoostrap,
-  dht_maxTables: maxDhtTables,
   dht_maxValues: maxDhtValues,
-  dht_concurrency: maxDhtConcurrency,
-  dht_nodeLiveness: dhtNodeLiveness,
   api_port: apiPort,
   dht_peer_maxAge: maxDhtPeerAge,
-  cache_maxAge: maxCacheAge,
   check_maxPayloadSize: maxPayloadSize
 })