status-go/vendor/github.com/multiformats/go-multihash
Richard Ramos 28229faec0 chore: bump libp2p related dependencies 2023-06-30 14:23:08 -04:00
..
core chore: upgrade deps 2022-11-09 17:39:17 +03:00
register chore: bump libp2p related dependencies 2023-06-30 14:23:08 -04:00
.gitignore migrate to go 1.12 and go modules 2019-06-12 13:12:00 +02:00
.gitmodules Upgrade geth to 1.9.5 and Whisper (#1617) 2019-10-04 17:21:24 +02:00
LICENSE Add rendezvous implementation for discovery interface 2018-07-25 15:10:57 +03:00
README.md migrate to go 1.12 and go modules 2019-06-12 13:12:00 +02:00
codecov.yml migrate to go 1.12 and go modules 2019-06-12 13:12:00 +02:00
io.go go-waku integration (#2247) 2021-06-16 16:19:45 -04:00
multihash.go chore: bump libp2p related dependencies 2023-06-30 14:23:08 -04:00
registry.go Upgrade go-ens 2021-07-20 10:57:38 +02:00
set.go go-waku integration (#2247) 2021-06-16 16:19:45 -04:00
sum.go chore: bump libp2p related dependencies 2023-06-30 14:23:08 -04:00
version.json chore: bump libp2p related dependencies 2023-06-30 14:23:08 -04:00

README.md

go-multihash

GoDoc Travis CI codecov.io

multihash implementation in Go

Table of Contents

Install

go-multihash is a standard Go module which can be installed with:

go get github.com/multiformats/go-multihash

Usage

Example

This example takes a standard hex-encoded data and uses EncodeName to calculate the SHA1 multihash value for the buffer.

The resulting hex-encoded data corresponds to: <hash function code><digest size><hash function output>, which could be re-parsed with Multihash.FromHexString().

package main

import (
	"encoding/hex"
	"fmt"

	"github.com/multiformats/go-multihash"
)

func main() {
	// ignores errors for simplicity.
	// don't do that at home.
	// Decode a SHA1 hash to a binary buffer
	buf, _ := hex.DecodeString("0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33")

	// Create a new multihash with it.
	mHashBuf, _ := multihash.EncodeName(buf, "sha1")
	// Print the multihash as hex string
	fmt.Printf("hex: %s\n", hex.EncodeToString(mHashBuf))

	// Parse the binary multihash to a DecodedMultihash
	mHash, _ := multihash.Decode(mHashBuf)
	// Convert the sha1 value to hex string
	sha1hex := hex.EncodeToString(mHash.Digest)
	// Print all the information in the multihash
	fmt.Printf("obj: %v 0x%x %d %s\n", mHash.Name, mHash.Code, mHash.Length, sha1hex)
}

To run, copy to example/foo.go and:

> cd example/
> go build
> ./example
hex: 11140beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33
obj: sha1 0x11 20 0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33

Contribute

Contributions welcome. Please check out the issues.

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2014 Juan Batiz-Benet