This repository has been archived by the owner. It is now read-only.
JavaScript IPFS record class implementation
Switch branches/tags
Nothing to show
Clone or download
victorb and daviddias Updating CI files (#31)
This commit updates all CI scripts to the latest version
Latest commit e559439 Mar 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci Updating CI files (#31) Mar 19, 2018
src refactor: use aegir Apr 15, 2016
test refactor: use aegir Apr 15, 2016
.gitignore refactor: use aegir Apr 15, 2016
.npmignore refactor: use aegir Apr 15, 2016
.travis.yml Updating CI files (#31) Mar 19, 2018
LICENSE Initial commit Jul 23, 2015
README.md Fix broken links to IPRS spec Mar 10, 2017
appveyor.yml Updating CI files (#31) Mar 19, 2018
circle.yml Updating CI files (#31) Mar 19, 2018
package.json Merge pull request #28 from libp2p/greenkeeper-aegir-11.0.2 Feb 5, 2018

README.md

iprs-record JavaScript implementation

[ Build Status](https://travis-ci.org/diasdavid/js-iprs-record) Dependency Status js-standard-style

JavaScript IPRS Record implementations follows specification(IPRS) implementation

Disclaimer: This module is way out of date there will be 🐉🐉

Description

Usage

Example record

// Record is a IPLD object
{
  '@context': {
    mlink: 'http://merkle-link'
  },
  scheme: {
    mlink: <hash to validity scheme or identifier for hard coded validity scheme>
  },
  expires: <data>, // datetime at which record expires
  value: <data>, // the data that this Record Stores
}

Record types

A record type should be identified by its validity scheme and a record validity scheme should be a MerkleDAG object containing its validity checking rules, however, for simplicity, we have developed 4 types of records, in which their validity schemes are hardcoded in this module. To identify which validity scheme to use, we use a enum:

  • a - signed, valid within a datetime range
  • b - signed, expiring after a Time-To-Live
  • c - signed, based on ancestry (chain)
  • d - signed, with cryptographic freshness

Reference: https://github.com/ipfs/specs/tree/master/iprs/README.md#example-record-types