mirror of
https://github.com/ipfs/kubo.git
synced 2025-08-06 19:44:01 +08:00
42 lines
1.2 KiB
Go
42 lines
1.2 KiB
Go
package iface
|
|
|
|
import (
|
|
"context"
|
|
|
|
options "github.com/ipfs/go-ipfs/core/coreapi/interface/options"
|
|
|
|
"gx/ipfs/QmbNepETomvmXfz1X5pHNFD2QuPqnqi47dTd94QJWSorQ3/go-libp2p-peer"
|
|
)
|
|
|
|
// Key specifies the interface to Keys in KeyAPI Keystore
|
|
type Key interface {
|
|
// Key returns key name
|
|
Name() string
|
|
|
|
// Path returns key path
|
|
Path() Path
|
|
|
|
// ID returns key PeerID
|
|
ID() peer.ID
|
|
}
|
|
|
|
// 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)
|
|
|
|
// 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)
|
|
|
|
// List lists keys stored in keystore
|
|
List(ctx context.Context) ([]Key, error)
|
|
|
|
// Self returns the 'main' node key
|
|
Self(ctx context.Context) (Key, error)
|
|
|
|
// Remove removes keys from keystore. Returns ipns path of the removed key
|
|
Remove(ctx context.Context, name string) (Key, error)
|
|
}
|