New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@ensdomains/content-hash

Package Overview
Dependencies
Maintainers
8
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ensdomains/content-hash

A simple tool to encode/decode content hash for EIP 1577 compliant ENS Resolvers (fork of pldespaigne/content-hash)

  • 3.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
927
decreased by-78.24%
Maintainers
8
Weekly downloads
 
Created
Source

content-hash

npm package licence

This is a simple package made for encoding and decoding content hashes as specified in the EIP 1577. This package will be useful for every Ethereum developer wanting to interact with EIP 1577 compliant ENS resolvers.

🔠 Supported Codec

  • swarm
  • ipfs
  • ipns
  • onion
  • onion3
  • skynet
  • arweave

📥 Install

npm install @ensdomains/content-hash

🛠 Usage

import { decode } from "@ensdomains/content-hash";

const encoded =
  "e3010170122029f2d17be6139079dc48696d1f582a8530eb9805b561eda517e22a892c7e3f1f";

const content = decode(encoded);
// 'QmRAQB6YaCyidP37UdDnjFY5vQuiBrcqdyoW1CuDgwxkD4'

📕 API

All hex string inputs can be prefixed with 0x, but it's not mandatory.

⚠️ All outputs are NOT prefixed with 0x

decode( contentHash ) -> string

This function takes a content hash as a hex string and returns the decoded content as a string.

import { decode } from "@ensdomains/content-hash";

const encoded =
  "e3010170122029f2d17be6139079dc48696d1f582a8530eb9805b561eda517e22a892c7e3f1f";

const content = decode(encoded);
// 'QmRAQB6YaCyidP37UdDnjFY5vQuiBrcqdyoW1CuDgwxkD4'

encode( codec, value) -> string

This function takes a supported codec as a string and a value as a string and returns coresponding content hash as a hex string.

import { encode } from "@ensdomains/content-hash";

const onion = "zqktlwi4fecvo6ri";

const encoded = encode("onion", onion);
// 'bc037a716b746c776934666563766f367269'

getCodec( contentHash ) -> string

This function takes a content hash as a hex string and returns the codec as a hex string.

import { getCodec } from "@ensdomains/content-hash";

const encoded =
  "e40101701b20d1de9994b4d039f6548d191eb26786769f580809256b4685ef316805265ea162";

const codec = getCodec(encoded);
// 'swarm'

Helpers

  • cidV0ToV1Base32( ipfsHash ) -> string

    This function takes an ipfsHash and converts it to a CID v1 encoded in base32.

    import { cidV0ToV1Base32 } from "@ensdomains/content-hash";
    
    const ipfs = "QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG";
    
    const cidV1 = cidV0ToV1Base32(ipfs);
    // 'bafybeibj6lixxzqtsb45ysdjnupvqkufgdvzqbnvmhw2kf7cfkesy7r7d4'
    
  • cidForWeb( ipfsHash ) -> string

    This function takes any ipfsHash and converts it to DNS-compatible CID.

    import { cidForWeb } from "@ensdomains/content-hash";
    
    const ipfs = "QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG";
    
    const cidV1 = cidForWeb(ipfs);
    // 'bafybeibj6lixxzqtsb45ysdjnupvqkufgdvzqbnvmhw2kf7cfkesy7r7d4'
    

📝 License

This project is licensed under the MIT License, you can find it here.

Note that the dependencies may have a different License

👥 Acknowledgements

This repo is forked from the original content-hash library, which was written by pldespaigne.

Keywords

FAQs

Package last updated on 11 Aug 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc