opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-05-17 06:57:40 +08:00
Code Issues Projects Releases Wiki Activity

client/rpc: rename package name to match rpc and edit migration story

Browse Source
This commit is contained in:
Jorropo
2023-05-31 14:29:59 +02:00
parent 4019d94fef
commit 12f343d837
23 changed files with 27 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
client/rpc/README.md
View File

@ -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

2
client/rpc/api.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"errors"

2
client/rpc/api_test.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

2
client/rpc/apifile.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

2
client/rpc/block.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"bytes"

2
client/rpc/dag.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"bytes"

2
client/rpc/dht.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

2
client/rpc/errors.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"errors"

2
client/rpc/errors_test.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"errors"

2
client/rpc/key.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

2
client/rpc/name.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

2
client/rpc/object.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"bytes"

2
client/rpc/path.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

2
client/rpc/pin.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

2
client/rpc/pubsub.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"bytes"

2
client/rpc/request.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

2
client/rpc/requestbuilder.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"bytes"

2
client/rpc/response.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"encoding/json"

2
client/rpc/routing.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"bytes"

2
client/rpc/swarm.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

2
client/rpc/unixfs.go
View File

@ -1,4 +1,4 @@
package httpapi
package rpc
import (
"context"

3
docs/changelogs/v0.21.md
View File

@ -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

4
docs/http-rpc-clients.md
View File

@ -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) |