https://github.com/stradivario/gapi-orbitdb
@Gapi OrbitDB Ipfs module
https://github.com/stradivario/gapi-orbitdb
gapi ipfs node orbitdb
Last synced: 4 months ago
JSON representation
@Gapi OrbitDB Ipfs module
- Host: GitHub
- URL: https://github.com/stradivario/gapi-orbitdb
- Owner: Stradivario
- Created: 2018-06-12T16:08:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-08-21T15:59:27.000Z (6 months ago)
- Last Synced: 2025-08-25T13:02:53.913Z (6 months ago)
- Topics: gapi, ipfs, node, orbitdb
- Language: JavaScript
- Homepage:
- Size: 1.21 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @Gapi OrbitDb decentralized database Module (Beta)
##### More information about OrbitDb can be found here [OrbitDb](https://github.com/orbitdb/orbit-db)
##### For questions/issues you can write ticket [here](http://gitlab.youvolio.com/gapi/gapi-orbitdb/issues)
##### This module is intended to be used with [GAPI](https://github.com/Stradivario/gapi)
## Installation and basic examples:
##### To install this Gapi module, run:
```bash
$ npm install @gapi/orbitdb --save
```
## Beta Decentralized module using @rxdi infrastructure
##### To install @orbitdb from ipfs network install globally @rxdi/core `npm i @rxdi/core`
Check it inside ipfs network: [QmWxi1tiVRJfVCTkFD9upaeQoPgG4NzbagxyA1RQCt3X3P](http://ipfs.io/ipfs/QmWxi1tiVRJfVCTkFD9upaeQoPgG4NzbagxyA1RQCt3X3P)
```bash
$ rxdi i QmWxi1tiVRJfVCTkFD9upaeQoPgG4NzbagxyA1RQCt3X3P
```
Important:
- Decentralized module includes property packages: [] if it depends on some "centralized" source
- rxdi install will trigger npm install after finish if there are any packages: [] inside array so you don't have to install
- In this case we will install @gapi/ipfs@1.2.55 and orbit-db@0.19.8 since it is the working version nothing less nothing more! ;)
- Later @gapi/ipfs will be also decentralized module and will be added as a dependency like [@rxdi/core](http://ipfs.io/ipfs/QmP9n7m1UWkFn2hqt7mnfQYnBtxmFyyvKZHN7hgngQb1gM)
```json
{
"name": "@gapi/orbitdb",
"version":"1.4.8",
"typings": "QmVXzhhjQCoNZJLwYWwtxLYtAC1x1No8yrZcE9d3unaXnQ",
"module": "QmUEqSRJvn44ThooeizVT8Tp7moW188hX4sBDgV3hN2khc",
"dependencies": [
"QmP9n7m1UWkFn2hqt7mnfQYnBtxmFyyvKZHN7hgngQb1gM"
],
"packages": [
{
"name": "orbit-db",
"version": "0.19.8"
},
{
"name": "@gapi/ipfs",
"version": "1.4.7"
}
]
}
```
## Consuming @gapi/orbitdb
Important: if you install from decentralized source via `rxdi i` command you don't need to install @gapi/ipfs module!
##### To work everything as expected we need to install [@gapi/ipfs](https://github.com/Stradivario/gapi-ipfs) module because OrbitDB is working with ipfs protocol to install it type:
```bash
npm i @gapi/ipfs
```
##### Important part is that Ipfs module should be resolved before OrbitDb module to work properly
##### Then import your module above OrbitDbModule the following way:
##### Import inside AppModule or CoreModule
```typescript
import { Module } from '@rxdi/core';
import { IpfsModule } from '@gapi/ipfs';
import { OrbitDbModule } from '@gapi/orbitdb';
@Module({
imports: [
IpfsModule.forRoot({
start: true,
config: {
Addresses: {
API: '/ip4/127.0.0.1/tcp/5002',
Announce: [],
Gateway: '/ip4/127.0.0.1/tcp/8081',
NoAnnounce: [],
Swarm: [
'/ip4/0.0.0.0/tcp/4002',
'/ip6/::/tcp/4002'
]
},
},
logging: true,
}),
OrbitDbModule
]
})
export class CoreModule { }
```
##### Interact with orbitdb
note: keep in mind that this is beta testing and contribution is appreciated ! :)
```typescript
import { Inject, Service } from '@rxdi/core';
import { IPFS_NODE_READY } from '@gapi/ipfs';
import { OrbitDb } from '@gapi/orbitdb';
import { Subject } from 'rxjs/Subject';
import { Observable } from 'rxjs/Observable';
export class User {
id: number;
name: string;
email: string;
};
@Service()
export class OrbitService {
constructor(
@Inject(OrbitDb) private orbitdb: OrbitDb,
) {}
async orbitTest() {
const db = await this.orbitdb.log('hello');
await db.load();
// Listen for updates from peers
db.events.on('replicated', (address) => {
console.log(db.iterator({ limit: -1 }).collect());
});
// Add an entry
const hash = await db.add({ id: 1, name: 'Kristiyan Tachev', email: 'kristiqn.tachev@gmail.com' });
console.log(hash);
// Query
const result = db.iterator({ limit: -1 }).collect();
console.log(result[result.length - 1].payload.value.id);
// 1
console.log(result[result.length - 1].payload.value.name);
// Kristiyan Tachev
console.log(result[result.length - 1].payload.value.email);
// kristiqn.tachev@gmail.com
return await Promise.resolve();
}
}
```
Or you can do more if you inject database as a Service
```typescript
import { Module } from '@rxdi/core';
import { IpfsModule } from '@gapi/ipfs';
import { OrbitDbModule } from '@gapi/orbitdb';
import { OrbitDb } from '@gapi/orbitdb';
interface User {
id: string;
}
@Module({
imports: [
IpfsModule.forRoot({
start: true,
config: {
Addresses: {
API: '/ip4/127.0.0.1/tcp/5002',
Announce: [],
Gateway: '/ip4/127.0.0.1/tcp/8081',
NoAnnounce: [],
Swarm: [
'/ip4/0.0.0.0/tcp/4002',
'/ip6/::/tcp/4002'
]
},
},
logging: true,
}),
OrbitDbModule
],
services: [
{
provide: 'hello',
deps: [OrbitDb],
useFactory: async (orbitdb: OrbitDb) => await (await orbitdb.log('hello')).load()
}
]
})
export class CoreModule { }
```
Then inject database inside whole application the following way:
```typescript
import { Service, Inject } from '@rxdi/core';
import { OrbitDb } from '@gapi/orbitdb';
interface User {
id: string;
}
@Service()
export class OrbitService {
constructor(
@Inject('hello') private helloDB: OrbitLogDatabaseInstance,
) {}
}
```
TODO: Better documentation...
Enjoy ! :)