metadata

Documentation

Overview

Package metadata captures the metadata types known by the index-provider.

The metadata is used to provide information about how to retrieve data blocks associated to multihashes advertised by a provider. It is represented as an array of bytes in the indexer protocol, starting with a varint ProtocolID that defines how to decode the remaining bytes.

Two metadata types are currently represented here: BitswapMetadata and GraphsyncFilecoinV1Metadata.

Index

• Variables
• type ErrNotGraphsyncFilecoinV1
  • func (e ErrNotGraphsyncFilecoinV1) Error() string
• type GraphsyncFilecoinV1Metadata
  • func (dtm *GraphsyncFilecoinV1Metadata) FromIndexerMetadata(m stiapi.Metadata) error
  • func (dtm *GraphsyncFilecoinV1Metadata) ToIndexerMetadata() (stiapi.Metadata, error)

Variables

var BitswapMetadata = stiapi.Metadata{
	ProtocolID: multicodec.TransportBitswap,
}

BitswapMetadata represents the indexing metadata that uses multicodec.TransportBitswap.

Types

type ErrNotGraphsyncFilecoinV1

type ErrNotGraphsyncFilecoinV1 struct {
	// contains filtered or unexported fields
}

ErrNotGraphsyncFilecoinV1 indicates a protocol does not use graphsync filecoin v1 transport. See: multicodec.TransportGraphsyncFilecoinv1.

func (ErrNotGraphsyncFilecoinV1) Error

func (e ErrNotGraphsyncFilecoinV1) Error() string

type GraphsyncFilecoinV1Metadata

type GraphsyncFilecoinV1Metadata struct {
	// PieceCID identifies the piece this data can be found in
	PieceCID cid.Cid
	// VerifiedDeal indicates if the deal is verified
	VerifiedDeal bool
	// FastRetrieval indicates whether the provider claims there is an unsealed copy
	FastRetrieval bool
}

GraphsyncFilecoinV1Metadata represents the indexing metadata for multicodec.TransportGraphsyncFilecoinv1.

func (*GraphsyncFilecoinV1Metadata) FromIndexerMetadata

func (dtm *GraphsyncFilecoinV1Metadata) FromIndexerMetadata(m stiapi.Metadata) error

FromIndexerMetadata decodes the indexer metadata format into GraphsyncFilecoinV1Metadata if the protocol ID of the given metadata matches multicodec.TransportGraphsyncFilecoinv1. Otherwise, ErrNotGraphsyncFilecoinV1 error is returned.

func (*GraphsyncFilecoinV1Metadata) ToIndexerMetadata

func (dtm *GraphsyncFilecoinV1Metadata) ToIndexerMetadata() (stiapi.Metadata, error)

ToIndexerMetadata converts GraphsyncFilecoinV1Metadata into indexer Metadata format.