interface.go 12.8 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 19
var ErrIsDir = errors.New("object is a directory")
var ErrOffline = errors.New("can't resolve, ipfs node is offline")

20 21
// 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.
22
type Path interface {
23
	// String returns the path as a string.
24
	String() string
25
	// Cid returns cid referred to by path
26
	Cid() *cid.Cid
27
	// Root returns cid of root path
28
	Root() *cid.Cid
29
	// Resolved returns whether path has been fully resolved
30 31 32 33
	Resolved() bool
}

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

type Reader interface {
	io.ReadSeeker
	io.Closer
}

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

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

Łukasz Magiera's avatar
Łukasz Magiera committed
59 60 61 62 63
type BlockStat interface {
	Size() int
	Path() Path
}

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

	// Type of the pin
	Type() string
}

Łukasz Magiera's avatar
Łukasz Magiera committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
// PinStatus holds information about pin health
type PinStatus interface {
	// Ok indicates whether the pin has been verified to be correct
	Ok() bool

	// BadNodes returns any bad (usually missing) nodes from the pin
	BadNodes() []BadPinNode
}

// BadPinNode is a node that has been marked as bad by Pin.Verify
type BadPinNode interface {
	// Path is the path of the node
	Path() Path

	// Err is the reason why the node has been marked as bad
	Err() error
}

91
// CoreAPI defines an unified interface to IPFS for Go programs.
92
type CoreAPI interface {
93
	// Unixfs returns an implementation of Unixfs API.
94
	Unixfs() UnixfsAPI
95

Łukasz Magiera's avatar
Łukasz Magiera committed
96 97
	// Block returns an implementation of Block API.
	Block() BlockAPI
98

99
	// Dag returns an implementation of Dag API.
Łukasz Magiera's avatar
Łukasz Magiera committed
100
	Dag() DagAPI
101

102
	// Name returns an implementation of Name API.
Łukasz Magiera's avatar
Łukasz Magiera committed
103
	Name() NameAPI
104

105
	// Key returns an implementation of Key API.
106
	Key() KeyAPI
Łukasz Magiera's avatar
Łukasz Magiera committed
107
	Pin() PinAPI
108

109 110 111
	// ObjectAPI returns an implementation of Object API
	Object() ObjectAPI

112
	// ResolvePath resolves the path using Unixfs resolver
113
	ResolvePath(context.Context, Path) (Path, error)
114 115 116

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

120
// UnixfsAPI is the basic interface to immutable files in IPFS
121
type UnixfsAPI interface {
122
	// Add imports the data from the reader into merkledag file
123
	Add(context.Context, io.Reader) (Path, error)
124 125

	// Cat returns a reader for the file
126
	Cat(context.Context, Path) (Reader, error)
127 128

	// Ls returns the list of links in a directory
129
	Ls(context.Context, Path) ([]*Link, error)
130 131
}

Łukasz Magiera's avatar
Łukasz Magiera committed
132
// BlockAPI specifies the interface to the block layer
Łukasz Magiera's avatar
Łukasz Magiera committed
133
type BlockAPI interface {
Łukasz Magiera's avatar
Łukasz Magiera committed
134
	// Put imports raw block data, hashing it using specified settings.
Łukasz Magiera's avatar
Łukasz Magiera committed
135
	Put(context.Context, io.Reader, ...options.BlockPutOption) (Path, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
136 137 138

	// 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
139
	WithFormat(codec string) options.BlockPutOption
Łukasz Magiera's avatar
Łukasz Magiera committed
140 141 142 143

	// 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
144 145
	WithHash(mhType uint64, mhLen int) options.BlockPutOption

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

Łukasz Magiera's avatar
Łukasz Magiera committed
149 150 151 152 153
	// 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
154
	Rm(context.Context, Path, ...options.BlockRmOption) error
Łukasz Magiera's avatar
Łukasz Magiera committed
155 156 157

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

Łukasz Magiera's avatar
Łukasz Magiera committed
160
	// Stat returns information on
Łukasz Magiera's avatar
Łukasz Magiera committed
161
	Stat(context.Context, Path) (BlockStat, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
162 163
}

Łukasz Magiera's avatar
Łukasz Magiera committed
164
// DagAPI specifies the interface to IPLD
Łukasz Magiera's avatar
Łukasz Magiera committed
165
type DagAPI interface {
Łukasz Magiera's avatar
Łukasz Magiera committed
166
	// Put inserts data using specified format and input encoding.
Łukasz Magiera's avatar
Łukasz Magiera committed
167 168 169
	// 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)
170 171 172 173 174 175 176 177 178 179 180 181 182 183

	// 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
184 185

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

	// Tree returns list of paths within a node specified by the path.
189 190 191 192 193
	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
194 195
}

196 197 198 199 200 201 202 203
// 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
204
type NameAPI interface {
205
	// Publish announces new IPNS name
206
	Publish(ctx context.Context, path Path, opts ...options.NamePublishOption) (IpnsEntry, error)
207 208 209

	// WithValidTime is an option for Publish which specifies for how long the
	// entry will remain valid. Default value is 24h
210
	WithValidTime(validTime time.Duration) options.NamePublishOption
211 212 213

	// 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.
214
	// The key parameter must be either PeerID or keystore key alias.
215
	//
216
	// You can use KeyAPI to list and generate more names and their respective keys.
217 218
	WithKey(key string) options.NamePublishOption

219
	// Resolve attempts to resolve the newest version of the specified name
220
	Resolve(ctx context.Context, name string, opts ...options.NameResolveOption) (Path, error)
221 222 223

	// WithRecursive is an option for Resolve which specifies whether to perform a
	// recursive lookup. Default value is false
224
	WithRecursive(recursive bool) options.NameResolveOption
225 226 227

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

230 231 232
	// 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
233 234
}

235
// KeyAPI specifies the interface to Keystore
236
type KeyAPI interface {
237 238
	// Generate generates new key, stores it in the keystore under the specified
	// name and returns a base58 encoded multihash of it's public key
239
	Generate(ctx context.Context, name string, opts ...options.KeyGenerateOption) (Key, error)
240

Łukasz Magiera's avatar
Łukasz Magiera committed
241
	// WithType is an option for Generate which specifies which algorithm
242
	// should be used for the key. Default is options.RSAKey
243
	//
Łukasz Magiera's avatar
Łukasz Magiera committed
244
	// Supported key types:
245 246
	// * options.RSAKey
	// * options.Ed25519Key
Łukasz Magiera's avatar
Łukasz Magiera committed
247
	WithType(algorithm string) options.KeyGenerateOption
248 249

	// WithSize is an option for Generate which specifies the size of the key to
Łukasz Magiera's avatar
Łukasz Magiera committed
250 251 252 253
	// generated. Default is -1
	//
	// value of -1 means 'use default size for key type':
	//  * 2048 for RSA
254 255
	WithSize(size int) options.KeyGenerateOption

256 257 258
	// 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)
259 260 261

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

264
	// List lists keys stored in keystore
265
	List(ctx context.Context) ([]Key, error)
266

267 268
	// 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
269 270
}

Łukasz Magiera's avatar
Łukasz Magiera committed
271 272
// ObjectAPI specifies the interface to MerkleDAG and contains useful utilities
// for manipulating MerkleDAG data structures.
273
type ObjectAPI interface {
Łukasz Magiera's avatar
Łukasz Magiera committed
274
	// New creates new, empty (by default) dag-node.
Łukasz Magiera's avatar
Łukasz Magiera committed
275
	New(context.Context, ...options.ObjectNewOption) (Node, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
276 277 278 279 280 281 282

	// 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
283 284
	WithType(string) options.ObjectNewOption

285 286 287 288 289 290 291 292 293 294
	// 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
295

Łukasz Magiera's avatar
Łukasz Magiera committed
296 297 298 299 300 301 302 303
	// 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
304
	// Get returns the node for the path
305
	Get(context.Context, Path) (Node, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
306 307

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

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

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

Łukasz Magiera's avatar
Łukasz Magiera committed
316 317 318
	// 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
319
	AddLink(ctx context.Context, base Path, name string, child Path, opts ...options.ObjectAddLinkOption) (Path, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
320 321 322

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

Łukasz Magiera's avatar
Łukasz Magiera committed
325
	// RmLink removes a link from the node
Łukasz Magiera's avatar
Łukasz Magiera committed
326
	RmLink(ctx context.Context, base Path, link string) (Path, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
327 328

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

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

Łukasz Magiera's avatar
Łukasz Magiera committed
335
// ObjectStat provides information about dag nodes
336
type ObjectStat struct {
Łukasz Magiera's avatar
Łukasz Magiera committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
	// 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
352
	// CumulativeSize is size of the tree (BlockSize + link sizes)
353 354
	CumulativeSize int
}
355

Łukasz Magiera's avatar
Łukasz Magiera committed
356 357 358 359 360 361 362 363 364 365 366
// 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
Łukasz Magiera's avatar
Łukasz Magiera committed
367
	Ls(context.Context, ...options.PinLsOption) ([]Pin, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384

	// 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
Łukasz Magiera's avatar
Łukasz Magiera committed
385
	Update(ctx context.Context, from Path, to Path, opts ...options.PinUpdateOption) error
Łukasz Magiera's avatar
Łukasz Magiera committed
386 387

	// Verify verifies the integrity of pinned objects
Łukasz Magiera's avatar
Łukasz Magiera committed
388
	Verify(context.Context) (<-chan PinStatus, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
389
}