API revamp and cleansing

README.md

@@ -137,7 +137,74 @@ This now has created the following structure, either on disk or as an in memory
 
 ## API
 
-See https://ipfs.github.io/js-ipfs-repo
+### new Repo(path[, options])
+
+Creates an IPFS Repo.
+
+Arguments:
+
+* `path` (string, mandatory): the path for this repo
+* `options` (object, optional): may contain the following values
+  * `lock` (string, defaults to `"fs"` in Node.js, `"memory"` in the browser): what type of lock to use. Lock has to be acquired when opening.
+  * `storageBackends` (object, optional): may contain the following values, which should each be a class implementing the [datastore interface](https://github.com/ipfs/interface-datastore#readme):
+    * `root` (defaults to [`datastore-fs`](https://github.com/ipfs/js-datastore-fs#readme) in Node.js and [`datastore-level`](https://github.com/ipfs/js-datastore-level#readme) in the browser)
+    * `blocks` (defaults to [`datastore-fs`](https://github.com/ipfs/js-datastore-fs#readme) in Node.js and [`datastore-level`](https://github.com/ipfs/js-datastore-level#readme) in the browser)
+    * `datastore` (defaults to `datastore-level`)
+
+```js
+const repo = new Repo('path/to/repo')
+```
+
+### repo.init (callback)
+
+Creates the necesary folder structure inside the repo.
+
+### repo.open (callback)
+
+Locks the repo.
+
+### repo.close (callback)
+
+Unlocks the repo.
+
+### repo.put (key, value:Buffer, callback)
+
+Put a value at the root of the repo.
+
+* `key` can be a buffer, a string or a [Key](https://github.com/ipfs/interface-datastore#keys).
+
+### repo.get (key, callback)
+
+Get a value at the root of the repo.
+
+* `key` can be a buffer, a string or a [Key](https://github.com/ipfs/interface-datastore#keys).
+* `callback` is a callback function `function (err, result:Buffer)`
+
+### repo.blocks.put (key, value, callback)
+
+Put block.
+
+* `key` can be a buffer, a string or a [Key](https://github.com/ipfs/interface-datastore#keys).
+* `value` should be a buffer.
+
+### repo.blocks.get (key, callback)
+
+Get block.
+
+* `key` can be a buffer, a string or a [Key](https://github.com/ipfs/interface-datastore#keys).
+* `callback` is a callback function `function (err, result:Buffer)`
+
+### repo.datastore
+
+This is contains a full implementation of [the `interface-datastore` API](https://github.com/ipfs/interface-datastore#api).
+
+### repo.config.put(key:string, value, callback)
+
+Set a config value. `value` can be any object that is serializable to JSON.
+
+### repo.config.get(key:string, callback)
+
+Get a config value. `callback` is a function with the signature: `function (err, value)`, wehre the `value` is of the same type that was set before.
 
 ## Notes
 

package.json

@@ -85,4 +85,4 @@
     "nginnever <[email protected]>",
     "npmcdn-to-unpkg-bot <[email protected]>"
   ]
-}
+}

src/api-addr.js

@@ -0,0 +1,44 @@
+'use strict'
+
+const Key = require('interface-datastore').Key
+
+const apiFile = new Key('api')
+
+module.exports = (store) => {
+  return {
+    /**
+     * Get the current configuration from the repo.
+     *
+     * @param {function(Error, Object)} callback
+     * @returns {void}
+     */
+    get (callback) {
+      store.get(apiFile, (err, value) => {
+        if (err) {
+          return callback(err)
+        }
+
+        callback(err, value && value.toString())
+      })
+    },
+    /**
+     * Set the current configuration for this repo.
+     *
+     * @param {Object} value - the api address to be written
+     * @param {function(Error)} callback
+     * @returns {void}
+     */
+    set (value, callback) {
+      store.put(apiFile, Buffer.from(value.toString()), callback)
+    },
+    /**
+     * Deletes api file
+     *
+     * @param {function(Error, bool)} callback
+     * @returns {void}
+     */
+    delete (callback) {
+      store.delete(apiFile, callback)
+    }
+  }
+}

src/backends.js

@@ -0,0 +1,7 @@
+'use strict'
+
+exports.create = function createBackend (name, path, options) {
+  const Ctor = options.storageBackends[name]
+  const backendOptions = Object.assign({}, options.storageBackendOptions[name] || {})
+  return new Ctor(path, backendOptions)
+}

src/blockstore.js

@@ -1,15 +1,14 @@
 'use strict'
 
-const NamespaceStore = require('datastore-core').NamespaceDatastore
+const core = require('datastore-core')
+const ShardingStore = core.ShardingDatastore
 const Key = require('interface-datastore').Key
 const base32 = require('base32.js')
 const Block = require('ipfs-block')
 const setImmediate = require('async/setImmediate')
 const reject = require('async/reject')
 const CID = require('cids')
 
-const blockPrefix = new Key('blocks')
-
 /**
  * Transform a raw buffer to a base32 encoded key.
  *
@@ -31,8 +30,27 @@ const cidToDsKey = (cid) => {
   return keyFromBuffer(cid.buffer)
 }
 
-module.exports = (repo) => {
-  const store = new NamespaceStore(repo.store, blockPrefix)
+module.exports = (filestore, datastore, options, callback) => {
+  maybeWithSharding(filestore, datastore, options, (err, store) => {
+    if (err) {
+      callback(err)
+      return // early
+    }
+
+    callback(null, createBaseStore(store))
+  })
+}
+
+function maybeWithSharding (filestore, datastore, options, callback) {
+  if (options.sharding) {
+    const shard = new core.shard.NextToLast(2)
+    ShardingStore.createOrOpen(filestore, shard, callback)
+  } else {
+    setImmediate(() => callback(null, filestore))
+  }
+}
+
+function createBaseStore (store) {
   return {
     /**
      * Get a single block by CID.
@@ -134,6 +152,10 @@ module.exports = (repo) => {
       }
 
       store.delete(cidToDsKey(cid), callback)
+    },
+
+    close (callback) {
+      store.close(callback)
     }
   }
 }

src/default-options-browser.js

@@ -2,11 +2,23 @@
 
 // Default configuration for a repo in the browser
 module.exports = {
-  fs: require('datastore-level'),
-  sharding: false,
   lock: 'memory',
-  fsOptions: {
-    db: require('level-js')
+  storageBackends: {
+    root: require('datastore-level'),
+    blocks: require('datastore-level'),
+    datastore: require('datastore-level')
   },
-  level: require('level-js')
+  storageBackendOptions: {
+    root: {
+      db: require('level-js'),
+      extension: ''
+    },
+    blocks: {
+      sharding: false,
+      db: require('level-js')
+    },
+    datastore: {
+      db: require('level-js')
+    }
+  }
 }

src/default-options.js

@@ -2,8 +2,18 @@
 
 // Default configuration for a repo in node.js
 module.exports = {
-  sharding: true,
   lock: 'fs',
-  fs: require('datastore-fs'),
-  level: require('leveldown')
+  storageBackends: {
+    root: require('datastore-fs'),
+    blocks: require('datastore-fs'),
+    datastore: require('datastore-level')
+  },
+  storageBackendOptions: {
+    root: {
+      extension: ''
+    },
+    blocks: {
+      sharding: true
+    }
+  }
 }