Dendrite

Dendrite is a tool designed for the retrieval and validation of the SEP-001 standard. Its main goal is to provide a user-friendly and easy-to-use interface to interact with the standard.

Key features

• Fetches metadata from the Meta Lake (IPFS).
• Automatically detects the serialization format of the metadata and applies the appropriate strategy to fetch and decode it.
• Validates the metadata's signature to ensure its authenticity and integrity.
• Verifies that the retrieved metadata adheres to the defined schema, ensuring its correctness and compliance with standards.
• Provides a standardized interface for interacting with the metadata, allowing users to:
  • Validate the fingerprint of the metadata.
  • Determine the type of multimedia represented by the metadata.
  • Handle and manage the results of the payload recovered from the metadata.

Install

Dendrite is available as a NPM package.

npm install dendritejs

Usage

You can start using dendrite with a few lines of code:

import {create} from 'ipfs-core'
import dendrite from 'dendritejs'

const node = await create()
const decoder = dendrite(node)

try {

  // 1 - Auto-detect the serialization and apply the right strategy to fetch and decode the metadata.
  // 2 - The signature is validated using the embedded JWK public key.
  // 3 - The metadata schema is validated.
  // 4 - Returns a standard standard interface.
  const dagJoseCID = 'bagcqcerann63enqn2vssm6gko624gojakrswyppm56rao7m6e6vfnvtcxzha'
  const decoded = await decoder(dagJoseCID)

  const mediaType = decoded.type() // eg. application/vnd.apple.mpegurl
  const payload = decoded.metadata() // {s,t,d} standard SEP-001 payload

  // fingerprint verification with shared fingerprint
  const expectedFingerprint = 'aba44a9673c452de6183c82919de2cdb8b830615e9ac684841502ba7173ee00a'
  const validFingerprint = decoded.validate(expectedFingerprint)

} catch(e) {
  // A TypeError is thrown if any error is encountered during validation or decoding.
}

Development

Some available capabilities for dev support:

• Install: make install
• Tests: make test
• Lint: make lint
• Lint Fix: make format

Note: Run make help to check for more capabilities.

References

• Multiformats JS Library
• DAG Service Documentation
• Block Service Documentation