Skip to content

docs: update deprecation comments to reference IPIP-526 #1076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lidel merged 1 commit into from
Dec 3, 2025
+16 −16
Merged

docs: update deprecation comments to reference IPIP-526 #1076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions routing/http/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,9 +339,9 @@ func (c *Client) FindProviders(ctx context.Context, key cid.Cid) (providers iter
return &measuringIter[iter.Result[types.Record]]{Iter: it, ctx: ctx, m: m}, nil
}

// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
//
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
func (c *Client) ProvideBitswap(ctx context.Context, keys []cid.Cid, ttl time.Duration) (time.Duration, error) {
if c.identity == nil {
return 0, errors.New("cannot provide Bitswap records without an identity")
Expand Down
12 changes: 6 additions & 6 deletions routing/http/server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ type DelegatedRouter interface {
// Limit indicates the maximum amount of results to return; 0 means unbounded.
FindProviders(ctx context.Context, cid cid.Cid, limit int) (iter.ResultIter[types.Record], error)

// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
//
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
ProvideBitswap(ctx context.Context, req *BitswapWriteProvideRequest) (time.Duration, error)

// FindPeers searches for peers who have the provided [peer.ID].
Expand All @@ -95,9 +95,9 @@ type DelegatedRouter interface {
// Deprecated: use DelegatedRouter. ContentRouter will be removed in a future version.
type ContentRouter = DelegatedRouter

// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
//
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
type BitswapWriteProvideRequest struct {
Keys []cid.Cid
Timestamp time.Time
Expand All @@ -106,9 +106,9 @@ type BitswapWriteProvideRequest struct {
Addrs []multiaddr.Multiaddr
}

// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
//
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
type WriteProvideRequest struct {
Protocol string
Schema string
Expand Down
4 changes: 2 additions & 2 deletions routing/http/types/json/requests.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import (
"github.com/ipfs/boxo/routing/http/types"
)

// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
//
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
type WriteProvidersRequest struct {
Providers []types.Record
}
Expand Down
4 changes: 2 additions & 2 deletions routing/http/types/json/responses.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ func (r *RecordsArray) UnmarshalJSON(b []byte) error {
return nil
}

// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
//
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
type WriteProvidersResponse struct {
ProvideResults []types.Record
}
Expand Down
8 changes: 4 additions & 4 deletions routing/http/types/record_bitswap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ func (br *BitswapRecord) GetSchema() string {

var _ Record = &WriteBitswapRecord{}

// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
//
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
type WriteBitswapRecord struct {
Schema string
Protocol string
Expand Down Expand Up @@ -170,9 +170,9 @@ func (p *WriteBitswapRecord) Verify() error {

var _ Record = &WriteBitswapRecordResponse{}

// Deprecated: protocol-agnostic provide is being worked on in [IPIP-378]:
// Deprecated: historic API from [IPIP-526], may be removed in a future version.
//
// [IPIP-378]: https://github.com/ipfs/specs/pull/378
// [IPIP-526]: https://specs.ipfs.tech/ipips/ipip-0526/
type WriteBitswapRecordResponse struct {
Schema string
Protocol string
Expand Down