IPFS Repo implementation
npm install ipfs-repo



> IPFS Repo implementation
- Install
- Background
- Usage
- API
- Setup
- [createRepo(path[, options])](#createrepopath-options)
- Promise repo.init()
- Promise repo.open()
- Promise repo.close()
- Promise
- Promise
- Repos
- Promise repo.put(key, value:Uint8Array)
- Promise
- Blocks
- Promise
- AsyncIterator
- Promise
- AsyncIterable
- Promise
- Promise
- AsyncIterator
- Promise
- AsyncIterator
- Datastore
- repo.datastore
- Config
- Promise repo.config.set(key:String, value:Object)
- Promise repo.config.replace(value:Object)
- Promise> repo.config.get(key:String)
- Promise
- Promise
- Version
- Promise
- Promise repo.version.set (version:Number)
- API Addr
- Promise
- Promise repo.apiAddr.set(value)
- Status
- Promise
- Lock
- Promise lock.lock(dir)
- Promise closer.close()
- Promise
- Notes
- Migrations
- License
- Contribute
``console`
$ npm i ipfs-repo
This is the implementation of the IPFS repo spec in JavaScript.
Here is the architectural reasoning for this repo:
`bash
┌────────────────────────────────────────┐
│ IPFSRepo │
└────────────────────────────────────────┘
┌─────────────────┐
│ / │
├─────────────────┤
│ Datastore │
└─────────────────┘
┌───────────┴───────────┐
┌─────────────────┐ ┌─────────────────┐
│ /blocks │ │ /datastore │
├─────────────────┤ ├─────────────────┤
│ Datastore │ │ LevelDatastore │
└─────────────────┘ └─────────────────┘
┌────────────────────────────────────────┐ ┌────────────────────────────────────────┐
│ IPFSRepo - Default Node.js │ │ IPFSRepo - Default Browser │
└────────────────────────────────────────┘ └────────────────────────────────────────┘
┌─────────────────┐ ┌─────────────────┐
│ / │ │ / │
├─────────────────┤ ├─────────────────┤
│ FsDatastore │ │ IdbDatastore │
└─────────────────┘ └─────────────────┘
┌───────────┴───────────┐ ┌───────────┴───────────┐
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ /blocks │ │ /datastore │ │ /blocks │ │ /datastore │
├─────────────────┤ ├─────────────────┤ ├─────────────────┤ ├─────────────────┤
│ FlatfsDatastore │ │LevelDBDatastore │ │ IdbDatastore │ │ IdbDatastore │
└─────────────────┘ └─────────────────┘ └─────────────────┘ └─────────────────┘
`
This provides a well defined interface for creating and interacting with an IPFS repo.
`sh`
> npm install ipfs-repo
`js`
import { createRepo } from 'ipfs-repo'
Example:
`js
import { createRepo } from 'ipfs-repo'
const repo = createRepo('/tmp/ipfs-repo')
await repo.init({ cool: 'config' })
await repo.open()
console.log('repo is ready')
`
This now has created the following structure, either on disk or as an in memory representation:
├── blocks
│ ├── SHARDING
│ └── _README
├── config
├── datastore
├── keys
└── version
#### createRepo(path[, options])
Creates an IPFS Repo.
Arguments:
- path (string, mandatory): the path for this repooptions
- (object, optional): may contain the following valuesautoMigrate
- (bool, defaults to true): controls automatic migrations of repository.onMigrationProgress
- (function(version, percentComplete, message)): callback function to be notified of migration progresslock
- (Lock or string Deprecated): what type of lock to use. Lock has to be acquired when opening. string can be "fs" or "memory".storageBackends
- (object, optional): may contain the following values, which should each be a class implementing the datastore interface:root
- (defaults to datastore-fs in Node.js and datastore-level in the browser). Defines the back-end type used for gets and puts of values at the root (repo.set(), repo.get())blocks
- (defaults to datastore-fs in Node.js and datastore-level in the browser). Defines the back-end type used for gets and puts of values at repo.blocks.keys
- (defaults to datastore-fs in Node.js and datastore-level in the browser). Defines the back-end type used for gets and puts of encrypted keys at repo.keysdatastore
- (defaults to datastore-level). Defines the back-end type used as the key-value store used for gets and puts of values at repo.datastore.
`js`
const repo = createRepo('path/to/repo')
#### Promise repo.init()
Creates the necessary folder structure inside the repo
#### Promise repo.open()
Locks the repo to prevent conflicts arising from simultaneous access
#### Promise repo.close()
Unlocks the repo.
#### Promise
Tells whether this repo exists or not. Returned promise resolves to a boolean
#### Promise
The returned promise resolves to false if the repo has not been initialized and true if it has
Root repo:
#### Promise repo.put(key, value:Uint8Array)
Put a value at the root of the repo
- key can be a Uint8Array, a string or a [Key][]
#### Promise
Get a value at the root of the repo
- key can be a Uint8Array, a string or a [Key][]
#### Promise
- block should be of type [Block][]
#### AsyncIterator
Put many blocks.
- source should be an AsyncIterable that yields entries of type [Block][]
#### Promise
Get block.
- cid is the content id of type [CID][]
#### AsyncIterable
Get many blocks
- source should be an AsyncIterable that yields entries of type [CID][]
#### Promise
Indicate if a block is present for the passed CID
- cid should be of the type [CID][]
#### Promise
Deletes a block
- cid should be of the type [CID][]
#### AsyncIterator
Query what blocks are available in blockstore.
If query.keysOnly is true, the returned iterator will yield [CID][]s, otherwise it will yield [Block][]s
- query is a object as specified in interface-datastore.
Datastore:
#### Promise
- cid should be of the type [CID][]
Delete a block
#### AsyncIterator
- source should be an Iterable or AsyncIterable that yields entries of the type [CID][]
Delete many blocks
#### repo.datastore
This contains a full implementation of the interface-datastore API.
Instead of using repo.set('config') this exposes an API that allows you to set and get a decoded config object, as well as, in a safe manner, change any of the config values individually.
#### Promise repo.config.set(key:String, value:Object)
Set a config value. value can be any object that is serializable to JSON.
- key is a string specifying the object path. Example:
`js`
await repo.config.set('a.b.c', 'c value')
const config = await repo.config.get()
assert.equal(config.a.b.c, 'c value')
#### Promise repo.config.replace(value:Object)
Set the whole config value. value can be any object that is serializable to JSON.
#### Promise> repo.config.get(key:String)
Get a config value. Returned promise resolves to the same type that was set before.
- key is a string specifying the object path. Example:
`js`
const value = await repo.config.get('a.b.c')
console.log('config.a.b.c = ', value)
#### Promise
Get the entire config value.
#### Promise
Whether the config sub-repo exists.
#### Promise
Gets the repo version (an integer).
#### Promise repo.version.set (version:Number)
Sets the repo version
#### Promise
Gets the API address.
#### Promise repo.apiAddr.set(value)
Sets the API address.
- value should be a [Multiaddr][] or a String representing a valid one.
#### Promise
Gets the repo status.
Returned promise resolves to an Object with the following keys:
- numObjectsrepoPath
- repoSize
- version
- storageMax
-
IPFS Repo comes with two built in locks: memory and fs. These can be imported via the following:
`js`
import { FSLock } from 'ipfs-repo/locks/fs' // Default in Node.js
import { MemoryLock } from 'ipfs-repo/locks/memory' // Default in browser
You can also provide your own custom Lock. It must be an object with the following interface:
#### Promise lock.lock(dir)
Sets the lock if one does not already exist. If a lock already exists, should throw an error.
dir is a string to the directory the lock should be created at. The repo typically creates the lock at its root.
Returns closer, where closer has a close method for removing the lock.
#### Promise closer.close()
Closes the lock created by lock.open
If no error was thrown, the lock was successfully removed.
#### Promise
Checks the existence of the lock.
dir is the path to the directory to check for the lock. The repo typically checks for the lock at its root.
Returned promise resolves to a boolean indicating the existence of the lock.
- Explanation of how repo is structured
When there is a new repo migration and the version of the repo is increased, don't
forget to propagate the changes into the test repo (test/test-repo`).
**For tools that run mainly in the browser environment, be aware that disabling automatic
migrations leaves the user with no way to run the migrations because there is no CLI in the browser. In such
a case, you should provide a way to trigger migrations manually.**

Licensed under either of
- Apache 2.0, (LICENSE-APACHE /
- MIT (LICENSE-MIT /
Contributions welcome! Please check out the issues.
Also see our contributing document for more information on how we work, and about contributing in general.
Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[CID]: https://github.com/multiformats/js-cid
[Key]: https://github.com/ipfs/interface-datastore#keys
[Block]: https://github.com/ipld/js-ipld-block
[Multiaddr]: https://github.com/multiformats/js-multiaddr