storage

package

v0.0.0-...-269d6e4 Latest Latest Go to latest Published: Nov 24, 2022 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/textileio/broker-core

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AuctionDataRequest ¶

type AuctionDataRequest struct {
	PayloadCid               string            `json:"payloadCid"`
	PieceCid                 string            `json:"pieceCid"`
	PieceSize                uint64            `json:"pieceSize"`
	RepFactor                int               `json:"repFactor"`
	Deadline                 string            `json:"deadline"`
	MaxProposalDeadlineHours int               `json:"maxProposalDeadlineHours"`
	CARURL                   *CARURL           `json:"carURL"`
	CARIPFS                  *CARIPFS          `json:"carIPFS"`
	Tags                     map[string]string `json:"tags"`
	RemoteWallet             *RemoteWallet     `json:"remoteWallet"`
	Providers                []string          `json:"providers"`
}

AuctionDataRequest contains information about a prepared dataset hosted externally.

type CARIPFS ¶

type CARIPFS struct {
	Cid        string   `json:"cid"`
	Multiaddrs []string `json:"multiaddrs"`
}

CARIPFS contains details of a CAR file Cid stored in an HTTP endpoint.

type CARURL ¶

type CARURL struct {
	URL string `json:"url"`
}

CARURL contains details of a CAR file stored in an HTTP endpoint.

type Deal ¶

type Deal struct {
	StorageProviderID string `json:"storage_provider_id"`
	DealID            int64  `json:"deal_id"`
	Expiration        uint64 `json:"deal_expiration"`
}

Deal contains information of an on-chain deal.

type RemoteWallet ¶

type RemoteWallet struct {
	PeerID     string   `json:"peerId"`
	AuthToken  string   `json:"authToken"`
	WalletAddr string   `json:"walletAddr"`
	Multiaddrs []string `json:"multiaddrs"`
}

RemoteWallet contains details of a remote wallet to do signing proposal.

type Request ¶

type Request struct {
	ID         string  `json:"id"`
	Cid        cid.Cid `json:"cid"`
	StatusCode Status  `json:"status_code"`
}

Request is a request for storing data in a Broker.

type RequestInfo ¶

type RequestInfo struct {
	Request Request `json:"request"`
	Deals   []Deal  `json:"deals"`
}

RequestInfo describes the current state of a request.

type Requester ¶

type Requester interface {
	IsAuthorized(ctx context.Context, identity string) (auth.AuthorizedEntity, bool, string, error)
	CreateFromReader(ctx context.Context, r io.Reader, origin string) (Request, error)
	CreateFromExternalSource(ctx context.Context, adr AuctionDataRequest, origin string) (Request, error)
	GetCARHeader(ctx context.Context, c cid.Cid, w io.Writer) (bool, error)
	GetCAR(ctx context.Context, c cid.Cid, w io.Writer) (bool, error)
	GetRequestInfo(ctx context.Context, id string) (RequestInfo, error)
}

Requester contains handles raw-files uploads of data to be stored with the Broker service.

type Status ¶

type Status string

Status is the status of a StorageRequest.

const (
	// StatusUnknown is the default value to an unitialized
	// StorageRequest. This status must be considered invalid in any
	// real StorageRequest instance.
	StatusUnknown Status = "Unknown"
	// StatusBatching indicates that the storage request is being batched.
	StatusBatching Status = "Batching"
	// StatusPreparing indicates that the batch containing the data is being prepared.
	StatusPreparing Status = "Preparing"
	// StatusAuctioning indicates that the batch containing the data is being auctioned.
	StatusAuctioning Status = "Auctioning"
	// StatusDealMaking indicates that the data is in deal-making process.
	StatusDealMaking Status = "DealMaking"
	// StatusSuccess indicates that the request was stored in Filecoin.
	StatusSuccess Status = "Success"
	// StatusError indicates that there is some error handling the request.
	StatusError Status = "Error"
)

Source Files ¶

View all Source files

storage.go

Directories ¶

Path	Synopsis
brokerstorage
brokerauth
uploader
uploader/ipfsuploader

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL