Skip to content

Fix broken Go client code samples #184

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

Draft
prodalex wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Fix broken Go client code samples #184

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
83 changes: 35 additions & 48 deletions src/pages/go-client.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ To interact with the Storacha API you need your private key to sign UCAN invocat
package main

import (
"ioutil"
"os"

"github.com/storacha/go-ucanto/did"
"github.com/storacha/go-ucanto/principal/ed25519/signer"
Expand All @@ -110,68 +110,60 @@ import (
space, _ := did.Parse("did:key:z6MkwDuRThQcyWjqNsK54yKAmzfsiH6BTkASyiucThMtHt1y")

// private key to sign UCAN invocations with
priv, _ := ioutil.ReadFile("path/to/private.key")
issuer, _ := signer.Parse(priv)
keybytes, _ := os.ReadFile("path/to/private.key")
issuer, _ := signer.FromRaw(keybytes)

// UCAN proof(s) that the signer can perform tasks in this space (a delegation chain)
prfbytes, _ := ioutil.ReadFile("path/to/proof.ucan")
prfbytes, _ := os.ReadFile("path/to/proof.ucan")
proof, _ := delegation.ExtractProof(prfbytes)
```

## Upload a CAR

Once you have loaded your space DID, your private key and your delegation proofs, you can upload a CAR ([content addressed archive file](/concepts/car)) to Storacha.

<Callout type="error">
The following code sample is out of date. An update is coming soon.
</Callout>
Once you have loaded your space DID, your private key and your delegation proof, you can upload a CAR ([content addressed archive file](/concepts/car)) to Storacha.

```go
package main

import (
"bytes"
"fmt"
"net/http"

"github.com/ipfs/go-cid"
"github.com/ipld/go-ipld-prime/linking/cid"
"github.com/multiformats/go-multihash"
"github.com/storacha/guppy/capability/storeadd"
"github.com/storachas/guppy/client"
"context"
"fmt"
"os"

"github.com/storacha/go-ucanto/did"
"github.com/storacha/go-ucanto/principal/ed25519/signer"
"github.com/storacha/guppy/pkg/client"
"github.com/storacha/guppy/pkg/delegation"
)

func main() {
data, _ := ioutil.ReadFile("path/to/my.car")
ctx := context.Background()

// generate the CID for the CAR
mh, _ := multihash.Sum(data, multihash.SHA2_256, -1)
link := cidlink.Link{Cid: cid.NewCidV1(0x0202, mh)}
// space that the client will interact with
space, _ := did.Parse("did:key:z6MkwDuRThQcyWjqNsK54yKAmzfsiH6BTkASyiucThMtHt1y")

rcpt, _ := client.StoreAdd(
issuer,
space,
&storeadd.Caveat{Link: link, Size: len(data)},
client.WithProofs(proofs),
)
// private key to sign UCAN invocations with
keybytes, _ := os.ReadFile("path/to/private.key")
issuer, _ := signer.FromRaw(keybytes)

// "upload" means it needs to be uploaded, "done" means it is already done!
if rcpt.Out().Ok().Status == "upload" {
hr, _ := http.NewRequest("PUT", *rcpt.Out().Ok().Url, bytes.NewReader(data))
// UCAN proof(s) that the signer can perform tasks in this space (a delegation chain)
prfbytes, _ := os.ReadFile("path/to/proof.ucan")
proof, _ := delegation.ExtractProof(prfbytes)

hdr := map[string][]string{}
for k, v := range rcpt.Out().Ok().Headers.Values {
hdr[k] = []string{v}
}
// create a client with your identity and proof
c, _ := client.NewClient(
client.WithPrincipal(issuer),
client.WithAdditionalProofs(proof),
)

hr.Header = hdr
hr.ContentLength = len(data)
httpClient := http.Client{}
res, _ := httpClient.Do(hr)
res.Body.Close()
}
// open the CAR file
carFile, _ := os.Open("path/to/my.car")
defer carFile.Close()

fmt.Println(link.String())
// upload the CAR — the client handles hashing, allocation, and HTTP upload
blob, _ := c.SpaceBlobAdd(ctx, carFile, space)

fmt.Printf("Uploaded blob: %d bytes\n", blob.Size)
}
```

Expand All @@ -188,10 +180,5 @@ A DAG can be sharded amongst multiple CAR files (see maximum upload size above).
Registering an upload is simple:

```go
rcpt, _ := client.UploadAdd(
issuer,
space,
&uploadadd.Caveat{Root: root, Shards: shards},
client.WithProofs(proofs),
)
uploadOk, _ := c.UploadAdd(ctx, space, root, shards)
```
Loading