48 lines
1.5 KiB
Go
48 lines
1.5 KiB
Go
package iface
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
path "github.com/ipfs/interface-go-ipfs-core/path"
|
|
|
|
"github.com/ipfs/interface-go-ipfs-core/options"
|
|
)
|
|
|
|
var ErrResolveFailed = errors.New("could not resolve name")
|
|
|
|
// IpnsEntry specifies the interface to IpnsEntries
|
|
type IpnsEntry interface {
|
|
// Name returns IpnsEntry name
|
|
Name() string
|
|
// Value returns IpnsEntry value
|
|
Value() path.Path
|
|
}
|
|
|
|
type IpnsResult struct {
|
|
path.Path
|
|
Err error
|
|
}
|
|
|
|
// NameAPI specifies the interface to IPNS.
|
|
//
|
|
// IPNS is a PKI namespace, where names are the hashes of public keys, and the
|
|
// private key enables publishing new (signed) values. In both publish and
|
|
// resolve, the default name used is the node's own PeerID, which is the hash of
|
|
// its public key.
|
|
//
|
|
// You can use .Key API to list and generate more names and their respective keys.
|
|
type NameAPI interface {
|
|
// Publish announces new IPNS name
|
|
Publish(ctx context.Context, path path.Path, opts ...options.NamePublishOption) (IpnsEntry, error)
|
|
|
|
// Resolve attempts to resolve the newest version of the specified name
|
|
Resolve(ctx context.Context, name string, opts ...options.NameResolveOption) (path.Path, error)
|
|
|
|
// Search is a version of Resolve which outputs paths as they are discovered,
|
|
// reducing the time to first entry
|
|
//
|
|
// Note: by default, all paths read from the channel are considered unsafe,
|
|
// except the latest (last path in channel read buffer).
|
|
Search(ctx context.Context, name string, opts ...options.NameResolveOption) (<-chan IpnsResult, error)
|
|
}
|