chore(deps): bump lodash from 4.17.20 to 4.17.21

.editorconfig

@@ -0,0 +1,4 @@
+root = true
+[*/**.js]
+indent_style = space
+indent_size = 2

.github/workflows/test.yml

@@ -0,0 +1,84 @@
+name: Test
+
+on: push
+
+jobs:
+  linux:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v1
+
+      - name: Install Node.js, NPM and Yarn
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.13.1
+
+      - name: Yarn install
+        run: |
+          yarn install --frozen-lockfile --network-timeout 300000
+
+      - name: Install ffmpeg & chromaprint
+        run: |
+          sudo apt-get install software-properties-common
+          sudo add-apt-repository -y ppa:savoury1/ffmpeg4
+          sudo apt-get update
+          sudo apt-get install libchromaprint-tools ffmpeg
+
+      - name: Test & Lint
+        run: |
+          yarn lint
+          yarn test
+
+  # 'NODE_ENV' is not recognized as an internal or external command
+  # windows:
+  #   runs-on: windows-latest
+  #   steps:
+  #     - name: Check out Git repository
+  #       uses: actions/checkout@v1
+
+  #     - name: Install Node.js, NPM and Yarn
+  #       uses: actions/setup-node@v1
+  #       with:
+  #         node-version: 12.13.1
+
+  #     - name: Yarn install
+  #       run: |
+  #         yarn install --frozen-lockfile --network-timeout 300000
+
+  #     - name: Install ffmpeg & chromaprint
+  #       run: |
+  #         choco install ffmpeg chromaprint
+
+  #     - name: Test & Lint
+  #       run: |
+  #         yarn lint
+  #         yarn test
+
+  mac:
+    runs-on: macos-latest
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v1
+
+      - name: Install Node.js, NPM and Yarn
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.13.1
+
+      - name: Yarn install
+        run: |
+          yarn install --frozen-lockfile --network-timeout 300000
+
+      - uses: FedericoCarboni/setup-ffmpeg@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install chromaprint
+        run: |
+          brew install chromaprint
+
+      - name: Test & Lint
+        run: |
+          yarn lint
+          yarn test

.gitignore

@@ -10,3 +10,7 @@ yarn-error.log
 
 # App specific
 #
+orbitdb/
+keystore/
+cache/
+test/tmp/nodes

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,21 +1,44 @@
+<a href="https://bafybeidk4zev2jlw2jijtdyufo3itspx45k4ynq634x4rjm6ycjfdvxfrq.ipfs.infura-ipfs.io/" title="Record">
+  <img src="https://github.com/mistakia/record-app/raw/master/resources/icon.png" alt="Record Logo" width="150" />
+</a>
+
 # Record Node
 
 [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat)](https://github.com/RichardLitt/standard-readme)
+[![CircleCI Status](https://circleci.com/gh/mistakia/record-node.svg?style=shield)](https://circleci.com/gh/mistakia/record-node)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmistakia%2Frecord-node.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmistakia%2Frecord-node?ref=badge_shield)
 
 > Library, CLI and REST API for Record.
 
-A proof of concept distributed social & music application (library, sharing, discovery & curation) network built entirely on [IPFS](https://github.com/ipfs/js-ipfs). User data is stored via a [scuttlebot](http://scuttlebot.io/)-like immutable log via [IPFS-Log](https://github.com/orbitdb/ipfs-log) & [OrbitDB](https://github.com/orbitdb/orbit-db).
+Record is a proof of concept immutable distributed system for audio files. Built entirely on [IPFS](https://github.com/ipfs/js-ipfs), user data is stored in a [scuttlebot](http://scuttlebot.io/)-esque immutable log via [IPFS-Log](https://github.com/orbitdb/ipfs-log) & [OrbitDB](https://github.com/orbitdb/orbit-db). Bootstraping/peer discovery is done via [bitboot](https://github.com/tintfoundation/bitboot).
+
+At it's core, the application intends to be a media library management & playback system akin to [beets](https://github.com/beetbox/beets) with the ability to join various sources of music like [tomahawk player](https://github.com/tomahawk-player/tomahawk). By building everything on top of IPFS, it can become a connected network of libraries, opening the door to many other possibilities (i.e. soundcloud & musicbrainz), while still being entirely distributed and thus being able to function permanently.
+
+*Note: View the [UI/UX repo](https://github.com/mistakia/record-app) for more information.*
+
+## Install Dependencies
+```
+yarn install
+```
+
+### Install Chromaprint & FFmpeg
+
+Note: fpcalc ([chromaprint](https://github.com/acoustid/chromaprint)) must be installed to be able to import audio files.
+##### OSX using Homebrew
+```
+brew install chromaprint ffmpeg
+```
 
-## Install
+##### Ubuntu
 ```
-npm install
+sudo apt-get install libchromaprint-tools
 ```
 
 ## Usage
 
 ### Running
 ```
-npm run start
+yarn start
 ```
 
 ### CLI
@@ -30,32 +53,47 @@ wip
 
 ### Module
 ```js
-const IPFS = require('ipfs')
 const RecordNode = require('record-node')
-const OrbitDB = require('orbit-db')
+const createIPFSDaemon = require('record-ipfsd')
 
-const ipfs = new IPFS()
-ipfs.on('ready', async () => {
-    const rn = new RecordNode(ipfs, OrbitDB)
+const ipfsd = await createIPFSDaemon({
+    repo: repoPath,
+    ipfsBin: ipfsBinPath
+})
 
-    await rn.loadLog() // or rn.loadLog('/me')
-    // User's log loaded
+const node = new RecordNode()
+node.on('ready', async () => {
+    const log = await node.log.get() // or node.log.get(record.address)
 })
+await node.init(ipfsd)
 ```
 
 ## API
 ### RecordNode Constructor
 ```js
-const rn = new RecordNode(ipfs, OrbitDB, options)
+const record = new RecordNode(options)
 ```
-Use the `options` argument to specify configuration. It is an object with any of these properties:
-- `orbitPath` (string): The file path passed to OrbitDB. (Default: `undefined`)
-- `orbitAddress` (string): Valid OrbitDB database address. (Default: `undefined`)
-- `api` (boolean or object): Initialize the api when creating Record Node instance (Default: `undefined`)
-- `logConfig` (object): Options passed to OrbitDB when creating log.
-  - `create` (boolean): Wether or not to create db if given just a db name (Default: `true`)
-  - `replicate` (boolean): Subscribe to updates via IPFS pubsub (Default: `true`)
-  - `replicationConcurrency` (integer): (Default: `128`)
+View default options at [`config.js`](https://github.com/mistakia/record-node/blob/master/config.js). Use the `options` argument to specify configuration. It is an object with any of these properties:
+
+##### `options.api`
+
+| Type | Default |
+|------|---------|
+| boolean | `false` |
+| object | `{ port: 3000 }` |
+
+Enable http api (Default: `undefined`)
+
+##### `options.bitboot`
+
+| Type | Default |
+|------|---------|
+| object | `{ enabled: true }` |
+
+Enable finding peers via [bitboot](https://github.com/tintfoundation/bitboot)
 
 ## License
 MIT
+
+
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmistakia%2Frecord-node.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmistakia%2Frecord-node?ref=badge_large)

benchmark/benchmarks/add-tracks.js

@@ -0,0 +1,30 @@
+const { startRecord, createTrack } = require('../../test/utils')
+
+const base = {
+  prepare: async function () {
+    return startRecord('0')
+  },
+  cycle: async function ({ record }, { count }) {
+    await record.tracks.add(createTrack(`Hello${count}`))
+  },
+  teardown: async function ({ record }) {
+    await record.stop()
+  }
+}
+
+const baseline = {
+  while: ({ stats, startTime, baselineLimit }) => {
+    return stats.count < baselineLimit
+  }
+}
+
+const stress = {
+  while: ({ stats, startTime, stressLimit }) => {
+    return process.hrtime(startTime)[0] < stressLimit
+  }
+}
+
+module.exports = [
+  { name: 'add-tracks-baseline', ...base, ...baseline },
+  { name: 'add-tracks-stress', ...base, ...stress }
+]

benchmark/benchmarks/index.js

@@ -0,0 +1,19 @@
+const addTracks = require('./add-tracks')
+const listTracks = require('./list-tracks')
+
+// TODO add links
+// TODO list links
+// TODO listens
+// TODO list tags
+// TODO list listens
+// TODO remove tracks
+// TODO remove tags
+// TODO remove links
+
+// TODO replicate
+// TODO process index
+
+module.exports = [
+  ...addTracks,
+  ...listTracks
+]

benchmark/benchmarks/list-tracks.js

@@ -0,0 +1,43 @@
+const { startRecord, createTrack } = require('../../test/utils')
+
+const base = {
+  prepare: async function () {
+    const { record } = await startRecord('0')
+
+    process.stdout.clearLine()
+    for (let i = 1; i < this.count + 1; i++) {
+      process.stdout.write(`\r${this.name} - Preparing - Writing: ${i}/${this.count}`)
+      await record.tracks.add(createTrack(`Hello${i}`))
+    }
+
+    return { record }
+  },
+  cycle: async function ({ record }, { count }) {
+    await record.tracks.list({ addresses: [record.address] })
+  },
+  teardown: async function ({ record }) {
+    await record.stop()
+  }
+}
+
+const baseline = {
+  while: ({ stats, startTime, baselineLimit }) => {
+    return stats.count < baselineLimit
+  }
+}
+
+const stress = {
+  while: ({ stats, startTime, stressLimit }) => {
+    return process.hrtime(startTime)[0] < stressLimit
+  }
+}
+
+const counts = [100, 500, 1000]
+const benchmarks = []
+for (const count of counts) {
+  const c = { count }
+  benchmarks.push({ name: `list-tracks-${count}-baseline`, ...base, ...c, ...baseline })
+  benchmarks.push({ name: `list-tracks-${count}-stress`, ...base, ...c, ...stress })
+}
+
+module.exports = benchmarks