From 12f343d837850b0cb198ccf2b40630bdbf1ec715 Mon Sep 17 00:00:00 2001 From: Jorropo Date: Wed, 31 May 2023 14:29:59 +0200 Subject: [PATCH] client/rpc: rename package name to match rpc and edit migration story --- client/rpc/README.md | 6 +++--- client/rpc/api.go | 2 +- client/rpc/api_test.go | 2 +- client/rpc/apifile.go | 2 +- client/rpc/block.go | 2 +- client/rpc/dag.go | 2 +- client/rpc/dht.go | 2 +- client/rpc/errors.go | 2 +- client/rpc/errors_test.go | 2 +- client/rpc/key.go | 2 +- client/rpc/name.go | 2 +- client/rpc/object.go | 2 +- client/rpc/path.go | 2 +- client/rpc/pin.go | 2 +- client/rpc/pubsub.go | 2 +- client/rpc/request.go | 2 +- client/rpc/requestbuilder.go | 2 +- client/rpc/response.go | 2 +- client/rpc/routing.go | 2 +- client/rpc/swarm.go | 2 +- client/rpc/unixfs.go | 2 +- docs/changelogs/v0.21.md | 3 ++- docs/http-rpc-clients.md | 4 ++-- 23 files changed, 27 insertions(+), 26 deletions(-) diff --git a/client/rpc/README.md b/client/rpc/README.md index e6b534b90..a020aa9da 100644 --- a/client/rpc/README.md +++ b/client/rpc/README.md @@ -1,4 +1,4 @@ -# `httpapi` +# `coreiface.CoreAPI` over http `rpc` > IPFS CoreAPI implementation using HTTP API @@ -19,13 +19,13 @@ import ( "context" "fmt" - ipfsClient "github.com/ipfs/kubo/client/rpc" + "github.com/ipfs/kubo/client/rpc" path "github.com/ipfs/boxo/coreiface/path" ) func main() { // "Connect" to local node - node, err := ipfsClient.NewLocalApi() + node, err := rpc.NewLocalApi() if err != nil { fmt.Printf(err) return diff --git a/client/rpc/api.go b/client/rpc/api.go index 5584de85d..4df4dfde1 100644 --- a/client/rpc/api.go +++ b/client/rpc/api.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "errors" diff --git a/client/rpc/api_test.go b/client/rpc/api_test.go index 2fd8a65dc..51f8cf89d 100644 --- a/client/rpc/api_test.go +++ b/client/rpc/api_test.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/client/rpc/apifile.go b/client/rpc/apifile.go index 25fd7c3b3..24e93a834 100644 --- a/client/rpc/apifile.go +++ b/client/rpc/apifile.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/client/rpc/block.go b/client/rpc/block.go index 2a794c26f..a11e5e655 100644 --- a/client/rpc/block.go +++ b/client/rpc/block.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "bytes" diff --git a/client/rpc/dag.go b/client/rpc/dag.go index 795e1d78d..62b54697e 100644 --- a/client/rpc/dag.go +++ b/client/rpc/dag.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "bytes" diff --git a/client/rpc/dht.go b/client/rpc/dht.go index a2910fef6..1d3b24643 100644 --- a/client/rpc/dht.go +++ b/client/rpc/dht.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/client/rpc/errors.go b/client/rpc/errors.go index 59e4ad705..dc5946be3 100644 --- a/client/rpc/errors.go +++ b/client/rpc/errors.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "errors" diff --git a/client/rpc/errors_test.go b/client/rpc/errors_test.go index 0e6cfe0dc..c14738740 100644 --- a/client/rpc/errors_test.go +++ b/client/rpc/errors_test.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "errors" diff --git a/client/rpc/key.go b/client/rpc/key.go index 434e98fe5..487c14c3d 100644 --- a/client/rpc/key.go +++ b/client/rpc/key.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/client/rpc/name.go b/client/rpc/name.go index f82f69f3a..e6c726c58 100644 --- a/client/rpc/name.go +++ b/client/rpc/name.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/client/rpc/object.go b/client/rpc/object.go index 4e3b9ef6b..5860c7661 100644 --- a/client/rpc/object.go +++ b/client/rpc/object.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "bytes" diff --git a/client/rpc/path.go b/client/rpc/path.go index d69d425ab..6edf0e797 100644 --- a/client/rpc/path.go +++ b/client/rpc/path.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/client/rpc/pin.go b/client/rpc/pin.go index 30a3d7b7a..9ce92b4cf 100644 --- a/client/rpc/pin.go +++ b/client/rpc/pin.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/client/rpc/pubsub.go b/client/rpc/pubsub.go index 28f1ef8e6..a386c80a1 100644 --- a/client/rpc/pubsub.go +++ b/client/rpc/pubsub.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "bytes" diff --git a/client/rpc/request.go b/client/rpc/request.go index dd5293b7a..675717707 100644 --- a/client/rpc/request.go +++ b/client/rpc/request.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/client/rpc/requestbuilder.go b/client/rpc/requestbuilder.go index 476aed786..63206be40 100644 --- a/client/rpc/requestbuilder.go +++ b/client/rpc/requestbuilder.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "bytes" diff --git a/client/rpc/response.go b/client/rpc/response.go index 189b43671..bad274777 100644 --- a/client/rpc/response.go +++ b/client/rpc/response.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "encoding/json" diff --git a/client/rpc/routing.go b/client/rpc/routing.go index 550308329..a6c4f5c08 100644 --- a/client/rpc/routing.go +++ b/client/rpc/routing.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "bytes" diff --git a/client/rpc/swarm.go b/client/rpc/swarm.go index 9b073078d..49ece0d07 100644 --- a/client/rpc/swarm.go +++ b/client/rpc/swarm.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/client/rpc/unixfs.go b/client/rpc/unixfs.go index b9c34c59f..2099f190b 100644 --- a/client/rpc/unixfs.go +++ b/client/rpc/unixfs.go @@ -1,4 +1,4 @@ -package httpapi +package rpc import ( "context" diff --git a/docs/changelogs/v0.21.md b/docs/changelogs/v0.21.md index d88a48fa6..ce08e3dcc 100644 --- a/docs/changelogs/v0.21.md +++ b/docs/changelogs/v0.21.md @@ -66,7 +66,8 @@ updated the CoreAPI with new Kubo features but forgot to port thoses to the http-client, making it impossible to use them together with the same coreapi version. -**TODO(@Jorropo)**: add link to `boxo-migrate` once support for rewriting this import path has been added +For smooth transition `v0.7.0` of `go-ipfs-http-client` provides updated stubs +for Kubo `v0.21`. ### 📝 Changelog diff --git a/docs/http-rpc-clients.md b/docs/http-rpc-clients.md index 0a6ea369d..0b4baa1b0 100644 --- a/docs/http-rpc-clients.md +++ b/docs/http-rpc-clients.md @@ -4,11 +4,11 @@ Kubo provides official HTTP RPC (`/api/v0`) clients for selected languages: - [`js-kubo-rpc-client`](https://github.com/ipfs/js-kubo-rpc-client) - Official JS client for talking to Kubo RPC over HTTP - [`go-ipfs-api`](https://github.com/ipfs/go-ipfs-api) - The go interface to ipfs's HTTP RPC - Follow https://github.com/ipfs/kubo/issues/9124 for coming changes. -- [`httpapi`](./client/rpc) (previously `go-ipfs-http-client`)) - IPFS CoreAPI implementation using HTTP RPC +- [`httpapi`](./client/rpc) (previously `go-ipfs-http-client`) - [`coreiface.CoreAPI`](https://pkg.go.dev/github.com/ipfs/boxo/coreiface#CoreAPI) implementation using HTTP RPC ## Recommended clients | Language | Package Name | Github Repository | |:--------:|:-------------------:|--------------------------------------------| | JS | kubo-rpc-client | https://github.com/ipfs/js-kubo-rpc-client | -| Go | `httpapi` | [`./client/rpc`](./client/rpc) | +| Go | `rpc` | [`./client/rpc`](./client/rpc) |