grenache-nodejs-link/README.md

Granache Node.js Link

# grenache-nodejs-link

<img src="logo.png" width="15%" />

In Grenache, `grenache-nodejs-link` communicates with the DHT.

### Requirements

Install `Grenache Grape`: https://github.com/bitfinexcom/grenache-grape:

```bash
npm i -g grenache-grape
```

```
// Start 2 Grapes
grape --dp 20001 --aph 30001 --bn '127.0.0.1:20002'
grape --dp 20002 --aph 40001 --bn '127.0.0.1:20001'
```

### Class: Link

#### new Link(options)

 - `options` &lt;Object&gt; Options for the link
    - `grape` &lt;String&gt; Address of the Grenache Grape instance. Communication is done via WebSocket or HTTP.
    - `requestTimeout` &lt;Number&gt; Default timeout for requests to Grape,
    - `pingTimeout` &lt;Number&gt; Ping connection timeout to Grape (triggers reconnect attempt),
    - `lruMaxSizeLookup` &lt;Number&gt; Maximum size of the cache,
        checked by applying the length function to all values
        in the cache
    - `lruMaxAgeLookup` &lt;Number&gt; Maximum cache age in ms.

#### link.start()

Sets up the link.

#### link.stop()

Stops all current requests and announces.

#### link.announce(name)

  - `name` &lt;String&gt; Name of the service, used to find the service
    from other peers

Used to announce a service, e.g. a [RPC Server](#class-peerrpcserver).

#### link.startAnnouncing(name, port, [opts])

Keep announcing a service every ~2min (default) or specify interval in `opts.interval`

#### link.stopAnnouncing(name, port)

Stop announcing a service

#### link.put(data, callback)

  - `data`
    - `v`: &lt;String&gt; value to store
  - `callback` &lt;function&gt;

Puts a value into the DHT.
[Example](https://github.com/bitfinexcom/grenache-nodejs-link/blob/master/examples/put_get.js).

#### link.get(hash | object, callback)

  - `hash` &lt;String&gt; Hash used for lookup
  - `object` &lt;Object&gt;
    - `hash`: &lt;String&gt; Hash used for lookup
    - `salt`: &lt;String&gt; (optional) salt that was used if data was stored with salt. Required in those cases.

  - `callback` &lt;function&gt;

Retrieves a stored value from the DHT via a `hash` &lt;String&gt;.
It also supports an object, which is used to pass a previously used salt in order to retrieve the data teh salt was used upon.

Callback returns `err` &lt;Object&gt; and data &lt;Object&gt;.

[Example](https://github.com/bitfinexcom/grenache-nodejs-link/blob/master/examples/put_get.js).


#### link.lookup(name, [opts], callback)

  - `name` &lt;String&gt; Name of the service to lookup
  - `opts`
    - `retry`: &lt;Number&gt; retry count
  - `callback` &lt;function&gt;

Retrieves the ports and IPs of a given service name.