client/rpc: rename package name to match rpc and edit migration story
Jorropo committed
May 31, 2023 at 14:29 UTC
12f343d837850b0cb198ccf2b40630bdbf1ec715
23 files changed
+27
-26
client/rpc/README.md
+3
-3
@@ -1,4 +1,4 @@
1
-# `httpapi`
1
+# `coreiface.CoreAPI` over http `rpc`
2
3
> IPFS CoreAPI implementation using HTTP API
4
@@ -19,13 +19,13 @@ import (
19
"context"
20
"fmt"
21
22
- ipfsClient "github.com/ipfs/kubo/client/rpc"
22
+ "github.com/ipfs/kubo/client/rpc"
23
path "github.com/ipfs/boxo/coreiface/path"
24
)
25
26
func main() {
27
// "Connect" to local node
28
- node, err := ipfsClient.NewLocalApi()
28
+ node, err := rpc.NewLocalApi()
29
if err != nil {
30
fmt.Printf(err)
31
return
client/rpc/api.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"errors"
client/rpc/api_test.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
client/rpc/apifile.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
client/rpc/block.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"bytes"
client/rpc/dag.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"bytes"
client/rpc/dht.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
client/rpc/errors.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"errors"
client/rpc/errors_test.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"errors"
client/rpc/key.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
client/rpc/name.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
client/rpc/object.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"bytes"
client/rpc/path.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
client/rpc/pin.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
client/rpc/pubsub.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"bytes"
client/rpc/request.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
client/rpc/requestbuilder.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"bytes"
client/rpc/response.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"encoding/json"
client/rpc/routing.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"bytes"
client/rpc/swarm.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
client/rpc/unixfs.go
+1
-1
@@ -1,4 +1,4 @@
1
-package httpapi
1
+package rpc
2
3
import (
4
"context"
docs/changelogs/v0.21.md
+2
-1
@@ -66,7 +66,8 @@ updated the CoreAPI with new Kubo features but forgot to port thoses to the
66
http-client, making it impossible to use them together with the same coreapi
67
version.
68
69
-**TODO(@Jorropo)**: add link to `boxo-migrate` once support for rewriting this import path has been added
69
+For smooth transition `v0.7.0` of `go-ipfs-http-client` provides updated stubs
70
+for Kubo `v0.21`.
71
72
### 📝 Changelog
73
docs/http-rpc-clients.md
+2
-2
@@ -4,11 +4,11 @@ Kubo provides official HTTP RPC (`/api/v0`) clients for selected languages:
4
5
- [`js-kubo-rpc-client`](https://github.com/ipfs/js-kubo-rpc-client) - Official JS client for talking to Kubo RPC over HTTP
6
- [`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.
7
-- [`httpapi`](./client/rpc) (previously `go-ipfs-http-client`)) - IPFS CoreAPI implementation using HTTP RPC
7
+- [`httpapi`](./client/rpc) (previously `go-ipfs-http-client`) - [`coreiface.CoreAPI`](https://pkg.go.dev/github.com/ipfs/boxo/coreiface#CoreAPI) implementation using HTTP RPC
8
9
## Recommended clients
10
11
| Language | Package Name | Github Repository |
12
|:--------:|:-------------------:|--------------------------------------------|
13
| JS | kubo-rpc-client | https://github.com/ipfs/js-kubo-rpc-client |
14
-| Go | `httpapi` | [`./client/rpc`](./client/rpc) |
14
+| Go | `rpc` | [`./client/rpc`](./client/rpc) |