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

storagemarket

package

Go to main page

Versions in this module

v1

v1.2.12

Apr 8, 2021

v1.2.11

Apr 8, 2021

v1.2.10

Apr 8, 2021

v1.2.9

Apr 7, 2021

v1.2.8

Apr 7, 2021

v1.2.7

Mar 30, 2021

v1.2.5

Mar 29, 2021

Changes in this version

type StorageProviderNode

+ LocatePieceForDealWithinSector func(ctx context.Context, dealID abi.DealID, tok shared.TipSetToken) (sectorID abi.SectorNumber, offset abi.PaddedPieceSize, ...)

v1.2.4

Mar 29, 2021

Changes in this version

+ const AskProtocolID

+ const DealProtocolID

+ const DealStatusProtocolID

+ const OldAskProtocolID

+ const OldDealProtocolID

+ const OldDealStatusProtocolID

+ const StorageDealAcceptWait

+ const StorageDealActive

+ const StorageDealAwaitingPreCommit

+ const StorageDealCheckForAcceptance

+ const StorageDealClientFunding

+ const StorageDealClientTransferRestart

+ const StorageDealError

+ const StorageDealExpired

+ const StorageDealFailing

+ const StorageDealFinalizing

+ const StorageDealFundsReserved

+ const StorageDealProposalAccepted

+ const StorageDealProposalNotFound

+ const StorageDealProposalRejected

+ const StorageDealProviderFunding

+ const StorageDealProviderTransferAwaitRestart

+ const StorageDealPublish

+ const StorageDealPublishing

+ const StorageDealRejecting

+ const StorageDealReserveClientFunds

+ const StorageDealReserveProviderFunds

+ const StorageDealSealing

+ const StorageDealSlashed

+ const StorageDealStaged

+ const StorageDealStartDataTransfer

+ const StorageDealTransferring

+ const StorageDealUnknown

+ const StorageDealValidating

+ const StorageDealVerifyData

+ const StorageDealWaitingForData

+ const TTGraphsync

+ const TTManual

+ var ClientEvents = map[ClientEvent]string

+ var DealStates = map[StorageDealStatus]string

+ var DealStatesDescriptions = map[StorageDealStatus]string

+ var DealStatesDurations = map[StorageDealStatus]string

+ var ProviderEvents = map[ProviderEvent]string

+ var SignedStorageAskUndefined = SignedStorageAsk

+ var StorageAskUndefined = StorageAsk

+ type Balance struct

+ Available abi.TokenAmount

+ Locked abi.TokenAmount

+ func (t *Balance) MarshalCBOR(w io.Writer) error

+ func (t *Balance) UnmarshalCBOR(r io.Reader) error

+ type ClientDeal struct

+ AddFundsCid *cid.Cid

+ CreationTime cbg.CborTime

+ DataRef *DataRef

+ DealID abi.DealID

+ DealStages *DealStages

+ FastRetrieval bool

+ FundsReserved abi.TokenAmount

+ Message string

+ Miner peer.ID

+ MinerWorker address.Address

+ PollErrorCount uint64

+ PollRetryCount uint64

+ ProposalCid cid.Cid

+ PublishMessage *cid.Cid

+ SectorNumber abi.SectorNumber

+ SlashEpoch abi.ChainEpoch

+ State StorageDealStatus

+ StoreID *multistore.StoreID

+ TransferChannelID *datatransfer.ChannelID

+ func (d *ClientDeal) AddLog(msg string, a ...interface{})

+ func (t *ClientDeal) MarshalCBOR(w io.Writer) error

+ func (t *ClientDeal) UnmarshalCBOR(r io.Reader) error

+ type ClientEvent uint64

+ const ClientEventDataTransferCancelled

+ const ClientEventDataTransferComplete

+ const ClientEventDataTransferFailed

+ const ClientEventDataTransferInitiated

+ const ClientEventDataTransferRestartFailed

+ const ClientEventDataTransferRestarted

+ const ClientEventDataTransferStalled

+ const ClientEventDealAccepted

+ const ClientEventDealActivated

+ const ClientEventDealActivationFailed

+ const ClientEventDealCompletionFailed

+ const ClientEventDealExpired

+ const ClientEventDealPrecommitFailed

+ const ClientEventDealPrecommitted

+ const ClientEventDealPublishFailed

+ const ClientEventDealPublished

+ const ClientEventDealRejected

+ const ClientEventDealSlashed

+ const ClientEventFailed

+ const ClientEventFundingComplete

+ const ClientEventFundingInitiated

+ const ClientEventFundsReleased

+ const ClientEventFundsReserved

+ const ClientEventInitiateDataTransfer

+ const ClientEventOpen

+ const ClientEventReadResponseFailed

+ const ClientEventReserveFundsFailed

+ const ClientEventResponseDealDidNotMatch

+ const ClientEventResponseVerificationFailed

+ const ClientEventRestart

+ const ClientEventStreamCloseError

+ const ClientEventUnexpectedDealState

+ const ClientEventWaitForDealState

+ const ClientEventWriteProposalFailed

+ type ClientSubscriber func(event ClientEvent, deal ClientDeal)

+ type DataRef struct

+ PieceCid *cid.Cid

+ PieceSize abi.UnpaddedPieceSize

+ RawBlockSize uint64

+ Root cid.Cid

+ TransferType string

+ func (t *DataRef) MarshalCBOR(w io.Writer) error

+ func (t *DataRef) UnmarshalCBOR(r io.Reader) error

+ type DealExpiredCallback func(err error)

+ type DealSectorCommittedCallback func(err error)

+ type DealSectorPreCommittedCallback func(sectorNumber abi.SectorNumber, isActive bool, err error)

+ type DealSlashedCallback func(slashEpoch abi.ChainEpoch, err error)

+ type DealStage struct

+ CreatedTime cbg.CborTime

+ Description string

+ ExpectedDuration string

+ Logs []*Log

+ Name string

+ UpdatedTime cbg.CborTime

+ func (t *DealStage) MarshalCBOR(w io.Writer) error

+ func (t *DealStage) UnmarshalCBOR(r io.Reader) error

+ type DealStages struct

+ Stages []*DealStage

+ func NewDealStages() *DealStages

+ func (ds *DealStages) AddStageLog(stage, description, expectedDuration, msg string)

+ func (ds *DealStages) GetStage(stage string) *DealStage

+ func (t *DealStages) MarshalCBOR(w io.Writer) error

+ func (t *DealStages) UnmarshalCBOR(r io.Reader) error

+ type Log struct

+ Log string

+ UpdatedTime cbg.CborTime

+ func (t *Log) MarshalCBOR(w io.Writer) error

+ func (t *Log) UnmarshalCBOR(r io.Reader) error

+ type MinerDeal struct

+ AddFundsCid *cid.Cid

+ AvailableForRetrieval bool

+ Client peer.ID

+ CreationTime cbg.CborTime

+ DealID abi.DealID

+ FastRetrieval bool

+ FundsReserved abi.TokenAmount

+ Message string

+ MetadataPath filestore.Path

+ Miner peer.ID

+ PiecePath filestore.Path

+ ProposalCid cid.Cid

+ PublishCid *cid.Cid

+ Ref *DataRef

+ SectorNumber abi.SectorNumber

+ SlashEpoch abi.ChainEpoch

+ State StorageDealStatus

+ StoreID *multistore.StoreID

+ TransferChannelId *datatransfer.ChannelID

+ func (t *MinerDeal) MarshalCBOR(w io.Writer) error

+ func (t *MinerDeal) UnmarshalCBOR(r io.Reader) error

+ type PackingResult struct

+ Offset abi.PaddedPieceSize

+ SectorNumber abi.SectorNumber

+ Size abi.PaddedPieceSize

+ type ProposeStorageDealParams struct

+ Addr address.Address

+ Collateral abi.TokenAmount

+ Data *DataRef

+ EndEpoch abi.ChainEpoch

+ FastRetrieval bool

+ Info *StorageProviderInfo

+ Price abi.TokenAmount

+ Rt abi.RegisteredSealProof

+ StartEpoch abi.ChainEpoch

+ StoreID *multistore.StoreID

+ VerifiedDeal bool

+ type ProposeStorageDealResult struct

+ ProposalCid cid.Cid

+ type ProviderDealState struct

+ AddFundsCid *cid.Cid

+ DealID abi.DealID

+ FastRetrieval bool

+ Message string

+ Proposal *market.DealProposal

+ ProposalCid *cid.Cid

+ PublishCid *cid.Cid

+ State StorageDealStatus

+ func (t *ProviderDealState) MarshalCBOR(w io.Writer) error

+ func (t *ProviderDealState) UnmarshalCBOR(r io.Reader) error

+ type ProviderEvent uint64

+ const ProviderEventDataRequested

+ const ProviderEventDataTransferCancelled

+ const ProviderEventDataTransferCompleted

+ const ProviderEventDataTransferFailed

+ const ProviderEventDataTransferInitiated

+ const ProviderEventDataTransferRestartFailed

+ const ProviderEventDataTransferRestarted

+ const ProviderEventDataTransferStalled

+ const ProviderEventDataVerificationFailed

+ const ProviderEventDealAccepted

+ const ProviderEventDealActivated

+ const ProviderEventDealActivationFailed

+ const ProviderEventDealCompletionFailed

+ const ProviderEventDealDeciding

+ const ProviderEventDealExpired

+ const ProviderEventDealHandedOff

+ const ProviderEventDealHandoffFailed

+ const ProviderEventDealPrecommitFailed

+ const ProviderEventDealPrecommitted

+ const ProviderEventDealPublishError

+ const ProviderEventDealPublishInitiated

+ const ProviderEventDealPublished

+ const ProviderEventDealRejected

+ const ProviderEventDealSlashed

+ const ProviderEventFailed

+ const ProviderEventFileStoreErrored

+ const ProviderEventFinalized

+ const ProviderEventFunded

+ const ProviderEventFundingInitiated

+ const ProviderEventFundsReleased

+ const ProviderEventFundsReserved

+ const ProviderEventInsufficientFunds

+ const ProviderEventManualDataReceived

+ const ProviderEventMultistoreErrored

+ const ProviderEventNodeErrored

+ const ProviderEventOpen

+ const ProviderEventPieceStoreErrored

+ const ProviderEventRejectionSent

+ const ProviderEventRestart

+ const ProviderEventSendResponseFailed

+ const ProviderEventTrackFundsFailed

+ const ProviderEventVerifiedData

+ type ProviderSubscriber func(event ProviderEvent, deal MinerDeal)

+ type PublishDealsWaitResult struct

+ DealID abi.DealID

+ FinalCid cid.Cid

+ type SignedStorageAsk struct

+ Ask *StorageAsk

+ Signature *crypto.Signature

+ func (t *SignedStorageAsk) MarshalCBOR(w io.Writer) error

+ func (t *SignedStorageAsk) UnmarshalCBOR(r io.Reader) error

+ type StorageAsk struct

+ Expiry abi.ChainEpoch

+ MaxPieceSize abi.PaddedPieceSize

+ MinPieceSize abi.PaddedPieceSize

+ Miner address.Address

+ Price abi.TokenAmount

+ SeqNo uint64

+ Timestamp abi.ChainEpoch

+ VerifiedPrice abi.TokenAmount

+ func (t *StorageAsk) MarshalCBOR(w io.Writer) error

+ func (t *StorageAsk) UnmarshalCBOR(r io.Reader) error

+ type StorageAskOption func(*StorageAsk)

+ func MaxPieceSize(maxPieceSize abi.PaddedPieceSize) StorageAskOption

+ func MinPieceSize(minPieceSize abi.PaddedPieceSize) StorageAskOption

+ type StorageClient interface

+ AddPaymentEscrow func(ctx context.Context, addr address.Address, amount abi.TokenAmount) error

+ GetAsk func(ctx context.Context, info StorageProviderInfo) (*StorageAsk, error)

+ GetLocalDeal func(ctx context.Context, cid cid.Cid) (ClientDeal, error)

+ GetPaymentEscrow func(ctx context.Context, addr address.Address) (Balance, error)

+ GetProviderDealState func(ctx context.Context, proposalCid cid.Cid) (*ProviderDealState, error)

+ ListLocalDeals func(ctx context.Context) ([]ClientDeal, error)

+ ListProviders func(ctx context.Context) (<-chan StorageProviderInfo, error)

+ OnReady func(shared.ReadyFunc)

+ ProposeStorageDeal func(ctx context.Context, params ProposeStorageDealParams) (*ProposeStorageDealResult, error)

+ Start func(ctx context.Context) error

+ Stop func() error

+ SubscribeToEvents func(subscriber ClientSubscriber) shared.Unsubscribe

+ type StorageClientNode interface

+ GetDefaultWalletAddress func(ctx context.Context) (address.Address, error)

+ GetMinerInfo func(ctx context.Context, maddr address.Address, tok shared.TipSetToken) (*StorageProviderInfo, error)

+ ListStorageProviders func(ctx context.Context, tok shared.TipSetToken) ([]*StorageProviderInfo, error)

+ SignProposal func(ctx context.Context, signer address.Address, proposal market.DealProposal) (*market.ClientDealProposal, error)

+ ValidatePublishedDeal func(ctx context.Context, deal ClientDeal) (abi.DealID, error)

+ type StorageCommon interface

+ AddFunds func(ctx context.Context, addr address.Address, amount abi.TokenAmount) (cid.Cid, error)

+ DealProviderCollateralBounds func(ctx context.Context, size abi.PaddedPieceSize, isVerified bool) (abi.TokenAmount, abi.TokenAmount, error)

+ GetBalance func(ctx context.Context, addr address.Address, tok shared.TipSetToken) (Balance, error)

+ GetChainHead func(ctx context.Context) (shared.TipSetToken, abi.ChainEpoch, error)

+ OnDealExpiredOrSlashed func(ctx context.Context, dealID abi.DealID, onDealExpired DealExpiredCallback, ...) error

+ OnDealSectorCommitted func(ctx context.Context, provider address.Address, dealID abi.DealID, ...) error

+ OnDealSectorPreCommitted func(ctx context.Context, provider address.Address, dealID abi.DealID, ...) error

+ ReleaseFunds func(ctx context.Context, addr address.Address, amt abi.TokenAmount) error

+ ReserveFunds func(ctx context.Context, wallet, addr address.Address, amt abi.TokenAmount) (cid.Cid, error)

+ SignBytes func(ctx context.Context, signer address.Address, b []byte) (*crypto.Signature, error)

+ VerifySignature func(ctx context.Context, signature crypto.Signature, signer address.Address, ...) (bool, error)

+ WaitForMessage func(ctx context.Context, mcid cid.Cid, ...) error

+ type StorageDealStatus = uint64

+ type StorageProvider interface

+ AddStorageCollateral func(ctx context.Context, amount abi.TokenAmount) error

+ GetAsk func() *SignedStorageAsk

+ GetStorageCollateral func(ctx context.Context) (Balance, error)

+ ImportDataForDeal func(ctx context.Context, propCid cid.Cid, data io.Reader) error

+ ListLocalDeals func() ([]MinerDeal, error)

+ OnReady func(shared.ReadyFunc)

+ SetAsk func(price abi.TokenAmount, verifiedPrice abi.TokenAmount, duration abi.ChainEpoch, ...) error

+ Start func(ctx context.Context) error

+ Stop func() error

+ SubscribeToEvents func(subscriber ProviderSubscriber) shared.Unsubscribe

+ type StorageProviderInfo struct

+ Address address.Address

+ Addrs []ma.Multiaddr

+ Owner address.Address

+ PeerID peer.ID

+ SectorSize uint64

+ Worker address.Address

+ type StorageProviderNode interface

+ GetDataCap func(ctx context.Context, addr address.Address, tok shared.TipSetToken) (*verifreg.DataCap, error)

+ GetMinerWorkerAddress func(ctx context.Context, addr address.Address, tok shared.TipSetToken) (address.Address, error)

+ GetProofType func(ctx context.Context, addr address.Address, tok shared.TipSetToken) (abi.RegisteredSealProof, error)

+ OnDealComplete func(ctx context.Context, deal MinerDeal, pieceSize abi.UnpaddedPieceSize, ...) (*PackingResult, error)

+ PublishDeals func(ctx context.Context, deal MinerDeal) (cid.Cid, error)

+ WaitForPublishDeals func(ctx context.Context, mcid cid.Cid, proposal market.DealProposal) (*PublishDealsWaitResult, error)