fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-04-24 21:42:21 +00:00
Code Issues Projects Releases Wiki Activity

update name

Browse Source
This commit is contained in:
David Dias 2015-12-11 20:27:55 -08:00
parent 4a9eabb293
commit 894bb69f18
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,11 +1,11 @@
abstract-record-store
interface-record-store
=====================
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
> A test suite and interface you can use to implement a a IPRS compliant(https://github.com/ipfs/specs/tree/master/records) Record Store.
The primary goal of this module is to enable developers to pick and swap their Record Store module as they see fit for their libp2p installation, without having to go through shims or compatibility issues. This module and test suite were heavily inspired by [`abstract-blob-store`](https://github.com/maxogden/abstract-blob-store) and [`abstract-stream-muxer`](https://github.com/diasdavid/abstract-stream-muxer).
The primary goal of this module is to enable developers to pick and swap their Record Store module as they see fit for their libp2p installation, without having to go through shims or compatibility issues. This module and test suite were heavily inspired by [`abstract-blob-store`](https://github.com/maxogden/abstract-blob-store) and [`interface-stream-muxer`](https://github.com/diasdavid/interface-stream-muxer).
Publishing a test suite as a module lets multiple modules all ensure compatibility since they use the same test suite.
@ -18,9 +18,9 @@ The API is presented with both Node.js and Go primitives, however, there is not
# Badge
Include this badge in your readme if you make a module that is compatible with the abstract-record-store API. You can validate this by running the tests.
Include this badge in your readme if you make a module that is compatible with the interface-record-store API. You can validate this by running the tests.
![](https://raw.githubusercontent.com/diasdavid/abstract-record-store/master/img/badge.png)
![](https://raw.githubusercontent.com/diasdavid/interface-record-store/master/img/badge.png)
# How to use the battery of tests
@ -28,7 +28,7 @@ Include this badge in your readme if you make a module that is compatible with t
```
var tape = require('tape')
var tests = require('abstract-record-store/tests')
var tests = require('interface-record-store/tests')
var YourRecordStore = require('../src')
var common = {
@ -74,7 +74,7 @@ if `err` is passed, means that the record wasn't stored properly or it was unval
- the key is a multihash but not necessarily the hash of the record signature object.
- a DRS instance must have a mapping of key->[hash(recordSignature)] to know which records belong to a given key (provided value)
- DRS implements the abstract-record-store interface
- DRS may levarage other implementations of abstract-record-store to find records in the network or other storage mechanisms
- DRS implements the interface-record-store interface
- DRS may levarage other implementations of interface-record-store to find records in the network or other storage mechanisms
- DRS should return every valid record it can find in a query
- all unvalid records detected in the process should be discarded/deleted

8
package.json
View File

@ -1,5 +1,5 @@
{
"name": "abstract-record-store",
"name": "interface-record-store",
"version": "0.1.1",
"description": "A test suite and interface you can use to implement a a IPRS compliant(https://github.com/ipfs/specs/tree/master/records) Record Store",
"scripts": {
@ -7,7 +7,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/diasdavid/abstract-record-store.git"
"url": "https://github.com/diasdavid/interface-record-store.git"
},
"keywords": [
"IPFS"
@ -18,9 +18,9 @@
"author": "David Dias <daviddias@ipfs.io>",
"license": "MIT",
"bugs": {
"url": "https://github.com/diasdavid/abstract-record-store/issues"
"url": "https://github.com/diasdavid/interface-record-store/issues"
},
"homepage": "https://github.com/diasdavid/abstract-record-store",
"homepage": "https://github.com/diasdavid/interface-record-store",
"dependencies": {
"ecdsa": "^0.6.0",
"ipld": "^0.2.0",