Categorygithub.com/hsanjuan/go-ipfs-ds-help
modulepackage
1.0.0
Repository: https://github.com/hsanjuan/go-ipfs-ds-help.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
4
Dependents
1
Files
32 SLOC

# README

go-ipfs-ds-help

standard-readme compliant GoDoc Build Status

go-ipfs-ds-help provides utilities for parsing and creating datastore keys used by go-ipfs.

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.

Contribute

PRs accepted.

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

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.