filcold

Documentation

Index

• type FilChain
• type FilCold
  • func New(ms ffs.MinerSelector, dm *dealsModule.Module, ipfs iface.CoreAPI, ...) *FilCold
  • func (fc *FilCold) EnsureRenewals(ctx context.Context, c cid.Cid, inf ffs.FilInfo, cfg ffs.FilConfig) (ffs.FilInfo, []ffs.DealError, error)
  • func (fc *FilCold) Fetch(ctx context.Context, dataCid cid.Cid, waddr string) error
  • func (fc *FilCold) IsFilDealActive(ctx context.Context, proposalCid cid.Cid) (bool, error)
  • func (fc *FilCold) Store(ctx context.Context, c cid.Cid, cfg ffs.FilConfig) ([]cid.Cid, []ffs.DealError, uint64, error)
  • func (fc *FilCold) WaitForDeal(ctx context.Context, c cid.Cid, proposal cid.Cid) (ffs.FilStorage, error)

Types

type FilChain

type FilChain interface {
	GetHeight(context.Context) (uint64, error)
}

FilChain is an abstraction of a Filecoin node to get information of the network.

type FilCold

type FilCold struct {
	// contains filtered or unexported fields
}

FilCold is a ColdStorage implementation which saves data in the Filecoin network. It assumes the underlying Filecoin client has access to an IPFS node where data is stored.

func New

func New(ms ffs.MinerSelector, dm *dealsModule.Module, ipfs iface.CoreAPI, chain FilChain, l ffs.CidLogger) *FilCold

New returns a new FilCold instance.

func (*FilCold) EnsureRenewals

func (fc *FilCold) EnsureRenewals(ctx context.Context, c cid.Cid, inf ffs.FilInfo, cfg ffs.FilConfig) (ffs.FilInfo, []ffs.DealError, error)

EnsureRenewals analyzes a FilInfo state for a Cid and executes renewals considering the FilConfig desired configuration.

func (*FilCold) Fetch

func (fc *FilCold) Fetch(ctx context.Context, dataCid cid.Cid, waddr string) error

Fetch fetches the stored Cid data.The data will be considered available to the underlying blockstore.

func (*FilCold) IsFilDealActive

func (fc *FilCold) IsFilDealActive(ctx context.Context, proposalCid cid.Cid) (bool, error)

IsFilDealActive returns true if a deal is considered active on-chain, false otherwise.

func (*FilCold) Store

func (fc *FilCold) Store(ctx context.Context, c cid.Cid, cfg ffs.FilConfig) ([]cid.Cid, []ffs.DealError, uint64, error)

Store stores a Cid in Filecoin considering the configuration provided. The Cid is retrieved using the DAGService registered on instance creation. It returns a slice of ProposalCids that were correctly started, and a slice of with Proposal Cids rejected. Returned proposed deals can be tracked with the WaitForDeal API.

func (*FilCold) WaitForDeal

func (fc *FilCold) WaitForDeal(ctx context.Context, c cid.Cid, proposal cid.Cid) (ffs.FilStorage, error)

WaitForDeal blocks the provided Deal Proposal reaches a final state. If the deal finishes successfully it returns a FilStorage result. If the deal finished with error, it returns a ffs.DealError error result, so it should be considered in error handling.