Merge pull request #287 from orbitdb/feat/optional-pin

add pin option

benchmarks/benchmark-append.js

@@ -18,7 +18,7 @@ let queriesPerSecond = 0
 let lastTenSeconds = 0
 
 const queryLoop = async () => {
-  await log.append(totalQueries.toString())
+  await log.append(totalQueries.toString(), 1, false)
   totalQueries++
   lastTenSeconds++
   queriesPerSecond++

package.json

@@ -24,7 +24,7 @@
     "json-stringify-deterministic": "^1.0.1",
     "multihashing-async": "^0.7.0",
     "orbit-db-identity-provider": "orbitdb/orbit-db-identity-provider#feat/cache",
-    "orbit-db-io": "orbitdb/orbit-db-io",
+    "orbit-db-io": "github:orbitdb/orbit-db-io#feat/pin",
     "p-do-whilst": "^1.1.0",
     "p-each-series": "^2.1.0",
     "p-map": "^1.1.1",

src/entry.js

@@ -23,7 +23,7 @@ class Entry {
    * console.log(entry)
    * // { hash: null, payload: "hello", next: [] }
    */
-  static async create (ipfs, identity, logId, data, next = [], clock, refs = []) {
+  static async create (ipfs, identity, logId, data, next = [], clock, refs = [], pin) {
     if (!isDefined(ipfs)) throw IpfsNotDefinedError()
     if (!isDefined(identity)) throw new Error('Identity is required, cannot create entry')
     if (!isDefined(logId)) throw new Error('Entry requires an id')
@@ -49,7 +49,7 @@ class Entry {
     entry.key = identity.publicKey
     entry.identity = identity.toJSON()
     entry.sig = signature
-    entry.hash = await Entry.toMultihash(ipfs, entry)
+    entry.hash = await Entry.toMultihash(ipfs, entry, pin)
 
     return entry
   }
@@ -93,13 +93,13 @@ class Entry {
    * // "Qm...Foo"
    * @deprecated
    */
-  static async toMultihash (ipfs, entry) {
+  static async toMultihash (ipfs, entry, pin = false) {
     if (!ipfs) throw IpfsNotDefinedError()
     if (!Entry.isEntry(entry)) throw new Error('Invalid object format, cannot generate entry hash')
 
     // // Ensure `entry` follows the correct format
     const e = Entry.toEntry(entry)
-    return io.write(ipfs, getWriteFormat(e.v), e, { links: IPLD_LINKS })
+    return io.write(ipfs, getWriteFormat(e.v), e, { links: IPLD_LINKS, pin })
   }
 
   static toEntry (entry, { presigned = false, includeHash = false } = {}) {

src/log.js

@@ -256,7 +256,7 @@ class Log extends GSet {
    * @param {Entry} entry Entry to add
    * @return {Log} New Log containing the appended value
    */
-  async append (data, pointerCount = 1) {
+  async append (data, pointerCount = 1, pin = false) {
     // Update the clock (find the latest clock)
     const newTime = Math.max(this.clock.time, this.heads.reduce(maxClockTimeReducer, 0)) + 1
     this._clock = new Clock(this.clock.id, newTime)
@@ -297,7 +297,8 @@ class Log extends GSet {
       data,
       nexts,
       this.clock,
-      refs
+      refs,
+      pin
     )
 
     const canAppend = await this._access.canAppend(entry, this._identity.provider)