exchange

README

go-ipfs-exchange-interface

go-ipfs-exchange-interface defines the IPFS exchange interface

Lead Maintainer

Steven Allen

Table of Contents

• Install
• Usage
• Contribute
• License

Install

go-ipfs-exchange-interface works like a regular Go module:

> go get github.com/ipfs/go-ipfs-exchange-interface

Usage

import "github.com/ipfs/go-ipfs-exchange-interface"

Check the GoDoc documentation

Contribute

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © Protocol Labs, Inc.

Documentation

Overview

Package exchange defines the DMS3 exchange interface

Index

• type Fetcher
• type Interface
• type SessionExchange

Types

type Fetcher

type Fetcher interface {
	// GetBlock returns the block associated with a given key.
	GetBlock(context.Context, cid.Cid) (blocks.Block, error)
	GetBlocks(context.Context, []cid.Cid) (<-chan blocks.Block, error)
}

Fetcher is an object that can be used to retrieve blocks

type Interface

type Interface interface {
	Fetcher

	// TODO Should callers be concerned with whether the block was made
	// available on the network?
	HasBlock(blocks.Block) error

	IsOnline() bool

	io.Closer
}

Interface defines the functionality of the DMS3 block exchange protocol.

type SessionExchange

type SessionExchange interface {
	Interface
	NewSession(context.Context) Fetcher
}

SessionExchange is an exchange.Interface which supports sessions.