# js-iprs-record

**Repository Path**: mirrors_libp2p/js-iprs-record

## Basic Information

- **Project Name**: js-iprs-record
- **Description**: JavaScript IPFS record class implementation
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-03-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

iprs-record JavaScript implementation
=======================================

[![](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) 
![Build Status](https://travis-ci.org/diasdavid/js-iprs-record.svg?style=flat-square)](https://travis-ci.org/diasdavid/js-iprs-record) 
![](https://img.shields.io/badge/coverage-%3F-yellow.svg?style=flat-square) 
[![Dependency Status](https://david-dm.org/diasdavid/js-iprs-record.svg?style=flat-square)](https://david-dm.org/diasdavid/js-iprs-record)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)

> JavaScript IPRS Record implementations follows specification([IPRS](https://github.com/ipfs/specs/tree/master/iprs/README.md)) 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