/go-namesys

go-namesys provides publish and resolution support for the /ipns/ namespace in go-ipfs

Primary LanguageGoOtherNOASSERTION

go-namesys

Go Reference Travis CI

go-namesys provides publish and resolution support for the /ipns/ namespace

Package namesys defines Resolver and Publisher interfaces for IPNS paths, that is, paths in the form of /ipns/<name_to_be_resolved>. A "resolved" IPNS path becomes an /ipfs/<cid> path.

Traditionally, these paths would be in the form of /ipns/{libp2p-key}, which references an IPNS record in a distributed ValueStore (usually the IPFS DHT).

Additionally, the /ipns/ namespace can also be used with domain names that use DNSLink (/ipns/en.wikipedia-on-ipfs.org, see https://docs.ipfs.io/concepts/dnslink/).

The package provides implementations for all three resolvers.

Table of Contents

Install

go-namesys works like a regular Go module:

> go get github.com/ipfs/go-namesys

Usage

import "github.com/ipfs/go-namesys"

See the Pkg.go.dev documentation

Contribute

PRs accepted.

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

License

This project is dual-licensed under Apache 2.0 and MIT terms: