Deprecate WithPeerLedger option for bitswap server (#929)

gammazero · web-flow · commit a3bb071ea813 · 2025-05-27T15:23:32.000-07:00
This is no longer needed and should be removed next release. See #928 for more information
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,6 +26,7 @@ The following emojis are used to highlight certain changes:
 ### Changed
 
 - upgrade to `go-libp2p-kad-dht` [v0.33.1](https://github.com/libp2p/go-libp2p-kad-dht/releases/tag/v0.33.1)
+- deprecated `WithPeerLedger` option for bitswap server. Will remove option in next release. See [issue #928](https://github.com/ipfs/boxo/issues/928)
 
 ### Removed
 
diff --git a/bitswap/options.go b/bitswap/options.go
@@ -55,6 +55,7 @@ func WithScoreLedger(scoreLedger server.ScoreLedger) Option {
 	return Option{server.WithScoreLedger(scoreLedger)}
 }
 
+// Deprecated: This is no longer needed and will be removed.
 func WithPeerLedger(peerLedger server.PeerLedger) Option {
 	return Option{server.WithPeerLedger(peerLedger)}
 }
diff --git a/bitswap/server/internal/decision/engine.go b/bitswap/server/internal/decision/engine.go
@@ -281,6 +281,8 @@ func WithScoreLedger(scoreledger ScoreLedger) Option {
 }
 
 // WithPeerLedger sets a custom [PeerLedger] to be used with this [Engine].
+//
+// Deprecated: This is no longer needed and will be removed.
 func WithPeerLedger(peerLedger PeerLedger) Option {
 	return func(e *Engine) {
 		e.peerLedger = peerLedger
diff --git a/bitswap/server/server.go b/bitswap/server/server.go
@@ -131,6 +131,8 @@ func WithScoreLedger(scoreLedger decision.ScoreLedger) Option {
 }
 
 // WithPeerLedger configures the engine with a custom [decision.PeerLedger].
+//
+// Deprecated: This is no longer needed and will be removed.
 func WithPeerLedger(peerLedger decision.PeerLedger) Option {
 	o := decision.WithPeerLedger(peerLedger)
 	return func(bs *Server) {

Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ func WithScoreLedger(scoreLedger server.ScoreLedger) Option {`
`55`	`55`	`return Option{server.WithScoreLedger(scoreLedger)}`
`56`	`56`	`}`
`57`	`57`
	`58`	`+// Deprecated: This is no longer needed and will be removed.`
`58`	`59`	`func WithPeerLedger(peerLedger server.PeerLedger) Option {`
`59`	`60`	`return Option{server.WithPeerLedger(peerLedger)}`
`60`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -281,6 +281,8 @@ func WithScoreLedger(scoreledger ScoreLedger) Option {`
`281`	`281`	`}`
`282`	`282`
`283`	`283`	`// WithPeerLedger sets a custom [PeerLedger] to be used with this [Engine].`
	`284`	`+//`
	`285`	`+// Deprecated: This is no longer needed and will be removed.`
`284`	`286`	`func WithPeerLedger(peerLedger PeerLedger) Option {`
`285`	`287`	`return func(e *Engine) {`
`286`	`288`	`e.peerLedger = peerLedger`
Original file line number	Diff line number	Diff line change
`@@ -131,6 +131,8 @@ func WithScoreLedger(scoreLedger decision.ScoreLedger) Option {`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`// WithPeerLedger configures the engine with a custom [decision.PeerLedger].`
	`134`	`+//`
	`135`	`+// Deprecated: This is no longer needed and will be removed.`
`134`	`136`	`func WithPeerLedger(peerLedger decision.PeerLedger) Option {`
`135`	`137`	`o := decision.WithPeerLedger(peerLedger)`
`136`	`138`	`return func(bs *Server) {`