dtsync

Documentation

Index

• Constants
• Variables
• type Option
  • func WithAllowPeer(allowPeer func(peer.ID) bool) Option
  • func WithMaxGraphsyncRequests(maxIn, maxOut uint64) Option
• type Publisher
  • func NewPublisher(host host.Host, ds datastore.Batching, lsys ipld.LinkSystem, topicName string, ...) (*Publisher, error)
  • func NewPublisherFromExisting(dtManager dt.Manager, host host.Host, topicName string, lsys ipld.LinkSystem, ...) (*Publisher, error)
  • func (p *Publisher) Addrs() []multiaddr.Multiaddr
  • func (p *Publisher) Close() error
  • func (p *Publisher) ID() peer.ID
  • func (p *Publisher) Protocol() int
  • func (p *Publisher) SetRoot(c cid.Cid)
• type Sync
  • func NewSync(host host.Host, ds datastore.Batching, lsys ipld.LinkSystem, ...) (*Sync, error)
  • func (s *Sync) Close() error
  • func (s *Sync) NewSyncer(peerInfo peer.AddrInfo, topicName string) *Syncer
• type Syncer
  • func (s *Syncer) GetHead(ctx context.Context) (cid.Cid, error)
  • func (s *Syncer) SameAddrs(maddrs []multiaddr.Multiaddr) bool
  • func (s *Syncer) Sync(ctx context.Context, nextCid cid.Cid, sel ipld.Node) error
• type Voucher
  • func VoucherFromNode(node datamodel.Node) (*Voucher, error)
  • func (v *Voucher) AsVoucher() datatransfer.TypedVoucher
  • func (t *Voucher) MarshalCBOR(w io.Writer) error
  • func (t *Voucher) UnmarshalCBOR(r io.Reader) error
• type VoucherResult
  • func VoucherResultFromNode(node datamodel.Node) (*VoucherResult, error)
  • func (vr *VoucherResult) AsVoucher() datatransfer.TypedVoucher
  • func (t *VoucherResult) MarshalCBOR(w io.Writer) error
  • func (t *VoucherResult) UnmarshalCBOR(r io.Reader) error

Constants

const LegsVoucherResultType = datatransfer.TypeIdentifier("LegsVoucherResult")

const LegsVoucherType = datatransfer.TypeIdentifier("LegsVoucher")

Variables

var BindnodeRegistry = bindnoderegistry.NewRegistry()

Types

type Option

type Option func(*config) error

Option is a function that sets a value in a config.

func WithAllowPeer

func WithAllowPeer(allowPeer func(peer.ID) bool) Option

WithAllowPeer sets the function that determines whether to allow or reject graphsync sessions from a peer.

func WithMaxGraphsyncRequests

func WithMaxGraphsyncRequests(maxIn, maxOut uint64) Option

type Publisher

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

Publisher serves an advertisement over libp2p using data-transfer.

func NewPublisher

func NewPublisher(host host.Host, ds datastore.Batching, lsys ipld.LinkSystem, topicName string, options ...Option) (*Publisher, error)

NewPublisher creates a new dagsync publisher.

func NewPublisherFromExisting

func NewPublisherFromExisting(dtManager dt.Manager, host host.Host, topicName string, lsys ipld.LinkSystem, options ...Option) (*Publisher, error)

NewPublisherFromExisting instantiates publishing on an existing data transfer instance.

func (*Publisher) Addrs

func (p *Publisher) Addrs() []multiaddr.Multiaddr

Addrs returns the multiaddrs of the publisher's host.

func (*Publisher) Close

func (p *Publisher) Close() error

Close closes the publisher.

func (*Publisher) ID

func (p *Publisher) ID() peer.ID

ID returns the peer ID of the publisher's host.

func (*Publisher) Protocol

func (p *Publisher) Protocol() int

Protocol returns the multihash protocol ID of the transport used by the publisher.

func (*Publisher) SetRoot

func (p *Publisher) SetRoot(c cid.Cid)

SetRoot sets the root CID of the advertisement chain.

type Sync

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

Sync provides sync functionality for use with all datatransfer syncs.

func NewSync

func NewSync(host host.Host, ds datastore.Batching, lsys ipld.LinkSystem, blockHook func(peer.ID, cid.Cid), gsMaxInReq, gsMaxOutReq uint64) (*Sync, error)

NewSync creates a new Sync with its own datatransfer.Manager.

func (*Sync) Close

func (s *Sync) Close() error

Close unregisters datatransfer event notification. If this Sync owns the datatransfer.Manager then the Manager is stopped.

func (*Sync) NewSyncer

func (s *Sync) NewSyncer(peerInfo peer.AddrInfo, topicName string) *Syncer

NewSyncer creates a new Syncer to use for a single sync operation against a peer.

type Syncer

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

Syncer handles a single sync with a provider.

func (*Syncer) GetHead

func (s *Syncer) GetHead(ctx context.Context) (cid.Cid, error)

GetHead queries a provider for the latest CID.

func (*Syncer) SameAddrs

func (s *Syncer) SameAddrs(maddrs []multiaddr.Multiaddr) bool

func (*Syncer) Sync

func (s *Syncer) Sync(ctx context.Context, nextCid cid.Cid, sel ipld.Node) error

Sync opens a datatransfer data channel and uses the selector to pull data from the provider.

type Voucher

type Voucher struct {
	Head *cid.Cid
}

A Voucher is used to communicate a new DAG head

func VoucherFromNode

func VoucherFromNode(node datamodel.Node) (*Voucher, error)

reads a voucher from an ipld node

func (*Voucher) AsVoucher

func (v *Voucher) AsVoucher() datatransfer.TypedVoucher

func (*Voucher) MarshalCBOR

func (t *Voucher) MarshalCBOR(w io.Writer) error

func (*Voucher) UnmarshalCBOR

func (t *Voucher) UnmarshalCBOR(r io.Reader) error

type VoucherResult

type VoucherResult struct {
	Code uint64
}

A VoucherResult responds to a voucher

func VoucherResultFromNode

func VoucherResultFromNode(node datamodel.Node) (*VoucherResult, error)

reads a voucher from an ipld node

func (*VoucherResult) AsVoucher

func (vr *VoucherResult) AsVoucher() datatransfer.TypedVoucher

func (*VoucherResult) MarshalCBOR

func (t *VoucherResult) MarshalCBOR(w io.Writer) error

func (*VoucherResult) UnmarshalCBOR

func (t *VoucherResult) UnmarshalCBOR(r io.Reader) error