Skip to content

feat: add filecoin info command to query storage status #230

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

Open
Goddhi wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: add filecoin info command to query storage status #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa8072f
feat: filecoin method/command
Goddhi Dec 4, 2025
ce73bf9
minor fix
Goddhi Dec 4, 2025
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
11 changes: 11 additions & 0 deletions cmd/filecoin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package cmd

import (
"github.com/storacha/guppy/cmd/filecoin"
)

func init() {
filecoin.StorePathP = &storePath

rootCmd.AddCommand(filecoin.FilecoinCmd)
}
13 changes: 13 additions & 0 deletions cmd/filecoin/filecoin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package filecoin

import (
"github.com/spf13/cobra"
)

var StorePathP *string

var FilecoinCmd = &cobra.Command{
Use: "filecoin",
Short: "Interact with Filecoin capabilities",
Long: "Commands for interacting with the Filecoin storage pipeline, such as querying piece status.",
}
97 changes: 97 additions & 0 deletions cmd/filecoin/info.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
package filecoin

import (
"encoding/json"
"fmt"

"github.com/ipfs/go-cid"
"github.com/mitchellh/go-wordwrap"
mh "github.com/multiformats/go-multihash"
"github.com/spf13/cobra"
"github.com/storacha/go-ucanto/did"
"github.com/storacha/guppy/internal/cmdutil"
)

var infoFlags struct {
jsonOutput bool
space string
}

var infoCmd = &cobra.Command{
Use: "info <piece-cid>",
Short: "Get information about a piece",
Long: wordwrap.WrapString(
"Gets information about a piece's storage status. You must provide the Space DID associated with the content.",
80),
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if infoFlags.space == "" {
return fmt.Errorf("space DID is required. Use --space <did>")
}
spaceDID, err := did.Parse(infoFlags.space)
if err != nil {
return fmt.Errorf("invalid space DID: %w", err)
}

pieceCid, err := cid.Decode(args[0])
if err != nil {
return fmt.Errorf("invalid piece CID: %w", err)
}

decodedMh, err := mh.Decode(pieceCid.Hash())
if err != nil {
return fmt.Errorf("decoding multihash: %w", err)
}

if pieceCid.Type() != cid.Raw || decodedMh.Code != 0x1011 {
newMh, err := mh.Encode(decodedMh.Digest, 0x1011)
if err != nil {
return fmt.Errorf("encoding multihash: %w", err)
}
pieceCid = cid.NewCidV1(cid.Raw, newMh)
}

c := cmdutil.MustGetClient(*StorePathP)

result, err := c.FilecoinInfo(cmd.Context(), pieceCid, spaceDID)
if err != nil {
return fmt.Errorf("getting filecoin info: %w", err)
}

// 4. Output
if infoFlags.jsonOutput {
jsonBytes, err := json.MarshalIndent(result, "", " ")
if err != nil {
return fmt.Errorf("marshaling output: %w", err)
}
fmt.Println(string(jsonBytes))
} else {
fmt.Printf("Piece: %s\n", result.Piece.String())

if len(result.Aggregates) > 0 {
fmt.Println("\nAggregates:")
for _, agg := range result.Aggregates {
fmt.Printf(" CID: %s\n", agg.Aggregate.String())
}
}

if len(result.Deals) > 0 {
fmt.Println("\nDeals:")
for _, deal := range result.Deals {
fmt.Printf(" - Provider: %s\n", deal.Provider)
fmt.Printf(" Deal ID: %d\n", deal.Aux.DataSource.DealID)
}
} else {
fmt.Println("\nNo active deals found yet.")
}
}

return nil
},
}

func init() {
infoCmd.Flags().BoolVar(&infoFlags.jsonOutput, "json", false, "Output in JSON format")
infoCmd.Flags().StringVarP(&infoFlags.space, "space", "s", "", "Space DID (required)")
FilecoinCmd.AddCommand(infoCmd)
}
48 changes: 48 additions & 0 deletions pkg/client/filecoininfo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package client

import (
"context"
"fmt"

"github.com/ipfs/go-cid"
cidlink "github.com/ipld/go-ipld-prime/linking/cid"
filecoincap "github.com/storacha/go-libstoracha/capabilities/filecoin"
"github.com/storacha/go-ucanto/core/result"
"github.com/storacha/go-ucanto/did"
)

// FilecoinInfo retrieves info about a content piece in Filecoin deals.
func (c *Client) FilecoinInfo(ctx context.Context, piece cid.Cid, space did.DID) (filecoincap.InfoOk, error) {
pieceLink := cidlink.Link{Cid: piece}
caveats := filecoincap.InfoCaveats{
Piece: pieceLink,
}

inv, err := invoke[filecoincap.InfoCaveats, filecoincap.InfoOk](
c,
filecoincap.Info,
space.String(),
caveats,
)
if err != nil {
return filecoincap.InfoOk{}, fmt.Errorf("invoking `filecoin/info`: %w", err)
}

res, _, err := execute[filecoincap.InfoCaveats, filecoincap.InfoOk](
ctx,
c,
filecoincap.Info,
inv,
filecoincap.InfoOkType(),
)
if err != nil {
return filecoincap.InfoOk{}, fmt.Errorf("executing `filecoin/info`: %w", err)
}

infoOk, failErr := result.Unwrap(res)
if failErr != nil {
return filecoincap.InfoOk{}, fmt.Errorf("`filecoin/info` failed: %w", failErr)
}

return infoOk, nil
}