interface.go 12.3 KB
Newer Older
1 2
// Package iface defines IPFS Core API which is a set of interfaces used to
// interact with IPFS nodes.
3 4 5 6 7 8
package iface

import (
	"context"
	"errors"
	"io"
Łukasz Magiera's avatar
Łukasz Magiera committed
9
	"time"
10

11 12
	options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"

Steven Allen's avatar
Steven Allen committed
13 14
	cid "gx/ipfs/QmcZfnkapfECQGcLZaf9B79NRg7cRa9EnZh4LSbkCzwNvY/go-cid"
	ipld "gx/ipfs/Qme5bWv7wtjUNGsK2BNGVUFPKiuxWrsqrtvYwCLRw8YFES/go-ipld-format"
15 16
)

17 18
// Path is a generic wrapper for paths used in the API. A path can be resolved
// to a CID using one of Resolve functions in the API.
19
type Path interface {
20
	// String returns the path as a string.
21
	String() string
22
	// Cid returns cid referred to by path
23
	Cid() *cid.Cid
24
	// Root returns cid of root path
25
	Root() *cid.Cid
26
	// Resolved returns whether path has been fully resolved
27 28 29 30
	Resolved() bool
}

// TODO: should we really copy these?
31
//       if we didn't, godoc would generate nice links straight to go-ipld-format
32
type Node ipld.Node
Lars Gierth's avatar
Lars Gierth committed
33
type Link ipld.Link
34 35 36 37 38 39

type Reader interface {
	io.ReadSeeker
	io.Closer
}

40
// IpnsEntry specifies the interface to IpnsEntries
41
type IpnsEntry interface {
42
	// Name returns IpnsEntry name
43
	Name() string
44
	// Value returns IpnsEntry value
45 46 47
	Value() Path
}

48
// Key specifies the interface to Keys in KeyAPI Keystore
49
type Key interface {
50
	// Key returns key name
51
	Name() string
52
	// Path returns key path
53 54 55
	Path() Path
}

Łukasz Magiera's avatar
Łukasz Magiera committed
56 57 58 59 60
type BlockStat interface {
	Size() int
	Path() Path
}

Łukasz Magiera's avatar
Łukasz Magiera committed
61 62 63 64 65 66 67 68 69
// Pin holds information about pinned resource
type Pin interface {
	// Path to the pinned object
	Path() Path

	// Type of the pin
	Type() string
}

70
// CoreAPI defines an unified interface to IPFS for Go programs.
71
type CoreAPI interface {
72
	// Unixfs returns an implementation of Unixfs API.
73
	Unixfs() UnixfsAPI
74

Łukasz Magiera's avatar
Łukasz Magiera committed
75 76
	// Block returns an implementation of Block API.
	Block() BlockAPI
77

78
	// Dag returns an implementation of Dag API.
Łukasz Magiera's avatar
Łukasz Magiera committed
79
	Dag() DagAPI
80

81
	// Name returns an implementation of Name API.
Łukasz Magiera's avatar
Łukasz Magiera committed
82
	Name() NameAPI
83

84
	// Key returns an implementation of Key API.
85
	Key() KeyAPI
86

87 88 89
	// ObjectAPI returns an implementation of Object API
	Object() ObjectAPI

90
	// ResolvePath resolves the path using Unixfs resolver
91
	ResolvePath(context.Context, Path) (Path, error)
92 93 94

	// ResolveNode resolves the path (if not resolved already) using Unixfs
	// resolver, gets and returns the resolved Node
Łukasz Magiera's avatar
Łukasz Magiera committed
95
	ResolveNode(context.Context, Path) (Node, error)
96 97
}

98
// UnixfsAPI is the basic interface to immutable files in IPFS
99
type UnixfsAPI interface {
100
	// Add imports the data from the reader into merkledag file
101
	Add(context.Context, io.Reader) (Path, error)
102 103

	// Cat returns a reader for the file
104
	Cat(context.Context, Path) (Reader, error)
105 106

	// Ls returns the list of links in a directory
107
	Ls(context.Context, Path) ([]*Link, error)
108 109
}

Łukasz Magiera's avatar
Łukasz Magiera committed
110
// BlockAPI specifies the interface to the block layer
Łukasz Magiera's avatar
Łukasz Magiera committed
111
type BlockAPI interface {
Łukasz Magiera's avatar
Łukasz Magiera committed
112
	// Put imports raw block data, hashing it using specified settings.
Łukasz Magiera's avatar
Łukasz Magiera committed
113
	Put(context.Context, io.Reader, ...options.BlockPutOption) (Path, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
114 115 116

	// WithFormat is an option for Put which specifies the multicodec to use to
	// serialize the object. Default is "v0"
Łukasz Magiera's avatar
Łukasz Magiera committed
117
	WithFormat(codec string) options.BlockPutOption
Łukasz Magiera's avatar
Łukasz Magiera committed
118 119 120 121

	// WithHash is an option for Put which specifies the multihash settings to use
	// when hashing the object. Default is mh.SHA2_256 (0x12).
	// If mhLen is set to -1, default length for the hash will be used
Łukasz Magiera's avatar
Łukasz Magiera committed
122 123
	WithHash(mhType uint64, mhLen int) options.BlockPutOption

Łukasz Magiera's avatar
Łukasz Magiera committed
124
	// Get attempts to resolve the path and return a reader for data in the block
Łukasz Magiera's avatar
Łukasz Magiera committed
125
	Get(context.Context, Path) (io.Reader, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
126

Łukasz Magiera's avatar
Łukasz Magiera committed
127 128 129 130 131
	// Rm removes the block specified by the path from local blockstore.
	// By default an error will be returned if the block can't be found locally.
	//
	// NOTE: If the specified block is pinned it won't be removed and no error
	// will be returned
Łukasz Magiera's avatar
Łukasz Magiera committed
132
	Rm(context.Context, Path, ...options.BlockRmOption) error
Łukasz Magiera's avatar
Łukasz Magiera committed
133 134 135

	// WithForce is an option for Rm which, when set to true, will ignore
	// non-existing blocks
Łukasz Magiera's avatar
Łukasz Magiera committed
136 137
	WithForce(force bool) options.BlockRmOption

Łukasz Magiera's avatar
Łukasz Magiera committed
138
	// Stat returns information on
Łukasz Magiera's avatar
Łukasz Magiera committed
139
	Stat(context.Context, Path) (BlockStat, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
140 141
}

Łukasz Magiera's avatar
Łukasz Magiera committed
142
// DagAPI specifies the interface to IPLD
Łukasz Magiera's avatar
Łukasz Magiera committed
143
type DagAPI interface {
Łukasz Magiera's avatar
Łukasz Magiera committed
144
	// Put inserts data using specified format and input encoding.
Łukasz Magiera's avatar
Łukasz Magiera committed
145 146 147
	// Unless used with WithCodec or WithHash, the defaults "dag-cbor" and
	// "sha256" are used.
	Put(ctx context.Context, src io.Reader, opts ...options.DagPutOption) (Path, error)
148 149 150 151 152 153 154 155 156 157 158 159 160 161

	// WithInputEnc is an option for Put which specifies the input encoding of the
	// data. Default is "json", most formats/codecs support "raw"
	WithInputEnc(enc string) options.DagPutOption

	// WithCodec is an option for Put which specifies the multicodec to use to
	// serialize the object. Default is cid.DagCBOR (0x71)
	WithCodec(codec uint64) options.DagPutOption

	// WithHash is an option for Put which specifies the multihash settings to use
	// when hashing the object. Default is based on the codec used
	// (mh.SHA2_256 (0x12) for DagCBOR). If mhLen is set to -1, default length for
	// the hash will be used
	WithHash(mhType uint64, mhLen int) options.DagPutOption
Łukasz Magiera's avatar
Łukasz Magiera committed
162 163

	// Get attempts to resolve and get the node specified by the path
Łukasz Magiera's avatar
Łukasz Magiera committed
164
	Get(ctx context.Context, path Path) (Node, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
165 166

	// Tree returns list of paths within a node specified by the path.
167 168 169 170 171
	Tree(ctx context.Context, path Path, opts ...options.DagTreeOption) ([]Path, error)

	// WithDepth is an option for Tree which specifies maximum depth of the
	// returned tree. Default is -1 (no depth limit)
	WithDepth(depth int) options.DagTreeOption
Łukasz Magiera's avatar
Łukasz Magiera committed
172 173
}

174 175 176 177 178 179 180 181
// 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.
Łukasz Magiera's avatar
Łukasz Magiera committed
182
type NameAPI interface {
183
	// Publish announces new IPNS name
184
	Publish(ctx context.Context, path Path, opts ...options.NamePublishOption) (IpnsEntry, error)
185 186 187

	// WithValidTime is an option for Publish which specifies for how long the
	// entry will remain valid. Default value is 24h
188
	WithValidTime(validTime time.Duration) options.NamePublishOption
189 190 191

	// WithKey is an option for Publish which specifies the key to use for
	// publishing. Default value is "self" which is the node's own PeerID.
192
	// The key parameter must be either PeerID or keystore key alias.
193
	//
194
	// You can use KeyAPI to list and generate more names and their respective keys.
195 196
	WithKey(key string) options.NamePublishOption

197
	// Resolve attempts to resolve the newest version of the specified name
198
	Resolve(ctx context.Context, name string, opts ...options.NameResolveOption) (Path, error)
199 200 201

	// WithRecursive is an option for Resolve which specifies whether to perform a
	// recursive lookup. Default value is false
202
	WithRecursive(recursive bool) options.NameResolveOption
203 204 205

	// WithLocal is an option for Resolve which specifies if the lookup should be
	// offline. Default value is false
206
	WithLocal(local bool) options.NameResolveOption
207

208 209 210
	// WithCache is an option for Resolve which specifies if cache should be used.
	// Default value is true
	WithCache(cache bool) options.NameResolveOption
Łukasz Magiera's avatar
Łukasz Magiera committed
211 212
}

213
// KeyAPI specifies the interface to Keystore
214
type KeyAPI interface {
215 216
	// Generate generates new key, stores it in the keystore under the specified
	// name and returns a base58 encoded multihash of it's public key
217
	Generate(ctx context.Context, name string, opts ...options.KeyGenerateOption) (Key, error)
218

Łukasz Magiera's avatar
Łukasz Magiera committed
219
	// WithType is an option for Generate which specifies which algorithm
220
	// should be used for the key. Default is options.RSAKey
221
	//
Łukasz Magiera's avatar
Łukasz Magiera committed
222
	// Supported key types:
223 224
	// * options.RSAKey
	// * options.Ed25519Key
Łukasz Magiera's avatar
Łukasz Magiera committed
225
	WithType(algorithm string) options.KeyGenerateOption
226 227

	// WithSize is an option for Generate which specifies the size of the key to
Łukasz Magiera's avatar
Łukasz Magiera committed
228 229 230 231
	// generated. Default is -1
	//
	// value of -1 means 'use default size for key type':
	//  * 2048 for RSA
232 233
	WithSize(size int) options.KeyGenerateOption

234 235 236
	// Rename renames oldName key to newName. Returns the key and whether another
	// key was overwritten, or an error
	Rename(ctx context.Context, oldName string, newName string, opts ...options.KeyRenameOption) (Key, bool, error)
237 238 239

	// WithForce is an option for Rename which specifies whether to allow to
	// replace existing keys.
240 241
	WithForce(force bool) options.KeyRenameOption

242
	// List lists keys stored in keystore
243
	List(ctx context.Context) ([]Key, error)
244

245 246
	// Remove removes keys from keystore. Returns ipns path of the removed key
	Remove(ctx context.Context, name string) (Path, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
247 248
}

Łukasz Magiera's avatar
Łukasz Magiera committed
249 250
// ObjectAPI specifies the interface to MerkleDAG and contains useful utilities
// for manipulating MerkleDAG data structures.
251
type ObjectAPI interface {
Łukasz Magiera's avatar
Łukasz Magiera committed
252
	// New creates new, empty (by default) dag-node.
Łukasz Magiera's avatar
Łukasz Magiera committed
253
	New(context.Context, ...options.ObjectNewOption) (Node, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
254 255 256 257 258 259 260

	// WithType is an option for New which allows to change the type of created
	// dag node.
	//
	// Supported types:
	// * 'empty' - Empty node
	// * 'unixfs-dir' - Empty UnixFS directory
Łukasz Magiera's avatar
Łukasz Magiera committed
261 262
	WithType(string) options.ObjectNewOption

263 264 265 266 267 268 269 270 271 272
	// Put imports the data into merkledag
	Put(context.Context, io.Reader, ...options.ObjectPutOption) (Path, error)

	// WithInputEnc is an option for Put which specifies the input encoding of the
	// data. Default is "json".
	//
	// Supported encodings:
	// * "protobuf"
	// * "json"
	WithInputEnc(e string) options.ObjectPutOption
Łukasz Magiera's avatar
Łukasz Magiera committed
273

Łukasz Magiera's avatar
Łukasz Magiera committed
274 275 276 277 278 279 280 281
	// WithDataType specifies the encoding of data field when using Josn or XML
	// input encoding.
	//
	// Supported types:
	// * "text" (default)
	// * "base64"
	WithDataType(t string) options.ObjectPutOption

Łukasz Magiera's avatar
Łukasz Magiera committed
282
	// Get returns the node for the path
283
	Get(context.Context, Path) (Node, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
284 285

	// Data returns reader for data of the node
286
	Data(context.Context, Path) (io.Reader, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
287 288

	// Links returns lint or links the node contains
289
	Links(context.Context, Path) ([]*Link, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
290 291

	// Stat returns information about the node
292 293
	Stat(context.Context, Path) (*ObjectStat, error)

Łukasz Magiera's avatar
Łukasz Magiera committed
294 295 296
	// AddLink adds a link under the specified path. child path can point to a
	// subdirectory within the patent which must be present (can be overridden
	// with WithCreate option).
Łukasz Magiera's avatar
Łukasz Magiera committed
297
	AddLink(ctx context.Context, base Path, name string, child Path, opts ...options.ObjectAddLinkOption) (Path, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
298 299 300

	// WithCreate is an option for AddLink which specifies whether create required
	// directories for the child
Łukasz Magiera's avatar
Łukasz Magiera committed
301 302
	WithCreate(create bool) options.ObjectAddLinkOption

Łukasz Magiera's avatar
Łukasz Magiera committed
303
	// RmLink removes a link from the node
Łukasz Magiera's avatar
Łukasz Magiera committed
304
	RmLink(ctx context.Context, base Path, link string) (Path, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
305 306

	// AppendData appends data to the node
Łukasz Magiera's avatar
Łukasz Magiera committed
307
	AppendData(context.Context, Path, io.Reader) (Path, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
308 309

	// SetData sets the data contained in the node
Łukasz Magiera's avatar
Łukasz Magiera committed
310
	SetData(context.Context, Path, io.Reader) (Path, error)
311 312
}

Łukasz Magiera's avatar
Łukasz Magiera committed
313
// ObjectStat provides information about dag nodes
314
type ObjectStat struct {
Łukasz Magiera's avatar
Łukasz Magiera committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
	// Cid is the CID of the node
	Cid *cid.Cid

	// NumLinks is number of links the node contains
	NumLinks int

	// BlockSize is size of the raw serialized node
	BlockSize int

	// LinksSize is size of the links block section
	LinksSize int

	// DataSize is the size of data block section
	DataSize int

Łukasz Magiera's avatar
Łukasz Magiera committed
330
	// CumulativeSize is size of the tree (BlockSize + link sizes)
331 332
	CumulativeSize int
}
333

Łukasz Magiera's avatar
Łukasz Magiera committed
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
// PinAPI specifies the interface to pining
type PinAPI interface {
	// Add creates new pin, be default recursive - pinning the whole referenced
	// tree
	Add(context.Context, Path, ...options.PinAddOption) error

	// WithRecursive is an option for Add which specifies whether to pin an entire
	// object tree or just one object. Default: true
	WithRecursive(bool) options.PinAddOption

	// Ls returns list of pinned objects on this node
	Ls(context.Context) ([]Pin, error)

	// WithType is an option for Ls which allows to specify which pin types should
	// be returned
	//
	// Supported values:
	// * "direct" - directly pinned objects
	// * "recursive" - roots of recursive pins
	// * "indirect" - indirectly pinned objects (referenced by recursively pinned
	//    objects)
	// * "all" - all pinned objects (default)
	WithType(string) options.PinLsOption

	// Rm removes pin for object specified by the path
	Rm(context.Context, Path) error

	// Update changes one pin to another, skipping checks for matching paths in
	// the old tree
	Update(ctx context.Context, from Path, to Path) error

	// Verify verifies the integrity of pinned objects
	Verify(context.Context) error
}

369 370
var ErrIsDir = errors.New("object is a directory")
var ErrOffline = errors.New("can't resolve, ipfs node is offline")