@fireproof/core 0.0.10 → 0.1.1

package/README.md

@@ -96,7 +96,7 @@ Documents changes are persisted to [Filecoin](https://filecoin.io) via [web3.sto
 
 ### Cryptographic Proofs
 
-The [UCAN protocol](https://ucan.xyz) verifably links Fireproof updates to authorized agents via cryptographic proof chains. These proofs are portable like bearer tokens, but because invocations are signed by end-user device keys, UCAN proofs don't need to be hidden to be secure, allowing for delegation of service capabilities across devices and parties. Additionally, Fireproof's Merkle clocks and hash trees are immutable and self-validating, making merging changes safe and efficient. Fireproof makes cryptographic proofs available for all of it's operations, making it an ideal verfiable document database for smart contracts and other applications running in trustless environments. [Proof chains provide performance benefits as well](https://purrfect-tracker-45c.notion.site/Data-Routing-23c37b269b4c4c3dacb60d0077113bcb), by allowing recipients to skip costly I/O operations and instead cryptographically verify that changes contain all of the required context.
+The [UCAN protocol](https://ucan.xyz) verifiably links Fireproof updates to authorized agents via cryptographic proof chains. These proofs are portable like bearer tokens, but because invocations are signed by end-user device keys, UCAN proofs don't need to be hidden to be secure, allowing for delegation of service capabilities across devices and parties. Additionally, Fireproof's Merkle clocks and hash trees are immutable and self-validating, making merging changes safe and efficient. Fireproof makes cryptographic proofs available for all of its operations, making it an ideal verifiable document database for smart contracts and other applications running in trustless environments. [Proof chains provide performance benefits as well](https://purrfect-tracker-45c.notion.site/Data-Routing-23c37b269b4c4c3dacb60d0077113bcb), by allowing recipients to skip costly I/O operations and instead cryptographically verify that changes contain all of the required context.
 
 ## Limitations 💣
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fireproof/core",
-  "version": "0.0.10",
+  "version": "0.1.1",
   "description": "Realtime database for IPFS",
   "main": "index.js",
   "type": "module",
@@ -10,6 +10,7 @@
     "test:watch": "npm run test:mocha -- -w --parallel test/*.test.js",
     "coverage": "c8 -r html -r text npm test",
     "prepublishOnly" : "cp ../../README.md .",
+    "postpublish": "rm README.md",
     "lint": "standard",
     "lint:fix": "standard --fix"
   },
@@ -68,7 +69,7 @@
   "bugs": {
     "url": "https://github.com/fireproof-storage/fireproof/issues"
   },
-  "homepage": "https://github.com/fireproof-storage/fireproof#readme",
+  "homepage": "https://fireproof.storage",
   "workspaces": [
     "examples/todomvc"
   ]

package/src/db-index.js

@@ -9,7 +9,7 @@ import { cidsToProof } from './fireproof.js'
 
 import * as codec from '@ipld/dag-cbor'
 // import { create as createBlock } from 'multiformats/block'
-import { doTransaction } from './blockstore.js'
+import TransactionBlockstore, { doTransaction } from './blockstore.js'
 import charwise from 'charwise'
 
 const ALWAYS_REBUILD = false // todo: make false
@@ -109,6 +109,9 @@ export default class DbIndex {
      * @type {Fireproof}
      */
     this.database = database
+    if (!database.indexBlocks) {
+      database.indexBlocks = new TransactionBlockstore(database.name + '.indexes')
+    }
     /**
      * The map function to apply to each entry in the database.
      * @type {Function}
@@ -190,13 +193,13 @@ export default class DbIndex {
     // if (!root) {
     // pass a root to query a snapshot
     // console.time(callId + '.#updateIndex')
-    await this.#updateIndex(this.database.blocks)
+    await this.#updateIndex(this.database.indexBlocks)
     // console.timeEnd(callId + '.#updateIndex')
 
     // }
     // console.time(callId + '.doIndexQuery')
     // console.log('query', query)
-    const response = await doIndexQuery(this.database.blocks, this.indexByKey, query)
+    const response = await doIndexQuery(this.database.indexBlocks, this.indexByKey, query)
     // console.timeEnd(callId + '.doIndexQuery')
 
     return {
@@ -319,7 +322,10 @@ async function loadIndex (blocks, index, indexOpts) {
 
 async function doIndexQuery (blocks, indexByKey, query) {
   await loadIndex(blocks, indexByKey, dbIndexOpts)
-  if (query.range) {
+  if (!query) {
+    const { result, ...all } = await indexByKey.root.getAllEntries()
+    return { result: result.map(({ key: [k, id], value }) => ({ key: k, id, row: value })), ...all }
+  } else if (query.range) {
     const encodedRange = query.range.map((key) => charwise.encode(key))
     return indexByKey.root.range(...encodedRange)
   } else if (query.key) {

package/src/fireproof.js

@@ -27,7 +27,7 @@ export default class Fireproof {
    * @static
    * @returns {Fireproof} - a new Fireproof instance
    */
-  static storage = (name) => {
+  static storage = (name = 'global') => {
     return new Fireproof(new TransactionBlockstore(name), [], { name })
   }
 

package/test/db-index.test.js

@@ -30,10 +30,10 @@ describe('DbIndex query', () => {
     })
   })
   it('query index range', async () => {
-    const result = await index.query({ range: [41, 44] })
+    const result = await index.query({ range: [41, 49] })
     assert(result, 'did return result')
     assert(result.rows)
-    assert.equal(result.rows.length, 1, 'one row matched')
+    assert.equal(result.rows.length, 2, 'two row matched')
     assert.equal(result.rows[0].key, 43)
     assert(result.rows[0].value === 'carol', 'correct value')
   })
@@ -47,6 +47,33 @@ describe('DbIndex query', () => {
     assert.equal(result.rows[0].key, 43)
     assert(result.rows[0].value === 'carol', 'correct value')
   })
+  it('query index all', async () => {
+    const result = await index.query()
+    assert(result, 'did return result')
+    assert(result.rows)
+    assert.equal(result.rows.length, 6, 'six row matched')
+    assert.equal(result.rows[0].key, 4)
+    assert.equal(result.rows[0].value, 'emily')
+    assert.equal(result.rows[result.rows.length - 1].value, 'dave')
+  })
+  it('query index NaN', async () => {
+    const result = await index.query({ range: [NaN, 44] })
+    assert(result, 'did return result')
+    assert(result.rows)
+    assert.equal(result.rows.length, 5, 'six row matched')
+    assert.equal(result.rows[0].key, 4)
+    assert.equal(result.rows[0].value, 'emily')
+    assert.equal(result.rows[result.rows.length - 1].value, 'carol')
+  })
+  it('query index Infinity', async () => {
+    const result = await index.query({ range: [42, Infinity] })
+    assert(result, 'did return result')
+    assert(result.rows)
+    assert.equal(result.rows.length, 2, 'six row matched')
+    assert.equal(result.rows[0].key, 43)
+    assert.equal(result.rows[0].value, 'carol')
+    assert.equal(result.rows[result.rows.length - 1].value, 'dave')
+  })
   it('query twice', async () => {
     let result = await index.query({ range: [41, 44] })
     assert(result, 'did return result')