broker

type AuctionStatus string

type Batch struct {
	ID                  BatchID
	Status              BatchStatus
	RepFactor           int
	DealDuration        int
	Sources             auction.Sources
	DisallowRebatching  bool
	FilEpochDeadline    uint64
	ProposalStartOffset time.Duration
	Error               string
	Origin              string
	Tags                map[string]string
	Providers           []address.Address

	// Packer calculates this field after batching storage requests.
	PayloadCid  cid.Cid
	PayloadSize *int64

	// Piecer calculates these fields after preparing the batched DAG.
	PieceCid  cid.Cid
	PieceSize uint64
	CreatedAt time.Time
	UpdatedAt time.Time
}

type BatchID string

type BatchMetadata struct {
	Origin    string
	Tags      map[string]string
	Providers []address.Address
}

type BatchStatus string

type Broker interface {
	// Create creates a new StorageRequest for a cid.
	Create(ctx context.Context, dataCid cid.Cid, origin string) (StorageRequest, error)

	// CreatePrepared creates a new StorageRequest for prepared data.
	CreatePrepared(
		ctx context.Context,
		payloadCid cid.Cid,
		pc PreparedCAR,
		m BatchMetadata,
		rw *RemoteWallet) (StorageRequest, error)

	// GetStorageRequestInfo returns a storage request information by id.
	GetStorageRequestInfo(ctx context.Context, ID StorageRequestID) (StorageRequestInfo, error)
}

type ClosedAuction struct {
	ID              auction.ID
	BatchID         BatchID
	DealDuration    uint64
	DealReplication uint32
	DealVerified    bool
	Status          AuctionStatus
	WinningBids     map[auction.BidID]WinningBid
	ErrorCause      string
}

type DataPreparationResult struct {
	PieceSize uint64
	PieceCid  cid.Cid
}

type FinalizedDeal struct {
	BatchID           BatchID
	StorageProviderID string
	DealID            int64
	DealExpiration    uint64
	ErrorCause        string
	AuctionID         auction.ID
	BidID             auction.BidID
}

type PreparedCAR struct {
	PieceCid            cid.Cid
	PieceSize           uint64
	RepFactor           int
	Deadline            time.Time
	ProposalStartOffset time.Duration
	Sources             auction.Sources
}

type RemoteWallet struct {
	PeerID     peer.ID
	WalletAddr address.Address
	AuthToken  string
	Multiaddrs []multiaddr.Multiaddr
}

type StorageRequest struct {
	ID        StorageRequestID
	DataCid   cid.Cid
	Status    StorageRequestStatus
	Origin    string
	BatchID   BatchID
	CreatedAt time.Time
	UpdatedAt time.Time
}

type StorageRequestDeal struct {
	StorageProviderID string
	DealID            int64
	Expiration        uint64
}

type StorageRequestID string

type StorageRequestInfo struct {
	StorageRequest StorageRequest
	Deals          []StorageRequestDeal
}

type StorageRequestStatus string

type WinningBid struct {
	StorageProviderID string
	Price             int64
	StartEpoch        uint64
	FastRetrieval     bool
}