chore: add datastore and types

README.md

@@ -1,4 +1,4 @@
-# js-libp2p-rendezvous
+# js-libp2p-rendezvous <!-- omit in toc -->
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
 [![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
@@ -7,16 +7,26 @@
 
 > Javascript implementation of the rendezvous protocol for libp2p
 
+## Lead Maintainer <!-- omit in toc -->
+
+[Vasco Santos](https://github.com/vasco-santos).
+
+## Table of Contents<!-- omit in toc -->
+
+- [Overview](#overview)
+- [Usage](#usage)
+  - [Install](#install)
+  - [CLI](#cli)
+  - [Docker Setup](#docker-setup)
+- [Contribute](#contribute)
+- [License](#license)
+
 ## Overview
 
 Libp2p rendezvous is a lightweight mechanism for generalized peer discovery. It can be used for bootstrap purposes, real time peer discovery, application specific routing, and so on. Any node implementing the rendezvous protocol can act as a rendezvous point, allowing the discovery of relevant peers in a decentralized fashion.
 
 See the [SPEC](https://github.com/libp2p/specs/tree/master/rendezvous) for more details.
 
-## Lead Maintainer
-
-[Vasco Santos](https://github.com/vasco-santos).
-
 ## Usage
 
 ### Install
@@ -27,10 +37,12 @@ See the [SPEC](https://github.com/libp2p/specs/tree/master/rendezvous) for more
 
 Now you can use the cli command `libp2p-rendezvous-server` to spawn a libp2p rendezvous server.
 
-It accepts several arguments: `--peerId`, `--listenMultiaddrs`, `--announceMultiaddrs`, `--metricsMultiaddr` and `--disableMetrics`
+### CLI
+
+After installing the rendezvous server, you can use its binary. It accepts several arguments: `--peerId`, `--listenMultiaddrs`, `--announceMultiaddrs`, `--metricsPort` and `--disableMetrics`
 
 ```sh
-libp2p-rendezvous-server [--peerId <jsonFilePath>] [--listenMultiaddrs <ma> ... <ma>] [--announceMultiaddrs <ma> ... <ma>] [--metricsMultiaddr <ma>] [--disableMetrics]
+libp2p-rendezvous-server [--peerId <jsonFilePath>] [--listenMultiaddrs <ma> ... <ma>] [--announceMultiaddrs <ma> ... <ma>] [--metricsPort <port>] [--disableMetrics]
 ```
 
 For further customization (e.g. swapping the muxer, using other transports) it is recommended to create a server via the API.
@@ -55,10 +67,10 @@ By default it listens on `/ip4/127.0.0.1/tcp/15002/ws` and has no announce multi
 
 #### Metrics
 
-Metrics are enabled by default on `/ip4/127.0.0.1/tcp/8003` via Prometheus. This address can also be modified with:
+Metrics are enabled by default on `/ip4/127.0.0.1/tcp/8003` via Prometheus. This port can also be modified with:
 
 ```sh
-libp2p-rendezvous-server --metricsMultiaddr '/ip4/127.0.0.1/tcp/8000'
+libp2p-rendezvous-server --metricsPort '8008'
 ```
 
 Moreover, metrics can also be disabled with:
@@ -67,13 +79,13 @@ Moreover, metrics can also be disabled with:
 libp2p-rendezvous-server --disableMetrics
 ```
 
-## Docker Setup
+### Docker Setup
 
 TODO
 
 ## Contribute
 
-Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-libp2p-pubsub-peer-discovery/issues)!
+Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-libp2p-rendezvous/issues)!
 
 This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 

mysql/.env

@@ -0,0 +1,6 @@
+# MySQL
+DATABASE=libp2p_rendezvous_db
+ROOT_USER=root
+ROOT_PASSWORD=my-secret-pw
+USER=libp2p
+PASSWORD=dev

mysql/Dockerfile

@@ -0,0 +1,10 @@
+# Derived from official mysql image (our base image)
+FROM mysql
+
+# Add env variables
+ENV MYSQL_DATABASE libp2p-rendezvous
+ENV MYSQL_ROOT_PASSWORD=my-secret-pw
+ENV MYSQL_USER=vsantos
+ENV MYSQL_PASSWORD=my-secret-pw
+
+EXPOSE 3306

mysql/docker-compose.yml

@@ -0,0 +1,21 @@
+version: '3.1'
+services:
+  db:
+    image: mysql
+    volumes:
+        - mysql-db:/var/lib/mysql
+    command: --default-authentication-plugin=mysql_native_password
+    restart: always
+    environment:
+      # MYSQL_ROOT_PASSWORD: my-secret-pw
+      # MYSQL_USER: libp2p
+      # MYSQL_PASSWORD: my-secret-pw
+      # MYSQL_DATABASE: libp2p_rendezvous_db
+      MYSQL_DATABASE: ${DATABASE}
+      MYSQL_ROOT_PASSWORD: ${ROOT_PASSWORD}
+      MYSQL_USER: ${USER}
+      MYSQL_PASSWORD: ${PASSWORD}
+    ports:
+      - "3306:3306"
+volumes:
+  mysql-db:

package.json

@@ -44,24 +44,25 @@
   "dependencies": {
     "debug": "^4.2.0",
     "err-code": "^2.0.3",
+    "es6-promisify": "^6.1.1",
     "it-buffer": "^0.1.2",
     "it-length-prefixed": "^3.1.0",
     "it-pipe": "^1.1.0",
-    "libp2p": "libp2p/js-libp2p#0.30.x",
+    "libp2p": "libp2p/js-libp2p#chore/add-typedfs-with-post-install",
     "libp2p-mplex": "^0.10.0",
     "libp2p-noise": "^2.0.1",
     "libp2p-tcp": "^0.15.1",
     "libp2p-websockets": "^0.14.0",
     "menoetius": "0.0.2",
     "minimist": "^1.2.5",
     "multiaddr": "^8.0.0",
+    "mysql": "^2.18.1",
     "peer-id": "^0.14.1",
     "protons": "^2.0.0",
-    "streaming-iterables": "^5.0.2",
-    "uint8arrays": "^1.1.0"
+    "streaming-iterables": "^5.0.2"
   },
   "devDependencies": {
-    "aegir": "^28.2.0",
+    "aegir": "^29.2.2",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "delay": "^4.4.0",