mirror of
https://github.com/orbitdb/orbitdb.git
synced 2025-03-30 15:08:28 +00:00
60fbe47ee3
* fix: Load correct main. * docs: Enable markdown. * docs: Add jsdoc blocks. * docs: Separate orbitdb into module and namespace. * docs: Database module and namespace. * docs: Default values for storage. * docs: Match param naming across modules. * docs: Use @link where possible. * docs: Use @example for code. * docs: KeyStore module and namespace documentation. * docs: API for Access controller management. * docs: Document Database events. * docs: Formatting. * docs: Notes on Custom AC and including a canAppend function. * docs: Standardize primitive data types. * docs: Proposed submodule structure. * docs: Composed storage. How to create custom storage. * docs: annotations for all storage modules. * docs: Documents. * docs: KeyValueIndexed. * docs: Provide example for specifying storage for keyvalue. * docs: KeyValue. * docs: Remove const documentation where not required. * docs: KeyStore static functions. * docs: Identities. * docs: Identity. * refactor: Remove unused param. * docs: Address. * docs: Address. * docs: Manifest. * docs: IPFSAccessController. * docs: OrbitDBAccessController. * docs: Utils. * test: check for correct message.
265 lines
8.0 KiB
JavaScript
265 lines
8.0 KiB
JavaScript
import { strictEqual, notStrictEqual } from 'assert'
|
|
import rmrf from 'rimraf'
|
|
import fs from 'fs'
|
|
import path from 'path'
|
|
import * as IPFS from 'ipfs-core'
|
|
import { OrbitDB, isIdentity } from '../src/index.js'
|
|
import config from './config.js'
|
|
import connectPeers from './utils/connect-nodes.js'
|
|
|
|
const isBrowser = () => typeof window !== 'undefined'
|
|
|
|
describe('OrbitDB', function () {
|
|
this.timeout(5000)
|
|
|
|
let ipfs1, ipfs2
|
|
let orbitdb1
|
|
|
|
before(async () => {
|
|
ipfs1 = await IPFS.create({ ...config.daemon1, repo: './ipfs1' })
|
|
ipfs2 = await IPFS.create({ ...config.daemon2, repo: './ipfs2' })
|
|
await connectPeers(ipfs1, ipfs2)
|
|
})
|
|
|
|
after(async () => {
|
|
if (ipfs1) {
|
|
await ipfs1.stop()
|
|
}
|
|
if (ipfs2) {
|
|
await ipfs2.stop()
|
|
}
|
|
await rmrf('./ipfs1')
|
|
await rmrf('./ipfs2')
|
|
})
|
|
|
|
describe('OrbitDB instance creation - defaults', () => {
|
|
before(async () => {
|
|
await rmrf('./orbitdb')
|
|
orbitdb1 = await OrbitDB({ ipfs: ipfs1 })
|
|
})
|
|
|
|
after(async () => {
|
|
if (orbitdb1) {
|
|
await orbitdb1.stop()
|
|
}
|
|
await rmrf('./orbitdb')
|
|
})
|
|
|
|
it('has an IPFS instance', async () => {
|
|
notStrictEqual(orbitdb1.ipfs, undefined)
|
|
strictEqual(typeof orbitdb1.ipfs, 'object')
|
|
})
|
|
|
|
it('has the IPFS instance given as a parameter', async () => {
|
|
const { id: expectedId } = await ipfs1.id()
|
|
const { id: resultId } = await orbitdb1.ipfs.id()
|
|
strictEqual(expectedId, resultId)
|
|
})
|
|
|
|
it('has a directory', async () => {
|
|
notStrictEqual(orbitdb1.directory, undefined)
|
|
strictEqual(typeof orbitdb1.directory, 'string')
|
|
})
|
|
|
|
it('has the directory given as a parameter', async () => {
|
|
strictEqual(orbitdb1.directory, './orbitdb')
|
|
})
|
|
|
|
it('has a keystore', async () => {
|
|
notStrictEqual(orbitdb1.keystore, undefined)
|
|
strictEqual(typeof orbitdb1.keystore, 'object')
|
|
})
|
|
|
|
it('has a keystore that contains a private key for the created identity', async () => {
|
|
const privateKey = await orbitdb1.keystore.getKey(orbitdb1.identity.id)
|
|
notStrictEqual(privateKey, undefined)
|
|
strictEqual(privateKey.constructor.name, 'Secp256k1PrivateKey')
|
|
notStrictEqual(privateKey._key, undefined)
|
|
notStrictEqual(privateKey._publicKey, undefined)
|
|
})
|
|
|
|
it('has a keystore that contains a public key that matches the identity\'s public key', async () => {
|
|
const privateKey = await orbitdb1.keystore.getKey(orbitdb1.identity.id)
|
|
const publicKey = await orbitdb1.keystore.getPublic(privateKey)
|
|
notStrictEqual(publicKey, undefined)
|
|
strictEqual(typeof publicKey, 'string')
|
|
strictEqual(publicKey, orbitdb1.identity.publicKey)
|
|
})
|
|
|
|
it('creates a directory for the keystore', async () => {
|
|
const directoryExists = fs.existsSync(path.join('./orbitdb/keystore'))
|
|
strictEqual(directoryExists, true)
|
|
})
|
|
|
|
it('has an identity', async () => {
|
|
notStrictEqual(orbitdb1.identity, undefined)
|
|
strictEqual(typeof orbitdb1.identity, 'object')
|
|
})
|
|
|
|
it('creates a valid identity', async () => {
|
|
strictEqual(isIdentity(orbitdb1.identity), true)
|
|
})
|
|
|
|
it('has a peerId', async () => {
|
|
notStrictEqual(orbitdb1.peerId, undefined)
|
|
})
|
|
|
|
it('has a peerId of type Ed25519PeerIdImpl', async () => {
|
|
strictEqual(orbitdb1.peerId.constructor.name, 'Ed25519PeerIdImpl')
|
|
})
|
|
|
|
it('has a peerId that matches the IPFS id', async () => {
|
|
const { id } = await ipfs1.id()
|
|
strictEqual(orbitdb1.peerId, id)
|
|
})
|
|
|
|
it('has an open function', async () => {
|
|
notStrictEqual(orbitdb1.open, undefined)
|
|
strictEqual(typeof orbitdb1.open, 'function')
|
|
})
|
|
|
|
it('has a stop function', async () => {
|
|
notStrictEqual(orbitdb1.stop, undefined)
|
|
strictEqual(typeof orbitdb1.stop, 'function')
|
|
})
|
|
})
|
|
|
|
describe('OrbitDB instance creation - user given parameters', () => {
|
|
before(async () => {
|
|
await rmrf('./orbitdb1')
|
|
orbitdb1 = await OrbitDB({ ipfs: ipfs1, id: 'user1', directory: './orbitdb1' })
|
|
})
|
|
|
|
after(async () => {
|
|
if (orbitdb1) {
|
|
await orbitdb1.stop()
|
|
}
|
|
await rmrf('./orbitdb1')
|
|
})
|
|
|
|
it('has an IPFS instance', async () => {
|
|
notStrictEqual(orbitdb1.ipfs, undefined)
|
|
strictEqual(typeof orbitdb1.ipfs, 'object')
|
|
})
|
|
|
|
it('has the IPFS instance given as a parameter', async () => {
|
|
const { id: expectedId } = await ipfs1.id()
|
|
const { id: resultId } = await orbitdb1.ipfs.id()
|
|
strictEqual(expectedId, resultId)
|
|
})
|
|
|
|
it('has a directory', async () => {
|
|
notStrictEqual(orbitdb1.directory, undefined)
|
|
strictEqual(typeof orbitdb1.directory, 'string')
|
|
})
|
|
|
|
it('has the directory given as a parameter', async () => {
|
|
strictEqual(orbitdb1.directory, './orbitdb1')
|
|
})
|
|
|
|
it('has a keystore', async () => {
|
|
notStrictEqual(orbitdb1.keystore, undefined)
|
|
strictEqual(typeof orbitdb1.keystore, 'object')
|
|
})
|
|
|
|
it('has a keystore that contains a private key for the created identity', async () => {
|
|
const privateKey = await orbitdb1.keystore.getKey(orbitdb1.identity.id)
|
|
notStrictEqual(privateKey, undefined)
|
|
strictEqual(privateKey.constructor.name, 'Secp256k1PrivateKey')
|
|
notStrictEqual(privateKey._key, undefined)
|
|
notStrictEqual(privateKey._publicKey, undefined)
|
|
})
|
|
|
|
it('has a keystore that contains a public key that matches the identity\'s public key', async () => {
|
|
const privateKey = await orbitdb1.keystore.getKey(orbitdb1.identity.id)
|
|
const publicKey = await orbitdb1.keystore.getPublic(privateKey)
|
|
notStrictEqual(publicKey, undefined)
|
|
strictEqual(typeof publicKey, 'string')
|
|
strictEqual(publicKey, orbitdb1.identity.publicKey)
|
|
})
|
|
|
|
it('creates a directory for the keystore', async () => {
|
|
const directoryExists = fs.existsSync(path.join('./orbitdb1/keystore'))
|
|
strictEqual(directoryExists, true)
|
|
})
|
|
|
|
it('has an identity', async () => {
|
|
notStrictEqual(orbitdb1.identity, undefined)
|
|
strictEqual(typeof orbitdb1.identity, 'object')
|
|
})
|
|
|
|
it('creates a valid identity', async () => {
|
|
strictEqual(isIdentity(orbitdb1.identity), true)
|
|
})
|
|
|
|
it('has a peerId', async () => {
|
|
notStrictEqual(orbitdb1.peerId, undefined)
|
|
})
|
|
|
|
it('has a peerId of type Ed25519PeerIdImpl', async () => {
|
|
strictEqual(orbitdb1.peerId.constructor.name, 'Ed25519PeerIdImpl')
|
|
})
|
|
|
|
it('has a peerId that matches the IPFS id', async () => {
|
|
const { id } = await ipfs1.id()
|
|
strictEqual(orbitdb1.peerId, id)
|
|
})
|
|
|
|
it('has an open function', async () => {
|
|
notStrictEqual(orbitdb1.open, undefined)
|
|
strictEqual(typeof orbitdb1.open, 'function')
|
|
})
|
|
|
|
it('has a stop function', async () => {
|
|
notStrictEqual(orbitdb1.stop, undefined)
|
|
strictEqual(typeof orbitdb1.stop, 'function')
|
|
})
|
|
})
|
|
|
|
describe('OrbitDB instance creation - errors', () => {
|
|
after(async () => {
|
|
if (orbitdb1) {
|
|
await orbitdb1.stop()
|
|
}
|
|
})
|
|
|
|
it('throws an error if given an empty parameters object', async () => {
|
|
let err
|
|
try {
|
|
orbitdb1 = await OrbitDB({})
|
|
} catch (e) {
|
|
err = e
|
|
}
|
|
notStrictEqual(err, undefined)
|
|
strictEqual(err.message, 'IPFS instance is a required argument.')
|
|
})
|
|
|
|
it('throws an error if IPFS instance is not given', async () => {
|
|
let err
|
|
try {
|
|
orbitdb1 = await OrbitDB()
|
|
} catch (e) {
|
|
err = e
|
|
}
|
|
notStrictEqual(err, undefined)
|
|
strictEqual(err.message, 'IPFS instance is a required argument.')
|
|
})
|
|
|
|
it('doesn\'t create the data directory when an error occurs', async () => {
|
|
// A bit hacky but 🤷♂️
|
|
if (isBrowser) {
|
|
return
|
|
}
|
|
|
|
try {
|
|
orbitdb1 = await OrbitDB()
|
|
} catch (e) {
|
|
}
|
|
const dataDirectoryExists = fs.existsSync(path.join('./orbitdb'))
|
|
const keysDirectoryExists = fs.existsSync(path.join('./orbitdb/keystore'))
|
|
strictEqual(dataDirectoryExists, false)
|
|
strictEqual(keysDirectoryExists, false)
|
|
})
|
|
})
|
|
})
|