bitswap

package module

v0.0.0-...-adb0fc9 Latest Latest Go to latest Published: Feb 17, 2023 License: Apache-2.0, MIT Imports: 15 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/brossetti1/go-selfish-bitswap-client

README ¶

Selfish Bitswap Client

A minimal retrieve-only bitswap client

This client implements a minimal bitswap session that allows retrieval of CIDs from a single known peer.

Documentation

Usage

import (
	bitswap "github.com/willscott/go-selfish-bitswap-client"
)


session := bitswap.New(libp2p.Host, peer.ID)
defer session.Close()
bytes, err := session.Get(cid.Cid)

Lead Maintainer

willscott

Contributing

Contributions are welcome! This repository is governed by the ipfs contributing guidelines.

License

SPDX-License-Identifier: Apache-2.0 OR MIT

Documentation ¶

Index ¶

Constants
Variables
type Bitswap
type Options
type Session
- func New(h host.Host, peer peer.ID, opts Options) *Session
- func (s *Session) Close() error
- func (s *Session) Get(ctx context.Context, c cid.Cid) ([]byte, error)

Constants ¶

View Source

const (
	// maximum block we'll read is 4mb
	MaxBlockSize = 1024 * 1024 * 4
)

Variables ¶

View Source

var (
	// ProtocolBitswapNoVers is a legacy bitswap protocol id
	ProtocolBitswapNoVers protocol.ID = "/ipfs/bitswap"
	// ProtocolBitswapOneZero is the prefix for the legacy bitswap protocol
	ProtocolBitswapOneZero protocol.ID = "/ipfs/bitswap/1.0.0"
	// ProtocolBitswapOneOne is the the prefix for version 1.1.0
	ProtocolBitswapOneOne protocol.ID = "/ipfs/bitswap/1.1.0"
	// ProtocolBitswap is the current version of the bitswap protocol: 1.2.0
	ProtocolBitswap protocol.ID = "/ipfs/bitswap/1.2.0"
)

Functions ¶

This section is empty.

Types ¶

type Bitswap ¶

type Bitswap interface {
	Get(ctx context.Context, c cid.Cid) ([]byte, error)
	Close() error
}

type Options ¶

type Options struct {
	SessionTimeout          time.Duration
	WriteAggregationQuantum time.Duration
}

type Session ¶

type Session struct {
	host.Host
	// contains filtered or unexported fields
}

Session holds state for a related set of CID requests from a single remote peer

func New ¶

func New(h host.Host, peer peer.ID, opts Options) *Session

New initiates a bitswap retrieval session

func (*Session) Close ¶

func (s *Session) Close() error

Close stops the session.

func (*Session) Get ¶

func (s *Session) Get(ctx context.Context, c cid.Cid) ([]byte, error)

Get a specific block of data in this session. ctx is used to wrap client in timeout logic across a session.

Source Files ¶

View all Source files

session.go

Directories ¶

Path	Synopsis
cmd
getswap
message
server
util

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