0.0.2 • Published 9 years ago

ipfs-record v0.0.2

Weekly downloads
1
License
MIT
Repository
github
Last release
9 years ago

node-ipfs-record

npm.io [npm.io](http://webchat.freenode.net/?channels=%23ipfs) Build Status npm.io Dependency Status js-standard-style

Node.js IPFS record object specification(IPRS) implementation

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/records#example-record-types