Documentation ¶
Index ¶
- Constants
- type Asks
- type Client
- type Deals
- func (d *Deals) Retrieve(ctx context.Context, waddr string, cid cid.Cid) (io.Reader, error)
- func (d *Deals) Store(ctx context.Context, addr string, data io.Reader, ...) ([]cid.Cid, []deals.StorageDealConfig, error)
- func (d *Deals) Watch(ctx context.Context, proposals []cid.Cid) (<-chan WatchEvent, error)
- type FFS
- func (f *FFS) AddToHot(ctx context.Context, data io.Reader) (*cid.Cid, error)
- func (f *FFS) Addrs(ctx context.Context) ([]api.AddrInfo, error)
- func (f *FFS) Close(ctx context.Context) error
- func (f *FFS) Create(ctx context.Context) (string, string, error)
- func (f *FFS) DefaultConfig(ctx context.Context) (ffs.DefaultConfig, error)
- func (f *FFS) Get(ctx context.Context, c cid.Cid) (io.Reader, error)
- func (f *FFS) GetCidConfig(ctx context.Context, c cid.Cid) (*rpc.GetCidConfigReply, error)
- func (f *FFS) GetDefaultCidConfig(ctx context.Context, c cid.Cid) (ffs.CidConfig, error)
- func (f *FFS) ID(ctx context.Context) (ffs.APIID, error)
- func (f *FFS) Info(ctx context.Context) (api.InstanceInfo, error)
- func (f *FFS) ListAPI(ctx context.Context) ([]ffs.APIID, error)
- func (f *FFS) NewAddr(ctx context.Context, name string, options ...NewAddressOption) (string, error)
- func (f *FFS) PushConfig(ctx context.Context, c cid.Cid, opts ...PushConfigOption) (ffs.JobID, error)
- func (f *FFS) Remove(ctx context.Context, c cid.Cid) error
- func (f *FFS) Replace(ctx context.Context, c1 cid.Cid, c2 cid.Cid) (ffs.JobID, error)
- func (f *FFS) SendFil(ctx context.Context, from string, to string, amount int64) error
- func (f *FFS) SetDefaultConfig(ctx context.Context, config ffs.DefaultConfig) error
- func (f *FFS) Show(ctx context.Context, c cid.Cid) (*rpc.ShowReply, error)
- func (f *FFS) WatchJobs(ctx context.Context, ch chan<- JobEvent, jids ...ffs.JobID) error
- func (f *FFS) WatchLogs(ctx context.Context, ch chan<- LogEvent, c cid.Cid, opts ...WatchLogsOption) error
- type Health
- type JobEvent
- type LogEvent
- type Miners
- type Net
- func (net *Net) ConnectPeer(ctx context.Context, addrInfo peer.AddrInfo) error
- func (net *Net) Connectedness(ctx context.Context, peerID peer.ID) (n.Connectedness, error)
- func (net *Net) DisconnectPeer(ctx context.Context, peerID peer.ID) error
- func (net *Net) FindPeer(ctx context.Context, peerID peer.ID) (n.PeerInfo, error)
- func (net *Net) ListenAddr(ctx context.Context) (peer.AddrInfo, error)
- func (net *Net) Peers(ctx context.Context) ([]n.PeerInfo, error)
- type NewAddressOption
- type PushConfigOption
- type Reputation
- type Slashing
- type TokenAuth
- type Wallet
- type WatchEvent
- type WatchLogsOption
Constants ¶
const AuthKey = ctxKey("ffstoken")
AuthKey is the key that should be used to set the auth token in a Context
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Asks ¶
type Asks struct {
// contains filtered or unexported fields
}
Asks provides an API for viewing asks data
type Client ¶
type Client struct { Asks *Asks Miners *Miners Slashing *Slashing Deals *Deals Wallet *Wallet Reputation *Reputation FFS *FFS Health *Health Net *Net // contains filtered or unexported fields }
Client provides the client api
type Deals ¶
type Deals struct {
// contains filtered or unexported fields
}
Deals provides an API for managing deals and storing data
func (*Deals) Store ¶
func (d *Deals) Store(ctx context.Context, addr string, data io.Reader, dealConfigs []deals.StorageDealConfig, duration uint64) ([]cid.Cid, []deals.StorageDealConfig, error)
Store creates a proposal deal for data using wallet addr to all miners indicated by dealConfigs for duration epochs
type FFS ¶
type FFS struct {
// contains filtered or unexported fields
}
FFS provides the API to create and interact with an FFS instance
func (*FFS) AddToHot ¶
AddToHot allows you to add data to the Hot layer in preparation for pushing a cid config
func (*FFS) DefaultConfig ¶
DefaultConfig returns the default storage config
func (*FFS) GetCidConfig ¶
GetCidConfig gets the current config for a cid
func (*FFS) GetDefaultCidConfig ¶
GetDefaultCidConfig returns a CidConfig built from the default storage config and prepped for the provided cid
func (*FFS) NewAddr ¶
func (f *FFS) NewAddr(ctx context.Context, name string, options ...NewAddressOption) (string, error)
NewAddr created a new wallet address managed by the FFS instance
func (*FFS) PushConfig ¶
func (f *FFS) PushConfig(ctx context.Context, c cid.Cid, opts ...PushConfigOption) (ffs.JobID, error)
PushConfig push a new configuration for the Cid in the Hot and Cold layers
func (*FFS) Remove ¶
Remove removes a Cid from being tracked as an active storage. The Cid should have both Hot and Cold storage disabled, if that isn't the case it will return ErrActiveInStorage.
func (*FFS) Replace ¶
Replace pushes a CidConfig of c2 equal to c1, and removes c1. This operation is more efficient than manually removing and adding in two separate operations.
func (*FFS) SendFil ¶
SendFil sends fil from a managed address to any another address, returns immediately but funds are sent asynchronously
func (*FFS) SetDefaultConfig ¶
SetDefaultConfig sets the default storage config
func (*FFS) WatchJobs ¶
WatchJobs pushes JobEvents to the provided channel. The provided channel will be owned by the client after the call, so it shouldn't be closed by the client. To stop receiving events, the provided ctx should be canceled. If an error occurs, it will be returned in the Err field of JobEvent and the channel will be closed.
func (*FFS) WatchLogs ¶
func (f *FFS) WatchLogs(ctx context.Context, ch chan<- LogEvent, c cid.Cid, opts ...WatchLogsOption) error
WatchLogs pushes human-friendly messages about Cid executions. The method is blocking and will continue to send messages until the context is canceled. The provided channel is owned by the method and must not be closed.
type Health ¶
type Health struct {
// contains filtered or unexported fields
}
Health provides an API for checking node Health
type Miners ¶
type Miners struct {
// contains filtered or unexported fields
}
Miners provides an API for viewing miner data
type Net ¶
type Net struct {
// contains filtered or unexported fields
}
Net provides the Net API
func (*Net) ConnectPeer ¶
ConnectPeer connects to a peer
func (*Net) Connectedness ¶
Connectedness returns the connection status to a peer
func (*Net) DisconnectPeer ¶
DisconnectPeer disconnects from a peer
func (*Net) ListenAddr ¶
ListenAddr returns listener address info for the local node
type NewAddressOption ¶
type NewAddressOption func(r *rpc.NewAddrRequest)
NewAddressOption is a function that changes a NewAddressConfig
func WithAddressType ¶
func WithAddressType(addressType string) NewAddressOption
WithAddressType specifies the type of address to create
func WithMakeDefault ¶
func WithMakeDefault(makeDefault bool) NewAddressOption
WithMakeDefault specifies if the new address should become the default
type PushConfigOption ¶
type PushConfigOption func(r *rpc.PushConfigRequest)
PushConfigOption mutates a push request.
func WithCidConfig ¶
func WithCidConfig(c ffs.CidConfig) PushConfigOption
WithCidConfig overrides the Api default Cid configuration.
func WithOverride ¶
func WithOverride(override bool) PushConfigOption
WithOverride allows a new push configuration to override an existing one. It's used as an extra security measure to avoid unwanted configuration changes.
type Reputation ¶
type Reputation struct {
// contains filtered or unexported fields
}
Reputation provides an API for viewing reputation data
func (*Reputation) AddSource ¶
AddSource adds a new external Source to be considered for reputation generation
func (*Reputation) GetTopMiners ¶
func (r *Reputation) GetTopMiners(ctx context.Context, limit int) ([]reputation.MinerScore, error)
GetTopMiners gets the top n miners with best score
type Slashing ¶
type Slashing struct {
// contains filtered or unexported fields
}
Slashing provides an API for viewing slashing data
type TokenAuth ¶
type TokenAuth struct {
// contains filtered or unexported fields
}
TokenAuth provides token based auth
func (TokenAuth) GetRequestMetadata ¶
GetRequestMetadata returns request metadata that includes the auth token
func (TokenAuth) RequireTransportSecurity ¶
RequireTransportSecurity specifies if the connection should be secure
type Wallet ¶
type Wallet struct {
// contains filtered or unexported fields
}
Wallet provides an API for managing filecoin wallets
type WatchEvent ¶
WatchEvent is used to send data or error values for Watch
type WatchLogsOption ¶
type WatchLogsOption func(r *rpc.WatchLogsRequest)
WatchLogsOption is a function that changes GetLogsConfig.
func WithHistory ¶
func WithHistory(enabled bool) WatchLogsOption
WithHistory indicates that prior history logs should be sent in the channel before getting real time logs.
func WithJidFilter ¶
func WithJidFilter(jid ffs.JobID) WatchLogsOption
WithJidFilter filters only log messages of a Cid related to the Job with id jid.