kbucketfix

README

go-libp2p-kad-dht-patcher

Utility to patch peer protection logic in go-libp2p-kad-dht

N-Bucket problem

Details to be added

Run tests

go mod vendor
go test -v

Options

// Max number of peers to protect
// non-positive means unlimited
// default is 0
MaxProtected int
// Target percentage of protected peers, (0.0,1.0]
// default is 0.5
ProtectionRate float32

Public APIs

// Creates a new patcher instance
func NewPatcher() DHTPeerProtectionPatcher

// Notify the patcher with a validated / known trusted peer id
// so that it will be prefered in the protected peer selection algorithm
func (p *DHTPeerProtectionPatcher) Heartbeat(peerId peer.ID) bool

// Patches the peer protection algorithm of the given dht instance
func (p *DHTPeerProtectionPatcher) Patch(dht *kaddht.IpfsDHT)

Usage

patcher := NewPatcher()

if hostDHT, err := kaddht.New(ctx, host, dhtOpts...); err != nil {
    patcher.ProtectionRate = targetProtectionRate
	patcher.MaxProtected = maxProtected
	patcher.Patch(hostDHT)
}

Refer to kbucket_fix_test.go for details

Documentation

Index

• type DHTPeerProtectionPatcher
  • func NewPatcher() DHTPeerProtectionPatcher
  • func (p *DHTPeerProtectionPatcher) Heartbeat(peerId peer.ID) bool
  • func (p *DHTPeerProtectionPatcher) Patch(dht *kaddht.IpfsDHT)

Types

type DHTPeerProtectionPatcher

type DHTPeerProtectionPatcher struct {
	// Max number of peers to protect
	// non-positive means unlimited
	// default is 0
	MaxProtected int
	// Target percentage of protected peers, (0.0,1.0]
	// default is 0.5
	ProtectionRate float32
	// contains filtered or unexported fields
}

func NewPatcher

func NewPatcher() DHTPeerProtectionPatcher

Creates a new patcher instance

func (*DHTPeerProtectionPatcher) Heartbeat

func (p *DHTPeerProtectionPatcher) Heartbeat(peerId peer.ID) bool

Notify the patcher with a validated / known trusted peer id so that it will be prefered in the protected peer selection algorithm

func (*DHTPeerProtectionPatcher) Patch

func (p *DHTPeerProtectionPatcher) Patch(dht *kaddht.IpfsDHT)

Patches the peer protection algorithm of the given dht instance