Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

filclient

package module

Go to main page

Versions in this module

v0

v0.5.0-rc1

Jan 25, 2023

v0.4.0

Nov 24, 2022

Changes in this version

type FilClient

+ func (fc *FilClient) RetrieveContentFromPeerAsync(ctx context.Context, peerID peer.ID, minerWallet address.Address, ...) (result <-chan RetrievalResult, onProgress <-chan uint64, ...)

+ type RetrievalResult struct

+ Err error

v0.3.0

Oct 21, 2022

Changes in this version

type FilClient

+ func (fc *FilClient) GetDtMgr() datatransfer.Manager

v0.2.0

Aug 23, 2022

Changes in this version

+ const DealProtocolv110

+ const DealProtocolv120

+ const DealStatusProtocolv110

+ const DealStatusProtocolv120

+ const QueryAskProtocol

+ const RetrievalQueryProtocol

+ var ErrNoTransferFound = fmt.Errorf("no transfer found")

+ var Tracer trace.Tracer = otel.Tracer("filclient")

+ func ChannelIDFromString(id string) (*datatransfer.ChannelID, error)

+ func ComputePrice(askPrice types.BigInt, size abi.PaddedPieceSize, duration abi.ChainEpoch) (*abi.TokenAmount, error)

+ func GeneratePieceCommitment(ctx context.Context, payloadCid cid.Cid, bstore blockstore.Blockstore) (cid.Cid, uint64, abi.UnpaddedPieceSize, error)

+ func GeneratePieceCommitmentFFI(ctx context.Context, payloadCid cid.Cid, bstore blockstore.Blockstore) (cid.Cid, uint64, abi.UnpaddedPieceSize, error)

+ func NewErrLotusError(err error) error

+ func NewErrMinerConnectionFailed(err error) error

+ func NewErrUnknown(err error) error

+ func ZeroPadPieceCommitment(c cid.Cid, curSize abi.UnpaddedPieceSize, toSize abi.UnpaddedPieceSize) (cid.Cid, error)

+ type Balance struct

+ Account address.Address

+ Balance types.FIL

+ MarketAvailable types.FIL

+ MarketEscrow types.FIL

+ MarketLocked types.FIL

+ VerifiedClientBalance *abi.StoragePower

+ type ChannelState struct

+ BaseCid string

+ ChannelID datatransfer.ChannelID

+ Message string

+ Received uint64

+ RemotePeer peer.ID

+ SelfPeer peer.ID

+ Sent uint64

+ Stages *datatransfer.ChannelStages

+ Status datatransfer.Status

+ StatusStr string

+ TransferID string

+ TransferType TransferType

+ func ChannelStateConv(st datatransfer.ChannelState) *ChannelState

+ type Config struct

+ Addr address.Address

+ Api api.Gateway

+ Blockstore blockstore.Blockstore

+ ChannelMonitorConfig channelmonitor.Config

+ DataDir string

+ Datastore datastore.Batching

+ GraphsyncOpts []gsimpl.Option

+ Host host.Host

+ LogRetrievalProgressEvents bool

+ Lp2pDTConfig Lp2pDTConfig

+ RetrievalConfigurer datatransfer.TransportConfigurer

+ Wallet *wallet.LocalWallet

+ type Error struct

+ Code ErrorCode

+ Inner error

+ func NewError(code ErrorCode, err error) *Error

+ func (err *Error) Error() string

+ func (err *Error) Unwrap() error

+ type ErrorCode int

+ const ErrLotusError

+ const ErrMinerConnectionFailed

+ const ErrUnknown

+ func (code ErrorCode) String() string

+ type FilClient struct

+ ClientAddr address.Address

+ Libp2pTransferMgr *libp2pTransferManager

+ func NewClient(h host.Host, api api.Gateway, w *wallet.LocalWallet, addr address.Address, ...) (*FilClient, error)

+ func NewClientWithConfig(cfg *Config) (*FilClient, error)

+ func (fc *FilClient) Balance(ctx context.Context) (*Balance, error)

+ func (fc *FilClient) CheckChainDeal(ctx context.Context, dealid abi.DealID) (bool, *api.MarketDeal, error)

+ func (fc *FilClient) CheckOngoingTransfer(ctx context.Context, miner address.Address, st *ChannelState) (outerr error)

+ func (fc *FilClient) ConnectToMiner(ctx context.Context, maddr address.Address) (peer.ID, error)

+ func (fc *FilClient) DealProtocolForMiner(ctx context.Context, miner address.Address) (protocol.ID, error)

+ func (fc *FilClient) DealStatus(ctx context.Context, miner address.Address, propCid cid.Cid, ...) (*storagemarket.ProviderDealState, error)

+ func (fc *FilClient) GetAsk(ctx context.Context, maddr address.Address) (*network.AskResponse, error)

+ func (fc *FilClient) GetMinerVersion(ctx context.Context, maddr address.Address) (string, error)

+ func (fc *FilClient) GraphSyncStats() graphsync.Stats

+ func (fc *FilClient) LockMarketFunds(ctx context.Context, amt types.FIL) (*LockFundsResp, error)

+ func (fc *FilClient) MakeDeal(ctx context.Context, miner address.Address, data cid.Cid, price types.BigInt, ...) (*network.Proposal, error)

+ func (fc *FilClient) MinerPeer(ctx context.Context, miner address.Address) (peer.AddrInfo, error)

+ func (fc *FilClient) MinerTransferDiagnostics(ctx context.Context, miner address.Address) (*MinerTransferDiagnostics, error)

+ func (fc *FilClient) OnRetrievalEvent(event rep.RetrievalEvent)

+ func (fc *FilClient) RestartTransfer(ctx context.Context, chanid *datatransfer.ChannelID) error

+ func (fc *FilClient) RetrievalQuery(ctx context.Context, maddr address.Address, pcid cid.Cid) (*retrievalmarket.QueryResponse, error)

+ func (fc *FilClient) RetrievalQueryToPeer(ctx context.Context, minerPeer peer.AddrInfo, pcid cid.Cid) (*retrievalmarket.QueryResponse, error)

+ func (fc *FilClient) RetrieveContent(ctx context.Context, miner address.Address, ...) (*RetrievalStats, error)

+ func (fc *FilClient) RetrieveContentFromPeerWithProgressCallback(ctx context.Context, peerID peer.ID, minerWallet address.Address, ...) (*RetrievalStats, error)

+ func (fc *FilClient) RetrieveContentWithProgressCallback(ctx context.Context, miner address.Address, ...) (*RetrievalStats, error)

+ func (fc *FilClient) SendProposalV110(ctx context.Context, netprop network.Proposal, propCid cid.Cid) (bool, error)

+ func (fc *FilClient) SendProposalV120(ctx context.Context, dbid uint, netprop network.Proposal, dealUUID uuid.UUID, ...) (bool, error)

+ func (fc *FilClient) SetPieceCommFunc(pcf GetPieceCommFunc)

+ func (fc *FilClient) StartDataTransfer(ctx context.Context, miner address.Address, propCid cid.Cid, dataCid cid.Cid) (*datatransfer.ChannelID, error)

+ func (fc *FilClient) SubscribeToDataTransferEvents(f datatransfer.Subscriber) func()

+ func (fc *FilClient) SubscribeToRetrievalEvents(subscriber rep.RetrievalSubscriber)

+ func (fc *FilClient) TransferStatus(ctx context.Context, chanid *datatransfer.ChannelID) (*ChannelState, error)

+ func (fc *FilClient) TransferStatusByID(ctx context.Context, id string) (*ChannelState, error)

+ func (fc *FilClient) TransferStatusForContent(ctx context.Context, content cid.Cid, miner address.Address) (*ChannelState, error)

+ func (fc *FilClient) TransfersInProgress(ctx context.Context) (map[string]*ChannelState, error)

+ func (fc *FilClient) V110TransfersInProgress(ctx context.Context) (map[datatransfer.ChannelID]datatransfer.ChannelState, error)

+ type GetPieceCommFunc func(ctx context.Context, payloadCid cid.Cid, bstore blockstore.Blockstore) (cid.Cid, uint64, abi.UnpaddedPieceSize, error)

+ type GraphSyncDataTransfer struct

+ ChannelID *datatransfer.ChannelID

+ ChannelState *ChannelState

+ Diagnostics []string

+ IsCurrentChannelRequest bool

+ RequestID graphsync.RequestID

+ RequestState string

+ type LockFundsResp struct

+ MsgCid cid.Cid

+ type Lp2pDTConfig struct

+ Server httptransport.ServerConfig

+ TransferTimeout time.Duration

+ type MinerTransferDiagnostics struct

+ ReceivingTransfers []*GraphSyncDataTransfer

+ SendingTransfers []*GraphSyncDataTransfer

+ type MsgPusher struct

+ func NewMsgPusher(gapi api.Gateway, w *wallet.LocalWallet) *MsgPusher

+ func (mp *MsgPusher) MpoolPushMessage(ctx context.Context, msg *types.Message, maxFee *api.MessageSendSpec) (*types.SignedMessage, error)

+ type RetrievalStats struct

+ AskPrice abi.TokenAmount

+ AverageSpeed uint64

+ Duration time.Duration

+ NumPayments int

+ Peer peer.ID

+ Size uint64

+ TotalPayment abi.TokenAmount

+ type TransferType string

+ const BoostTransfer

+ const GraphsyncTransfer

v0.1.0

Aug 3, 2022