Compare commits

..

No commits in common. "main" and "v2.0.0" have entirely different histories.
main ... v2.0.0

60 changed files with 8250 additions and 5777 deletions

View File

@ -25,7 +25,7 @@ jobs:
registry-url: https://registry.npmjs.org/ registry-url: https://registry.npmjs.org/
- run: npm ci - run: npm ci
- run: npm run build:docs - run: npm run build:docs
- uses: actions/upload-pages-artifact@v3 - uses: actions/upload-pages-artifact@v2
with: with:
path: ./docs/api/ path: ./docs/api/
@ -37,5 +37,5 @@ jobs:
steps: steps:
- name: Deploy to GitHub Pages - name: Deploy to GitHub Pages
id: deployment id: deployment
uses: actions/deploy-pages@v4 # or the latest "vX.X.X" version tag for this action uses: actions/deploy-pages@v2 # or the latest "vX.X.X" version tag for this action

View File

@ -1,20 +0,0 @@
---
name: Run Tests (Node Minimum Version)
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 20
registry-url: https://registry.npmjs.org/
- name: Install dependencies
run: npm ci
- name: Run linter
run: npm run lint
- name: Run tests
run: npm run test:ci

View File

@ -1 +0,0 @@
https://orbitdb.org/funding.json

View File

@ -2,10 +2,4 @@
For now, please refer to our Git commit history for a list of changes. For now, please refer to our Git commit history for a list of changes.
https://github.com/orbitdb/orbitdb/compare/v2.5.0...v3.0.2 https://github.com/orbitdb/orbitdb/commits/v1.0.2
You can also use the following git command to generate a log of changes:
```
git log v2.5.0..v3.0.2 --oneline
```

View File

@ -28,7 +28,7 @@ Install OrbitDB and its dependencies:
npm install @orbitdb/core helia npm install @orbitdb/core helia
``` ```
### Browser `<script>` tag ### Browser <script> tag
OrbitDB can be loaded in the browser using the distributed js file with the `<script/>` tag. OrbitDB is the global namespace and all external functions are available via this namespace: OrbitDB can be loaded in the browser using the distributed js file with the `<script/>` tag. OrbitDB is the global namespace and all external functions are available via this namespace:
@ -45,23 +45,9 @@ If you're using `@orbitdb/core` to develop **browser** or **Node.js** applicatio
```javascript ```javascript
import { createHelia } from 'helia' import { createHelia } from 'helia'
import { createOrbitDB } from '@orbitdb/core' import { createOrbitDB } from '@orbitdb/core'
import { gossipsub } from "@chainsafe/libp2p-gossipsub";
import { identify } from "@libp2p/identify";
import { createLibp2p } from 'libp2p'
const Libp2pOptions = {
services: {
pubsub: gossipsub({
// neccessary to run a single peer
allowPublishToZeroTopicPeers: true
}),
identify: identify()
}
}
;(async function () { ;(async function () {
const libp2p = await createLibp2p({ ...Libp2pOptions }) const ipfs = await createHelia()
const ipfs = await createHelia({libp2p})
const orbitdb = await createOrbitDB({ ipfs }) const orbitdb = await createOrbitDB({ ipfs })
// Create / Open a database. Defaults to db type "events". // Create / Open a database. Defaults to db type "events".
@ -92,7 +78,6 @@ const Libp2pOptions = {
await orbitdb.stop() await orbitdb.stop()
await ipfs.stop() await ipfs.stop()
})() })()
``` ```
To configure your [IPFS instance](https://github.com/ipfs/helia) for persistency and [Libp2p](https://github.com/libp2p/js-libp2p) to connect to peers, see [Creating a Helia instance](https://github.com/orbitdb/quickstart/blob/main/src/index.js) and the [Default Libp2p Configurations](https://github.com/orbitdb/quickstart/blob/main/src/config/libp2p/index.js) in [@orbitdb/quickstart](https://github.com/orbitdb/quickstart/blob/main/src/config/libp2p/index.js) for examples. To configure your [IPFS instance](https://github.com/ipfs/helia) for persistency and [Libp2p](https://github.com/libp2p/js-libp2p) to connect to peers, see [Creating a Helia instance](https://github.com/orbitdb/quickstart/blob/main/src/index.js) and the [Default Libp2p Configurations](https://github.com/orbitdb/quickstart/blob/main/src/config/libp2p/index.js) in [@orbitdb/quickstart](https://github.com/orbitdb/quickstart/blob/main/src/config/libp2p/index.js) for examples.
@ -109,7 +94,6 @@ You can find more advanced topics in our [docs](https://github.com/orbitdb/orbit
- [Connecting Peers](https://github.com/orbitdb/orbitdb/blob/main/docs/CONNECTING_PEERS.md) - [Connecting Peers](https://github.com/orbitdb/orbitdb/blob/main/docs/CONNECTING_PEERS.md)
- [Replication](https://github.com/orbitdb/orbitdb/blob/main/docs/REPLICATION.md) - [Replication](https://github.com/orbitdb/orbitdb/blob/main/docs/REPLICATION.md)
- [Oplog](https://github.com/orbitdb/orbitdb/blob/main/docs/OPLOG.md) - [Oplog](https://github.com/orbitdb/orbitdb/blob/main/docs/OPLOG.md)
- [Encryption](https://github.com/orbitdb/orbitdb/blob/main/docs/ENCRYPTION.md)
### API ### API

View File

@ -1,68 +0,0 @@
import { createOrbitDB } from '../src/index.js'
// import { createOrbitDB, MemoryStorage } from '../src/index.js'
import { rimraf as rmrf } from 'rimraf'
import createHelia from '../test/utils/create-helia.js'
import { EventEmitter } from 'events'
EventEmitter.defaultMaxListeners = 10000
;(async () => {
console.log('Starting benchmark...')
const entryCount = 1000
await rmrf('./ipfs')
await rmrf('./orbitdb')
const ipfs = await createHelia()
const orbitdb = await createOrbitDB({ ipfs })
console.log(`Insert ${entryCount} documents`)
// const entryStorage = await MemoryStorage()
// const headsStorage = await MemoryStorage()
// const indexStorage = await MemoryStorage()
// const db1 = await orbitdb.open('benchmark-documents', { type: 'documents', referencesCount: 16, entryStorage, headsStorage, indexStorage })
const db1 = await orbitdb.open('benchmark-documents', { type: 'documents' })
const startTime1 = new Date().getTime()
for (let i = 0; i < entryCount; i++) {
const doc = { _id: i.toString(), message: 'hello ' + i }
await db1.put(doc)
}
const endTime1 = new Date().getTime()
const duration1 = endTime1 - startTime1
const operationsPerSecond1 = Math.floor(entryCount / (duration1 / 1000))
const millisecondsPerOp1 = duration1 / entryCount
console.log(`Inserting ${entryCount} documents took ${duration1} ms, ${operationsPerSecond1} ops/s, ${millisecondsPerOp1} ms/op`)
console.log(`Query ${entryCount} documents`)
const startTime2 = new Date().getTime()
const all = []
for await (const { key, value } of db1.iterator()) {
all.unshift({ key, value })
}
const endTime2 = new Date().getTime()
const duration2 = endTime2 - startTime2
const operationsPerSecond2 = Math.floor(entryCount / (duration2 / 1000))
const millisecondsPerOp2 = duration2 / entryCount
console.log(`Querying ${all.length} documents took ${duration2} ms, ${operationsPerSecond2} ops/s, ${millisecondsPerOp2} ms/op`)
await db1.drop()
await db1.close()
await orbitdb.stop()
await ipfs.stop()
await rmrf('./ipfs')
await rmrf('./orbitdb')
process.exit(0)
})()

View File

@ -1,60 +0,0 @@
import { createOrbitDB, KeyValueIndexed } from '../src/index.js'
import { rimraf as rmrf } from 'rimraf'
import createHelia from '../test/utils/create-helia.js'
import { EventEmitter } from 'events'
EventEmitter.defaultMaxListeners = 10000
;(async () => {
console.log('Starting benchmark...')
const entryCount = 1000
await rmrf('./ipfs')
await rmrf('./orbitdb')
const ipfs = await createHelia()
const orbitdb = await createOrbitDB({ ipfs })
console.log(`Set ${entryCount} keys/values`)
const db1 = await orbitdb.open('benchmark-keyvalue-indexed', { Database: KeyValueIndexed() })
const startTime1 = new Date().getTime()
for (let i = 0; i < entryCount; i++) {
await db1.set(i.toString(), 'hello' + i)
}
const endTime1 = new Date().getTime()
const duration1 = endTime1 - startTime1
const operationsPerSecond1 = Math.floor(entryCount / (duration1 / 1000))
const millisecondsPerOp1 = duration1 / entryCount
console.log(`Setting ${entryCount} key/values took ${duration1} ms, ${operationsPerSecond1} ops/s, ${millisecondsPerOp1} ms/op`)
console.log(`Iterate ${entryCount} key/values`)
const startTime2 = new Date().getTime()
const all = []
for await (const { key, value } of db1.iterator()) {
all.unshift({ key, value })
}
const endTime2 = new Date().getTime()
const duration2 = endTime2 - startTime2
const operationsPerSecond2 = Math.floor(entryCount / (duration2 / 1000))
const millisecondsPerOp2 = duration2 / entryCount
console.log(`Iterating ${all.length} key/values took ${duration2} ms, ${operationsPerSecond2} ops/s, ${millisecondsPerOp2} ms/op`)
await db1.drop()
await db1.close()
await orbitdb.stop()
await ipfs.stop()
await rmrf('./ipfs')
await rmrf('./orbitdb')
process.exit(0)
})()

View File

@ -45,10 +45,8 @@ EventEmitter.defaultMaxListeners = 10000
let connected = false let connected = false
const onJoin = async (peerId) => (connected = true) const onJoin = async (peerId) => (connected = true)
const onError = async (err) => console.error(err)
db2.events.on('join', onJoin) db2.events.on('join', onJoin)
db2.events.on('error', onError)
await waitFor(() => connected, () => true) await waitFor(() => connected, () => true)

View File

@ -2,7 +2,7 @@
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<title>OrbitDB API - v2.1</title> <title>OrbitDB API - v1.0</title>
<script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>

View File

@ -38,8 +38,6 @@ export default (env, argv) => {
], ],
fallback: { fallback: {
path: require.resolve('path-browserify'), path: require.resolve('path-browserify'),
crypto: false,
stream: require.resolve('stream-browserify'),
process: false process: false
} }
}, },

View File

@ -10,13 +10,11 @@ Different access controllers can be assigned to the database using the `AccessCo
import { createLibp2p } from 'libp2p' import { createLibp2p } from 'libp2p'
import { createHelia } from 'helia' import { createHelia } from 'helia'
import { createOrbitDB } from '@orbitdb/core' import { createOrbitDB } from '@orbitdb/core'
import { LevelBlockstore } from 'blockstore-level'
import { Libp2pOptions } from './config/libp2p.js'
import * as SomeAccessController from 'some-access-controller.js' import * as SomeAccessController from 'some-access-controller.js'
import { Libp2pOptions } from './config/libp2p.js'
const blockstore = new LevelBlockstore('./ipfs')
const libp2p = await createLibp2p(Libp2pOptions) const libp2p = await createLibp2p(Libp2pOptions)
const ipfs = await createHelia({ libp2p, blockstore }) const ipfs = await createHelia({ libp2p })
const orbitdb = await createOrbitDB({ ipfs }) const orbitdb = await createOrbitDB({ ipfs })
@ -41,13 +39,11 @@ To change write access, pass the IPFSAccessController with the `write` parameter
```js ```js
import { createLibp2p } from 'libp2p' import { createLibp2p } from 'libp2p'
import { createHelia } from 'helia' import { createHelia } from 'helia'
import { LevelBlockstore } from 'blockstore-level'
import { createOrbitDB, Identities, IPFSAccessController } from '@orbitdb/core' import { createOrbitDB, Identities, IPFSAccessController } from '@orbitdb/core'
import { Libp2pOptions } from './config/libp2p.js' import { Libp2pOptions } from './config/libp2p.js'
const blockstore = new LevelBlockstore('./ipfs')
const libp2p = await createLibp2p(Libp2pOptions) const libp2p = await createLibp2p(Libp2pOptions)
const ipfs = await createHelia({ libp2p, blockstore }) const ipfs = await createHelia({ libp2p })
const identities = await Identities() const identities = await Identities()
const anotherIdentity = identities.createIdentity('userB') const anotherIdentity = identities.createIdentity('userB')
@ -64,11 +60,9 @@ To allow anyone to write to the database, specify the wildcard '*':
```js ```js
import { createLibp2p } from 'libp2p' import { createLibp2p } from 'libp2p'
import { createHelia } from 'helia' import { createHelia } from 'helia'
import { LevelBlockstore } from 'blockstore-level'
import { createOrbitDB, Identities, IPFSAccessController } from '@orbitdb/core' import { createOrbitDB, Identities, IPFSAccessController } from '@orbitdb/core'
import { Libp2pOptions } from './config/libp2p.js' import { Libp2pOptions } from './config/libp2p.js'
const blockstore = new LevelBlockstore('./ipfs')
const libp2p = await createLibp2p(Libp2pOptions) const libp2p = await createLibp2p(Libp2pOptions)
const ipfs = await createHelia({ libp2p }) const ipfs = await createHelia({ libp2p })
@ -86,17 +80,15 @@ The OrbitDB access controller provides configurable write access using grant and
```js ```js
import { createLibp2p } from 'libp2p' import { createLibp2p } from 'libp2p'
import { createHelia } from 'helia' import { createHelia } from 'helia'
import { LevelBlockstore } from 'blockstore-level'
import { createOrbitDB, Identities, OrbitDBAccessController } from '@orbitdb/core' import { createOrbitDB, Identities, OrbitDBAccessController } from '@orbitdb/core'
import { Libp2pOptions } from './config/libp2p.js' import { Libp2pOptions } from './config/libp2p.js'
const blockstore = new LevelBlockstore('./ipfs')
const libp2p = await createLibp2p(Libp2pOptions) const libp2p = await createLibp2p(Libp2pOptions)
const ipfs = await createHelia({ libp2p }) const ipfs = await createHelia({ libp2p })
const orbitdb = await createOrbitDB({ ipfs }) const orbitdb = await createOrbitDB({ ipfs })
const identities = await Identities({ ipfs }) const identities = await Identities()
const anotherIdentity = identities.createIdentity('userB') const anotherIdentity = identities.createIdentity('userB')
const db = orbitdb.open('my-db', { AccessController: OrbitDBAccessController({ write: [orbitdb.identity.id, anotherIdentity.id]) }) const db = orbitdb.open('my-db', { AccessController: OrbitDBAccessController({ write: [orbitdb.identity.id, anotherIdentity.id]) })
@ -170,21 +162,6 @@ const canAppend = async (entry) => {
In the above example, the `entry.identity` will be the hash of the identity. Using this hash, the entire identity can be retrieved and the identity's id is used to verify write access. `write.includes('*')` is wildcard write and would allow any identity to write to the operations log. In the above example, the `entry.identity` will be the hash of the identity. Using this hash, the entire identity can be retrieved and the identity's id is used to verify write access. `write.includes('*')` is wildcard write and would allow any identity to write to the operations log.
The Identities getIdentity function will fetch the identity from the Identities storage, requesting it from the remote peer if it is not available locally. To synchronize identities across peers, IPFSStorage must be used. To enable IPFSStorage for Identities, pass either an instance of IPFS or an IPFS-enabled storage to the Identities function.
To pass IPFS to Identities:
```
const identities = await Identities({ ipfs })
```
To pass IPFS-enabled storage:
```
const storage = await IPFSStorage({ ipfs })
const identities = await Identities{{ storage })
```
### Using a custom access controller with OrbitDB ### Using a custom access controller with OrbitDB
Before passing the custom access controller to the `open` function, it must be added to OrbitDB's AccessControllers: Before passing the custom access controller to the `open` function, it must be added to OrbitDB's AccessControllers:
@ -192,15 +169,13 @@ Before passing the custom access controller to the `open` function, it must be a
```js ```js
import { createLibp2p } from 'libp2p' import { createLibp2p } from 'libp2p'
import { createHelia } from 'helia' import { createHelia } from 'helia'
import { LevelBlockstore } from 'blockstore-level'
import { createOrbitDB, useAccessController } from '@orbitdb/core' import { createOrbitDB, useAccessController } from '@orbitdb/core'
import { Libp2pOptions } from './config/libp2p.js' import { Libp2pOptions } from './config/libp2p.js'
const blockstore = new LevelBlockstore('./ipfs')
const libp2p = await createLibp2p(Libp2pOptions) const libp2p = await createLibp2p(Libp2pOptions)
const ipfs = await createHelia({ libp2p, blockstore }) const ipfs = await createHelia({ libp2p })
useAccessController(CustomAccessController) useAccessController(CustomAccessController)
const orbitdb = await createOrbitDB({ ipfs }) const orbitdb = await createOrbitDB({ ipfs })
const db = await orbitdb.open('my-db', { AccessController: CustomAccessController(params) }) const db = await orbitdb.open('my-db', { AccessController: CustomAccessController(params) })
``` ```

View File

@ -72,7 +72,7 @@ const options = {
filter: filters.all filter: filters.all
}) })
], ],
connectionEncrypters: [noise()], connectionEncryption: [noise()],
streamMuxers: [yamux()], streamMuxers: [yamux()],
services: { services: {
identify: identify(), identify: identify(),
@ -114,7 +114,7 @@ const options = {
discoverRelays: 1 discoverRelays: 1
}) })
], ],
connectionEncrypters: [noise()], connectionEncryption: [noise()],
streamMuxers: [yamux()], streamMuxers: [yamux()],
connectionGater: { connectionGater: {
denyDialMultiaddr: () => { denyDialMultiaddr: () => {
@ -180,7 +180,7 @@ const options = {
discoverRelays: 1 discoverRelays: 1
}) })
], ],
connectionEncrypters: [noise()], connectionEncryption: [noise()],
streamMuxers: [yamux()], streamMuxers: [yamux()],
connectionGater: { connectionGater: {
denyDialMultiaddr: () => { denyDialMultiaddr: () => {
@ -247,7 +247,7 @@ const options = {
discoverRelays: 1 discoverRelays: 1
}) })
], ],
connectionEncrypters: [noise()], connectionEncryption: [noise()],
streamMuxers: [yamux()], streamMuxers: [yamux()],
connectionGater: { connectionGater: {
denyDialMultiaddr: () => { denyDialMultiaddr: () => {

View File

@ -208,7 +208,7 @@ for await (const record of db2.iterator()) {
} }
``` ```
To learn more, check out [OrbitDB's sychronization protocol](https://api.orbitdb.org/module-Sync.html) and the [OrbitDB replication documentation](./REPLICATION.md). To learn more, check out [OrbitDB's sychronization protocol](https://orbitdb.org/api/module-Sync.html) and the [OrbitDB replication documentation](./REPLICATION.md).
## Custom databases ## Custom databases
@ -264,7 +264,7 @@ CustomDB.type = type
export default CustomDB export default CustomDB
``` ```
[Documents](../src/databases/documents.js), [Events](../src/databases/events.js) and [KeyValue](../src/databases/keyvalue.js) provide good examples of how a database is implemented in OrbitDB and how to add the logic for returning records from the database (the state of the database). [Documents](../src/db/documents.js), [Events](../src/db/events.js) and [KeyValue](../src/db/keyvalue.js) provide good examples of how a database is implemented in OrbitDB and how to add the logic for returning records from the database (the state of the database).
To use a custom database, add it to the list of supported database types: To use a custom database, add it to the list of supported database types:

View File

@ -1,94 +0,0 @@
# Encryption
OrbitDB features a modular architecture for database encryption. By passing a module to an OrbitDB database, different encryption methods can be employed.
OrbitDB project currently maintains a [SimpleEncryption](https://github.com/orbitdb/simple-encryption) module that can be used to get started with encrypted databases.
**WARNING:** SimpleEncryption is an unaudited encryption module. Use at your own risk.
## How it works
OrbitDB encrypts databases in two layers: encrypting the payload and encrypting the log entry.
Log entry encryption encrypts each log entry fully. Payload encryption encrypts just the value.
This makes it possible to separate users of a database and replicators of a database, ie. an orbitdb peer can replicate a database without being able to decrypt the payloads (=data) of the database.
## Configuring encryption
You can configure OrbitDB to encrypt either the payload data being stored or the entire database.
To ***encrypt payload data only***, specify an encryption module and pass it to OtbiDB via the encryption object using the `data` property:
```
const data = await EncryptionModule()
const encryption = { data }
const db = await orbitdb.open(dbNameOrAddress, { encryption })
```
To ***encrypt the database log entries***, specify an encryption module and pass it to OrbitDB via the encryption object using the `replication` property:
```
const replication = await EncryptionModule()
const encryption = { replication }
const db = await orbitdb.open(dbNameOrAddress, { encryption })
```
To ***encrypt the whole database***, payload data and oplog entries separately, specify an encryption module and pass it to OrbitDB via the encryption object using both the `replication` and `data` properties:
```
const replication = await EncryptionModule()
const data = await EncryptionModule()
const encryption = { replication, data }
const db = await orbitdb.open(dbNameOrAddress, { encryption })
```
## Encrypting Databases
OrbitDB provides simple password-based encryption via an external module called [SimpleEncryption](https://github.com/orbitdb/simple-encryption).
**WARNING:** This is an unaudited encryption module. Use at your own risk.
To install SimpleEncryption:
```
npm i @orbitdb/simple-encryption
```
To use encryption, initiate SimpleEncryption with a password and pass it to OrbitDB when opening your database:
```js
import { SimpleEncryption } from '@orbitdb/simple-encryption'
const replication = await SimpleEncryption({ password: 'hello' })
const data = await SimpleEncryption({ password: 'world' })
const encryption = { data, replication }
const db = await orbitdb.open(dbNameOrAddress, { encryption })
```
If you wish to use another encryption type, simply replace SimpleEncryption with the module of your choice.
## Custom Encryption
To implement a custom encryption module for OrbitDB, expose encrypt and decrypt functions:
```
const CustomEncryption = async () => {
const encrypt = (value) => {
// return encrypted value
}
const decrypt = (value) => {
// return decrypted value
}
return {
encrypt,
decrypt
}
}
export default CustomEncryption
```

View File

@ -4,15 +4,21 @@ This guide will help you get up and running with a simple OrbitDB database that
## install ## install
Install OrbitDB and Helia: Install OrbitDB:
```sh ```sh
npm i helia @orbitdb/core npm i @orbitdb/core
```
You will also need Helia for replication:
```sh
npm i helia
``` ```
## Prerequisites: Helia and Libp2p ## Prerequisites: Helia and Libp2p
OrbitDB uses Helia for block storage and Libp2p for database synchronization. You will need to configure Helia and pass it to OrbitDB when creating a peer. OrbitDB uses Helia for block storage and Libp2p for database synchronization. However, you need to configure Helia and pass it to OrbitDB when creating a peer.
### Block Storage ### Block Storage
@ -27,7 +33,7 @@ then instantiate and pass to Helia:
``` ```
import { LevelBlockstore } from 'blockstore-level' import { LevelBlockstore } from 'blockstore-level'
const blockstore = new LevelBlockstore('./ipfs/blocks') const blockstore = new LevelBlockstore('./ipfs')
const ipfs = createHelia({ blockstore }) const ipfs = createHelia({ blockstore })
``` ```
@ -39,53 +45,58 @@ An instance of Libp2p is required by Helia which is then used by OrbitDB to sync
A simple Node.js example might look something like: A simple Node.js example might look something like:
```js ```json
{ {
peerDiscovery: [
mdns()
],
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0/ws']
}, },
transports: [ transports: [
tcp() webSockets({
filter: all
}),
webRTC(),
circuitRelayTransport({
discoverRelays: 1
})
], ],
connectionEncrypters: [noise()], connectionEncryption: [noise()],
streamMuxers: [yamux()], streamMuxers: [yamux()],
connectionGater: {
denyDialMultiaddr: () => false
},
services: { services: {
identify: identify(), identify: identify(),
pubsub: gossipsub({ allowPublishToZeroTopicPeers: true }) pubsub: gossipsub({ allowPublishToZeroPeers: true })
} }
} }
``` ```
You can export the above configuration from an ES module: You can export the above configuration from a file:
```js ```js
import { tcp } from '@libp2p/tcp'
import { identify } from '@libp2p/identify'
import { gossipsub } from '@chainsafe/libp2p-gossipsub'
import { noise } from '@chainsafe/libp2p-noise'
import { yamux } from '@chainsafe/libp2p-yamux'
import { mdns } from '@libp2p/mdns'
export const Libp2pOptions = { export const Libp2pOptions = {
peerDiscovery: [
mdns()
],
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/0'] listen: ['/ip4/0.0.0.0/tcp/0/ws']
}, },
transports: [ transports: [
tcp() webSockets({
filter: all
}),
webRTC(),
circuitRelayTransport({
discoverRelays: 1
})
], ],
connectionEncrypters: [noise()], connectionEncryption: [noise()],
streamMuxers: [yamux()], streamMuxers: [yamux()],
connectionGater: {
denyDialMultiaddr: () => false
},
services: { services: {
identify: identify(), identify: identify(),
pubsub: gossipsub({ allowPublishToZeroTopicPeers: true }) pubsub: gossipsub({ allowPublishToZeroPeers: true })
} }
} }
``` ```
Throughout this documentation, you will see the above Libp2p configuration imported from a file called **./config/libp2p.js**, for example: Throughout this documentation, you will see the above Libp2p configuration imported from a file called **./config/libp2p.js**, for example:
@ -104,7 +115,6 @@ Assuming you have a Node.js development environment installed, create a new proj
mkdir orbitdb-app mkdir orbitdb-app
cd orbitdb-app cd orbitdb-app
npm init npm init
npm i helia @orbitdb/core blockstore-level @chainsafe/libp2p-gossipsub
``` ```
Create a file in your project called index.js and add the following code to it: Create a file in your project called index.js and add the following code to it:
@ -113,13 +123,11 @@ Create a file in your project called index.js and add the following code to it:
import { createLibp2p } from 'libp2p' import { createLibp2p } from 'libp2p'
import { createHelia } from 'helia' import { createHelia } from 'helia'
import { createOrbitDB } from '@orbitdb/core' import { createOrbitDB } from '@orbitdb/core'
import { LevelBlockstore } from 'blockstore-level'
import { Libp2pOptions } from './config/libp2p.js' import { Libp2pOptions } from './config/libp2p.js'
// Create an IPFS instance. // Create an IPFS instance.
const blockstore = new LevelBlockstore('./ipfs/blocks')
const libp2p = await createLibp2p(Libp2pOptions) const libp2p = await createLibp2p(Libp2pOptions)
const ipfs = await createHelia({ libp2p, blockstore }) const ipfs = await createHelia({ libp2p })
const orbitdb = await createOrbitDB({ ipfs }) const orbitdb = await createOrbitDB({ ipfs })
@ -146,20 +154,21 @@ Run index.js to create your new OrbitDB database:
node index.js node index.js
``` ```
You should see the address of your new database and the records you have added to it. You should see the address of your new database and the records you have added
to it.
Without a type, OrbitDB defaults to a database type of 'events'. To change the database type, pass the `type` parameter with a valid database type. Without a type, OrbitDB defaults to a database type of 'events'. To change the database type, pass the `type` parameter with a valid database type.
Change: Update:
```js ```js
const db = await orbitdb.open('my-db') const db = await orbitdb.open('my-db')
``` ```
to: to read:
```js ```js
const db = await orbitdb.open('my-documents-db', { type: 'documents' }) const db = await orbitdb.open('my-documents-db', { 'documents '})
``` ```
Also replace: Also replace:
@ -172,8 +181,8 @@ await db.add('hello world 2')
with: with:
```js ```js
await db.put({ _id: "doc1", hello: "world 1", hits: 5 }) await db.put('doc1', { hello: "world 1", hits: 5 })
await db.put({ _id: "doc2", hello: "world 2", hits: 2 }) await db.put('doc2', { hello: "world 2", hits: 2 })
``` ```
Run index.js again: Run index.js again:
@ -195,7 +204,6 @@ To create an OrbitDB database peer, create a new project called `orbitdb-peer`:
mkdir orbitdb-peer mkdir orbitdb-peer
cd orbitdb-peer cd orbitdb-peer
npm init npm init
npm i helia @orbitdb/core blockstore-level @chainsafe/libp2p-gossipsub
``` ```
Create a new file called index.js and paste in the following code: Create a new file called index.js and paste in the following code:
@ -203,59 +211,50 @@ Create a new file called index.js and paste in the following code:
```js ```js
import { createLibp2p } from 'libp2p' import { createLibp2p } from 'libp2p'
import { createHelia } from 'helia' import { createHelia } from 'helia'
import { createOrbitDB, IPFSAccessController } from '@orbitdb/core' import { OrbitDB, IPFSAccessController } from '@orbitdb/core'
import { LevelBlockstore } from 'blockstore-level'
import { Libp2pOptions } from './config/libp2p.js' import { Libp2pOptions } from './config/libp2p.js'
import { multiaddr } from '@multiformats/multiaddr'
const main = async () => { const main = async () => {
const libp2p = await createLibp2p(Libp2pOptions)
const ipfs = await createHelia({ libp2p })
// create a random directory to avoid OrbitDB conflicts. // create a random directory to avoid OrbitDB conflicts.
let randDir = (Math.random() + 1).toString(36).substring(2) let randDir = (Math.random() + 1).toString(36).substring(2)
const blockstore = new LevelBlockstore(`./${randDir}/ipfs/blocks`)
const libp2p = await createLibp2p(Libp2pOptions)
const ipfs = await createHelia({ libp2p, blockstore })
const orbitdb = await createOrbitDB({ ipfs, directory: `./${randDir}/orbitdb` }) const orbitdb = await createOrbitDB({ ipfs, directory: `./${randDir}/orbitdb` })
let db let db
if (process.argv[2] && process.argv[3]) { if (process.argv[2]) {
await orbitdb.ipfs.libp2p.dial(multiaddr(process.argv[3]))
console.log('opening db', process.argv[2])
db = await orbitdb.open(process.argv[2]) db = await orbitdb.open(process.argv[2])
} else { } else {
// When we open a new database, write access is only available to the // When we open a new database, write access is only available to the
// db creator. If we want to allow other peers to write to the database, // db creator. When replicating a database on a remote peer, the remote
// they must be specified in IPFSAccessController write array param. Here, // peer must also have write access. Here, we are simply allowing anyone
// we simply allow anyone to write to the database. A more robust solution // to write to the database. A more robust solution would use the
// would use the OrbitDBAccessController to provide mutable, "fine-grain" // OrbitDBAccessController to provide "fine-grain" access using grant and
// access using grant and revoke. // revoke.
db = await orbitdb.open('my-db', { AccessController: IPFSAccessController({ write: ['*']}) }) db = await orbitdb.open('my-db', { AccessController: IPFSAccessController({ write: ['*']})})
console.log('libp2p address', '(copy one of these addresses then dial into this node from the second node)', orbitdb.ipfs.libp2p.getMultiaddrs())
// Copy this output if you want to connect a peer to another.
console.log('my-db address', '(copy my db address and use when launching peer 2)', db.address)
} }
db.events.on('update', async (entry) => { // Copy this output if you want to connect a peer to another.
// what has been updated. console.log('my-db address', db.address)
console.log('update', entry.payload.value)
// Add some records to the db when another peers joins.
db.events.on('join', async (peerId, heads) => {
await db.add('hello world 1')
await db.add('hello world 2')
}) })
if (process.argv[2]) { db.events.on('update', async (entry) => {
await db.add('hello from second peer') console.log('entry', entry)
await db.add('hello again from second peer')
} else { // To complete full replication, fetch all the records from the other peer.
// write some records await db.all()
await db.add('hello from first peer') })
await db.add('hello again from first peer')
}
// Clean up when stopping this app using ctrl+c // Clean up when stopping this app using ctrl+c
process.on('SIGINT', async () => { process.on('SIGINT', async () => {
// print the final state of the db.
console.log((await db.all()).map(e => e.value))
// Close your db and stop OrbitDB and IPFS. // Close your db and stop OrbitDB and IPFS.
await db.close() await db.close()
await orbitdb.stop() await orbitdb.stop()
@ -268,44 +267,30 @@ const main = async () => {
main() main()
``` ```
Launch peer 1 from the terminal: Open two consoles in your command line terminal.
```bash In terminal 1, run the first peer:
node test.js
```sh
node index.js
``` ```
Once launched you will see some output which may look something like this: When running, you should see the address of the database, for example:
``` ```sh
libp2p address (copy one of these addresses then dial into this node from the second node) [ my-db address /orbitdb/zdpuB2aYUCnZ7YUBrDkCWpRLQ8ieUbqJEVRZEd5aDhJBDpBqj
Multiaddr(/ip4/127.0.0.1/tcp/36161/p2p/12D3KooWKFWB78Hka2uPVNYYoXfucWp6rDLsQzr5CFiP67NAo7YF),
Multiaddr(/ip4/192.168.1.22/tcp/36161/p2p/12D3KooWKFWB78Hka2uPVNYYoXfucWp6rDLsQzr5CFiP67NAo7YF),
Multiaddr(/ip4/100.64.100.6/tcp/36161/p2p/12D3KooWKFWB78Hka2uPVNYYoXfucWp6rDLsQzr5CFiP67NAo7YF)
]
my-db address (copy my db address and use when launching peer 2) /orbitdb/zdpuB2aYUCnZ7YUBrDkCWpRLQ8ieUbqJEVRZEd5aDhJBDpBqj
``` ```
It contains the libp2p address and db address. You will need both of these when connecting from peer 2. Copy the database's address from terminal 1 and, in terminal 2, run:
Open another terminal and launch peer 2. The command takes the form `node test.js <orbitdb-address> <libp2p-address>` ```sh
node index.js /orbitdb/zdpuB2aYUCnZ7YUBrDkCWpRLQ8ieUbqJEVRZEd5aDhJBDpBqj
```bash
node test.js /orbitdb/zdpuB2aYUCnZ7YUBrDkCWpRLQ8ieUbqJEVRZEd5aDhJBDpBqj /ip4/127.0.0.1/tcp/36161/p2p/12D3KooWKFWB78Hka2uPVNYYoXfucWp6rDLsQzr5CFiP67NAo7YF
``` ```
What is happening is the second peer is dialing the first peer on the /ip4/ address then opens the database. Upon connection, you should see the records being created in terminal 1's database received by the database running in terminal 2.
**PLEASE NOTE:**
This example is using mDNS to find peers on a local network. This example will not work if each peer is on a different network and you will need to implement an alternative peer discovery mechanism to achieve connectivity. Alternatively, if the address of one of the peers is known and is accessible, the other peer can dial it manually.
These kinds of connectivity configurations are beyond the scope of OrbitDB. To find out more about connectivity in Libp2p, check out https://connectivity.libp2p.io/.
## Further Reading ## Further Reading
[Databases](./DATABASES.md) covers database management and data entry in more detail. [Databases](./DATABASES.md) covers database management and data entry in more detail.
[Replication](./REPLICATION.md) provides a comprehensive overview of how to perform data replication across multiple peers. [Replication](./REPLICATION.md) provides a comprehensive overview of how to perform data replication across multiple peers.
[Encryption](./ENCRYPTION.md) discusses database encryption using OrbitDB's modular architecture.

View File

@ -89,8 +89,7 @@ The identity object is stored like any other [IPLD data structure](https://ipld.
```js ```js
import { createLibp2p } from 'libp2p' import { createLibp2p } from 'libp2p'
import { createHelia } from 'helia' import { createHelia } from 'helia' from 'ipfs-core'
import { LevelBlockstore } from 'blockstore-level'
import * as Block from 'multiformats/block' import * as Block from 'multiformats/block'
import { Identities } from '@orbitdb/core' import { Identities } from '@orbitdb/core'
import * as dagCbor from '@ipld/dag-cbor' import * as dagCbor from '@ipld/dag-cbor'
@ -99,9 +98,8 @@ import { base58btc } from 'multiformats/bases/base58'
import { CID } from 'multiformats/cid' import { CID } from 'multiformats/cid'
import { Libp2pOptions } from './config/libp2p.js' import { Libp2pOptions } from './config/libp2p.js'
const blockstore = new LevelBlockstore('./ipfs')
const libp2p = await createLibp2p(Libp2pOptions) const libp2p = await createLibp2p(Libp2pOptions)
const ipfs = await createHelia({ libp2p, blockstore }) const ipfs = await createHelia({ libp2p })
const identities = await Identities({ ipfs }) const identities = await Identities({ ipfs })
const identity = await identities.createIdentity({ id: 'me' }) const identity = await identities.createIdentity({ id: 'me' })
@ -109,7 +107,7 @@ const identity = await identities.createIdentity({ id: 'me' })
const cid = CID.parse(identity.hash, base58btc) const cid = CID.parse(identity.hash, base58btc)
// Extract the hash from the full db path. // Extract the hash from the full db path.
const bytes = await ipfs.blockstore.get(cid) const bytes = await ipfs.block.get(cid)
// Defines how we serialize/hash the data. // Defines how we serialize/hash the data.
const codec = dagCbor const codec = dagCbor

View File

@ -5,16 +5,14 @@ Below is a simple replication example. Both peers run within the same Nodejs pro
```js ```js
import { createLibp2p } from 'libp2p' import { createLibp2p } from 'libp2p'
import { createHelia } from 'helia' import { createHelia } from 'helia'
import { LevelBlockstore } from 'blockstore-level'
import { createOrbitDB } from '@orbitdb/core' import { createOrbitDB } from '@orbitdb/core'
import { Libp2pOptions } from './config/libp2p.js' import { Libp2pOptions } from './config/libp2p.js'
// Our ipfs instances will be connecting over tcp. You can find out more about peer connectivity at https://connectivity.libp2p.io/. // Our ipfs instances will be connecting over websockets. However, you could achieve the same here using tcp. You can find out more about peer connectivity at https://connectivity.libp2p.io/.
const initIPFSInstance = () => { const initIPFSInstance = () => {
const blockstore = new LevelBlockstore('./ipfs')
const libp2p = await createLibp2p(Libp2pOptions) const libp2p = await createLibp2p(Libp2pOptions)
return createHelia({ libp2p, blockstore }) return createHelia({ libp2p })
} }
const ipfs1 = await initIPFSInstance() const ipfs1 = await initIPFSInstance()
@ -38,7 +36,9 @@ const db1 = await orbitdb1.open('my-db')
// synchronization of the heads between db1 and db2. // synchronization of the heads between db1 and db2.
const db2 = await orbitdb2.open(db1.address) const db2 = await orbitdb2.open(db1.address)
// We write some data to db1. This will automatically replicated on db2 // We write some data to db1. This will not be replicated on db2 until we
// explicitly request these records using db2's iterator or all() convenience
// function.
await db1.add('hello world 1') await db1.add('hello world 1')
await db1.add('hello world 2') await db1.add('hello world 2')
await db1.add('hello world 3') await db1.add('hello world 3')
@ -80,4 +80,4 @@ await orbitdb2.stop()
await ipfs2.stop() await ipfs2.stop()
``` ```
Refer to the API for more information about [OrbitDB's synchronization protocol](https://api.orbitdb.org/module-Sync.html). Refer to the API for more information about [OrbitDB's synchronization protocol](https://orbitdb.org/api/module-Sync.html).

View File

@ -1,4 +1,4 @@
## OrbitDB API - v3.0 ## OrbitDB API - v2.0
OrbitDB is a serverless, distributed, peer-to-peer database. OrbitDB uses IPFS OrbitDB is a serverless, distributed, peer-to-peer database. OrbitDB uses IPFS
as its data storage and Libp2p Pubsub to automatically sync databases with peers. It's an eventually consistent database that uses Merkle-CRDTs for conflict-free database writes and merges making OrbitDB an excellent choice for p2p and decentralized apps, blockchain applications and local first web applications. as its data storage and Libp2p Pubsub to automatically sync databases with peers. It's an eventually consistent database that uses Merkle-CRDTs for conflict-free database writes and merges making OrbitDB an excellent choice for p2p and decentralized apps, blockchain applications and local first web applications.
@ -9,21 +9,19 @@ To install OrbitDB:
npm install @orbitdb/core npm install @orbitdb/core
``` ```
Helia, the Javascript version of IPFS, is also required: IPFS is also required:
```bash ```bash
npm install helia npm install ipfs-core
``` ```
Instantiate OrbitDB and create a database: Instantiate OrbitDB and create a database:
```js ```js
import { createLibp2p } from 'libp2p' import { create } from 'ipfs-core'
import { createHelia } from 'helia'
import { createOrbitDB } from '@orbitdb/core' import { createOrbitDB } from '@orbitdb/core'
const libp2p = await createLibp2p({ /* Libp2p options */ }) const ipfs = await create() // IPFS is required for storage and network communication
const ipfs = await createHelia({ libp2p }) // Helia is required for storage and network communication
const orbitdb = await createOrbitDB({ ipfs }) const orbitdb = await createOrbitDB({ ipfs })
const mydb = await orbitdb.open('mydb') const mydb = await orbitdb.open('mydb')
console.log(mydb.address) // /orbitdb/zdpuAuK3BHpS7NvMBivynypqciYCuy2UW77XYBPUYRnLjnw13 console.log(mydb.address) // /orbitdb/zdpuAuK3BHpS7NvMBivynypqciYCuy2UW77XYBPUYRnLjnw13
@ -34,12 +32,10 @@ Open and replicate an existing database:
```js ```js
// In another process // In another process
import { createLibp2p } from 'libp2p' import { create } from 'ipfs-core'
import { createHelia } from 'helia'
import { createOrbitDB } from '@orbitdb/core' import { createOrbitDB } from '@orbitdb/core'
const libp2p = await createLibp2p({ /* Libp2p options */ }) const ipfs = await create()
const ipfs = await createHelia({ libp2p }) // Helia is required for storage and network
const orbitdb = await createOrbitDB({ ipfs }) const orbitdb = await createOrbitDB({ ipfs })
const theirdb = await orbitdb.open('/orbitdb/zdpuAuK3BHpS7NvMBivynypqciYCuy2UW77XYBPUYRnLjnw13') const theirdb = await orbitdb.open('/orbitdb/zdpuAuK3BHpS7NvMBivynypqciYCuy2UW77XYBPUYRnLjnw13')
for await (let record of theirdb.iterator()) { for await (let record of theirdb.iterator()) {

11514
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{ {
"name": "@orbitdb/core", "name": "@orbitdb/core",
"version": "3.0.2", "version": "2.0.0",
"description": "Distributed p2p database on IPFS", "description": "Distributed p2p database on IPFS",
"author": "Haad", "author": "Haad",
"license": "MIT", "license": "MIT",
@ -19,7 +19,7 @@
"main": "src/index.js", "main": "src/index.js",
"dependencies": { "dependencies": {
"@ipld/dag-cbor": "^9.0.6", "@ipld/dag-cbor": "^9.0.6",
"@libp2p/crypto": "^5.0.5", "@libp2p/crypto": "^3.0.2",
"it-pipe": "^3.0.1", "it-pipe": "^3.0.1",
"level": "^8.0.0", "level": "^8.0.0",
"lru": "^3.1.0", "lru": "^3.1.0",
@ -29,19 +29,19 @@
"uint8arrays": "^5.0.0" "uint8arrays": "^5.0.0"
}, },
"devDependencies": { "devDependencies": {
"@chainsafe/libp2p-gossipsub": "^14.1.0", "@chainsafe/libp2p-yamux": "^6.0.1",
"@libp2p/circuit-relay-v2": "^3.1.0", "@helia/block-brokers": "^1.0.0",
"@orbitdb/simple-encryption": "^0.0.2", "@libp2p/circuit-relay-v2": "^1.0.10",
"blockstore-level": "^2.0.1", "blockstore-level": "^1.1.7",
"c8": "^8.0.1", "c8": "^8.0.1",
"cross-env": "^7.0.3", "cross-env": "^7.0.3",
"fs-extra": "^11.2.0", "fs-extra": "^11.2.0",
"helia": "^5.3.0", "helia": "^3.0.1",
"it-all": "^3.0.4", "it-all": "^3.0.4",
"jsdoc": "^4.0.2", "jsdoc": "^4.0.2",
"mocha": "^10.2.0", "mocha": "^10.2.0",
"path-browserify": "^1.0.1", "path-browserify": "^1.0.1",
"playwright-test": "^14.1.9", "playwright-test": "^14.0.0",
"rimraf": "^5.0.5", "rimraf": "^5.0.5",
"standard": "^17.1.0", "standard": "^17.1.0",
"webpack": "^5.89.0", "webpack": "^5.89.0",

View File

@ -84,7 +84,7 @@ const IPFSAccessController = ({ write, storage } = {}) => async ({ orbitdb, iden
// Allow if the write access list contain the writer's id or is '*' // Allow if the write access list contain the writer's id or is '*'
if (write.includes(id) || write.includes('*')) { if (write.includes(id) || write.includes('*')) {
// Check that the identity is valid // Check that the identity is valid
return await identities.verifyIdentity(writerIdentity) return identities.verifyIdentity(writerIdentity)
} }
return false return false
} }

View File

@ -58,7 +58,7 @@ const OrbitDBAccessController = ({ write } = {}) => async ({ orbitdb, identities
// If the ACL contains the writer's public key or it contains '*' // If the ACL contains the writer's public key or it contains '*'
const hasWriteAccess = await hasCapability('write', id) || await hasCapability('admin', id) const hasWriteAccess = await hasCapability('write', id) || await hasCapability('admin', id)
if (hasWriteAccess) { if (hasWriteAccess) {
return await identities.verifyIdentity(writerIdentity) return identities.verifyIdentity(writerIdentity)
} }
return false return false

View File

@ -7,7 +7,7 @@
import { EventEmitter } from 'events' import { EventEmitter } from 'events'
import PQueue from 'p-queue' import PQueue from 'p-queue'
import Sync from './sync.js' import Sync from './sync.js'
import { Log } from './oplog/index.js' import { Log, Entry } from './oplog/index.js'
import { ComposedStorage, LRUStorage, IPFSBlockStorage, LevelStorage } from './storage/index.js' import { ComposedStorage, LRUStorage, IPFSBlockStorage, LevelStorage } from './storage/index.js'
import pathJoin from './utils/path-join.js' import pathJoin from './utils/path-join.js'
@ -39,12 +39,10 @@ const defaultCacheSize = 1000
* automatically. Otherwise, false. * automatically. Otherwise, false.
* @param {function} [params.onUpdate] A function callback. Fired when an * @param {function} [params.onUpdate] A function callback. Fired when an
* entry is added to the oplog. * entry is added to the oplog.
* @param {Function} options.encryptFn An encryption function.
* @param {Function} options.decryptFn A decryption function.
* @return {module:Databases~Database} An instance of Database. * @return {module:Databases~Database} An instance of Database.
* @instance * @instance
*/ */
const Database = async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate, encryption }) => { const Database = async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate }) => {
/** /**
* @namespace module:Databases~Database * @namespace module:Databases~Database
* @description The instance returned by {@link module:Database~Database}. * @description The instance returned by {@link module:Database~Database}.
@ -110,9 +108,7 @@ const Database = async ({ ipfs, identity, address, name, access, directory, meta
await LevelStorage({ path: pathJoin(directory, '/log/_index/') }) await LevelStorage({ path: pathJoin(directory, '/log/_index/') })
) )
encryption = encryption || {} const log = await Log(identity, { logId: address, access, entryStorage, headsStorage, indexStorage })
const log = await Log(identity, { logId: address, access, entryStorage, headsStorage, indexStorage, encryption })
const events = new EventEmitter() const events = new EventEmitter()
@ -138,23 +134,21 @@ const Database = async ({ ipfs, identity, address, name, access, directory, meta
return entry.hash return entry.hash
} }
const hash = await queue.add(task) const hash = await queue.add(task)
await queue.onIdle()
return hash return hash
} }
const applyOperation = async (entry) => { const applyOperation = async (bytes) => {
const task = async () => { const task = async () => {
try { const entry = await Entry.decode(bytes)
if (entry) { if (entry) {
const updated = await log.joinEntry(entry) const updated = await log.joinEntry(entry)
if (updated) { if (updated) {
if (onUpdate) { if (onUpdate) {
await onUpdate(log, entry) await onUpdate(log, entry)
}
events.emit('update', entry)
} }
events.emit('update', entry)
} }
} catch (e) {
console.error(e)
} }
} }
await queue.add(task) await queue.add(task)
@ -183,7 +177,7 @@ const Database = async ({ ipfs, identity, address, name, access, directory, meta
* @async * @async
*/ */
const drop = async () => { const drop = async () => {
await queue.clear() await queue.onIdle()
await log.clear() await log.clear()
if (access && access.drop) { if (access && access.drop) {
await access.drop() await access.drop()

View File

@ -3,11 +3,11 @@
* @memberof module:Databases * @memberof module:Databases
* @description Documents database. * @description Documents database.
* @example <caption>Create documents db with custom index</caption> * @example <caption>Create documents db with custom index</caption>
* import { createHelia } from 'helia' * import { create } from 'IPFS'
* import { createOrbitDB, Documents } from 'orbitdb' * import { OrbitDB, Documents } from 'orbitdb'
* *
* const ipfs = createHelia() * const ipfs = create()
* const orbitdb = await createOrbitDB({ ipfs }) * const orbitdb = await OrbitDB({ ipfs })
* const db = await orbitdb.open('my-docs', { Database: Documents({ indexBy: 'myCustomId'} ) } * const db = await orbitdb.open('my-docs', { Database: Documents({ indexBy: 'myCustomId'} ) }
* *
* @augments module:Databases~Database * @augments module:Databases~Database
@ -25,8 +25,8 @@ const DefaultOptions = { indexBy: '_id' }
* @return {module:Databases.Databases-Documents} A Documents function. * @return {module:Databases.Databases-Documents} A Documents function.
* @memberof module:Databases * @memberof module:Databases
*/ */
const Documents = ({ indexBy } = DefaultOptions) => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate, encrypt }) => { const Documents = ({ indexBy } = DefaultOptions) => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate }) => {
const database = await Database({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, encrypt }) const database = await Database({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically })
const { addOperation, log } = database const { addOperation, log } = database

View File

@ -15,8 +15,8 @@ const type = 'events'
* @return {module:Databases.Databases-Events} A Events function. * @return {module:Databases.Databases-Events} A Events function.
* @memberof module:Databases * @memberof module:Databases
*/ */
const Events = () => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate, encryption }) => { const Events = () => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate }) => {
const database = await Database({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate, encryption }) const database = await Database({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate })
const { addOperation, log } = database const { addOperation, log } = database

View File

@ -6,12 +6,12 @@
* *
* Key-value pairs are stored to the configured storage. * Key-value pairs are stored to the configured storage.
* @example <caption>Specify a custom storage</caption> * @example <caption>Specify a custom storage</caption>
* import { createHelia } from 'helia' * import { create } from 'IPFS'
* import { createOrbitDB, KeyValueIndexed, IPFSBlockStorage } from 'orbitdb' * import { OrbitDB, KeyValueIndexed, IPFSBlockStorage } from 'orbitdb'
* *
* const ipfs = createHelia() * const ipfs = create()
* const storage = await IPFSBlockStorage({ ipfs }) * const storage = await IPFSBlockStorage({ ipfs })
* const orbitdb = await createOrbitDB({ ipfs }) * const orbitdb = await OrbitDB({ ipfs })
* const db = await orbitdb.open('my-kv', { Database: KeyValueIndexed({ storage }) }) * const db = await orbitdb.open('my-kv', { Database: KeyValueIndexed({ storage }) })
* *
* @augments module:Databases~Database * @augments module:Databases~Database
@ -23,84 +23,6 @@ import pathJoin from '../utils/path-join.js'
const valueEncoding = 'json' const valueEncoding = 'json'
/**
* Defines an index for a KeyValue database.
* @param {string} [directory] A location for storing the index-related data
* @return {Index} A Index function.
*/
const Index = ({ directory } = {}) => async () => {
const index = await LevelStorage({ path: directory, valueEncoding })
const indexedEntries = await LevelStorage({ path: pathJoin(directory, '/_indexedEntries/'), valueEncoding })
const update = async (log, entry) => {
const keys = new Set()
const toBeIndexed = new Set()
const latest = entry.hash
// Function to check if a hash is in the entry index
const isIndexed = async (hash) => (await indexedEntries.get(hash)) === true
const isNotIndexed = async (hash) => !(await isIndexed(hash))
// Function to decide when the log traversal should be stopped
const shoudStopTraverse = async (entry) => {
// Go through the nexts of an entry and if any is not yet
// indexed, add it to the list of entries-to-be-indexed
for await (const hash of entry.next) {
if (await isNotIndexed(hash)) {
toBeIndexed.add(hash)
}
}
// If the latest entry and all its nexts are indexed and to-be-indexed list is empty,
// we don't have anything more to process, so return true to stop the traversal
return await isIndexed(latest) && toBeIndexed.size === 0
}
// Traverse the log and stop when everything has been processed
for await (const entry of log.traverse(null, shoudStopTraverse)) {
const { hash, payload } = entry
// If an entry is not yet indexed, process it
if (await isNotIndexed(hash)) {
const { op, key } = payload
if (op === 'PUT' && !keys.has(key)) {
keys.add(key)
await index.put(key, entry)
await indexedEntries.put(hash, true)
} else if (op === 'DEL' && !keys.has(key)) {
keys.add(key)
await index.del(key)
await indexedEntries.put(hash, true)
}
// Remove the entry (hash) from the list of to-be-indexed entries
toBeIndexed.delete(hash)
}
}
}
/**
* Closes the index and its storages.
*/
const close = async () => {
await index.close()
await indexedEntries.close()
}
/**
* Drops all records from the index and its storages.
*/
const drop = async () => {
await index.clear()
await indexedEntries.clear()
}
return {
get: index.get,
iterator: index.iterator,
update,
close,
drop
}
}
/** /**
* Defines a KeyValueIndexed database. * Defines a KeyValueIndexed database.
* @param {module:Storage} [storage=LevelStorage] A compatible storage where * @param {module:Storage} [storage=LevelStorage] A compatible storage where
@ -109,15 +31,36 @@ const Index = ({ directory } = {}) => async () => {
* function. * function.
* @memberof module:Databases * @memberof module:Databases
*/ */
const KeyValueIndexed = () => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate, encryption }) => { const KeyValueIndexed = ({ storage } = {}) => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate }) => {
// Set up the directory for an index const indexDirectory = pathJoin(directory || './orbitdb', `./${address}/_index/`)
directory = pathJoin(directory || './orbitdb', `./${address}/_index/`) const index = storage || await LevelStorage({ path: indexDirectory, valueEncoding })
// Set up the index let latestOplogHash
const index = await Index({ directory })()
// Set up the underlying KeyValue database const _updateIndex = async (log, entry) => {
const keyValueStore = await KeyValue()({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate: index.update, encryption }) const keys = {}
const it = await log.iterator({ gt: latestOplogHash })
for await (const entry of it) {
const { op, key, value } = entry.payload
if (op === 'PUT' && !keys[key]) {
keys[key] = true
await index.put(key, value)
} else if (op === 'DEL' && !keys[key]) {
keys[key] = true
await index.del(key)
}
}
latestOplogHash = entry ? entry.hash : null
}
// Create the underlying KeyValue database
const keyValueStore = await KeyValue()({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate: _updateIndex })
// Compute the index
await _updateIndex(keyValueStore.log)
/** /**
* Gets a value from the store by key. * Gets a value from the store by key.
@ -128,10 +71,11 @@ const KeyValueIndexed = () => async ({ ipfs, identity, address, name, access, di
* @instance * @instance
*/ */
const get = async (key) => { const get = async (key) => {
const entry = await index.get(key) const value = await index.get(key)
if (entry) { if (value) {
return entry.payload.value return value
} }
return keyValueStore.get(key)
} }
/** /**
@ -144,12 +88,8 @@ const KeyValueIndexed = () => async ({ ipfs, identity, address, name, access, di
* @instance * @instance
*/ */
const iterator = async function * ({ amount } = {}) { const iterator = async function * ({ amount } = {}) {
const it = index.iterator({ amount, reverse: true }) const it = keyValueStore.iterator({ amount })
for await (const record of it) { for await (const { key, value, hash } of it) {
// 'index' is a LevelStorage that returns a [key, value] pair
const entry = record[1]
const { key, value } = entry.payload
const hash = entry.hash
yield { key, value, hash } yield { key, value, hash }
} }
} }
@ -158,16 +98,16 @@ const KeyValueIndexed = () => async ({ ipfs, identity, address, name, access, di
* Closes the index and underlying storage. * Closes the index and underlying storage.
*/ */
const close = async () => { const close = async () => {
await keyValueStore.close()
await index.close() await index.close()
await keyValueStore.close()
} }
/** /**
* Drops all records from the index and underlying storage. * Drops all records from the index and underlying storage.
*/ */
const drop = async () => { const drop = async () => {
await index.clear()
await keyValueStore.drop() await keyValueStore.drop()
await index.drop()
} }
return { return {

View File

@ -11,12 +11,12 @@ import Database from '../database.js'
const type = 'keyvalue' const type = 'keyvalue'
/** /**
* Defines a KeyValue database. * Defines an KeyValue database.
* @return {module:Databases.Databases-KeyValue} A KeyValue function. * @return {module:Databases.Databases-KeyValue} A KeyValue function.
* @memberof module:Databases * @memberof module:Databases
*/ */
const KeyValue = () => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate, encryption }) => { const KeyValue = () => async ({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate }) => {
const database = await Database({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate, encryption }) const database = await Database({ ipfs, identity, address, name, access, directory, meta, headsStorage, entryStorage, indexStorage, referencesCount, syncAutomatically, onUpdate })
const { addOperation, log } = database const { addOperation, log } = database

View File

@ -52,7 +52,7 @@ const PublicKeyIdentityProvider = ({ keystore }) => async () => {
} }
const key = await keystore.getKey(id) || await keystore.createKey(id) const key = await keystore.getKey(id) || await keystore.createKey(id)
return uint8ArrayToString(key.publicKey.raw, 'base16') return uint8ArrayToString(key.public.marshal(), 'base16')
} }
/** /**

View File

@ -8,7 +8,7 @@
* const storage = await MemoryStorage() * const storage = await MemoryStorage()
* const keystore = await KeyStore({ storage }) * const keystore = await KeyStore({ storage })
*/ */
import { privateKeyFromRaw, publicKeyFromRaw, generateKeyPair } from '@libp2p/crypto/keys' import * as crypto from '@libp2p/crypto'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string' import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
import { toString as uint8ArrayToString } from 'uint8arrays/to-string' import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
import { compare as uint8ArrayCompare } from 'uint8arrays/compare' import { compare as uint8ArrayCompare } from 'uint8arrays/compare'
@ -16,6 +16,9 @@ import ComposedStorage from './storage/composed.js'
import LevelStorage from './storage/level.js' import LevelStorage from './storage/level.js'
import LRUStorage from './storage/lru.js' import LRUStorage from './storage/lru.js'
const unmarshal = crypto.keys.supportedKeys.secp256k1.unmarshalSecp256k1PrivateKey
const unmarshalPubKey = crypto.keys.supportedKeys.secp256k1.unmarshalSecp256k1PublicKey
const verifySignature = async (signature, publicKey, data) => { const verifySignature = async (signature, publicKey, data) => {
if (!signature) { if (!signature) {
throw new Error('No signature given') throw new Error('No signature given')
@ -35,7 +38,7 @@ const verifySignature = async (signature, publicKey, data) => {
let res = false let res = false
try { try {
const pubKey = publicKeyFromRaw(uint8ArrayFromString(publicKey, 'base16')) const pubKey = unmarshalPubKey(uint8ArrayFromString(publicKey, 'base16'))
res = await isValid(pubKey, data, uint8ArrayFromString(signature, 'base16')) res = await isValid(pubKey, data, uint8ArrayFromString(signature, 'base16'))
} catch (e) { } catch (e) {
// Catch error: sig length wrong // Catch error: sig length wrong
@ -120,13 +123,8 @@ const KeyStore = async ({ storage, path } = {}) => {
* @namespace module:KeyStore~KeyStore * @namespace module:KeyStore~KeyStore
* @description The instance returned by {@link module:KeyStore}. * @description The instance returned by {@link module:KeyStore}.
*/ */
// Persistent storage for keys
storage = storage || await ComposedStorage(await LRUStorage({ size: 1000 }), await LevelStorage({ path: path || defaultPath })) storage = storage || await ComposedStorage(await LRUStorage({ size: 1000 }), await LevelStorage({ path: path || defaultPath }))
// Cache for deserialized/unmarshaled keys
const keyCache = await LRUStorage({ size: 1000 })
/** /**
* Closes the KeyStore's underlying storage. * Closes the KeyStore's underlying storage.
* @memberof module:KeyStore~KeyStore * @memberof module:KeyStore~KeyStore
@ -135,7 +133,6 @@ const KeyStore = async ({ storage, path } = {}) => {
*/ */
const close = async () => { const close = async () => {
await storage.close() await storage.close()
await keyCache.close()
} }
/** /**
@ -146,7 +143,6 @@ const KeyStore = async ({ storage, path } = {}) => {
*/ */
const clear = async () => { const clear = async () => {
await storage.clear() await storage.clear()
await keyCache.clear()
} }
/** /**
@ -164,17 +160,12 @@ const KeyStore = async ({ storage, path } = {}) => {
} }
let hasKey = false let hasKey = false
let key = await keyCache.get(id) try {
if (key) { const storedKey = await storage.get('private_' + id)
hasKey = true hasKey = storedKey !== undefined && storedKey !== null
} else { } catch (e) {
try { // Catches 'Error: ENOENT: no such file or directory, open <path>'
key = await storage.get('private_' + id) console.error('Error: ENOENT: no such file or directory')
hasKey = key !== undefined && key !== null
} catch (e) {
// Catches 'Error: ENOENT: no such file or directory, open <path>'
console.error('Error: ENOENT: no such file or directory')
}
} }
return hasKey return hasKey
@ -189,11 +180,7 @@ const KeyStore = async ({ storage, path } = {}) => {
* @instance * @instance
*/ */
const addKey = async (id, key) => { const addKey = async (id, key) => {
const { privateKey } = key await storage.put('private_' + id, key.privateKey)
await storage.put('private_' + id, privateKey)
// Unmarshal the key and add it to the cache
const unmarshaledPrivateKey = privateKeyFromRaw(privateKey)
await keyCache.put(id, unmarshaledPrivateKey)
} }
/** /**
@ -210,16 +197,18 @@ const KeyStore = async ({ storage, path } = {}) => {
} }
// Generate a private key // Generate a private key
const keyPair = await generateKeyPair('secp256k1') const pair = await crypto.keys.generateKeyPair('secp256k1')
const keys = await crypto.keys.unmarshalPrivateKey(pair.bytes)
const pubKey = keys.public.marshal()
const key = { const key = {
publicKey: keyPair.publicKey.raw, publicKey: pubKey,
privateKey: keyPair.raw privateKey: keys.marshal()
} }
await addKey(id, key) await addKey(id, key)
return keyPair return keys
} }
/** /**
@ -236,26 +225,18 @@ const KeyStore = async ({ storage, path } = {}) => {
throw new Error('id needed to get a key') throw new Error('id needed to get a key')
} }
let key = await keyCache.get(id) let storedKey
try {
if (!key) { storedKey = await storage.get('private_' + id)
let storedKey } catch (e) {
try { // ignore ENOENT error
storedKey = await storage.get('private_' + id)
} catch (e) {
// ignore ENOENT error
}
if (!storedKey) {
return
}
key = privateKeyFromRaw(storedKey)
await keyCache.put(id, key)
} }
return key if (!storedKey) {
return
}
return unmarshal(storedKey)
} }
/** /**
@ -278,7 +259,7 @@ const KeyStore = async ({ storage, path } = {}) => {
throw new Error('Supported formats are `hex` and `buffer`') throw new Error('Supported formats are `hex` and `buffer`')
} }
const pubKey = keys.publicKey.raw const pubKey = keys.public.marshal()
return format === 'buffer' ? pubKey : uint8ArrayToString(pubKey, 'base16') return format === 'buffer' ? pubKey : uint8ArrayToString(pubKey, 'base16')
} }

View File

@ -16,17 +16,13 @@ const ManifestStore = async ({ ipfs, storage } = {}) => {
*/ */
storage = storage || await ComposedStorage( storage = storage || await ComposedStorage(
await LRUStorage({ size: 100000 }), await LRUStorage({ size: 1000 }),
await IPFSBlockStorage({ ipfs, pin: true }) await IPFSBlockStorage({ ipfs, pin: true })
) )
const get = async (address) => { const get = async (address) => {
const bytes = await storage.get(address) const bytes = await storage.get(address)
const { value } = await Block.decode({ bytes, codec, hasher }) const { value } = await Block.decode({ bytes, codec, hasher })
if (value) {
// Write to storage to make sure it gets pinned on IPFS
await storage.put(address, bytes)
}
return value return value
} }

View File

@ -55,7 +55,7 @@ const hashStringEncoding = base58btc
* // { payload: "hello", next: [], ... } * // { payload: "hello", next: [], ... }
* @private * @private
*/ */
const create = async (identity, id, payload, encryptPayloadFn, clock = null, next = [], refs = []) => { const create = async (identity, id, payload, clock = null, next = [], refs = []) => {
if (identity == null) throw new Error('Identity is required, cannot create entry') if (identity == null) throw new Error('Identity is required, cannot create entry')
if (id == null) throw new Error('Entry requires an id') if (id == null) throw new Error('Entry requires an id')
if (payload == null) throw new Error('Entry requires a payload') if (payload == null) throw new Error('Entry requires a payload')
@ -63,16 +63,9 @@ const create = async (identity, id, payload, encryptPayloadFn, clock = null, nex
clock = clock || Clock(identity.publicKey) clock = clock || Clock(identity.publicKey)
let encryptedPayload
if (encryptPayloadFn) {
const { bytes: encodedPayloadBytes } = await Block.encode({ value: payload, codec, hasher })
encryptedPayload = await encryptPayloadFn(encodedPayloadBytes)
}
const entry = { const entry = {
id, // For determining a unique chain id, // For determining a unique chain
payload: encryptedPayload || payload, // Can be any dag-cbor encodeable data payload, // Can be any dag-cbor encodeable data
next, // Array of strings of CIDs next, // Array of strings of CIDs
refs, // Array of strings of CIDs refs, // Array of strings of CIDs
clock, // Clock clock, // Clock
@ -85,13 +78,8 @@ const create = async (identity, id, payload, encryptPayloadFn, clock = null, nex
entry.key = identity.publicKey entry.key = identity.publicKey
entry.identity = identity.hash entry.identity = identity.hash
entry.sig = signature entry.sig = signature
entry.payload = payload
if (encryptPayloadFn) { return encode(entry)
entry._payload = encryptedPayload
}
return entry
} }
/** /**
@ -109,15 +97,13 @@ const verify = async (identities, entry) => {
if (!entry.key) throw new Error("Entry doesn't have a key") if (!entry.key) throw new Error("Entry doesn't have a key")
if (!entry.sig) throw new Error("Entry doesn't have a signature") if (!entry.sig) throw new Error("Entry doesn't have a signature")
const e = Object.assign({}, entry)
const value = { const value = {
id: e.id, id: entry.id,
payload: e._payload || e.payload, payload: entry.payload,
next: e.next, next: entry.next,
refs: e.refs, refs: entry.refs,
clock: e.clock, clock: entry.clock,
v: e.v v: entry.v
} }
const { bytes } = await Block.encode({ value, codec, hasher }) const { bytes } = await Block.encode({ value, codec, hasher })
@ -150,7 +136,7 @@ const isEntry = (obj) => {
* @private * @private
*/ */
const isEqual = (a, b) => { const isEqual = (a, b) => {
return a && b && a.hash && a.hash === b.hash return a && b && a.hash === b.hash
} }
/** /**
@ -160,40 +146,9 @@ const isEqual = (a, b) => {
* @memberof module:Log~Entry * @memberof module:Log~Entry
* @private * @private
*/ */
const decode = async (bytes, decryptEntryFn, decryptPayloadFn) => { const decode = async (bytes) => {
let cid const { value } = await Block.decode({ bytes, codec, hasher })
return encode(value)
if (decryptEntryFn) {
try {
const encryptedEntry = await Block.decode({ bytes, codec, hasher })
bytes = await decryptEntryFn(encryptedEntry.value)
cid = encryptedEntry.cid
} catch (e) {
throw new Error('Could not decrypt entry')
}
}
const decodedEntry = await Block.decode({ bytes, codec, hasher })
const entry = decodedEntry.value
if (decryptPayloadFn) {
try {
const decryptedPayloadBytes = await decryptPayloadFn(entry.payload)
const { value: decryptedPayload } = await Block.decode({ bytes: decryptedPayloadBytes, codec, hasher })
entry._payload = entry.payload
entry.payload = decryptedPayload
} catch (e) {
throw new Error('Could not decrypt payload')
}
}
cid = cid || decodedEntry.cid
const hash = cid.toString(hashStringEncoding)
return {
...entry,
hash
}
} }
/** /**
@ -203,28 +158,13 @@ const decode = async (bytes, decryptEntryFn, decryptPayloadFn) => {
* @memberof module:Log~Entry * @memberof module:Log~Entry
* @private * @private
*/ */
const encode = async (entry, encryptEntryFn, encryptPayloadFn) => { const encode = async (entry) => {
const e = Object.assign({}, entry) const { cid, bytes } = await Block.encode({ value: entry, codec, hasher })
if (encryptPayloadFn) {
e.payload = e._payload
}
delete e._payload
delete e.hash
let { cid, bytes } = await Block.encode({ value: e, codec, hasher })
if (encryptEntryFn) {
bytes = await encryptEntryFn(bytes)
const encryptedEntry = await Block.encode({ value: bytes, codec, hasher })
cid = encryptedEntry.cid
bytes = encryptedEntry.bytes
}
const hash = cid.toString(hashStringEncoding) const hash = cid.toString(hashStringEncoding)
const clock = Clock(entry.clock.id, entry.clock.time)
return { return {
...entry,
clock,
hash, hash,
bytes bytes
} }

View File

@ -9,17 +9,19 @@ import MemoryStorage from '../storage/memory.js'
const DefaultStorage = MemoryStorage const DefaultStorage = MemoryStorage
const Heads = async ({ storage, heads, decryptPayloadFn, decryptEntryFn }) => { const Heads = async ({ storage, heads }) => {
storage = storage || await DefaultStorage() storage = storage || await DefaultStorage()
const encoder = new TextEncoder()
const decoder = new TextDecoder()
const put = async (heads) => { const put = async (heads) => {
heads = findHeads(heads) heads = findHeads(heads)
const newHeads = heads.map(e => ({ hash: e.hash, next: e.next })) for (const head of heads) {
const bytes = encoder.encode(JSON.stringify(newHeads)) await storage.put(head.hash, head.bytes)
await storage.put('heads', bytes) }
}
const set = async (heads) => {
await storage.clear()
await put(heads)
} }
const add = async (head) => { const add = async (head) => {
@ -28,21 +30,22 @@ const Heads = async ({ storage, heads, decryptPayloadFn, decryptEntryFn }) => {
return return
} }
const newHeads = findHeads([...currentHeads, head]) const newHeads = findHeads([...currentHeads, head])
await put(newHeads) await set(newHeads)
return newHeads return newHeads
} }
const remove = async (hash) => { const remove = async (hash) => {
const currentHeads = await all() const currentHeads = await all()
const newHeads = currentHeads.filter(e => e.hash !== hash) const newHeads = currentHeads.filter(e => e.hash !== hash)
await put(newHeads) await set(newHeads)
} }
const iterator = async function * () { const iterator = async function * () {
const bytes = await storage.get('heads') const it = storage.iterator()
const headHashes = bytes ? JSON.parse(decoder.decode(bytes)) : [] for await (const [, bytes] of it) {
for (const hash of headHashes) { const head = await Entry.decode(bytes)
yield hash yield head
} }
} }
@ -63,13 +66,11 @@ const Heads = async ({ storage, heads, decryptPayloadFn, decryptEntryFn }) => {
} }
// Initialize the heads if given as parameter // Initialize the heads if given as parameter
if (heads) { await put(heads || [])
await put(heads)
}
return { return {
put, put,
set: put, set,
add, add,
remove, remove,
iterator, iterator,

View File

@ -7,17 +7,20 @@
* ["Merkle-CRDTs: Merkle-DAGs meet CRDTs"]{@link https://arxiv.org/abs/2004.00107} * ["Merkle-CRDTs: Merkle-DAGs meet CRDTs"]{@link https://arxiv.org/abs/2004.00107}
*/ */
import LRU from 'lru' import LRU from 'lru'
import PQueue from 'p-queue'
import Entry from './entry.js' import Entry from './entry.js'
import Clock, { tickClock } from './clock.js' import Clock, { tickClock } from './clock.js'
import Heads from './heads.js'
import ConflictResolution from './conflict-resolution.js' import ConflictResolution from './conflict-resolution.js'
import OplogStore from './oplog-store.js' import MemoryStorage from '../storage/memory.js'
const { LastWriteWins, NoZeroes } = ConflictResolution const { LastWriteWins, NoZeroes } = ConflictResolution
const randomId = () => new Date().getTime().toString() const randomId = () => new Date().getTime().toString()
const maxClockTimeReducer = (res, acc) => Math.max(res, acc.clock.time) const maxClockTimeReducer = (res, acc) => Math.max(res, acc.clock.time)
// Default storage for storing the Log and its entries. Default: Memory. Options: Memory, LRU, IPFS.
const DefaultStorage = MemoryStorage
// Default AccessController for the Log. // Default AccessController for the Log.
// Default policy is that anyone can write to the Log. // Default policy is that anyone can write to the Log.
// Signature of an entry will always be verified regardless of AccessController policy. // Signature of an entry will always be verified regardless of AccessController policy.
@ -52,7 +55,7 @@ const DefaultAccessController = async () => {
* @memberof module:Log * @memberof module:Log
* @instance * @instance
*/ */
const Log = async (identity, { logId, logHeads, access, entryStorage, headsStorage, indexStorage, sortFn, encryption } = {}) => { const Log = async (identity, { logId, logHeads, access, entryStorage, headsStorage, indexStorage, sortFn } = {}) => {
/** /**
* @namespace Log * @namespace Log
* @description The instance returned by {@link module:Log} * @description The instance returned by {@link module:Log}
@ -64,27 +67,21 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
if (logHeads != null && !Array.isArray(logHeads)) { if (logHeads != null && !Array.isArray(logHeads)) {
throw new Error('\'logHeads\' argument must be an array') throw new Error('\'logHeads\' argument must be an array')
} }
// Set Log's id // Set Log's id
const id = logId || randomId() const id = logId || randomId()
// Encryption of entries and payloads
encryption = encryption || {}
const encryptPayloadFn = encryption.data?.encrypt
// Access Controller // Access Controller
access = access || await DefaultAccessController() access = access || await DefaultAccessController()
// Oplog entry storage
// Index and storage of entries for this Log const _entries = entryStorage || await DefaultStorage()
const oplogStore = await OplogStore({ logHeads, entryStorage, indexStorage, headsStorage, encryption }) // Entry index for keeping track which entries are already in the log
const _index = indexStorage || await DefaultStorage()
// Heads storage
headsStorage = headsStorage || await DefaultStorage()
// Add heads to the state storage, ie. init the log state
const _heads = await Heads({ storage: headsStorage, heads: logHeads })
// Conflict-resolution sorting function // Conflict-resolution sorting function
sortFn = NoZeroes(sortFn || LastWriteWins) sortFn = NoZeroes(sortFn || LastWriteWins)
// Internal queues for processing appends and joins in their call-order
const appendQueue = new PQueue({ concurrency: 1 })
const joinQueue = new PQueue({ concurrency: 1 })
/** /**
* Returns the clock of the log. * Returns the clock of the log.
* @return {module:Clock} * @return {module:Clock}
@ -105,8 +102,8 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
* @instance * @instance
*/ */
const heads = async () => { const heads = async () => {
const heads_ = await oplogStore.heads() const res = await _heads.all()
return heads_.sort(sortFn).reverse() return res.sort(sortFn).reverse()
} }
/** /**
@ -133,14 +130,16 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
* @instance * @instance
*/ */
const get = async (hash) => { const get = async (hash) => {
if (!hash) { const bytes = await _entries.get(hash)
throw new Error('hash is required') if (bytes) {
const entry = await Entry.decode(bytes)
return entry
} }
return oplogStore.get(hash)
} }
const has = async (hash) => { const has = async (hash) => {
return oplogStore.has(hash) const entry = await _index.get(hash)
return entry != null
} }
/** /**
@ -154,45 +153,40 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
* @instance * @instance
*/ */
const append = async (data, options = { referencesCount: 0 }) => { const append = async (data, options = { referencesCount: 0 }) => {
const task = async () => { // 1. Prepare entry
// 1. Prepare entry // 2. Authorize entry
// 2. Authorize entry // 3. Store entry
// 3. Store entry // 4. return Entry
// 4. return Entry // Get current heads of the log
const heads_ = await heads()
// Get current heads of the log // Create the next pointers from heads
const heads_ = await heads() const nexts = heads_.map(entry => entry.hash)
// Create the next pointers from heads // Get references (pointers) to multiple entries in the past
const nexts = heads_.map(entry => entry.hash) // (skips the heads which are covered by the next field)
// Get references (pointers) to multiple entries in the past const refs = await getReferences(heads_, options.referencesCount + heads_.length)
// (skips the heads which are covered by the next field) // Create the entry
const refs = await getReferences(heads_, options.referencesCount + heads_.length) const entry = await Entry.create(
identity,
// Create the entry id,
const entry = await Entry.create( data,
identity, tickClock(await clock()),
id, nexts,
data, refs
encryptPayloadFn, )
tickClock(await clock()), // Authorize the entry
nexts, const canAppend = await access.canAppend(entry)
refs if (!canAppend) {
) throw new Error(`Could not append entry:\nKey "${identity.hash}" is not allowed to write to the log`)
// Authorize the entry
const canAppend = await access.canAppend(entry)
if (!canAppend) {
throw new Error(`Could not append entry:\nKey "${identity.hash}" is not allowed to write to the log`)
}
// Add the entry to the oplog store (=store and index it)
const hash = await oplogStore.setHead(entry)
// Return the appended entry
return { ...entry, hash }
} }
return appendQueue.add(task) // The appended entry is now the latest head
await _heads.set([entry])
// Add entry to the entry storage
await _entries.put(entry.hash, entry.bytes)
// Add entry to the entry index
await _index.put(entry.hash, true)
// Return the appended entry
return entry
} }
/** /**
@ -216,7 +210,9 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
if (!isLog(log)) { if (!isLog(log)) {
throw new Error('Given argument is not an instance of Log') throw new Error('Given argument is not an instance of Log')
} }
await oplogStore.storage.merge(log.storage) if (_entries.merge) {
await _entries.merge(log.storage)
}
const heads = await log.heads() const heads = await log.heads()
for (const entry of heads) { for (const entry of heads) {
await joinEntry(entry) await joinEntry(entry)
@ -236,79 +232,81 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
* @instance * @instance
*/ */
const joinEntry = async (entry) => { const joinEntry = async (entry) => {
const task = async () => { /* 1. Check if the entry is already in the log and return early if it is */
/* 1. Check if the entry is already in the log and return early if it is */ const isAlreadyInTheLog = await has(entry.hash)
const isAlreadyInTheLog = await has(entry.hash) if (isAlreadyInTheLog) {
if (isAlreadyInTheLog) { return false
return false
}
const verifyEntry = async (entry) => {
// Check that the Entry belongs to this Log
if (entry.id !== id) {
throw new Error(`Entry's id (${entry.id}) doesn't match the log's id (${id}).`)
}
// Verify if entry is allowed to be added to the log
const canAppend = await access.canAppend(entry)
if (!canAppend) {
throw new Error(`Could not append entry:\nKey "${entry.identity}" is not allowed to write to the log`)
}
// Verify signature for the entry
const isValid = await Entry.verify(identity, entry)
if (!isValid) {
throw new Error(`Could not validate signature for entry "${entry.hash}"`)
}
}
/* 2. Verify the entry */
await verifyEntry(entry)
/* 3. Find missing entries and connections (=path in the DAG) to the current heads */
const headsHashes = (await heads()).map(e => e.hash)
const hashesToAdd = new Set([entry.hash])
const hashesToGet = new Set([...entry.next, ...entry.refs])
const connectedHeads = new Set()
const traverseAndVerify = async () => {
const getEntries = Array.from(hashesToGet.values()).filter(has).map(get)
const entries = await Promise.all(getEntries)
for (const e of entries) {
hashesToGet.delete(e.hash)
await verifyEntry(e)
hashesToAdd.add(e.hash)
for (const hash of [...e.next, ...e.refs]) {
const isInTheLog = await has(hash)
if (!isInTheLog && !hashesToAdd.has(hash)) {
hashesToGet.add(hash)
} else if (headsHashes.includes(hash)) {
connectedHeads.add(hash)
}
}
}
if (hashesToGet.size > 0) {
await traverseAndVerify()
}
}
await traverseAndVerify()
/* 4. Add missing entries to the oplog store (=to the log) */
await oplogStore.addVerified(hashesToAdd.values())
/* 6. Remove heads which new entries are connect to */
await oplogStore.removeHeads(connectedHeads.values())
/* 7. Add the new entry to heads (=union with current heads) */
await oplogStore.addHead(entry)
return true
} }
return joinQueue.add(task) const verifyEntry = async (entry) => {
// Check that the Entry belongs to this Log
if (entry.id !== id) {
throw new Error(`Entry's id (${entry.id}) doesn't match the log's id (${id}).`)
}
// Verify if entry is allowed to be added to the log
const canAppend = await access.canAppend(entry)
if (!canAppend) {
throw new Error(`Could not append entry:\nKey "${entry.identity}" is not allowed to write to the log`)
}
// Verify signature for the entry
const isValid = await Entry.verify(identity, entry)
if (!isValid) {
throw new Error(`Could not validate signature for entry "${entry.hash}"`)
}
}
/* 2. Verify the entry */
await verifyEntry(entry)
/* 3. Find missing entries and connections (=path in the DAG) to the current heads */
const headsHashes = (await heads()).map(e => e.hash)
const hashesToAdd = new Set([entry.hash])
const hashesToGet = new Set([...entry.next, ...entry.refs])
const connectedHeads = new Set()
const traverseAndVerify = async () => {
const getEntries = Array.from(hashesToGet.values()).filter(has).map(get)
const entries = await Promise.all(getEntries)
for (const e of entries) {
hashesToGet.delete(e.hash)
await verifyEntry(e)
hashesToAdd.add(e.hash)
for (const hash of [...e.next, ...e.refs]) {
const isInTheLog = await has(hash)
if (!isInTheLog && !hashesToAdd.has(hash)) {
hashesToGet.add(hash)
} else if (headsHashes.includes(hash)) {
connectedHeads.add(hash)
}
}
}
if (hashesToGet.size > 0) {
await traverseAndVerify()
}
}
await traverseAndVerify()
/* 4. Add missing entries to the index (=to the log) */
for (const hash of hashesToAdd.values()) {
await _index.put(hash, true)
}
/* 5. Remove heads which new entries are connect to */
for (const hash of connectedHeads.values()) {
await _heads.remove(hash)
}
/* 6. Add the new entry to heads (=union with current heads) */
await _heads.add(entry)
return true
} }
/** /**
@ -316,7 +314,7 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
* @memberof module:Log~Log * @memberof module:Log~Log
* @instance * @instance
*/ */
const traverse = async function * (rootEntries, shouldStopFn) { const traverse = async function * (rootEntries, shouldStopFn, useRefs = true) {
// By default, we don't stop traversal and traverse // By default, we don't stop traversal and traverse
// until the end of the log // until the end of the log
const defaultStopFn = () => false const defaultStopFn = () => false
@ -340,7 +338,7 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
// Get the next entry from the stack // Get the next entry from the stack
entry = stack.pop() entry = stack.pop()
if (entry) { if (entry) {
const { hash, next } = entry const { hash, next, refs } = entry
// If we have an entry that we haven't traversed yet, process it // If we have an entry that we haven't traversed yet, process it
if (!traversed[hash]) { if (!traversed[hash]) {
// Yield the current entry // Yield the current entry
@ -355,7 +353,7 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
fetched[hash] = true fetched[hash] = true
// Add the next and refs hashes to the list of hashes to fetch next, // Add the next and refs hashes to the list of hashes to fetch next,
// filter out traversed and fetched hashes // filter out traversed and fetched hashes
toFetch = [...toFetch, ...next].filter(notIndexed) toFetch = [...toFetch, ...next, ...(useRefs ? refs : [])].filter(notIndexed)
// Function to fetch an entry and making sure it's not a duplicate (check the hash indices) // Function to fetch an entry and making sure it's not a duplicate (check the hash indices)
const fetchEntries = (hash) => { const fetchEntries = (hash) => {
if (!traversed[hash] && !fetched[hash]) { if (!traversed[hash] && !fetched[hash]) {
@ -369,7 +367,7 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
// Add the next and refs fields from the fetched entries to the next round // Add the next and refs fields from the fetched entries to the next round
toFetch = nexts toFetch = nexts
.filter(e => e !== null && e !== undefined) .filter(e => e !== null && e !== undefined)
.reduce((res, acc) => Array.from(new Set([...res, ...acc.next])), []) .reduce((res, acc) => Array.from(new Set([...res, ...acc.next, ...(useRefs ? acc.refs : [])])), [])
.filter(notIndexed) .filter(notIndexed)
// Add the fetched entries to the stack to be processed // Add the fetched entries to the stack to be processed
stack = [...nexts, ...stack] stack = [...nexts, ...stack]
@ -488,9 +486,9 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
* @instance * @instance
*/ */
const clear = async () => { const clear = async () => {
await appendQueue.clear() await _index.clear()
await joinQueue.clear() await _heads.clear()
await oplogStore.clear() await _entries.clear()
} }
/** /**
@ -499,9 +497,9 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
* @instance * @instance
*/ */
const close = async () => { const close = async () => {
await appendQueue.onIdle() await _index.close()
await joinQueue.onIdle() await _heads.close()
await oplogStore.close() await _entries.close()
} }
/** /**
@ -533,7 +531,7 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
const shouldStopTraversal = async (entry) => { const shouldStopTraversal = async (entry) => {
return refs.length >= amount && amount !== -1 return refs.length >= amount && amount !== -1
} }
for await (const { hash } of traverse(heads, shouldStopTraversal)) { for await (const { hash } of traverse(heads, shouldStopTraversal, false)) {
refs.push(hash) refs.push(hash)
} }
refs = refs.slice(heads.length + 1, amount) refs = refs.slice(heads.length + 1, amount)
@ -557,8 +555,7 @@ const Log = async (identity, { logId, logHeads, access, entryStorage, headsStora
close, close,
access, access,
identity, identity,
storage: oplogStore.storage, storage: _entries
encryption
} }
} }

View File

@ -1,112 +0,0 @@
import Entry from './entry.js'
import Heads from './heads.js'
import MemoryStorage from '../storage/memory.js'
// Default storage for storing the Log and its entries. Default: Memory. Options: Memory, LRU, IPFS.
const DefaultStorage = MemoryStorage
const OplogStore = async ({ logHeads, entryStorage, headsStorage, indexStorage, encryption }) => {
// Setup encryption and decryption functions
const encryptEntryFn = encryption?.replication?.encrypt
const decryptEntryFn = encryption?.replication?.decrypt
const encryptPayloadFn = encryption?.data?.encrypt
const decryptPayloadFn = encryption?.data?.decrypt
// Oplog entry storage
const _entries = entryStorage || await DefaultStorage()
// Entry index for keeping track which entries are already in the log
const _index = indexStorage || await DefaultStorage()
// Heads storage
headsStorage = headsStorage || await DefaultStorage()
// Add heads to the state storage, ie. init the log state
const _heads = await Heads({ storage: headsStorage, heads: logHeads, decryptPayloadFn, decryptEntryFn })
const get = async (hash) => {
const bytes = await _entries.get(hash)
if (bytes) {
const entry = await Entry.decode(bytes, decryptEntryFn, decryptPayloadFn)
return entry
}
}
const getBytes = async (hash) => {
return _entries.get(hash)
}
const has = async (hash) => {
const entry = await _index.get(hash)
return entry != null
}
const heads = async () => {
const heads_ = []
for (const { hash } of await _heads.all()) {
const head = await get(hash)
heads_.push(head)
}
return heads_
}
const setHead = async (entry) => {
const { hash, bytes } = await Entry.encode(entry, encryptEntryFn, encryptPayloadFn)
// Add entry to the entry storage
await _entries.put(hash, bytes)
// Add entry to the entry index
await _index.put(hash, true)
// The appended entry is now the latest head
await _heads.set([{ hash, next: entry.next }])
return hash
}
const addHead = async (entry) => {
/* 7. Add the new entry to heads (=union with current heads) */
await _heads.add(entry)
return entry.hash
}
const removeHeads = async (hashes) => {
/* 5. Remove heads which new entries are connect to */
for (const hash of hashes) {
await _heads.remove(hash)
}
}
const addVerified = async (hashes) => {
/* 4. Add missing entries to the index (=to the log) */
for (const hash of hashes) {
await _index.put(hash, true)
/* 5. Add new entry to entries (for pinning) */
if (_entries.persist) {
await _entries.persist(hash)
}
}
}
const clear = async () => {
await _index.clear()
await _heads.clear()
await _entries.clear()
}
const close = async () => {
await _index.close()
await _heads.close()
await _entries.close()
}
return {
get,
getBytes,
has,
heads,
setHead,
addHead,
removeHeads,
addVerified,
storage: _entries,
clear,
close
}
}
export default OplogStore

View File

@ -104,7 +104,6 @@ const OrbitDB = async ({ ipfs, id, identity, identities, directory } = {}) => {
* @param {module:Storage} [params.indexStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing an " index of log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage). * @param {module:Storage} [params.indexStorage=[ComposedStorage]{@link module:Storage.Storage-Composed}] A compatible storage instance for storing an " index of log entries. Defaults to ComposedStorage(LRUStorage, LevelStorage).
* @param {number} [params.referencesCount] The number of references to * @param {number} [params.referencesCount] The number of references to
* use for [Log]{@link module:Log} entries. * use for [Log]{@link module:Log} entries.
* @param {number} [params.encryption] Encryption module to encrypt/decrypt database payloads and entries. If provided, the encryption object must take the form { replication: { encrypt, decrypt }, data: { encrypt, decrypt } }.
* @memberof module:OrbitDB * @memberof module:OrbitDB
* @return {module:Database} A database instance. * @return {module:Database} A database instance.
* @throws "Unsupported database type" if the type specified is not in the list * @throws "Unsupported database type" if the type specified is not in the list
@ -113,7 +112,7 @@ const OrbitDB = async ({ ipfs, id, identity, identities, directory } = {}) => {
* @instance * @instance
* @async * @async
*/ */
const open = async (address, { type, meta, sync, Database, AccessController, headsStorage, entryStorage, indexStorage, referencesCount, encryption } = {}) => { const open = async (address, { type, meta, sync, Database, AccessController, headsStorage, entryStorage, indexStorage, referencesCount } = {}) => {
let name, manifest, accessController let name, manifest, accessController
if (databases[address]) { if (databases[address]) {
@ -154,7 +153,7 @@ const OrbitDB = async ({ ipfs, id, identity, identities, directory } = {}) => {
address = address.toString() address = address.toString()
const db = await Database({ ipfs, identity, address, name, access: accessController, directory, meta, syncAutomatically: sync, headsStorage, entryStorage, indexStorage, referencesCount, encryption }) const db = await Database({ ipfs, identity, address, name, access: accessController, directory, meta, syncAutomatically: sync, headsStorage, entryStorage, indexStorage, referencesCount })
db.events.on('close', onDatabaseClosed(address)) db.events.on('close', onDatabaseClosed(address))
@ -194,7 +193,6 @@ const OrbitDB = async ({ ipfs, id, identity, identities, directory } = {}) => {
ipfs, ipfs,
directory, directory,
keystore, keystore,
identities,
identity, identity,
peerId peerId
} }

View File

@ -57,18 +57,6 @@ const ComposedStorage = async (storage1, storage2) => {
return value return value
} }
/**
* Deletes a value from storage.
* @function
* @param {string} hash The hash of the value to delete.
* @memberof module:Storage.Storage-Composed
* @instance
*/
const del = async (hash) => {
await storage1.del(hash)
await storage2.del(hash)
}
/** /**
* Iterates over records stored in both storages. * Iterates over records stored in both storages.
* @function * @function
@ -76,11 +64,10 @@ const ComposedStorage = async (storage1, storage2) => {
* @memberof module:Storage.Storage-Composed * @memberof module:Storage.Storage-Composed
* @instance * @instance
*/ */
const iterator = async function * ({ amount, reverse } = {}) { const iterator = async function * () {
const keys = [] const keys = []
const iteratorOptions = { amount: amount || -1, reverse: reverse || false }
for (const storage of [storage1, storage2]) { for (const storage of [storage1, storage2]) {
for await (const [key, value] of storage.iterator(iteratorOptions)) { for await (const [key, value] of storage.iterator()) {
if (!keys[key]) { if (!keys[key]) {
keys[key] = true keys[key] = true
yield [key, value] yield [key, value]
@ -114,16 +101,6 @@ const ComposedStorage = async (storage1, storage2) => {
await storage2.clear() await storage2.clear()
} }
const persist = async (hash) => {
if (storage1.persist) {
await storage1.persist(hash)
}
if (storage2.persist) {
await storage2.persist(hash)
}
}
/** /**
* Calls close on each of the composed storages. * Calls close on each of the composed storages.
* @function * @function
@ -138,8 +115,6 @@ const ComposedStorage = async (storage1, storage2) => {
return { return {
put, put,
get, get,
del,
persist,
iterator, iterator,
merge, merge,
clear, clear,

View File

@ -7,7 +7,6 @@
import { CID } from 'multiformats/cid' import { CID } from 'multiformats/cid'
import { base58btc } from 'multiformats/bases/base58' import { base58btc } from 'multiformats/bases/base58'
import { TimeoutController } from 'timeout-abort-controller' import { TimeoutController } from 'timeout-abort-controller'
import drain from 'it-drain'
const DefaultTimeout = 30000 // 30 seconds const DefaultTimeout = 30000 // 30 seconds
@ -28,8 +27,6 @@ const DefaultTimeout = 30000 // 30 seconds
const IPFSBlockStorage = async ({ ipfs, pin, timeout } = {}) => { const IPFSBlockStorage = async ({ ipfs, pin, timeout } = {}) => {
if (!ipfs) throw new Error('An instance of ipfs is required.') if (!ipfs) throw new Error('An instance of ipfs is required.')
const timeoutControllers = new Set()
/** /**
* Puts data to an IPFS block. * Puts data to an IPFS block.
* @function * @function
@ -43,7 +40,9 @@ const IPFSBlockStorage = async ({ ipfs, pin, timeout } = {}) => {
const { signal } = new TimeoutController(timeout || DefaultTimeout) const { signal } = new TimeoutController(timeout || DefaultTimeout)
await ipfs.blockstore.put(cid, data, { signal }) await ipfs.blockstore.put(cid, data, { signal })
await persist(hash) if (pin && !(await ipfs.pins.isPinned(cid))) {
await ipfs.pins.add(cid)
}
} }
const del = async (hash) => {} const del = async (hash) => {}
@ -58,40 +57,25 @@ const IPFSBlockStorage = async ({ ipfs, pin, timeout } = {}) => {
*/ */
const get = async (hash) => { const get = async (hash) => {
const cid = CID.parse(hash, base58btc) const cid = CID.parse(hash, base58btc)
const controller = new TimeoutController(timeout || DefaultTimeout) const { signal } = new TimeoutController(timeout || DefaultTimeout)
timeoutControllers.add(controller) const block = await ipfs.blockstore.get(cid, { signal })
const block = await ipfs.blockstore.get(cid, { signal: controller.signal })
timeoutControllers.delete(controller)
if (block) { if (block) {
return block return block
} }
} }
const persist = async (hash) => {
const cid = CID.parse(hash, base58btc)
if (pin && !(await ipfs.pins.isPinned(cid))) {
await drain(ipfs.pins.add(cid))
}
}
const iterator = async function * () {} const iterator = async function * () {}
const merge = async (other) => {} const merge = async (other) => {}
const clear = async () => {} const clear = async () => {}
const close = async () => { const close = async () => {}
for (const controller in timeoutControllers) {
controller.abort()
}
timeoutControllers.clear()
}
return { return {
put, put,
del, del,
get, get,
persist,
iterator, iterator,
merge, merge,
clear, clear,

View File

@ -78,9 +78,8 @@ const LevelStorage = async ({ path, valueEncoding } = {}) => {
* @memberof module:Storage.Storage-Level * @memberof module:Storage.Storage-Level
* @instance * @instance
*/ */
const iterator = async function * ({ amount, reverse } = {}) { const iterator = async function * () {
const iteratorOptions = { limit: amount || -1, reverse: reverse || false } for await (const [key, value] of db.iterator()) {
for await (const [key, value] of db.iterator(iteratorOptions)) {
yield [key, value] yield [key, value]
} }
} }

View File

@ -3,7 +3,6 @@ import PQueue from 'p-queue'
import { EventEmitter } from 'events' import { EventEmitter } from 'events'
import { TimeoutController } from 'timeout-abort-controller' import { TimeoutController } from 'timeout-abort-controller'
import pathJoin from './utils/path-join.js' import pathJoin from './utils/path-join.js'
import { Entry } from './oplog/index.js'
const DefaultTimeout = 30000 // 30 seconds const DefaultTimeout = 30000 // 30 seconds
@ -20,9 +19,7 @@ const DefaultTimeout = 30000 // 30 seconds
* Upon subscribing to the topic, peers already connected to the topic receive * Upon subscribing to the topic, peers already connected to the topic receive
* the subscription message and "dial" the subscribing peer using a libp2p * the subscription message and "dial" the subscribing peer using a libp2p
* custom protocol. Once connected to the subscribing peer on a direct * custom protocol. Once connected to the subscribing peer on a direct
* peer-to-peer connection, the dialing peer and the subscribing peer exchange * peer-to-peer connection, the dialing peer and the subscribing peer exchange * the heads of the Log each peer currently has. Once completed, the peers have * the same "local state".
* the heads of the Log each peer currently has. Once completed, the peers have
* the same "local state".
* *
* Once the initial sync has completed, peers notify one another of updates to * Once the initial sync has completed, peers notify one another of updates to
* the log, ie. updates to the database, using the initially opened pubsub * the log, ie. updates to the database, using the initially opened pubsub
@ -135,7 +132,7 @@ const Sync = async ({ ipfs, log, events, onSynced, start, timeout }) => {
*/ */
events = events || new EventEmitter() events = events || new EventEmitter()
timeout ??= DefaultTimeout timeout = timeout || DefaultTimeout
let started = false let started = false
@ -147,8 +144,7 @@ const Sync = async ({ ipfs, log, events, onSynced, start, timeout }) => {
const sendHeads = (source) => { const sendHeads = (source) => {
return (async function * () { return (async function * () {
const heads = await log.heads() const heads = await log.heads()
for await (const { hash } of heads) { for await (const { bytes } of heads) {
const bytes = await log.storage.get(hash)
yield bytes yield bytes
} }
})() })()
@ -158,8 +154,7 @@ const Sync = async ({ ipfs, log, events, onSynced, start, timeout }) => {
for await (const value of source) { for await (const value of source) {
const headBytes = value.subarray() const headBytes = value.subarray()
if (headBytes && onSynced) { if (headBytes && onSynced) {
const entry = await Entry.decode(headBytes, log.encryption.replication?.decrypt, log.encryption.data?.decrypt) await onSynced(headBytes)
await onSynced(entry)
} }
} }
if (started) { if (started) {
@ -197,8 +192,9 @@ const Sync = async ({ ipfs, log, events, onSynced, start, timeout }) => {
const stream = await libp2p.dialProtocol(remotePeer, headsSyncAddress, { signal }) const stream = await libp2p.dialProtocol(remotePeer, headsSyncAddress, { signal })
await pipe(sendHeads, stream, receiveHeads(peerId)) await pipe(sendHeads, stream, receiveHeads(peerId))
} catch (e) { } catch (e) {
console.error(e)
peers.delete(peerId) peers.delete(peerId)
if (e.name === 'UnsupportedProtocolError') { if (e.code === 'ERR_UNSUPPORTED_PROTOCOL') {
// Skip peer, they don't have this database currently // Skip peer, they don't have this database currently
} else { } else {
events.emit('error', e) events.emit('error', e)
@ -222,8 +218,7 @@ const Sync = async ({ ipfs, log, events, onSynced, start, timeout }) => {
const task = async () => { const task = async () => {
try { try {
if (data && onSynced) { if (data && onSynced) {
const entry = await Entry.decode(data, log.encryption.replication?.decrypt, log.encryption.data?.decrypt) await onSynced(data)
await onSynced(entry)
} }
} catch (e) { } catch (e) {
events.emit('error', e) events.emit('error', e)
@ -235,10 +230,6 @@ const Sync = async ({ ipfs, log, events, onSynced, start, timeout }) => {
} }
} }
const handlePeerDisconnected = async event => {
peers.delete(event.detail.toString())
}
/** /**
* Add a log entry to the Sync Protocol to be sent to peers. * Add a log entry to the Sync Protocol to be sent to peers.
* @function add * @function add
@ -247,9 +238,8 @@ const Sync = async ({ ipfs, log, events, onSynced, start, timeout }) => {
* @instance * @instance
*/ */
const add = async (entry) => { const add = async (entry) => {
if (started && entry && entry.hash) { if (started) {
const bytes = await log.storage.get(entry.hash) await pubsub.publish(address, entry.bytes)
await pubsub.publish(address, bytes)
} }
} }
@ -262,12 +252,11 @@ const Sync = async ({ ipfs, log, events, onSynced, start, timeout }) => {
const stopSync = async () => { const stopSync = async () => {
if (started) { if (started) {
started = false started = false
await queue.clear() await queue.onIdle()
pubsub.removeEventListener('subscription-change', handlePeerSubscribed) pubsub.removeEventListener('subscription-change', handlePeerSubscribed)
pubsub.removeEventListener('message', handleUpdateMessage) pubsub.removeEventListener('message', handleUpdateMessage)
await libp2p.unhandle(headsSyncAddress) await libp2p.unhandle(headsSyncAddress)
await pubsub.unsubscribe(address) await pubsub.unsubscribe(address)
libp2p.removeEventListener('peer:disconnect', handlePeerDisconnected)
peers.clear() peers.clear()
} }
} }
@ -280,14 +269,12 @@ const Sync = async ({ ipfs, log, events, onSynced, start, timeout }) => {
*/ */
const startSync = async () => { const startSync = async () => {
if (!started) { if (!started) {
// Exchange head entries with peers when connected
await libp2p.handle(headsSyncAddress, handleReceiveHeads)
pubsub.addEventListener('subscription-change', handlePeerSubscribed) pubsub.addEventListener('subscription-change', handlePeerSubscribed)
pubsub.addEventListener('message', handleUpdateMessage) pubsub.addEventListener('message', handleUpdateMessage)
// Subscribe to the pubsub channel for this database through which updates are sent // Subscribe to the pubsub channel for this database through which updates are sent
await pubsub.subscribe(address) await pubsub.subscribe(address)
// Exchange head entries with peers when connected
await libp2p.handle(headsSyncAddress, handleReceiveHeads)
// Remove disconnected peers from `peers`, as otherwise they will not resync heads on reconnection
libp2p.addEventListener('peer:disconnect', handlePeerDisconnected)
started = true started = true
} }
} }

View File

@ -1,7 +1,10 @@
import { privateKeyFromRaw } from '@libp2p/crypto/keys' import * as crypto from '@libp2p/crypto'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string' import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
import { Identities, KeyStore } from '../../src/index.js' import { Identities, KeyStore } from '../../src/index.js'
const unmarshal = crypto.keys.supportedKeys.secp256k1.unmarshalSecp256k1PrivateKey
const unmarshalPubKey = crypto.keys.supportedKeys.secp256k1.unmarshalSecp256k1PublicKey
const keysPath = './testkeys' const keysPath = './testkeys'
const isBrowser = () => typeof window !== 'undefined' const isBrowser = () => typeof window !== 'undefined'
@ -49,10 +52,10 @@ before(async () => {
] ]
for (let user of users) { for (let user of users) {
const privateKey1 = privateKeyFromRaw(uint8ArrayFromString(user.privateKey, 'base16')) const privateKey1 = unmarshal(uint8ArrayFromString(user.privateKey, 'base16'))
const privateKey2 = privateKeyFromRaw(uint8ArrayFromString(user.identity.privateKey, 'base16')) const privateKey2 = unmarshal(uint8ArrayFromString(user.identity.privateKey, 'base16'))
await keystore.addKey(user.id, { privateKey: privateKey1.raw }) await keystore.addKey(user.id, { privateKey: privateKey1.marshal() })
await keystore.addKey(user.identity.id, { privateKey: privateKey2.raw }) await keystore.addKey(user.identity.id, { privateKey: privateKey2.marshal() })
} }
await keystore.close() await keystore.close()

View File

@ -196,20 +196,27 @@ describe('Database - Replication', function () {
db1 = await Database({ ipfs: ipfs1, identity: testIdentity1, address: databaseId, accessController, directory: './orbitdb1', entryStorage: storage1 }) db1 = await Database({ ipfs: ipfs1, identity: testIdentity1, address: databaseId, accessController, directory: './orbitdb1', entryStorage: storage1 })
db2 = await Database({ ipfs: ipfs2, identity: testIdentity2, address: databaseId, accessController, directory: './orbitdb2', entryStorage: storage2 }) db2 = await Database({ ipfs: ipfs2, identity: testIdentity2, address: databaseId, accessController, directory: './orbitdb2', entryStorage: storage2 })
let connected = false let connected1 = false
let connected2 = false
const onConnected = (peerId, heads) => { const onConnected1 = (peerId, heads) => {
connected = true connected1 = true
} }
db2.events.on('join', onConnected) const onConnected2 = (peerId, heads) => {
connected2 = true
}
db1.events.on('join', onConnected1)
db2.events.on('join', onConnected2)
await db1.addOperation({ op: 'PUT', key: 1, value: 'record 1 on db 1' }) await db1.addOperation({ op: 'PUT', key: 1, value: 'record 1 on db 1' })
await db1.addOperation({ op: 'PUT', key: 2, value: 'record 2 on db 1' }) await db1.addOperation({ op: 'PUT', key: 2, value: 'record 2 on db 1' })
await db1.addOperation({ op: 'PUT', key: 3, value: 'record 3 on db 1' }) await db1.addOperation({ op: 'PUT', key: 3, value: 'record 3 on db 1' })
await db1.addOperation({ op: 'PUT', key: 4, value: 'record 4 on db 1' }) await db1.addOperation({ op: 'PUT', key: 4, value: 'record 4 on db 1' })
await waitFor(() => connected, () => true) await waitFor(() => connected1, () => true)
await waitFor(() => connected2, () => true)
const all1 = [] const all1 = []
for await (const item of db1.log.iterator()) { for await (const item of db1.log.iterator()) {

View File

@ -3,7 +3,7 @@ import { rimraf } from 'rimraf'
import { existsSync } from 'fs' import { existsSync } from 'fs'
import { copy } from 'fs-extra' import { copy } from 'fs-extra'
import Path from 'path' import Path from 'path'
import { Database, KeyStore, Identities } from '../src/index.js' import { Database, Entry, KeyStore, Identities } from '../src/index.js'
import LevelStorage from '../src/storage/level.js' import LevelStorage from '../src/storage/level.js'
import MemoryStorage from '../src/storage/memory.js' import MemoryStorage from '../src/storage/memory.js'
import testKeysPath from './fixtures/test-keys-path.js' import testKeysPath from './fixtures/test-keys-path.js'
@ -68,13 +68,8 @@ describe('Database', function () {
describe('Options', () => { describe('Options', () => {
it('uses default directory for headsStorage', async () => { it('uses default directory for headsStorage', async () => {
db = await Database({ ipfs, identity: testIdentity, address: databaseId, accessController }) db = await Database({ ipfs, identity: testIdentity, address: databaseId, accessController })
const op = { op: 'PUT', key: 1, value: 'record 1 on db 1' }
const op1 = { op: 'PUT', key: 1, value: 'record 1 on db 1 version 1' } const hash = await db.addOperation(op)
const op2 = { op: 'PUT', key: 1, value: 'record 1 on db 1 version 2' }
await db.addOperation(op1)
const hash = await db.addOperation(op2)
const entry = await db.log.get(hash)
const headsPath = Path.join('./orbitdb/', `${databaseId}/`, '/log/_heads/') const headsPath = Path.join('./orbitdb/', `${databaseId}/`, '/log/_heads/')
@ -83,13 +78,8 @@ describe('Database', function () {
await db.close() await db.close()
const headsStorage = await LevelStorage({ path: headsPath }) const headsStorage = await LevelStorage({ path: headsPath })
const bytes = await headsStorage.get('heads')
const heads = JSON.parse(new TextDecoder().decode(bytes))
strictEqual(heads.length, 1) deepStrictEqual((await Entry.decode(await headsStorage.get(hash))).payload, op)
strictEqual(heads.at(0).hash, hash)
strictEqual(heads.at(0).next.length, 1)
strictEqual(heads.at(0).next.at(0), entry.next.at(0))
await headsStorage.close() await headsStorage.close()
@ -98,12 +88,8 @@ describe('Database', function () {
it('uses given directory for headsStorage', async () => { it('uses given directory for headsStorage', async () => {
db = await Database({ ipfs, identity: testIdentity, address: databaseId, accessController, directory: './custom-directory' }) db = await Database({ ipfs, identity: testIdentity, address: databaseId, accessController, directory: './custom-directory' })
const op1 = { op: 'PUT', key: 1, value: 'record 1 on db 1 version 1' } const op = { op: 'PUT', key: 1, value: 'record 1 on db 1' }
const op2 = { op: 'PUT', key: 1, value: 'record 1 on db 1 version 2' } const hash = await db.addOperation(op)
await db.addOperation(op1)
const hash = await db.addOperation(op2)
const entry = await db.log.get(hash)
const headsPath = Path.join('./custom-directory/', `${databaseId}/`, '/log/_heads/') const headsPath = Path.join('./custom-directory/', `${databaseId}/`, '/log/_heads/')
@ -113,13 +99,7 @@ describe('Database', function () {
const headsStorage = await LevelStorage({ path: headsPath }) const headsStorage = await LevelStorage({ path: headsPath })
const bytes = await headsStorage.get('heads') deepStrictEqual((await Entry.decode(await headsStorage.get(hash))).payload, op)
const heads = JSON.parse(new TextDecoder().decode(bytes))
strictEqual(heads.length, 1)
strictEqual(heads.at(0).hash, hash)
strictEqual(heads.at(0).next.length, 1)
strictEqual(heads.at(0).next.at(0), entry.next.at(0))
await headsStorage.close() await headsStorage.close()
@ -130,51 +110,23 @@ describe('Database', function () {
it('uses given MemoryStorage for headsStorage', async () => { it('uses given MemoryStorage for headsStorage', async () => {
const headsStorage = await MemoryStorage() const headsStorage = await MemoryStorage()
db = await Database({ ipfs, identity: testIdentity, address: databaseId, accessController, directory: './orbitdb', headsStorage }) db = await Database({ ipfs, identity: testIdentity, address: databaseId, accessController, directory: './orbitdb', headsStorage })
const op1 = { op: 'PUT', key: 1, value: 'record 1 on db 1 version 1' } const op = { op: 'PUT', key: 1, value: 'record 1 on db 1' }
const op2 = { op: 'PUT', key: 1, value: 'record 1 on db 1 version 2' } const hash = await db.addOperation(op)
await db.addOperation(op1) deepStrictEqual((await Entry.decode(await headsStorage.get(hash))).payload, op)
const hash = await db.addOperation(op2)
const entry = await db.log.get(hash)
const bytes = await headsStorage.get('heads')
const heads = JSON.parse(new TextDecoder().decode(bytes))
strictEqual(heads.length, 1)
strictEqual(heads.at(0).hash, hash)
strictEqual(heads.at(0).next.length, 1)
strictEqual(heads.at(0).next.at(0), entry.next.at(0))
await db.close() await db.close()
await headsStorage.close()
await rimraf('./orbitdb')
}) })
it('uses given MemoryStorage for entryStorage', async () => { it('uses given MemoryStorage for entryStorage', async () => {
const entryStorage = await MemoryStorage() const entryStorage = await MemoryStorage()
const headsStorage = await MemoryStorage() db = await Database({ ipfs, identity: testIdentity, address: databaseId, accessController, directory: './orbitdb', entryStorage })
db = await Database({ ipfs, identity: testIdentity, address: databaseId, accessController, directory: './orbitdb', headsStorage, entryStorage }) const op = { op: 'PUT', key: 1, value: 'record 1 on db 1' }
const op1 = { op: 'PUT', key: 1, value: 'record 1 on db 1 version 1' } const hash = await db.addOperation(op)
const op2 = { op: 'PUT', key: 1, value: 'record 1 on db 1 version 2' }
await db.addOperation(op1) deepStrictEqual((await Entry.decode(await entryStorage.get(hash))).payload, op)
const hash = await db.addOperation(op2)
const entry = await db.log.get(hash)
const bytes = await headsStorage.get('heads')
const heads = JSON.parse(new TextDecoder().decode(bytes))
strictEqual(heads.length, 1)
strictEqual(heads.at(0).hash, hash)
strictEqual(heads.at(0).next.length, 1)
strictEqual(heads.at(0).next.at(0), entry.next.at(0))
await db.close() await db.close()
await entryStorage.close()
await headsStorage.close()
await rimraf('./orbitdb')
}) })
}) })

View File

@ -287,7 +287,7 @@ describe('KeyValueIndexed Database', function () {
await db.put('key', 'value') await db.put('key', 'value')
let result let result
for await (const { key, value } of db.iterator()) { for await (const [key, value] of storage.iterator()) {
result = [key, value] result = [key, value]
} }

View File

@ -11,7 +11,7 @@ import createHelia from '../../utils/create-helia.js'
const keysPath = './testkeys' const keysPath = './testkeys'
describe('Documents Database Replication', function () { describe('Documents Database Replication', function () {
this.timeout(10000) this.timeout(30000)
let ipfs1, ipfs2 let ipfs1, ipfs2
let keystore let keystore

View File

@ -24,7 +24,7 @@ describe('KeyValueIndexed Database Replication', function () {
const accessController = { const accessController = {
canAppend: async (entry) => { canAppend: async (entry) => {
const identity = await identities.getIdentity(entry.identity) const identity = await identities.getIdentity(entry.identity)
return identity.id === testIdentity1.id || identity.id === testIdentity2.id return identity.id === testIdentity1.id
} }
} }
@ -32,12 +32,6 @@ describe('KeyValueIndexed Database Replication', function () {
[ipfs1, ipfs2] = await Promise.all([createHelia(), createHelia()]) [ipfs1, ipfs2] = await Promise.all([createHelia(), createHelia()])
await connectPeers(ipfs1, ipfs2) await connectPeers(ipfs1, ipfs2)
await rimraf(keysPath)
await rimraf('./orbitdb1')
await rimraf('./orbitdb2')
await rimraf('./ipfs1')
await rimraf('./ipfs2')
await copy(testKeysPath, keysPath) await copy(testKeysPath, keysPath)
keystore = await KeyStore({ path: keysPath }) keystore = await KeyStore({ path: keysPath })
identities = await Identities({ keystore }) identities = await Identities({ keystore })
@ -129,8 +123,8 @@ describe('KeyValueIndexed Database Replication', function () {
all2.push(keyValue) all2.push(keyValue)
} }
deepStrictEqual(all2.map(e => { return { key: e.key, value: e.value } }), [ deepStrictEqual(all2.map(e => { return { key: e.key, value: e.value } }), [
{ key: 'init', value: true }, { key: 'hello', value: 'friend3' },
{ key: 'hello', value: 'friend3' } { key: 'init', value: true }
]) ])
const all1 = [] const all1 = []
@ -138,8 +132,8 @@ describe('KeyValueIndexed Database Replication', function () {
all1.push(keyValue) all1.push(keyValue)
} }
deepStrictEqual(all1.map(e => { return { key: e.key, value: e.value } }), [ deepStrictEqual(all1.map(e => { return { key: e.key, value: e.value } }), [
{ key: 'init', value: true }, { key: 'hello', value: 'friend3' },
{ key: 'hello', value: 'friend3' } { key: 'init', value: true }
]) ])
}) })
@ -202,176 +196,17 @@ describe('KeyValueIndexed Database Replication', function () {
all2.push(keyValue) all2.push(keyValue)
} }
deepStrictEqual(all2.map(e => { return { key: e.key, value: e.value } }), [ deepStrictEqual(all2.map(e => { return { key: e.key, value: e.value } }), [
{ key: 'init', value: true },
{ key: 'hello', value: 'friend3' }
])
const all1 = []
for await (const keyValue of kv1.iterator()) {
all1.push(keyValue)
}
deepStrictEqual(all1.map(e => { return { key: e.key, value: e.value } }), [
{ key: 'init', value: true },
{ key: 'hello', value: 'friend3' }
])
})
it('indexes the database correctly', async () => {
let replicated1 = false
let replicated2 = false
let replicated3 = false
let expectedEntryHash1 = null
let expectedEntryHash2 = null
let expectedEntryHash3 = null
const onError = (err) => {
console.error(err)
deepStrictEqual(err, undefined)
}
const onUpdate = (entry) => {
replicated1 = expectedEntryHash1 !== null && entry.hash === expectedEntryHash1
}
kv1 = await KeyValueIndexed()({ ipfs: ipfs1, identity: testIdentity1, address: databaseId, accessController, directory: './orbitdb1' })
kv2 = await KeyValueIndexed()({ ipfs: ipfs2, identity: testIdentity2, address: databaseId, accessController, directory: './orbitdb2' })
kv2.events.on('update', onUpdate)
kv2.events.on('error', onError)
kv1.events.on('error', onError)
await kv1.set('init', true)
await kv1.set('hello', 'friend')
await kv1.del('hello')
await kv1.set('hello', 'friend2')
await kv1.del('hello')
await kv1.set('empty', '')
await kv1.del('empty')
expectedEntryHash1 = await kv1.set('hello', 'friend3')
await waitFor(() => replicated1, () => true)
await kv1.close()
await kv2.set('A', 'AAA')
await kv2.set('B', 'BBB')
expectedEntryHash3 = await kv2.set('C', 'CCC')
await kv2.close()
kv1 = await KeyValueIndexed()({ ipfs: ipfs1, identity: testIdentity1, address: databaseId, accessController, directory: './orbitdb1' })
const onUpdate3 = async (entry) => {
replicated3 = expectedEntryHash3 && entry.hash === expectedEntryHash3
}
kv1.events.on('update', onUpdate3)
kv1.events.on('error', onError)
await kv1.set('one', 1)
await kv1.set('two', 2)
await kv1.set('three', 3)
await kv1.del('three')
expectedEntryHash2 = await kv1.set('four', 4)
kv2 = await KeyValueIndexed()({ ipfs: ipfs2, identity: testIdentity2, address: databaseId, accessController, directory: './orbitdb2' })
const onUpdate2 = (entry) => {
replicated2 = expectedEntryHash2 && entry.hash === expectedEntryHash2
}
kv2.events.on('update', onUpdate2)
kv2.events.on('error', onError)
await waitFor(() => replicated2 && replicated3, () => true)
const all1 = []
for await (const keyValue of kv1.iterator()) {
all1.push(keyValue)
}
const all2 = []
for await (const keyValue of kv2.iterator()) {
all2.push(keyValue)
}
deepStrictEqual(all2.map(e => { return { key: e.key, value: e.value } }), [
{ key: 'two', value: 2 },
{ key: 'one', value: 1 },
{ key: 'init', value: true },
{ key: 'hello', value: 'friend3' }, { key: 'hello', value: 'friend3' },
{ key: 'four', value: 4 }, { key: 'init', value: true }
{ key: 'C', value: 'CCC' },
{ key: 'B', value: 'BBB' },
{ key: 'A', value: 'AAA' }
]) ])
deepStrictEqual(all1.map(e => { return { key: e.key, value: e.value } }), [
{ key: 'two', value: 2 },
{ key: 'one', value: 1 },
{ key: 'init', value: true },
{ key: 'hello', value: 'friend3' },
{ key: 'four', value: 4 },
{ key: 'C', value: 'CCC' },
{ key: 'B', value: 'BBB' },
{ key: 'A', value: 'AAA' }
])
})
it('indexes deletes correctly', async () => {
const databaseId = 'kv-CCC'
let replicated = false
let err
const onError = (error) => {
err = error
}
kv1 = await KeyValueIndexed()({ ipfs: ipfs1, identity: testIdentity1, address: databaseId, accessController, directory: './orbitdb11' })
kv1.events.on('error', onError)
await kv1.set('init', true)
await kv1.set('hello', 'friend')
await kv1.del('delete')
await kv1.set('delete', 'this value')
await kv1.del('delete')
kv2 = await KeyValueIndexed()({ ipfs: ipfs2, identity: testIdentity2, address: databaseId, accessController, directory: './orbitdb22' })
const onConnected = (entry) => {
replicated = true
}
kv2.events.on('join', onConnected)
kv2.events.on('error', onError)
await waitFor(() => replicated, () => true)
const all1 = [] const all1 = []
for await (const keyValue of kv1.iterator()) { for await (const keyValue of kv1.iterator()) {
all1.push(keyValue) all1.push(keyValue)
} }
const all2 = []
for await (const keyValue of kv2.iterator()) {
all2.push(keyValue)
}
deepStrictEqual(err, undefined)
deepStrictEqual(all2.map(e => { return { key: e.key, value: e.value } }), [
{ key: 'init', value: true },
{ key: 'hello', value: 'friend' }
])
deepStrictEqual(all1.map(e => { return { key: e.key, value: e.value } }), [ deepStrictEqual(all1.map(e => { return { key: e.key, value: e.value } }), [
{ key: 'init', value: true }, { key: 'hello', value: 'friend3' },
{ key: 'hello', value: 'friend' } { key: 'init', value: true }
]) ])
await rimraf('./orbitdb11')
await rimraf('./orbitdb22')
}) })
}) })

View File

@ -38,7 +38,7 @@ describe('Identities', function () {
identities = await Identities({ path: keysPath }) identities = await Identities({ path: keysPath })
identity = await identities.createIdentity({ id }) identity = await identities.createIdentity({ id })
const key = await identities.keystore.getKey(id) const key = await identities.keystore.getKey(id)
const externalId = uint8ArrayToString(key.publicKey.raw, 'base16') const externalId = uint8ArrayToString(key.public.marshal(), 'base16')
assert.strictEqual(identity.id, externalId) assert.strictEqual(identity.id, externalId)
}) })
}) })
@ -106,7 +106,7 @@ describe('Identities', function () {
identity = await identities.createIdentity({ id }) identity = await identities.createIdentity({ id })
keystore = identities.keystore keystore = identities.keystore
const key = await keystore.getKey(id) const key = await keystore.getKey(id)
const externalId = uint8ArrayToString(key.publicKey.raw, 'base16') const externalId = uint8ArrayToString(key.public.marshal(), 'base16')
assert.strictEqual(identity.id, externalId) assert.strictEqual(identity.id, externalId)
}) })
@ -117,7 +117,7 @@ describe('Identities', function () {
it('has the correct public key', async () => { it('has the correct public key', async () => {
const key = await keystore.getKey(id) const key = await keystore.getKey(id)
const externalId = uint8ArrayToString(key.publicKey.raw, 'base16') const externalId = uint8ArrayToString(key.public.marshal(), 'base16')
const signingKey = await keystore.getKey(externalId) const signingKey = await keystore.getKey(externalId)
assert.notStrictEqual(signingKey, undefined) assert.notStrictEqual(signingKey, undefined)
assert.strictEqual(identity.publicKey, keystore.getPublic(signingKey)) assert.strictEqual(identity.publicKey, keystore.getPublic(signingKey))
@ -125,10 +125,10 @@ describe('Identities', function () {
it('has a signature for the id', async () => { it('has a signature for the id', async () => {
const key = await keystore.getKey(id) const key = await keystore.getKey(id)
const externalId = uint8ArrayToString(key.publicKey.raw, 'base16') const externalId = uint8ArrayToString(key.public.marshal(), 'base16')
const signingKey = await keystore.getKey(externalId) const signingKey = await keystore.getKey(externalId)
const idSignature = await signMessage(signingKey, externalId) const idSignature = await signMessage(signingKey, externalId)
const publicKey = uint8ArrayToString(signingKey.publicKey.raw, 'base16') const publicKey = uint8ArrayToString(signingKey.public.marshal(), 'base16')
const verifies = await verifyMessage(idSignature, publicKey, externalId) const verifies = await verifyMessage(idSignature, publicKey, externalId)
assert.strictEqual(verifies, true) assert.strictEqual(verifies, true)
assert.strictEqual(identity.signatures.id, idSignature) assert.strictEqual(identity.signatures.id, idSignature)
@ -136,7 +136,7 @@ describe('Identities', function () {
it('has a signature for the publicKey', async () => { it('has a signature for the publicKey', async () => {
const key = await keystore.getKey(id) const key = await keystore.getKey(id)
const externalId = uint8ArrayToString(key.publicKey.raw, 'base16') const externalId = uint8ArrayToString(key.public.marshal(), 'base16')
const signingKey = await keystore.getKey(externalId) const signingKey = await keystore.getKey(externalId)
const idSignature = await signMessage(signingKey, externalId) const idSignature = await signMessage(signingKey, externalId)
const externalKey = await keystore.getKey(id) const externalKey = await keystore.getKey(id)
@ -171,7 +171,7 @@ describe('Identities', function () {
it('has the correct id', async () => { it('has the correct id', async () => {
const key = await savedKeysKeyStore.getKey(id) const key = await savedKeysKeyStore.getKey(id)
assert.strictEqual(identity.id, uint8ArrayToString(key.publicKey.raw, 'base16')) assert.strictEqual(identity.id, uint8ArrayToString(key.public.marshal(), 'base16'))
}) })
it('has the correct public key', async () => { it('has the correct public key', async () => {

View File

@ -145,7 +145,7 @@ describe('KeyStore', () => {
}) })
describe('Options', () => { describe('Options', () => {
const unmarshal = crypto.keys.privateKeyFromRaw const unmarshal = crypto.keys.supportedKeys.secp256k1.unmarshalSecp256k1PrivateKey
const privateKey = '198594a8de39fd97017d11996d619b3746211605a9d290964badf58bc79bdb33' const privateKey = '198594a8de39fd97017d11996d619b3746211605a9d290964badf58bc79bdb33'
const publicKey = '0260baeaffa1de1e4135e5b395e0380563a622b9599d1b8e012a0f7603f516bdaa' const publicKey = '0260baeaffa1de1e4135e5b395e0380563a622b9599d1b8e012a0f7603f516bdaa'
let privateKeyBuffer, publicKeyBuffer, unmarshalledPrivateKey let privateKeyBuffer, publicKeyBuffer, unmarshalledPrivateKey

View File

@ -33,8 +33,7 @@ describe('Entry', function () {
it('creates a an empty entry', async () => { it('creates a an empty entry', async () => {
const expectedHash = 'zdpuAsKzwUEa8cz9pkJxxFMxLuP3cutA9PDGoLZytrg4RSVEa' const expectedHash = 'zdpuAsKzwUEa8cz9pkJxxFMxLuP3cutA9PDGoLZytrg4RSVEa'
const entry = await create(testIdentity, 'A', 'hello') const entry = await create(testIdentity, 'A', 'hello')
const { hash } = await Entry.encode(entry) strictEqual(entry.hash, expectedHash)
strictEqual(hash, expectedHash)
strictEqual(entry.id, 'A') strictEqual(entry.id, 'A')
strictEqual(entry.clock.id, testIdentity.publicKey) strictEqual(entry.clock.id, testIdentity.publicKey)
strictEqual(entry.clock.time, 0) strictEqual(entry.clock.time, 0)
@ -48,8 +47,7 @@ describe('Entry', function () {
const expectedHash = 'zdpuAmthfqpHRQjdSpKN5etr1GrreJb7QcU1Hshm6pERnzsxi' const expectedHash = 'zdpuAmthfqpHRQjdSpKN5etr1GrreJb7QcU1Hshm6pERnzsxi'
const payload = 'hello world' const payload = 'hello world'
const entry = await create(testIdentity, 'A', payload) const entry = await create(testIdentity, 'A', payload)
const { hash } = await Entry.encode(entry) strictEqual(entry.hash, expectedHash)
strictEqual(hash, expectedHash)
strictEqual(entry.payload, payload) strictEqual(entry.payload, payload)
strictEqual(entry.id, 'A') strictEqual(entry.id, 'A')
strictEqual(entry.clock.id, testIdentity.publicKey) strictEqual(entry.clock.id, testIdentity.publicKey)
@ -83,7 +81,7 @@ describe('Entry', function () {
const payload2 = 'hello again' const payload2 = 'hello again'
const entry1 = await create(testIdentity, 'A', payload1) const entry1 = await create(testIdentity, 'A', payload1)
entry1.clock = tickClock(entry1.clock) entry1.clock = tickClock(entry1.clock)
const entry2 = await create(testIdentity, 'A', payload2, null, entry1.clock, [entry1]) const entry2 = await create(testIdentity, 'A', payload2, entry1.clock, [entry1])
strictEqual(entry2.payload, payload2) strictEqual(entry2.payload, payload2)
strictEqual(entry2.next.length, 1) strictEqual(entry2.next.length, 1)
// strictEqual(entry2.hash, expectedHash) // strictEqual(entry2.hash, expectedHash)
@ -93,8 +91,7 @@ describe('Entry', function () {
it('`next` parameter can be an array of strings', async () => { it('`next` parameter can be an array of strings', async () => {
const entry1 = await create(testIdentity, 'A', 'hello1') const entry1 = await create(testIdentity, 'A', 'hello1')
const { hash } = await Entry.encode(entry1) const entry2 = await create(testIdentity, 'A', 'hello2', null, [entry1.hash])
const entry2 = await create(testIdentity, 'A', 'hello2', null, null, [hash])
strictEqual(typeof entry2.next[0] === 'string', true) strictEqual(typeof entry2.next[0] === 'string', true)
}) })
@ -141,7 +138,7 @@ describe('Entry', function () {
it('throws an error if next is not an array', async () => { it('throws an error if next is not an array', async () => {
let err let err
try { try {
await create(testIdentity, 'A', 'hello', null, null, {}) await create(testIdentity, 'A', 'hello', null, {})
} catch (e) { } catch (e) {
err = e err = e
} }

View File

@ -1,7 +1,7 @@
import { strictEqual, notStrictEqual, deepStrictEqual } from 'assert' import { strictEqual, notStrictEqual, deepStrictEqual } from 'assert'
import { rimraf } from 'rimraf' import { rimraf } from 'rimraf'
import { copy } from 'fs-extra' import { copy } from 'fs-extra'
import { Log, Identities, KeyStore } from '../../src/index.js' import { Log, Entry, Identities, KeyStore } from '../../src/index.js'
import { Clock } from '../../src/oplog/log.js' import { Clock } from '../../src/oplog/log.js'
import { MemoryStorage } from '../../src/storage/index.js' import { MemoryStorage } from '../../src/storage/index.js'
import testKeysPath from '../fixtures/test-keys-path.js' import testKeysPath from '../fixtures/test-keys-path.js'
@ -760,7 +760,7 @@ describe('Log - Join', async function () {
await log1.storage.merge(log0.storage) await log1.storage.merge(log0.storage)
await headsStorage1.put('heads', new TextEncoder().encode(JSON.stringify([{ hash: e0.hash, next: e0.next }]))) await headsStorage1.put(e0.hash, e0.bytes)
await log1.append('hello1') await log1.append('hello1')
await log1.append('hello2') await log1.append('hello2')
@ -863,7 +863,7 @@ describe('Log - Join', async function () {
}) })
describe('throws an error if verification of an entry in given entry\'s history fails', async () => { describe('throws an error if verification of an entry in given entry\'s history fails', async () => {
let e1 let e1, e3
let headsStorage1, headsStorage2 let headsStorage1, headsStorage2
before(async () => { before(async () => {
@ -875,19 +875,23 @@ describe('Log - Join', async function () {
e1 = await log1.append('hello1') e1 = await log1.append('hello1')
await log1.append('hello2') await log1.append('hello2')
await log1.append('hello3') e3 = await log1.append('hello3')
}) })
it('throws an error if an entry doesn\'t have a payload field', async () => { it('throws an error if an entry doesn\'t have a payload field', async () => {
const e = Object.assign({}, e1) const e = Object.assign({}, e1)
delete e.payload delete e.payload
await headsStorage1.put('heads', JSON.stringify([{ hash: e1.hash, next: e1.next }])) delete e.bytes
delete e.hash
const ee = await Entry.encode(e)
await headsStorage1.put(e1.hash, ee.bytes)
await log2.storage.merge(headsStorage1) await log2.storage.merge(headsStorage1)
let err let err
try { try {
await log2.joinEntry(e) await log2.joinEntry(e3)
} catch (e) { } catch (e) {
err = e err = e
} }
@ -902,12 +906,16 @@ describe('Log - Join', async function () {
const e = Object.assign({}, e1) const e = Object.assign({}, e1)
delete e.key delete e.key
await headsStorage1.put('heads', JSON.stringify([{ hash: e1.hash, next: e1.next }])) delete e.bytes
delete e.hash
const ee = await Entry.encode(e)
await headsStorage1.put(e1.hash, ee.bytes)
await log2.storage.merge(headsStorage1) await log2.storage.merge(headsStorage1)
let err let err
try { try {
await log2.joinEntry(e) await log2.joinEntry(e3)
} catch (e) { } catch (e) {
err = e err = e
} }
@ -922,12 +930,16 @@ describe('Log - Join', async function () {
const e = Object.assign({}, e1) const e = Object.assign({}, e1)
delete e.sig delete e.sig
await headsStorage1.put('heads', JSON.stringify([{ hash: e1.hash, next: e1.next }])) delete e.bytes
delete e.hash
const ee = await Entry.encode(e)
await headsStorage1.put(e1.hash, ee.bytes)
await log2.storage.merge(headsStorage1) await log2.storage.merge(headsStorage1)
let err let err
try { try {
await log2.joinEntry(e) await log2.joinEntry(e3)
} catch (e) { } catch (e) {
err = e err = e
} }
@ -941,19 +953,22 @@ describe('Log - Join', async function () {
it('throws an error if an entry signature doesn\'t verify', async () => { it('throws an error if an entry signature doesn\'t verify', async () => {
const e = Object.assign({}, e1) const e = Object.assign({}, e1)
e.sig = '1234567890' e.sig = '1234567890'
delete e.bytes
delete e.hash
const ee = await Entry.encode(e)
await headsStorage1.put('heads', JSON.stringify([{ hash: e1.hash, next: e1.next }])) await headsStorage1.put(e1.hash, ee.bytes)
await log2.storage.merge(headsStorage1) await log2.storage.merge(headsStorage1)
let err let err
try { try {
await log2.joinEntry(e) await log2.joinEntry(e3)
} catch (e) { } catch (e) {
err = e err = e
} }
notStrictEqual(err, undefined) notStrictEqual(err, undefined)
strictEqual(err.message, 'Could not validate signature for entry "zdpuAxyE4ScWLf4X6VvkhMrpDQvwdvQno1DhzY5p1U3GPHrBT"') strictEqual(err.message, 'Could not validate signature for entry "zdpuAvkAJ8C46cnGdtFpcBratA5MqK7CcjqCJjjmuKuFvZir3"')
deepStrictEqual(await log2.all(), []) deepStrictEqual(await log2.all(), [])
deepStrictEqual(await log2.heads(), []) deepStrictEqual(await log2.heads(), [])
}) })

View File

@ -60,21 +60,15 @@ describe('Log', function () {
}) })
it('sets one head if multiple are given as params', async () => { it('sets one head if multiple are given as params', async () => {
const one = await create(testIdentity, 'A', 'entryA', null, null, []) const one = await create(testIdentity, 'A', 'entryA', null, [])
const { hash: hash1, bytes: bytes1 } = await Entry.encode(one) const two = await create(testIdentity, 'A', 'entryB', null, [one.hash])
const two = await create(testIdentity, 'A', 'entryB', null, null, [hash1]) const three = await create(testIdentity, 'A', 'entryC', null, [two.hash])
const { hash: hash2, bytes: bytes2 } = await Entry.encode(two) const four = await create(testIdentity, 'A', 'entryD', null, [two.hash])
const three = await create(testIdentity, 'A', 'entryC', null, null, [hash2])
const { hash: hash3, bytes: bytes3 } = await Entry.encode(three)
const four = await create(testIdentity, 'A', 'entryD', null, null, [hash3])
const { hash: hash4, bytes: bytes4 } = await Entry.encode(four)
const entryStorage = await MemoryStorage() const entryStorage = await MemoryStorage()
await entryStorage.put(hash1, bytes1) await entryStorage.put(one.hash, one.bytes)
await entryStorage.put(hash2, bytes2) await entryStorage.put(two.hash, two.bytes)
await entryStorage.put(hash3, bytes3) await entryStorage.put(three.hash, three.bytes)
await entryStorage.put(hash4, bytes4) await entryStorage.put(four.hash, four.bytes)
three.hash = hash3
two.hash = hash2
const log = await Log(testIdentity, { logId: 'A', logHeads: [three, three, two, two], entryStorage }) const log = await Log(testIdentity, { logId: 'A', logHeads: [three, three, two, two], entryStorage })
const values = await log.values() const values = await log.values()
const heads = await log.heads() const heads = await log.heads()
@ -84,22 +78,15 @@ describe('Log', function () {
}) })
it('sets two heads if two given as params', async () => { it('sets two heads if two given as params', async () => {
const one = await create(testIdentity, 'A', 'entryA', null, null, []) const one = await create(testIdentity, 'A', 'entryA', null, [])
const { hash: hash1, bytes: bytes1 } = await Entry.encode(one) const two = await create(testIdentity, 'A', 'entryB', null, [one.hash])
const two = await create(testIdentity, 'A', 'entryB', null, null, [hash1]) const three = await create(testIdentity, 'A', 'entryC', null, [two.hash])
const { hash: hash2, bytes: bytes2 } = await Entry.encode(two) const four = await create(testIdentity, 'A', 'entryD', null, [two.hash])
const three = await create(testIdentity, 'A', 'entryC', null, null, [hash2])
const { hash: hash3, bytes: bytes3 } = await Entry.encode(three)
const four = await create(testIdentity, 'A', 'entryD', null, null, [hash2])
const { hash: hash4, bytes: bytes4 } = await Entry.encode(four)
const entryStorage = await MemoryStorage() const entryStorage = await MemoryStorage()
await entryStorage.put(hash1, bytes1) await entryStorage.put(one.hash, one.bytes)
await entryStorage.put(hash2, bytes2) await entryStorage.put(two.hash, two.bytes)
await entryStorage.put(hash3, bytes3) await entryStorage.put(three.hash, three.bytes)
await entryStorage.put(hash4, bytes4) await entryStorage.put(four.hash, four.bytes)
three.hash = hash3
four.hash = hash4
two.hash = hash2
const log = await Log(testIdentity, { logId: 'A', logHeads: [three, four, two], entryStorage }) const log = await Log(testIdentity, { logId: 'A', logHeads: [three, four, two], entryStorage })
const values = await log.values() const values = await log.values()
const heads = await log.heads() const heads = await log.heads()

View File

@ -69,7 +69,7 @@ describe('Log - Replication', function () {
try { try {
if (!messageIsFromMe(message)) { if (!messageIsFromMe(message)) {
const entry = await Entry.decode(message.detail.data) const entry = await Entry.decode(message.detail.data)
await storage1.put(entry.hash, message.detail.data) await storage1.put(entry.hash, entry.bytes)
await log1.joinEntry(entry) await log1.joinEntry(entry)
} }
} catch (e) { } catch (e) {
@ -83,7 +83,7 @@ describe('Log - Replication', function () {
try { try {
if (!messageIsFromMe(message)) { if (!messageIsFromMe(message)) {
const entry = await Entry.decode(message.detail.data) const entry = await Entry.decode(message.detail.data)
await storage2.put(entry.hash, message.detail.data) await storage2.put(entry.hash, entry.bytes)
await log2.joinEntry(entry) await log2.joinEntry(entry)
} }
} catch (e) { } catch (e) {
@ -114,10 +114,8 @@ describe('Log - Replication', function () {
for (let i = 1; i <= amount; i++) { for (let i = 1; i <= amount; i++) {
const entry1 = await input1.append('A' + i) const entry1 = await input1.append('A' + i)
const entry2 = await input2.append('B' + i) const entry2 = await input2.append('B' + i)
const bytes1 = await input1.storage.get(entry1.hash) await ipfs1.libp2p.services.pubsub.publish(logId, entry1.bytes)
const bytes2 = await input1.storage.get(entry2.hash) await ipfs2.libp2p.services.pubsub.publish(logId, entry2.bytes)
await ipfs1.libp2p.services.pubsub.publish(logId, bytes1)
await ipfs2.libp2p.services.pubsub.publish(logId, bytes2)
} }
console.log('Messages sent') console.log('Messages sent')

View File

@ -1,376 +0,0 @@
import { strictEqual, notEqual } from 'assert'
import { rimraf } from 'rimraf'
import path from 'path'
import { createOrbitDB } from '../src/index.js'
import connectPeers from './utils/connect-nodes.js'
import waitFor from './utils/wait-for.js'
import createHelia from './utils/create-helia.js'
import * as Block from 'multiformats/block'
import * as dagCbor from '@ipld/dag-cbor'
import { sha256 } from 'multiformats/hashes/sha2'
import SimpleEncryption from '@orbitdb/simple-encryption'
const codec = dagCbor
const hasher = sha256
const dbPath = './orbitdb/tests/write-permissions'
describe('Encryption', function () {
this.timeout(5000)
let ipfs1, ipfs2
let orbitdb1, orbitdb2
let db1, db2
let replicationEncryption
let dataEncryption
before(async () => {
[ipfs1, ipfs2] = await Promise.all([createHelia(), createHelia()])
await connectPeers(ipfs1, ipfs2)
await rimraf('./orbitdb')
orbitdb1 = await createOrbitDB({ ipfs: ipfs1, id: 'user1', directory: path.join(dbPath, '1') })
orbitdb2 = await createOrbitDB({ ipfs: ipfs2, id: 'user2', directory: path.join(dbPath, '2') })
replicationEncryption = await SimpleEncryption({ password: 'hello' })
dataEncryption = await SimpleEncryption({ password: 'world' })
})
after(async () => {
if (orbitdb1) {
await orbitdb1.stop()
}
if (orbitdb2) {
await orbitdb2.stop()
}
if (ipfs1) {
await ipfs1.stop()
}
if (ipfs2) {
await ipfs2.stop()
}
await rimraf('./orbitdb')
await rimraf('./ipfs1')
await rimraf('./ipfs2')
})
describe('Data is encrypted when replicated to peers', async () => {
afterEach(async () => {
if (db1) {
await db1.drop()
await db1.close()
}
if (db2) {
await db2.drop()
await db2.close()
}
})
it('encrypts/decrypts data', async () => {
let connected = false
let updated = false
let error = false
const encryption = {
data: dataEncryption
}
db1 = await orbitdb1.open('encryption-test-1', { encryption })
db2 = await orbitdb2.open(db1.address, { encryption })
const onJoin = async (peerId, heads) => {
connected = true
}
db2.events.on('join', onJoin)
await waitFor(() => connected, () => true)
const onUpdate = async (peerId, heads) => {
updated = true
}
db2.events.on('update', onUpdate)
const onError = async (err) => {
// Catch "Could not decrypt entry" errors
console.log(err)
error = true
}
db2.events.on('error', onError)
const hash1 = await db1.add('record 1')
const hash2 = await db1.add('record 2')
strictEqual(await db1.get(hash1), 'record 1')
strictEqual(await db1.get(hash2), 'record 2')
await waitFor(() => updated || error, () => true)
const all = await db2.all()
strictEqual(all.length, 2)
strictEqual(all[0].value, 'record 1')
strictEqual(all[1].value, 'record 2')
})
it('encrypts/decrypts log', async () => {
let connected = false
let updated = false
let error = false
const encryption = {
replication: replicationEncryption
}
db1 = await orbitdb1.open('encryption-test-1', { encryption })
db2 = await orbitdb2.open(db1.address, { encryption })
const onJoin = async (peerId, heads) => {
connected = true
}
db2.events.on('join', onJoin)
await waitFor(() => connected, () => true)
const onUpdate = async (peerId, heads) => {
updated = true
}
db2.events.on('update', onUpdate)
const onError = async (err) => {
// Catch "Could not decrypt entry" errors
console.log(err)
error = true
}
db2.events.on('error', onError)
const hash1 = await db1.add('record 1')
const hash2 = await db1.add('record 2')
strictEqual(await db1.get(hash1), 'record 1')
strictEqual(await db1.get(hash2), 'record 2')
await waitFor(() => updated || error, () => true)
const all = await db2.all()
strictEqual(all.length, 2)
strictEqual(all[0].value, 'record 1')
strictEqual(all[1].value, 'record 2')
})
it('encrypts/decrypts log and data', async () => {
let connected = false
let updated = false
let error = false
const encryption = {
replication: replicationEncryption,
data: dataEncryption
}
db1 = await orbitdb1.open('encryption-test-1', { encryption })
db2 = await orbitdb2.open(db1.address, { encryption })
const onJoin = async (peerId, heads) => {
connected = true
}
db2.events.on('join', onJoin)
await waitFor(() => connected, () => true)
const onUpdate = async (peerId, heads) => {
updated = true
}
db2.events.on('update', onUpdate)
const onError = async (err) => {
// Catch "Could not decrypt entry" errors
console.log(err)
error = true
}
db2.events.on('error', onError)
const hash1 = await db1.add('record 1')
const hash2 = await db1.add('record 2')
strictEqual(await db1.get(hash1), 'record 1')
strictEqual(await db1.get(hash2), 'record 2')
await waitFor(() => updated || error, () => true)
const all = await db2.all()
strictEqual(all.length, 2)
strictEqual(all[0].value, 'record 1')
strictEqual(all[1].value, 'record 2')
})
it('throws an error if log can\'t be decrypted', async () => {
let connected = false
let hasError = false
let error
const replicationEncryptionWithFailure = await SimpleEncryption({ password: 'goodbye' })
const encryption = {
replication: replicationEncryption
}
const encryptionWithFailure = {
replication: replicationEncryptionWithFailure
}
db1 = await orbitdb1.open('encryption-test-1', { encryption })
db2 = await orbitdb2.open(db1.address, { encryption: encryptionWithFailure })
const onJoin = async (peerId, heads) => {
connected = true
}
db2.events.on('join', onJoin)
await waitFor(() => connected, () => true)
const onError = async (err) => {
// Catch "Could not decrypt entry" errors
error = err
hasError = true
}
db2.events.on('error', onError)
await db1.add('record 1')
await waitFor(() => hasError, () => true)
strictEqual(error.message, 'Could not decrypt entry')
const all = await db2.all()
strictEqual(all.length, 0)
})
it('throws an error if data can\'t be decrypted', async () => {
let connected = false
let hasError = false
let error
const dataEncryptionWithFailure = await SimpleEncryption({ password: 'goodbye' })
const encryption = {
data: dataEncryption
}
const encryptionWithFailure = {
data: dataEncryptionWithFailure
}
db1 = await orbitdb1.open('encryption-test-1', { encryption })
db2 = await orbitdb2.open(db1.address, { encryption: encryptionWithFailure })
const onJoin = async (peerId, heads) => {
connected = true
}
db2.events.on('join', onJoin)
await waitFor(() => connected, () => true)
const onError = async (err) => {
// Catch "Could not decrypt entry" errors
error = err
hasError = true
}
db2.events.on('error', onError)
await db1.add('record 1')
await waitFor(() => hasError, () => true)
strictEqual(error.message, 'Could not decrypt payload')
const all = await db2.all()
strictEqual(all.length, 0)
})
})
describe('Data is encrypted in storage', async () => {
afterEach(async () => {
if (db1) {
await db1.drop()
await db1.close()
}
})
it('payload bytes are encrypted in storage', async () => {
let error
const encryption = {
data: dataEncryption
}
db1 = await orbitdb1.open('encryption-test-1', { encryption })
const onError = async (err) => {
// Catch "Could not decrypt entry" errors
console.log(err)
error = true
}
db1.events.on('error', onError)
const hash1 = await db1.add('record 1')
const bytes = await db1.log.storage.get(hash1)
const { value } = await Block.decode({ bytes, codec, hasher })
const payload = value.payload
strictEqual(payload.constructor, Uint8Array)
try {
await Block.decode({ bytes: payload, codec, hasher })
} catch (e) {
error = e
}
strictEqual(error.message.startsWith('CBOR decode error'), true)
})
it('entry bytes are encrypted in storage', async () => {
let error
const encryption = {
replication: replicationEncryption
}
db1 = await orbitdb1.open('encryption-test-1', { encryption })
const onError = async (err) => {
// Catch "Could not decrypt entry" errors
console.log(err)
error = true
}
db1.events.on('error', onError)
const hash1 = await db1.add('record 1')
let decodedBytes
try {
const bytes = await db1.log.storage.get(hash1)
decodedBytes = await Block.decode({ bytes, codec, hasher })
await Block.decode({ bytes: decodedBytes, codec, hasher })
} catch (e) {
error = e
}
notEqual(error, undefined)
strictEqual(error.message.startsWith('CBOR decode error'), true)
strictEqual(decodedBytes.value.constructor, Uint8Array)
})
})
})

View File

@ -2,7 +2,7 @@ import { deepStrictEqual, strictEqual, notStrictEqual } from 'assert'
import { rimraf } from 'rimraf' import { rimraf } from 'rimraf'
import fs from 'fs' import fs from 'fs'
import path from 'path' import path from 'path'
import { createOrbitDB, isValidAddress } from '../src/index.js' import { createOrbitDB, isValidAddress, LevelStorage } from '../src/index.js'
import KeyValueIndexed from '../src/databases/keyvalue-indexed.js' import KeyValueIndexed from '../src/databases/keyvalue-indexed.js'
import connectPeers from './utils/connect-nodes.js' import connectPeers from './utils/connect-nodes.js'
import waitFor from './utils/wait-for.js' import waitFor from './utils/wait-for.js'
@ -419,13 +419,14 @@ describe('Open databases', function () {
}) })
describe('opening an indexed keyvalue database', () => { describe('opening an indexed keyvalue database', () => {
let storage
let db, address let db, address
const amount = 10 const amount = 10
before(async () => { before(async () => {
orbitdb1 = await createOrbitDB({ ipfs: ipfs1, id: 'user1' }) orbitdb1 = await createOrbitDB({ ipfs: ipfs1, id: 'user1' })
db = await orbitdb1.open('helloworld', { Database: KeyValueIndexed() }) db = await orbitdb1.open('helloworld', { type: 'keyvalue' })
address = db.address address = db.address
for (let i = 0; i < amount; i++) { for (let i = 0; i < amount; i++) {
@ -436,6 +437,9 @@ describe('Open databases', function () {
}) })
after(async () => { after(async () => {
if (storage) {
await storage.close()
}
if (db) { if (db) {
await db.close() await db.close()
} }
@ -447,7 +451,8 @@ describe('Open databases', function () {
}) })
it('returns all entries in the database and in the index', async () => { it('returns all entries in the database and in the index', async () => {
db = await orbitdb1.open(address, { Database: KeyValueIndexed() }) storage = await LevelStorage({ path: './index', valueEncoding: 'json' })
db = await orbitdb1.open(address, { Database: KeyValueIndexed({ storage }) })
strictEqual(db.address, address) strictEqual(db.address, address)
strictEqual(db.type, 'keyvalue') strictEqual(db.type, 'keyvalue')
@ -459,11 +464,18 @@ describe('Open databases', function () {
} }
const result = [] const result = []
for await (const { key, value } of db.iterator()) { for await (const [key, value] of storage.iterator()) {
result.unshift({ key, value }) result.push({ key, value })
} }
deepStrictEqual(result, expected) deepStrictEqual(result, expected)
const all = []
for await (const { key, value } of db.iterator()) {
all.unshift({ key, value })
}
deepStrictEqual(all, expected)
}) })
}) })

View File

@ -1,11 +1,9 @@
import { deepStrictEqual, strictEqual } from 'assert' import { deepStrictEqual } from 'assert'
import { rimraf } from 'rimraf' import { rimraf } from 'rimraf'
import { createOrbitDB } from '../src/index.js' import { createOrbitDB } from '../src/index.js'
import connectPeers from './utils/connect-nodes.js' import connectPeers from './utils/connect-nodes.js'
import waitFor from './utils/wait-for.js' import waitFor from './utils/wait-for.js'
import createHelia from './utils/create-helia.js' import createHelia from './utils/create-helia.js'
import { CID } from 'multiformats/cid'
import { base58btc } from 'multiformats/bases/base58'
describe('Replicating databases', function () { describe('Replicating databases', function () {
this.timeout(10000) this.timeout(10000)
@ -25,8 +23,8 @@ describe('Replicating databases', function () {
after(async () => { after(async () => {
await orbitdb1.stop() await orbitdb1.stop()
await orbitdb2.stop() await orbitdb2.stop()
await ipfs1.blockstore.child.child.child.close() await ipfs1.blockstore.child.child.close()
await ipfs2.blockstore.child.child.child.close() await ipfs2.blockstore.child.child.close()
await ipfs1.stop() await ipfs1.stop()
await ipfs2.stop() await ipfs2.stop()
@ -138,12 +136,8 @@ describe('Replicating databases', function () {
await orbitdb1.stop() await orbitdb1.stop()
await orbitdb2.stop() await orbitdb2.stop()
// TODO: Strange issue with ClassicLevel. Causes subsequent Helia await ipfs1.blockstore.child.child.close()
// instantiations to error with db closed. Explicitly closing the await ipfs2.blockstore.child.child.close()
// nested ClassicLevel db seems to resolve the issue. Requires further
// investigation.
await ipfs1.blockstore.child.child.child.close()
await ipfs2.blockstore.child.child.child.close()
await ipfs1.stop() await ipfs1.stop()
await ipfs2.stop() await ipfs2.stop()
@ -169,26 +163,5 @@ describe('Replicating databases', function () {
console.log('events:', amount) console.log('events:', amount)
}) })
it('pins all entries in the replicated database', async () => {
const db1 = await orbitdb1.open('helloworld', { referencesCount: 0 })
const hash = await db1.add('hello world')
let replicated = false
const onJoin = async (peerId, heads) => {
replicated = true
}
const db2 = await orbitdb2.open(db1.address)
db2.events.on('join', onJoin)
await waitFor(() => replicated, () => true)
const cid = CID.parse(hash, base58btc)
strictEqual(await ipfs1.pins.isPinned(cid), true)
strictEqual(await ipfs2.pins.isPinned(cid), true)
})
}) })
}) })

View File

@ -72,8 +72,8 @@ describe('OrbitDB', function () {
const privateKey = await orbitdb1.keystore.getKey(orbitdb1.identity.id) const privateKey = await orbitdb1.keystore.getKey(orbitdb1.identity.id)
notStrictEqual(privateKey, undefined) notStrictEqual(privateKey, undefined)
strictEqual(privateKey.constructor.name, 'Secp256k1PrivateKey') strictEqual(privateKey.constructor.name, 'Secp256k1PrivateKey')
notStrictEqual(privateKey.raw, undefined) notStrictEqual(privateKey._key, undefined)
notStrictEqual(privateKey.publicKey, undefined) notStrictEqual(privateKey._publicKey, undefined)
}) })
it('has a keystore that contains a public key that matches the identity\'s public key', async () => { it('has a keystore that contains a public key that matches the identity\'s public key', async () => {
@ -102,8 +102,8 @@ describe('OrbitDB', function () {
notStrictEqual(orbitdb1.peerId, undefined) notStrictEqual(orbitdb1.peerId, undefined)
}) })
it('has a peerId of type Ed25519', async () => { it('has a peerId of type Ed25519PeerIdImpl', async () => {
strictEqual(orbitdb1.peerId.type, 'Ed25519') strictEqual(orbitdb1.peerId.constructor.name, 'Ed25519PeerIdImpl')
}) })
it('has a peerId that matches the IPFS id', async () => { it('has a peerId that matches the IPFS id', async () => {
@ -164,8 +164,8 @@ describe('OrbitDB', function () {
const privateKey = await orbitdb1.keystore.getKey(orbitdb1.identity.id) const privateKey = await orbitdb1.keystore.getKey(orbitdb1.identity.id)
notStrictEqual(privateKey, undefined) notStrictEqual(privateKey, undefined)
strictEqual(privateKey.constructor.name, 'Secp256k1PrivateKey') strictEqual(privateKey.constructor.name, 'Secp256k1PrivateKey')
notStrictEqual(privateKey.raw, undefined) notStrictEqual(privateKey._key, undefined)
notStrictEqual(privateKey.publicKey, undefined) notStrictEqual(privateKey._publicKey, undefined)
}) })
it('has a keystore that contains a public key that matches the identity\'s public key', async () => { it('has a keystore that contains a public key that matches the identity\'s public key', async () => {
@ -194,8 +194,8 @@ describe('OrbitDB', function () {
notStrictEqual(orbitdb1.peerId, undefined) notStrictEqual(orbitdb1.peerId, undefined)
}) })
it('has a peerId of type Ed25519', async () => { it('has a peerId of type Ed25519PeerIdImpl', async () => {
strictEqual(orbitdb1.peerId.type, 'Ed25519') strictEqual(orbitdb1.peerId.constructor.name, 'Ed25519PeerIdImpl')
}) })
it('has a peerId that matches the IPFS id', async () => { it('has a peerId that matches the IPFS id', async () => {

View File

@ -2,7 +2,7 @@ import { strictEqual, notStrictEqual } from 'assert'
import { rimraf } from 'rimraf' import { rimraf } from 'rimraf'
import { copy } from 'fs-extra' import { copy } from 'fs-extra'
import { Log, Identities, KeyStore } from '../src/index.js' import { Log, Identities, KeyStore } from '../src/index.js'
import { IPFSBlockStorage, MemoryStorage, LRUStorage, ComposedStorage, LevelStorage } from '../src/storage/index.js' import { IPFSBlockStorage, MemoryStorage, LRUStorage, ComposedStorage } from '../src/storage/index.js'
import testKeysPath from './fixtures/test-keys-path.js' import testKeysPath from './fixtures/test-keys-path.js'
import createHelia from './utils/create-helia.js' import createHelia from './utils/create-helia.js'
@ -33,7 +33,6 @@ describe('Storages', function () {
await keystore.close() await keystore.close()
} }
await rimraf('./level')
await rimraf('./ipfs1') await rimraf('./ipfs1')
await rimraf(keysPath) await rimraf(keysPath)
}) })
@ -42,56 +41,26 @@ describe('Storages', function () {
const amount = 100 const amount = 100
const log1 = await Log(testIdentity, { logId: 'A', entryStorage: storage }) const log1 = await Log(testIdentity, { logId: 'A', entryStorage: storage })
const log2 = await Log(testIdentity, { logId: 'A', entryStorage: storage }) const log2 = await Log(testIdentity, { logId: 'A', entryStorage: storage })
for (let i = 0; i < amount; i++) { for (let i = 0; i < amount; i++) {
await log1.append('hello' + i) await log1.append('hello' + i)
await log2.append('hello' + i) await log2.append('hello' + i)
} }
const values = await log1.values() const values = await log1.values()
const heads = await log1.heads() const heads = await log1.heads()
strictEqual(heads.length, 1) strictEqual(heads.length, 1)
strictEqual(values.length, amount) strictEqual(values.length, amount)
await log1.storage.clear() await log1.storage.clear()
await log2.storage.clear() await log2.storage.clear()
const result = []
for await (const v of log1.storage.iterator()) {
result.push(v)
}
for await (const v of log2.storage.iterator()) {
result.push(v)
}
strictEqual(result.length, 0)
await log1.storage.close() await log1.storage.close()
await log2.storage.close() await log2.storage.close()
} }
const testInterface = (storage) => {
notStrictEqual(storage.put, undefined)
notStrictEqual(storage.get, undefined)
notStrictEqual(storage.del, undefined)
notStrictEqual(storage.iterator, undefined)
notStrictEqual(storage.merge, undefined)
notStrictEqual(storage.clear, undefined)
notStrictEqual(storage.close, undefined)
}
describe('LRUStorage', () => { describe('LRUStorage', () => {
it('tests the storage', async () => { it('tests the storage', async () => {
const storage = await LRUStorage() const storage = await LRUStorage()
notStrictEqual(storage, undefined) notStrictEqual(storage, undefined)
await runTestWithStorage(storage) await runTestWithStorage(storage)
}) })
it('has correct interface', async () => {
const storage = await LRUStorage()
testInterface(storage)
})
}) })
describe('MemoryStorage', () => { describe('MemoryStorage', () => {
@ -100,11 +69,6 @@ describe('Storages', function () {
notStrictEqual(storage, undefined) notStrictEqual(storage, undefined)
await runTestWithStorage(storage) await runTestWithStorage(storage)
}) })
it('has correct interface', async () => {
const storage = await MemoryStorage()
testInterface(storage)
})
}) })
describe('IPFSBlockStorage', () => { describe('IPFSBlockStorage', () => {
@ -113,27 +77,9 @@ describe('Storages', function () {
notStrictEqual(storage, undefined) notStrictEqual(storage, undefined)
await runTestWithStorage(storage) await runTestWithStorage(storage)
}) })
it('has correct interface', async () => {
const storage = await IPFSBlockStorage({ ipfs })
testInterface(storage)
})
}) })
describe('LevelStorage', () => { describe('Composed Storages', () => {
it('tests the storage', async () => {
const storage = await LevelStorage()
notStrictEqual(storage, undefined)
await runTestWithStorage(storage)
})
it('has correct interface', async () => {
const storage = await LevelStorage()
testInterface(storage)
})
})
describe('Composed Storage', () => {
it('tests Memory + IPFSBlockStorage composition', async () => { it('tests Memory + IPFSBlockStorage composition', async () => {
const storage1 = await MemoryStorage() const storage1 = await MemoryStorage()
const storage2 = await IPFSBlockStorage({ ipfs }) const storage2 = await IPFSBlockStorage({ ipfs })
@ -142,14 +88,6 @@ describe('Storages', function () {
await runTestWithStorage(storage) await runTestWithStorage(storage)
}) })
it('tests Memory + LevelStorage composition', async () => {
const storage1 = await MemoryStorage()
const storage2 = await LevelStorage()
const storage = await ComposedStorage(storage1, storage2)
notStrictEqual(storage, undefined)
await runTestWithStorage(storage)
})
it('tests LRU + IPFSBlockStorage composition', async () => { it('tests LRU + IPFSBlockStorage composition', async () => {
const storage1 = await LRUStorage({ size: -1 }) const storage1 = await LRUStorage({ size: -1 })
const storage2 = await IPFSBlockStorage({ ipfs }) const storage2 = await IPFSBlockStorage({ ipfs })
@ -173,12 +111,5 @@ describe('Storages', function () {
notStrictEqual(storage, undefined) notStrictEqual(storage, undefined)
await runTestWithStorage(storage) await runTestWithStorage(storage)
}) })
it('has correct interface', async () => {
const storage1 = await LRUStorage()
const storage2 = await MemoryStorage()
const storage = await ComposedStorage(storage1, storage2)
testInterface(storage)
})
}) })
}) })

View File

@ -25,28 +25,14 @@ describe('IPFSBlockStorage', function () {
}) })
it('gets a block', async () => { it('gets a block', async () => {
const expected = 'hello world'
const { cid, bytes } = await Block.encode({ value: expected, codec, hasher })
const hash = cid.toString(base58btc)
await storage.put(hash, bytes)
const data = await storage.get(hash)
const block = await Block.decode({ bytes: data, codec, hasher })
const actual = block.value
strictEqual(actual, expected)
})
it('checks that a block is pinned', async () => {
const expected = 'hello world' const expected = 'hello world'
const block = await Block.encode({ value: expected, codec, hasher }) const block = await Block.encode({ value: expected, codec, hasher })
const cid = block.cid.toString(base58btc) const cid = block.cid.toString(base58btc)
await storage.put(cid, block.bytes) await storage.put(cid, 'hello world')
const actual = await storage.get(cid)
strictEqual(await ipfs.pins.isPinned(block.cid), true) strictEqual(actual, expected)
}) })
it('throws an error if a block does not exist', async () => { it('throws an error if a block does not exist', async () => {

View File

@ -139,7 +139,8 @@ describe('Sync protocol', function () {
log1 = await Log(testIdentity1, { logId: 'synclog111', entryStorage: entryStorage1 }) log1 = await Log(testIdentity1, { logId: 'synclog111', entryStorage: entryStorage1 })
log2 = await Log(testIdentity2, { logId: 'synclog111', entryStorage: entryStorage2 }) log2 = await Log(testIdentity2, { logId: 'synclog111', entryStorage: entryStorage2 })
const onSynced = async (entry) => { const onSynced = async (bytes) => {
const entry = await Entry.decode(bytes)
if (await log2.joinEntry(entry)) { if (await log2.joinEntry(entry)) {
syncedHead = entry syncedHead = entry
syncedEventFired = true syncedEventFired = true
@ -206,7 +207,8 @@ describe('Sync protocol', function () {
log1 = await Log(testIdentity1, { logId: 'synclog7', entryStorage: entryStorage1 }) log1 = await Log(testIdentity1, { logId: 'synclog7', entryStorage: entryStorage1 })
log2 = await Log(testIdentity2, { logId: 'synclog7', entryStorage: entryStorage2 }) log2 = await Log(testIdentity2, { logId: 'synclog7', entryStorage: entryStorage2 })
const onSynced = async (entry) => { const onSynced = async (bytes) => {
const entry = await Entry.decode(bytes)
if (await log2.joinEntry(entry)) { if (await log2.joinEntry(entry)) {
syncedHead = entry syncedHead = entry
} }
@ -289,8 +291,8 @@ describe('Sync protocol', function () {
log1 = await Log(testIdentity1, { logId: 'synclog1' }) log1 = await Log(testIdentity1, { logId: 'synclog1' })
log2 = await Log(testIdentity2, { logId: 'synclog1' }) log2 = await Log(testIdentity2, { logId: 'synclog1' })
const onSynced = async (entry) => { const onSynced = async (bytes) => {
syncedHead = entry syncedHead = await Entry.decode(bytes)
syncedEventFired = expectedEntry.hash === syncedHead.hash syncedEventFired = expectedEntry.hash === syncedHead.hash
} }
@ -346,8 +348,8 @@ describe('Sync protocol', function () {
log1 = await Log(testIdentity1, { logId: 'synclog1' }) log1 = await Log(testIdentity1, { logId: 'synclog1' })
log2 = await Log(testIdentity2, { logId: 'synclog1' }) log2 = await Log(testIdentity2, { logId: 'synclog1' })
const onSynced = async (entry) => { const onSynced = async (bytes) => {
syncedHead = entry syncedHead = await Entry.decode(bytes)
if (expectedEntry) { if (expectedEntry) {
syncedEventFired = expectedEntry.hash === syncedHead.hash syncedEventFired = expectedEntry.hash === syncedHead.hash
} }
@ -432,9 +434,9 @@ describe('Sync protocol', function () {
log1 = await Log(testIdentity1, { logId: 'synclog1' }) log1 = await Log(testIdentity1, { logId: 'synclog1' })
log2 = await Log(testIdentity2, { logId: 'synclog1' }) log2 = await Log(testIdentity2, { logId: 'synclog1' })
const onSynced = async (entry) => { const onSynced = async (bytes) => {
if (expectedEntry && !syncedEventFired) { if (expectedEntry && !syncedEventFired) {
syncedHead = entry syncedHead = await Entry.decode(bytes)
syncedEventFired = expectedEntry.hash === syncedHead.hash syncedEventFired = expectedEntry.hash === syncedHead.hash
} }
} }
@ -516,8 +518,8 @@ describe('Sync protocol', function () {
log1 = await Log(testIdentity1, { logId: 'synclog2' }) log1 = await Log(testIdentity1, { logId: 'synclog2' })
log2 = await Log(testIdentity2, { logId: 'synclog2' }) log2 = await Log(testIdentity2, { logId: 'synclog2' })
const onSynced = async (entry) => { const onSynced = async (bytes) => {
syncedHead = entry syncedHead = await Entry.decode(bytes)
if (expectedEntry) { if (expectedEntry) {
syncedEventFired = expectedEntry ? expectedEntry.hash === syncedHead.hash : false syncedEventFired = expectedEntry ? expectedEntry.hash === syncedHead.hash : false
} }
@ -663,7 +665,7 @@ describe('Sync protocol', function () {
let sync1, sync2 let sync1, sync2
let log1, log2 let log1, log2
const timeoutTime = 0 // 0 milliseconds const timeoutTime = 1 // 1 millisecond
before(async () => { before(async () => {
[ipfs1, ipfs2] = await Promise.all([createHelia(), createHelia()]) [ipfs1, ipfs2] = await Promise.all([createHelia(), createHelia()])
@ -699,13 +701,13 @@ describe('Sync protocol', function () {
let err = null let err = null
const onError = (error) => { const onError = (error) => {
err ??= error (!err) && (err = error)
} }
sync1 = await Sync({ ipfs: ipfs1, log: log1, timeout: timeoutTime }) sync1 = await Sync({ ipfs: ipfs1, log: log1, timeout: timeoutTime })
sync1.events.on('error', onError)
sync2 = await Sync({ ipfs: ipfs2, log: log2, start: false, timeout: timeoutTime }) sync2 = await Sync({ ipfs: ipfs2, log: log2, start: false, timeout: timeoutTime })
sync1.events.on('error', onError)
sync2.events.on('error', onError) sync2.events.on('error', onError)
await log1.append('hello1') await log1.append('hello1')
@ -716,7 +718,7 @@ describe('Sync protocol', function () {
notStrictEqual(err, null) notStrictEqual(err, null)
strictEqual(err.type, 'aborted') strictEqual(err.type, 'aborted')
strictEqual(err.message.includes('aborted'), true) strictEqual(err.message, 'Read aborted')
}) })
}) })
}) })

View File

@ -21,16 +21,20 @@ const Libp2pOptions = {
transports: [ transports: [
webSockets({ webSockets({
filter: all filter: all
}),
webRTC(),
circuitRelayTransport({
discoverRelays: 1
}) })
], ],
connectionEncrypters: [noise()], connectionEncryption: [noise()],
streamMuxers: [yamux()], streamMuxers: [yamux()],
connectionGater: { connectionGater: {
denyDialMultiaddr: () => false denyDialMultiaddr: () => false
}, },
services: { services: {
identify: identify(), identify: identify(),
pubsub: gossipsub({ allowPublishToZeroTopicPeers: true }) pubsub: gossipsub({ allowPublishToZeroPeers: true })
} }
} }
@ -39,23 +43,25 @@ const Libp2pOptions = {
*/ */
const Libp2pBrowserOptions = { const Libp2pBrowserOptions = {
addresses: { addresses: {
listen: ['/webrtc', '/p2p-circuit'] listen: ['/webrtc']
}, },
transports: [ transports: [
webSockets({ webSockets({
filter: all filter: all
}), }),
webRTC(), webRTC(),
circuitRelayTransport() circuitRelayTransport({
discoverRelays: 1
})
], ],
connectionEncrypters: [noise()], connectionEncryption: [noise()],
streamMuxers: [yamux()], streamMuxers: [yamux()],
connectionGater: { connectionGater: {
denyDialMultiaddr: () => false denyDialMultiaddr: () => false
}, },
services: { services: {
identify: identify(), identify: identify(),
pubsub: gossipsub({ allowPublishToZeroTopicPeers: true }) pubsub: gossipsub({ allowPublishToZeroPeers: true })
} }
} }

View File

@ -5,18 +5,21 @@ import { circuitRelayServer } from '@libp2p/circuit-relay-v2'
import { webSockets } from '@libp2p/websockets' import { webSockets } from '@libp2p/websockets'
import * as filters from '@libp2p/websockets/filters' import * as filters from '@libp2p/websockets/filters'
import { identify } from '@libp2p/identify' import { identify } from '@libp2p/identify'
import { createFromPrivKey } from '@libp2p/peer-id-factory'
import { unmarshalPrivateKey } from '@libp2p/crypto/keys'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string' import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
import { privateKeyFromProtobuf } from '@libp2p/crypto/keys'
// output of: console.log(server.peerId.privateKey.toString('hex')) // output of: console.log(server.peerId.privateKey.toString('hex'))
const relayPrivKey = '08011240821cb6bc3d4547fcccb513e82e4d718089f8a166b23ffcd4a436754b6b0774cf07447d1693cd10ce11ef950d7517bad6e9472b41a927cd17fc3fb23f8c70cd99' const relayPrivKey = '08011240821cb6bc3d4547fcccb513e82e4d718089f8a166b23ffcd4a436754b6b0774cf07447d1693cd10ce11ef950d7517bad6e9472b41a927cd17fc3fb23f8c70cd99'
// the peer id of the above key // the peer id of the above key
// const relayId = '12D3KooWAJjbRkp8FPF5MKgMU53aUTxWkqvDrs4zc1VMbwRwfsbE' // const relayId = '12D3KooWAJjbRkp8FPF5MKgMU53aUTxWkqvDrs4zc1VMbwRwfsbE'
const privateKey = privateKeyFromProtobuf(uint8ArrayFromString(relayPrivKey, 'hex')) const encoded = uint8ArrayFromString(relayPrivKey, 'hex')
const privateKey = await unmarshalPrivateKey(encoded)
const peerId = await createFromPrivKey(privateKey)
const server = await createLibp2p({ const server = await createLibp2p({
privateKey, peerId,
addresses: { addresses: {
listen: ['/ip4/0.0.0.0/tcp/12345/ws'] listen: ['/ip4/0.0.0.0/tcp/12345/ws']
}, },
@ -25,13 +28,14 @@ const server = await createLibp2p({
filter: filters.all filter: filters.all
}) })
], ],
connectionEncrypters: [noise()], connectionEncryption: [noise()],
streamMuxers: [yamux()], streamMuxers: [yamux()],
services: { services: {
identify: identify(), identify: identify(),
relay: circuitRelayServer({ relay: circuitRelayServer({
reservations: { reservations: {
maxReservations: 5000, maxReservations: 5000,
reservationTtl: 1000,
defaultDataLimit: BigInt(1024 * 1024 * 1024) defaultDataLimit: BigInt(1024 * 1024 * 1024)
} }
}) })