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
// 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
}

Łukasz Magiera's avatar
Łukasz Magiera committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
// 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
}

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

Łukasz Magiera's avatar
Łukasz Magiera committed
93 94
	// Block returns an implementation of Block API.
	Block() BlockAPI
95

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

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

102
	// Key returns an implementation of Key API.
103
	Key() KeyAPI
Łukasz Magiera's avatar
Łukasz Magiera committed
104
	Pin() PinAPI
105

106 107 108
	// ObjectAPI returns an implementation of Object API
	Object() ObjectAPI

109
	// ResolvePath resolves the path using Unixfs resolver
110
	ResolvePath(context.Context, Path) (Path, error)
111 112 113

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

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

	// Cat returns a reader for the file
123
	Cat(context.Context, Path) (Reader, error)
124 125

	// Ls returns the list of links in a directory
126
	Ls(context.Context, Path) ([]*Link, error)
127 128
}

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

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

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

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

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

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

Łukasz Magiera's avatar
Łukasz Magiera committed
157
	// Stat returns information on
Łukasz Magiera's avatar
Łukasz Magiera committed
158
	Stat(context.Context, Path) (BlockStat, error)
Łukasz Magiera's avatar
Łukasz Magiera committed
159 160
}

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

	// 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
181 182

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

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

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

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

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

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

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

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

227 228 229
	// 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
230 231
}

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

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

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

253 254 255
	// 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)
256 257 258

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

261
	// List lists keys stored in keystore
262
	List(ctx context.Context) ([]Key, error)
263

264 265
	// 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
266 267
}

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

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

282 283 284 285 286 287 288 289 290 291
	// 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
292

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

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

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

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

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

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

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

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

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

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

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

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

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

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