client

package
v1.22.0-rc1-beta Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 11, 2023 License: Apache-2.0, MIT Imports: 69 Imported by: 0

Documentation

Index

Constants

View Source 
const DefaultDAGStoreDir = "dagstore"

Variables

View Source 
var DefaultHashFunction = unixfs.DefaultHashFunction

Functions

This section is empty.

Types

type API 

type API struct {
	fx.In

	full.ChainAPI
	full.WalletAPI
	paych.PaychAPI
	full.StateAPI

	SMDealClient storagemarket.StorageClient
	RetDiscovery discovery.PeerResolver
	Retrieval    rm.RetrievalClient
	Chain        *store.ChainStore

	// accessors for imports and retrievals.
	Imports                   dtypes.ClientImportMgr
	StorageBlockstoreAccessor storagemarket.BlockstoreAccessor
	RtvlBlockstoreAccessor    rm.BlockstoreAccessor
	ApiBlockstoreAccessor     *retrievaladapter.APIBlockstoreAccessor

	DataTransfer dtypes.ClientDataTransfer
	Host         host.Host

	Repo repo.LockedRepo
}

func (*API) ClientCalcCommP added in v0.3.0 

func (a *API) ClientCalcCommP(ctx context.Context, inpath string) (*api.CommPRet, error)

func (*API) ClientCancelDataTransfer added in v1.1.3 

func (a *API) ClientCancelDataTransfer(ctx context.Context, transferID datatransfer.TransferID, otherPeer peer.ID, isInitiator bool) error

func (*API) ClientCancelRetrievalDeal added in v1.9.0 

func (a *API) ClientCancelRetrievalDeal(ctx context.Context, dealID rm.DealID) error

func (*API) ClientDataTransferUpdates added in v0.5.0 

func (a *API) ClientDataTransferUpdates(ctx context.Context) (<-chan api.DataTransferChannel, error)

func (*API) ClientDealPieceCID added in v1.1.3 

func (a *API) ClientDealPieceCID(ctx context.Context, root cid.Cid) (api.DataCIDSize, error)

func (*API) ClientDealSize added in v0.5.0 

func (a *API) ClientDealSize(ctx context.Context, root cid.Cid) (api.DataSize, error)

func (*API) ClientExport added in v1.13.2 

func (a *API) ClientExport(ctx context.Context, exportRef api.ExportRef, ref api.FileRef) error

func (*API) ClientExportInto added in v1.13.2 

func (a *API) ClientExportInto(ctx context.Context, exportRef api.ExportRef, car bool, dest ExportDest) error

func (*API) ClientFindData 

func (a *API) ClientFindData(ctx context.Context, root cid.Cid, piece *cid.Cid) ([]api.QueryOffer, error)

func (*API) ClientGenCar added in v0.3.0 

func (a *API) ClientGenCar(ctx context.Context, ref api.FileRef, outputPath string) error

func (*API) ClientGetDealInfo 

func (a *API) ClientGetDealInfo(ctx context.Context, d cid.Cid) (*api.DealInfo, error)

func (*API) ClientGetDealStatus added in v1.1.1 

func (a *API) ClientGetDealStatus(ctx context.Context, statusCode uint64) (string, error)

func (*API) ClientGetDealUpdates added in v0.5.5 

func (a *API) ClientGetDealUpdates(ctx context.Context) (<-chan api.DealInfo, error)

func (*API) ClientGetRetrievalUpdates added in v1.11.0 

func (a *API) ClientGetRetrievalUpdates(ctx context.Context) (<-chan api.RetrievalInfo, error)

func (*API) ClientHasLocal 

func (a *API) ClientHasLocal(_ context.Context, root cid.Cid) (bool, error)

func (*API) ClientImport 

func (a *API) ClientImport(ctx context.Context, ref api.FileRef) (res *api.ImportRes, err error)

func (*API) ClientImportLocal 

func (a *API) ClientImportLocal(ctx context.Context, r io.Reader) (cid.Cid, error)

ClientImportLocal imports a standard file into this node as a UnixFS payload, storing it in a CARv2 file. Note that this method is NOT integrated with the IPFS blockstore. That is, if client-side IPFS integration is enabled, this method won't import the file into that

func (*API) ClientListDataTransfers added in v0.5.0 

func (a *API) ClientListDataTransfers(ctx context.Context) ([]api.DataTransferChannel, error)

func (*API) ClientListDeals 

func (a *API) ClientListDeals(ctx context.Context) ([]api.DealInfo, error)

func (*API) ClientListImports 

func (a *API) ClientListImports(_ context.Context) ([]api.Import, error)

func (*API) ClientListRetrievals added in v1.11.0 

func (a *API) ClientListRetrievals(ctx context.Context) ([]api.RetrievalInfo, error)

func (*API) ClientMinerQueryOffer added in v0.4.0 

func (a *API) ClientMinerQueryOffer(ctx context.Context, miner address.Address, root cid.Cid, piece *cid.Cid) (api.QueryOffer, error)

func (*API) ClientQueryAsk 

func (a *API) ClientQueryAsk(ctx context.Context, p peer.ID, miner address.Address) (*api.StorageAsk, error)

func (*API) ClientRemoveImport added in v0.5.0 

func (a *API) ClientRemoveImport(ctx context.Context, id imports.ID) error

func (*API) ClientRestartDataTransfer added in v0.10.1 

func (a *API) ClientRestartDataTransfer(ctx context.Context, transferID datatransfer.TransferID, otherPeer peer.ID, isInitiator bool) error

func (*API) ClientRetrieve 

func (a *API) ClientRetrieve(ctx context.Context, params api.RetrievalOrder) (*api.RestrievalRes, error)

func (*API) ClientRetrieveTryRestartInsufficientFunds added in v0.6.0 

func (a *API) ClientRetrieveTryRestartInsufficientFunds(ctx context.Context, paymentChannel address.Address) error

func (*API) ClientRetrieveWait added in v1.13.2 

func (a *API) ClientRetrieveWait(ctx context.Context, deal rm.DealID) error

func (*API) ClientStartDeal 

func (a *API) ClientStartDeal(ctx context.Context, params *api.StartDealParams) (*cid.Cid, error)

func (*API) ClientStatelessDeal added in v1.11.0 

func (a *API) ClientStatelessDeal(ctx context.Context, params *api.StartDealParams) (*cid.Cid, error)

type CarHeader added in v1.11.2 

type CarHeader struct {
	Roots   []cid.Cid
	Version uint64
}

type ExportDest added in v1.13.2 

type ExportDest struct {
	Writer io.Writer
	Path   string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.