# README
go-ipfs-ds-help
go-ipfs-ds-help provides utilities for parsing and creating datastore keys used by go-ipfs.
ā This repo is no longer maintained.
š We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/datastore/dshelp. šļø Good news! There is tooling and documentation to expedite a switch in your repo.
ā ļø If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).
š Learn more, including how to take the maintainership mantle or ask questions, here.
Table of Contents
Install
go-ipfs-ds-help works like a regular Go module:
> go get github.com/ipfs/go-ipfs-ds-help
Usage
import "github.com/ipfs/go-ipfs-ds-help"
Check the GoDoc documentation
This module uses Gx to manage dependencies. You can use make all to build it with the gx dependencies.
License
MIT Ā© Protocol Labs, Inc.
# Functions
BinaryFromDsKey returns the byte slice corresponding to the given Key.
DsKeyToCidV1Raw converts the given Key (which should be a raw multihash key) to a Cid V1 of the given type (see https://godoc.org/github.com/ipfs/go-cid#pkg-constants).
DsKeyToMultihash converts a dsKey to the corresponding Multihash.
MultihashToDsKey creates a Key from the given Multihash.
NewKeyFromBinary creates a new key from a byte slice.