voucher

Documentation

Index

• type Validator
  • func (vl *Validator) ValidatePull(isRestart bool, chid datatransfer.ChannelID, receiver peer.ID, ...) (datatransfer.VoucherResult, error)
  • func (vl *Validator) ValidatePush(isRestart bool, chid datatransfer.ChannelID, sender peer.ID, ...) (datatransfer.VoucherResult, error)
• type Voucher
  • func (t *Voucher) MarshalCBOR(w io.Writer) error
  • func (v *Voucher) Type() datatransfer.TypeIdentifier
  • func (t *Voucher) UnmarshalCBOR(r io.Reader) error
• type VoucherResult
  • func (t *VoucherResult) MarshalCBOR(w io.Writer) error
  • func (v *VoucherResult) Type() datatransfer.TypeIdentifier
  • func (t *VoucherResult) UnmarshalCBOR(r io.Reader) error

Types

type Validator

type Validator struct {
}

func (*Validator) ValidatePull

func (vl *Validator) ValidatePull(
	isRestart bool,
	chid datatransfer.ChannelID,
	receiver peer.ID,
	voucher datatransfer.Voucher,
	baseCid cid.Cid,
	selector ipld.Node) (datatransfer.VoucherResult, error)

func (*Validator) ValidatePush

func (vl *Validator) ValidatePush(
	isRestart bool,
	chid datatransfer.ChannelID,
	sender peer.ID,
	voucher datatransfer.Voucher,
	baseCid cid.Cid,
	selector ipld.Node) (datatransfer.VoucherResult, error)

type Voucher

type Voucher struct {
	C *cid.Cid
}

A Voucher is used to communicate a new DAG head

func (*Voucher) MarshalCBOR

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

func (*Voucher) Type

func (v *Voucher) Type() datatransfer.TypeIdentifier

Type provides an identifier for the voucher to go-data-transfer

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 (*VoucherResult) MarshalCBOR

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

func (*VoucherResult) Type

func (v *VoucherResult) Type() datatransfer.TypeIdentifier

Type provides an identifier for the voucher result to go-data-transfer

func (*VoucherResult) UnmarshalCBOR

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