mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-21 18:37:45 +08:00
coreapi: split the interface into multiple files
License: MIT Signed-off-by: Łukasz Magiera <magik6k@gmail.com> This commit was moved from ipfs/interface-go-ipfs-core@d4077754e8 This commit was moved from ipfs/boxo@a05b8c4e76
This commit is contained in:
Łukasz Magiera
parent
3f4a3d5524
commit
cdda2d3e4b
49
core/coreiface/block.go
Normal file
49
core/coreiface/block.go
Normal file
@ -0,0 +1,49 @@
|
||||
package iface
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
|
||||
options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
|
||||
)
|
||||
|
||||
// BlockStat contains information about a block
|
||||
type BlockStat interface {
|
||||
// Size is the size of a block
|
||||
Size() int
|
||||
|
||||
// Path returns path to the block
|
||||
Path() Path
|
||||
}
|
||||
|
||||
// BlockAPI specifies the interface to the block layer
|
||||
type BlockAPI interface {
|
||||
// Put imports raw block data, hashing it using specified settings.
|
||||
Put(context.Context, io.Reader, ...options.BlockPutOption) (Path, error)
|
||||
|
||||
// WithFormat is an option for Put which specifies the multicodec to use to
|
||||
// serialize the object. Default is "v0"
|
||||
WithFormat(codec string) options.BlockPutOption
|
||||
|
||||
// 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
|
||||
WithHash(mhType uint64, mhLen int) options.BlockPutOption
|
||||
|
||||
// Get attempts to resolve the path and return a reader for data in the block
|
||||
Get(context.Context, Path) (io.Reader, error)
|
||||
|
||||
// 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
|
||||
Rm(context.Context, Path, ...options.BlockRmOption) error
|
||||
|
||||
// WithForce is an option for Rm which, when set to true, will ignore
|
||||
// non-existing blocks
|
||||
WithForce(force bool) options.BlockRmOption
|
||||
|
||||
// Stat returns information on
|
||||
Stat(context.Context, Path) (BlockStat, error)
|
||||
}
|
||||
38
core/coreiface/coreapi.go
Normal file
38
core/coreiface/coreapi.go
Normal file
@ -0,0 +1,38 @@
|
||||
// Package iface defines IPFS Core API which is a set of interfaces used to
|
||||
// interact with IPFS nodes.
|
||||
package iface
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
ipld "gx/ipfs/Qme5bWv7wtjUNGsK2BNGVUFPKiuxWrsqrtvYwCLRw8YFES/go-ipld-format"
|
||||
)
|
||||
|
||||
// CoreAPI defines an unified interface to IPFS for Go programs.
|
||||
type CoreAPI interface {
|
||||
// Unixfs returns an implementation of Unixfs API.
|
||||
Unixfs() UnixfsAPI
|
||||
|
||||
// Block returns an implementation of Block API.
|
||||
Block() BlockAPI
|
||||
|
||||
// Dag returns an implementation of Dag API.
|
||||
Dag() DagAPI
|
||||
|
||||
// Name returns an implementation of Name API.
|
||||
Name() NameAPI
|
||||
|
||||
// Key returns an implementation of Key API.
|
||||
Key() KeyAPI
|
||||
Pin() PinAPI
|
||||
|
||||
// ObjectAPI returns an implementation of Object API
|
||||
Object() ObjectAPI
|
||||
|
||||
// ResolvePath resolves the path using Unixfs resolver
|
||||
ResolvePath(context.Context, Path) (Path, error)
|
||||
|
||||
// ResolveNode resolves the path (if not resolved already) using Unixfs
|
||||
// resolver, gets and returns the resolved Node
|
||||
ResolveNode(context.Context, Path) (ipld.Node, error)
|
||||
}
|
||||
42
core/coreiface/dag.go
Normal file
42
core/coreiface/dag.go
Normal file
@ -0,0 +1,42 @@
|
||||
package iface
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
|
||||
options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
|
||||
|
||||
ipld "gx/ipfs/Qme5bWv7wtjUNGsK2BNGVUFPKiuxWrsqrtvYwCLRw8YFES/go-ipld-format"
|
||||
)
|
||||
|
||||
// DagAPI specifies the interface to IPLD
|
||||
type DagAPI interface {
|
||||
// Put inserts data using specified format and input encoding.
|
||||
// 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)
|
||||
|
||||
// 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
|
||||
|
||||
// Get attempts to resolve and get the node specified by the path
|
||||
Get(ctx context.Context, path Path) (ipld.Node, error)
|
||||
|
||||
// Tree returns list of paths within a node specified by the path.
|
||||
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
|
||||
}
|
||||
6
core/coreiface/errors.go
Normal file
6
core/coreiface/errors.go
Normal file
@ -0,0 +1,6 @@
|
||||
package iface
|
||||
|
||||
import "errors"
|
||||
|
||||
var ErrIsDir = errors.New("object is a directory")
|
||||
var ErrOffline = errors.New("can't resolve, ipfs node is offline")
|
||||
@ -1,384 +0,0 @@
|
||||
// Package iface defines IPFS Core API which is a set of interfaces used to
|
||||
// interact with IPFS nodes.
|
||||
package iface
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"io"
|
||||
"time"
|
||||
|
||||
options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
|
||||
|
||||
cid "gx/ipfs/QmcZfnkapfECQGcLZaf9B79NRg7cRa9EnZh4LSbkCzwNvY/go-cid"
|
||||
ipld "gx/ipfs/Qme5bWv7wtjUNGsK2BNGVUFPKiuxWrsqrtvYwCLRw8YFES/go-ipld-format"
|
||||
)
|
||||
|
||||
var ErrIsDir = errors.New("object is a directory")
|
||||
var ErrOffline = errors.New("can't resolve, ipfs node is offline")
|
||||
|
||||
// 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.
|
||||
type Path interface {
|
||||
// String returns the path as a string.
|
||||
String() string
|
||||
// Cid returns cid referred to by path
|
||||
Cid() *cid.Cid
|
||||
// Root returns cid of root path
|
||||
Root() *cid.Cid
|
||||
// Resolved returns whether path has been fully resolved
|
||||
Resolved() bool
|
||||
}
|
||||
|
||||
type Reader interface {
|
||||
io.ReadSeeker
|
||||
io.Closer
|
||||
}
|
||||
|
||||
// IpnsEntry specifies the interface to IpnsEntries
|
||||
type IpnsEntry interface {
|
||||
// Name returns IpnsEntry name
|
||||
Name() string
|
||||
// Value returns IpnsEntry value
|
||||
Value() Path
|
||||
}
|
||||
|
||||
// Key specifies the interface to Keys in KeyAPI Keystore
|
||||
type Key interface {
|
||||
// Key returns key name
|
||||
Name() string
|
||||
// Path returns key path
|
||||
Path() Path
|
||||
}
|
||||
|
||||
type BlockStat interface {
|
||||
Size() int
|
||||
Path() Path
|
||||
}
|
||||
|
||||
// Pin holds information about pinned resource
|
||||
type Pin interface {
|
||||
// Path to the pinned object
|
||||
Path() Path
|
||||
|
||||
// Type of the pin
|
||||
Type() string
|
||||
}
|
||||
|
||||
// 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
|
||||
}
|
||||
|
||||
// CoreAPI defines an unified interface to IPFS for Go programs.
|
||||
type CoreAPI interface {
|
||||
// Unixfs returns an implementation of Unixfs API.
|
||||
Unixfs() UnixfsAPI
|
||||
|
||||
// Block returns an implementation of Block API.
|
||||
Block() BlockAPI
|
||||
|
||||
// Dag returns an implementation of Dag API.
|
||||
Dag() DagAPI
|
||||
|
||||
// Name returns an implementation of Name API.
|
||||
Name() NameAPI
|
||||
|
||||
// Key returns an implementation of Key API.
|
||||
Key() KeyAPI
|
||||
Pin() PinAPI
|
||||
|
||||
// ObjectAPI returns an implementation of Object API
|
||||
Object() ObjectAPI
|
||||
|
||||
// ResolvePath resolves the path using Unixfs resolver
|
||||
ResolvePath(context.Context, Path) (Path, error)
|
||||
|
||||
// ResolveNode resolves the path (if not resolved already) using Unixfs
|
||||
// resolver, gets and returns the resolved Node
|
||||
ResolveNode(context.Context, Path) (ipld.Node, error)
|
||||
}
|
||||
|
||||
// UnixfsAPI is the basic interface to immutable files in IPFS
|
||||
type UnixfsAPI interface {
|
||||
// Add imports the data from the reader into merkledag file
|
||||
Add(context.Context, io.Reader) (Path, error)
|
||||
|
||||
// Cat returns a reader for the file
|
||||
Cat(context.Context, Path) (Reader, error)
|
||||
|
||||
// Ls returns the list of links in a directory
|
||||
Ls(context.Context, Path) ([]*ipld.Link, error)
|
||||
}
|
||||
|
||||
// BlockAPI specifies the interface to the block layer
|
||||
type BlockAPI interface {
|
||||
// Put imports raw block data, hashing it using specified settings.
|
||||
Put(context.Context, io.Reader, ...options.BlockPutOption) (Path, error)
|
||||
|
||||
// WithFormat is an option for Put which specifies the multicodec to use to
|
||||
// serialize the object. Default is "v0"
|
||||
WithFormat(codec string) options.BlockPutOption
|
||||
|
||||
// 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
|
||||
WithHash(mhType uint64, mhLen int) options.BlockPutOption
|
||||
|
||||
// Get attempts to resolve the path and return a reader for data in the block
|
||||
Get(context.Context, Path) (io.Reader, error)
|
||||
|
||||
// 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
|
||||
Rm(context.Context, Path, ...options.BlockRmOption) error
|
||||
|
||||
// WithForce is an option for Rm which, when set to true, will ignore
|
||||
// non-existing blocks
|
||||
WithForce(force bool) options.BlockRmOption
|
||||
|
||||
// Stat returns information on
|
||||
Stat(context.Context, Path) (BlockStat, error)
|
||||
}
|
||||
|
||||
// DagAPI specifies the interface to IPLD
|
||||
type DagAPI interface {
|
||||
// Put inserts data using specified format and input encoding.
|
||||
// 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)
|
||||
|
||||
// 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
|
||||
|
||||
// Get attempts to resolve and get the node specified by the path
|
||||
Get(ctx context.Context, path Path) (ipld.Node, error)
|
||||
|
||||
// Tree returns list of paths within a node specified by the path.
|
||||
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
|
||||
}
|
||||
|
||||
// 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, opts ...options.NamePublishOption) (IpnsEntry, error)
|
||||
|
||||
// WithValidTime is an option for Publish which specifies for how long the
|
||||
// entry will remain valid. Default value is 24h
|
||||
WithValidTime(validTime time.Duration) options.NamePublishOption
|
||||
|
||||
// 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.
|
||||
// The key parameter must be either PeerID or keystore key alias.
|
||||
//
|
||||
// You can use KeyAPI to list and generate more names and their respective keys.
|
||||
WithKey(key string) options.NamePublishOption
|
||||
|
||||
// Resolve attempts to resolve the newest version of the specified name
|
||||
Resolve(ctx context.Context, name string, opts ...options.NameResolveOption) (Path, error)
|
||||
|
||||
// WithRecursive is an option for Resolve which specifies whether to perform a
|
||||
// recursive lookup. Default value is false
|
||||
WithRecursive(recursive bool) options.NameResolveOption
|
||||
|
||||
// WithLocal is an option for Resolve which specifies if the lookup should be
|
||||
// offline. Default value is false
|
||||
WithLocal(local bool) options.NameResolveOption
|
||||
|
||||
// WithCache is an option for Resolve which specifies if cache should be used.
|
||||
// Default value is true
|
||||
WithCache(cache bool) options.NameResolveOption
|
||||
}
|
||||
|
||||
// KeyAPI specifies the interface to Keystore
|
||||
type KeyAPI interface {
|
||||
// Generate generates new key, stores it in the keystore under the specified
|
||||
// name and returns a base58 encoded multihash of it's public key
|
||||
Generate(ctx context.Context, name string, opts ...options.KeyGenerateOption) (Key, error)
|
||||
|
||||
// WithType is an option for Generate which specifies which algorithm
|
||||
// should be used for the key. Default is options.RSAKey
|
||||
//
|
||||
// Supported key types:
|
||||
// * options.RSAKey
|
||||
// * options.Ed25519Key
|
||||
WithType(algorithm string) options.KeyGenerateOption
|
||||
|
||||
// WithSize is an option for Generate which specifies the size of the key to
|
||||
// generated. Default is -1
|
||||
//
|
||||
// value of -1 means 'use default size for key type':
|
||||
// * 2048 for RSA
|
||||
WithSize(size int) options.KeyGenerateOption
|
||||
|
||||
// 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)
|
||||
|
||||
// WithForce is an option for Rename which specifies whether to allow to
|
||||
// replace existing keys.
|
||||
WithForce(force bool) options.KeyRenameOption
|
||||
|
||||
// List lists keys stored in keystore
|
||||
List(ctx context.Context) ([]Key, error)
|
||||
|
||||
// Remove removes keys from keystore. Returns ipns path of the removed key
|
||||
Remove(ctx context.Context, name string) (Path, error)
|
||||
}
|
||||
|
||||
// ObjectAPI specifies the interface to MerkleDAG and contains useful utilities
|
||||
// for manipulating MerkleDAG data structures.
|
||||
type ObjectAPI interface {
|
||||
// New creates new, empty (by default) dag-node.
|
||||
New(context.Context, ...options.ObjectNewOption) (ipld.Node, error)
|
||||
|
||||
// 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
|
||||
WithType(string) options.ObjectNewOption
|
||||
|
||||
// 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
|
||||
|
||||
// WithDataType specifies the encoding of data field when using Josn or XML
|
||||
// input encoding.
|
||||
//
|
||||
// Supported types:
|
||||
// * "text" (default)
|
||||
// * "base64"
|
||||
WithDataType(t string) options.ObjectPutOption
|
||||
|
||||
// Get returns the node for the path
|
||||
Get(context.Context, Path) (ipld.Node, error)
|
||||
|
||||
// Data returns reader for data of the node
|
||||
Data(context.Context, Path) (io.Reader, error)
|
||||
|
||||
// Links returns lint or links the node contains
|
||||
Links(context.Context, Path) ([]*ipld.Link, error)
|
||||
|
||||
// Stat returns information about the node
|
||||
Stat(context.Context, Path) (*ObjectStat, error)
|
||||
|
||||
// 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).
|
||||
AddLink(ctx context.Context, base Path, name string, child Path, opts ...options.ObjectAddLinkOption) (Path, error)
|
||||
|
||||
// WithCreate is an option for AddLink which specifies whether create required
|
||||
// directories for the child
|
||||
WithCreate(create bool) options.ObjectAddLinkOption
|
||||
|
||||
// RmLink removes a link from the node
|
||||
RmLink(ctx context.Context, base Path, link string) (Path, error)
|
||||
|
||||
// AppendData appends data to the node
|
||||
AppendData(context.Context, Path, io.Reader) (Path, error)
|
||||
|
||||
// SetData sets the data contained in the node
|
||||
SetData(context.Context, Path, io.Reader) (Path, error)
|
||||
}
|
||||
|
||||
// ObjectStat provides information about dag nodes
|
||||
type ObjectStat struct {
|
||||
// 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
|
||||
|
||||
// CumulativeSize is size of the tree (BlockSize + link sizes)
|
||||
CumulativeSize int
|
||||
}
|
||||
|
||||
// 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, ...options.PinLsOption) ([]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, opts ...options.PinUpdateOption) error
|
||||
|
||||
// Verify verifies the integrity of pinned objects
|
||||
Verify(context.Context) (<-chan PinStatus, error)
|
||||
}
|
||||
51
core/coreiface/key.go
Normal file
51
core/coreiface/key.go
Normal file
@ -0,0 +1,51 @@
|
||||
package iface
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
|
||||
)
|
||||
|
||||
// Key specifies the interface to Keys in KeyAPI Keystore
|
||||
type Key interface {
|
||||
// Key returns key name
|
||||
Name() string
|
||||
// Path returns key path
|
||||
Path() Path
|
||||
}
|
||||
|
||||
// KeyAPI specifies the interface to Keystore
|
||||
type KeyAPI interface {
|
||||
// Generate generates new key, stores it in the keystore under the specified
|
||||
// name and returns a base58 encoded multihash of it's public key
|
||||
Generate(ctx context.Context, name string, opts ...options.KeyGenerateOption) (Key, error)
|
||||
|
||||
// WithType is an option for Generate which specifies which algorithm
|
||||
// should be used for the key. Default is options.RSAKey
|
||||
//
|
||||
// Supported key types:
|
||||
// * options.RSAKey
|
||||
// * options.Ed25519Key
|
||||
WithType(algorithm string) options.KeyGenerateOption
|
||||
|
||||
// WithSize is an option for Generate which specifies the size of the key to
|
||||
// generated. Default is -1
|
||||
//
|
||||
// value of -1 means 'use default size for key type':
|
||||
// * 2048 for RSA
|
||||
WithSize(size int) options.KeyGenerateOption
|
||||
|
||||
// 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)
|
||||
|
||||
// WithForce is an option for Rename which specifies whether to allow to
|
||||
// replace existing keys.
|
||||
WithForce(force bool) options.KeyRenameOption
|
||||
|
||||
// List lists keys stored in keystore
|
||||
List(ctx context.Context) ([]Key, error)
|
||||
|
||||
// Remove removes keys from keystore. Returns ipns path of the removed key
|
||||
Remove(ctx context.Context, name string) (Path, error)
|
||||
}
|
||||
55
core/coreiface/name.go
Normal file
55
core/coreiface/name.go
Normal file
@ -0,0 +1,55 @@
|
||||
package iface
|
||||
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
|
||||
)
|
||||
|
||||
// IpnsEntry specifies the interface to IpnsEntries
|
||||
type IpnsEntry interface {
|
||||
// Name returns IpnsEntry name
|
||||
Name() string
|
||||
// Value returns IpnsEntry value
|
||||
Value() Path
|
||||
}
|
||||
|
||||
// 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, opts ...options.NamePublishOption) (IpnsEntry, error)
|
||||
|
||||
// WithValidTime is an option for Publish which specifies for how long the
|
||||
// entry will remain valid. Default value is 24h
|
||||
WithValidTime(validTime time.Duration) options.NamePublishOption
|
||||
|
||||
// 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.
|
||||
// The key parameter must be either PeerID or keystore key alias.
|
||||
//
|
||||
// You can use KeyAPI to list and generate more names and their respective keys.
|
||||
WithKey(key string) options.NamePublishOption
|
||||
|
||||
// Resolve attempts to resolve the newest version of the specified name
|
||||
Resolve(ctx context.Context, name string, opts ...options.NameResolveOption) (Path, error)
|
||||
|
||||
// WithRecursive is an option for Resolve which specifies whether to perform a
|
||||
// recursive lookup. Default value is false
|
||||
WithRecursive(recursive bool) options.NameResolveOption
|
||||
|
||||
// WithLocal is an option for Resolve which specifies if the lookup should be
|
||||
// offline. Default value is false
|
||||
WithLocal(local bool) options.NameResolveOption
|
||||
|
||||
// WithCache is an option for Resolve which specifies if cache should be used.
|
||||
// Default value is true
|
||||
WithCache(cache bool) options.NameResolveOption
|
||||
}
|
||||
96
core/coreiface/object.go
Normal file
96
core/coreiface/object.go
Normal file
@ -0,0 +1,96 @@
|
||||
package iface
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
|
||||
options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
|
||||
|
||||
cid "gx/ipfs/QmcZfnkapfECQGcLZaf9B79NRg7cRa9EnZh4LSbkCzwNvY/go-cid"
|
||||
ipld "gx/ipfs/Qme5bWv7wtjUNGsK2BNGVUFPKiuxWrsqrtvYwCLRw8YFES/go-ipld-format"
|
||||
)
|
||||
|
||||
// ObjectStat provides information about dag nodes
|
||||
type ObjectStat struct {
|
||||
// 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
|
||||
|
||||
// CumulativeSize is size of the tree (BlockSize + link sizes)
|
||||
CumulativeSize int
|
||||
}
|
||||
|
||||
// ObjectAPI specifies the interface to MerkleDAG and contains useful utilities
|
||||
// for manipulating MerkleDAG data structures.
|
||||
type ObjectAPI interface {
|
||||
// New creates new, empty (by default) dag-node.
|
||||
New(context.Context, ...options.ObjectNewOption) (ipld.Node, error)
|
||||
|
||||
// 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
|
||||
WithType(string) options.ObjectNewOption
|
||||
|
||||
// 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
|
||||
|
||||
// WithDataType specifies the encoding of data field when using Josn or XML
|
||||
// input encoding.
|
||||
//
|
||||
// Supported types:
|
||||
// * "text" (default)
|
||||
// * "base64"
|
||||
WithDataType(t string) options.ObjectPutOption
|
||||
|
||||
// Get returns the node for the path
|
||||
Get(context.Context, Path) (ipld.Node, error)
|
||||
|
||||
// Data returns reader for data of the node
|
||||
Data(context.Context, Path) (io.Reader, error)
|
||||
|
||||
// Links returns lint or links the node contains
|
||||
Links(context.Context, Path) ([]*ipld.Link, error)
|
||||
|
||||
// Stat returns information about the node
|
||||
Stat(context.Context, Path) (*ObjectStat, error)
|
||||
|
||||
// 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).
|
||||
AddLink(ctx context.Context, base Path, name string, child Path, opts ...options.ObjectAddLinkOption) (Path, error)
|
||||
|
||||
// WithCreate is an option for AddLink which specifies whether create required
|
||||
// directories for the child
|
||||
WithCreate(create bool) options.ObjectAddLinkOption
|
||||
|
||||
// RmLink removes a link from the node
|
||||
RmLink(ctx context.Context, base Path, link string) (Path, error)
|
||||
|
||||
// AppendData appends data to the node
|
||||
AppendData(context.Context, Path, io.Reader) (Path, error)
|
||||
|
||||
// SetData sets the data contained in the node
|
||||
SetData(context.Context, Path, io.Reader) (Path, error)
|
||||
}
|
||||
18
core/coreiface/path.go
Normal file
18
core/coreiface/path.go
Normal file
@ -0,0 +1,18 @@
|
||||
package iface
|
||||
|
||||
import (
|
||||
cid "gx/ipfs/QmcZfnkapfECQGcLZaf9B79NRg7cRa9EnZh4LSbkCzwNvY/go-cid"
|
||||
)
|
||||
|
||||
// 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.
|
||||
type Path interface {
|
||||
// String returns the path as a string.
|
||||
String() string
|
||||
// Cid returns cid referred to by path
|
||||
Cid() *cid.Cid
|
||||
// Root returns cid of root path
|
||||
Root() *cid.Cid
|
||||
// Resolved returns whether path has been fully resolved
|
||||
Resolved() bool
|
||||
}
|
||||
69
core/coreiface/pin.go
Normal file
69
core/coreiface/pin.go
Normal file
@ -0,0 +1,69 @@
|
||||
package iface
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
|
||||
)
|
||||
|
||||
// Pin holds information about pinned resource
|
||||
type Pin interface {
|
||||
// Path to the pinned object
|
||||
Path() Path
|
||||
|
||||
// Type of the pin
|
||||
Type() string
|
||||
}
|
||||
|
||||
// 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
|
||||
}
|
||||
|
||||
// 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, ...options.PinLsOption) ([]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, opts ...options.PinUpdateOption) error
|
||||
|
||||
// Verify verifies the integrity of pinned objects
|
||||
Verify(context.Context) (<-chan PinStatus, error)
|
||||
}
|
||||
20
core/coreiface/unixfs.go
Normal file
20
core/coreiface/unixfs.go
Normal file
@ -0,0 +1,20 @@
|
||||
package iface
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
|
||||
ipld "gx/ipfs/Qme5bWv7wtjUNGsK2BNGVUFPKiuxWrsqrtvYwCLRw8YFES/go-ipld-format"
|
||||
)
|
||||
|
||||
// UnixfsAPI is the basic interface to immutable files in IPFS
|
||||
type UnixfsAPI interface {
|
||||
// Add imports the data from the reader into merkledag file
|
||||
Add(context.Context, io.Reader) (Path, error)
|
||||
|
||||
// Cat returns a reader for the file
|
||||
Cat(context.Context, Path) (Reader, error)
|
||||
|
||||
// Ls returns the list of links in a directory
|
||||
Ls(context.Context, Path) ([]*ipld.Link, error)
|
||||
}
|
||||
10
core/coreiface/util.go
Normal file
10
core/coreiface/util.go
Normal file
@ -0,0 +1,10 @@
|
||||
package iface
|
||||
|
||||
import (
|
||||
"io"
|
||||
)
|
||||
|
||||
type Reader interface {
|
||||
io.ReadSeeker
|
||||
io.Closer
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user