# mimostore

> Custom identity store for Mimo on OrbitDB

Latest version **0.1.0** (published 2019-01-01) · MIT license · 1 weekly downloads

## Install

```sh
npm install mimostore
pnpm add mimostore
yarn add mimostore
bun add mimostore
```

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score; declining downloads.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2019-01-01 |
| First published | 2019-01-01 |
| Weekly downloads | 1 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ghilia Weldesselasie |
| Maintainers | ghiliweld |
| Keywords | identity, web3, p2p, peer-to-peer, decentralized, database |

## Links

- npm: https://www.npmjs.com/package/mimostore
- Repository: https://github.com/ethmimo/mimo-orbit
- Homepage: https://github.com/ethmimo/mimo-orbit#readme
- Issues: https://github.com/ethmimo/mimo-orbit/issues
- npm.io page: https://npm.io/package/mimostore

## Dependencies (2)

- [eth-crypto](https://npm.io/package/eth-crypto.md) ^1.2.3
- [orbit-db-kvstore](https://npm.io/package/orbit-db-kvstore.md) ^1.4.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2019-01-01
- 0.0.2 — 2019-01-01

## README

# mimo-orbit
Custom identity store on OrbitDB

An key-value store refactored to accept digital signatures. Add new claims about your identity to the DB. It uses digital signatures to ensure that all data added to the DB has been approved by the owner of the identity.

## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [License](#license)

## Install
```
npm install mimostore
```

## Usage

First, create an instance of OrbitDB and Web3:

```javascript
const IPFS = require('ipfs')
const OrbitDB = require('orbit-db')
const MimoStore = require('mimostore')

const ipfs = new IPFS()

// add MimoStore to orbitdb
OrbitDB.addDatabaseType(MimoStore.type, MimoStore)

// instantiate MimoStore
const orbitdb = new OrbitDB(ipfs)
const mimostore = orbitdb.create('mimo', MimoStore.type, {
  write: ['*']
})
```

Add a claim to it, if the signature of the data is a valid one then the data will be added successfully:

```javascript
await store.put({ id: '0x_id', bio: 'I <3 Mimo' }, '<signature>')
```

Later, when the database contains data, query whenever:

```javascript
await store.get('0x_id')
```

## API

See the commented code in the [codebase](src/MimoStore.js)

## License

[MIT](LICENSE) © 2018 Ghilia Weldesselasie

---
_Source: https://npm.io/package/mimostore · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._