npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

multiformat-multicodec

v1.0.0

Published

An interface for (de)encoding a wide range of multicodecs simultaneously

Downloads

13

Readme

multiformat-multicodec

An interface for encoding/decoding across multiple multiformat BlockEncoders, BlockDecoders, BlockCodecs, and Hashers.

This interface lets library authors expose a dynamic dependency injection system to their users, so as to not be locked into any particular suite of codecs/hashers -- much like the IPFS modular interfaces. The library also provides a default trivial implementation of the interfaces.

If you need to decode blocks which may come encoded using many different codecs, or need your library users to give you the codecs and hashers they want you to use, this is probably what you're looking for.

Interfaces

The library exports three interfaces which encapsulate the notion of (de)encoding for given codec and hasher codes:

Multidecoder is an interface that can decode using multiple decoders/hashers:

interface Multidecoder {
  addDecoder(decoder: BlockDecoder): void;
  addHasher(hasher: Hasher): void;
  decode(opts: {
    codec: number;
    hasher: number;
    bytes: ByteView<T>;
  }): Promise<Block<T>>;
}

Multiencoder is its dual, and can encode using multiple encoders/hashers (you pick which one):

interface Multiencoder {
  addEncoder(encoder: BlockEncoder): void;
  addHasher(hasher: Hasher): void;
  encode(opts: { codec: number; hasher: number; value: T }): Promise<Block<T>>;
}

If you need both interfaces simultaneously, the Multicodec interface simply extends the two:

interface Multicodec extends Multidecoder, Multiencoder {}

Implementation

The library also exports a default implementation of Multicodec, called BlockMulticodec. By default, it already has sha256 hasher support. It has an extra method addCodec() which isn't in the Multicodec interface.

import { BlockMulticodec, Multidecoder } from "multiformat-multicodec";

import { CID } from "multiformats";

import * as json from "@ipld/dag-json";
import * as cbor from "@ipld/dag-cbor";
import * as pb from "@ipld/dag-pb";

const multidecoder = new BlockMulticodec<any>({
  codecs: [json, cbor, pb],
});

const cid = CID.parse("QmQy6xmJhrcC5QLboAcGFcAE1tC8CrwDVkrHdEYJkLscrQ");

await multidecoder.decode({
  codec: cid.code,
  hasher: cid.multihash.code,
  block.get(cid),
});