debugger

Various tools and commands that can help debugging the Storacha Network.

Install

go install github.com/storacha/debugger

Usage

debugger blobindex extract [car-file]

Extract a sharded DAG index that has been archived to a CAR. You can pipe directly to this command.

e.g.

$ debugger blobindex extract index.car
Content:
  bafybeiaqkhr2arwjc2solqwoiu2tncfrlptzmvkok72tdpdq5uiezoyhwi
Shards (14):
  zQmeDoFFnXb2zYYi4hFdNKz9kAwu5eHYLm7LokxQyfmjp1M
    Slices (253):
      zQmeoqurjukfWtjsNry2ogGNWifv66RsKRCNGar8xvf5apS @ 12583437-13632013
      zQmW6zw35SdyRhbuV44Kjwwju54drMXHup8JjRMEzDYb8q8 @ 177215992-178264568
...

debugger cid b58mh [cid]

Extract the multihash from a CID and print the multibase base58btc encoded string.

e.g.

$ debugger cid b58mh bafybeihfcdsxbirwgcuyrvabs3xi5adpootdutwy4zmluarltyskmszvla
zQmdkq1rExA72pPVr83RZNA1uRtNNimATafgTJxbf2fW54K

debugger cid decode <file>

Decode a byte encoded CID and print information to the console.

e.g.

$ debugger cid decode ./cid.bin
CID:        baguqeera3nw74wxxypvzcrf7jlieskytzaohhd4zyana2ndnk4ubjl2p5rvq (base32)
Version:    1
IPLD Codec: 0x129 (dag-json)
Digest:     zQmd7DGrjv8juYkDPsc4HHfCH6QUaMuQr32aHb4AuJWBZQv (base58btc)
Code:       0x12 (sha2-256)
Length:     32

debugger cid parse <cid>

Parse a CID and print information to the console.

$ debugger cid parse baguqeera3nw74wxxypvzcrf7jlieskytzaohhd4zyana2ndnk4ubjl2p5rvq
CID:        baguqeera3nw74wxxypvzcrf7jlieskytzaohhd4zyana2ndnk4ubjl2p5rvq (base32)
Version:    1
IPLD Codec: 0x129 (dag-json)
Digest:     zQmd7DGrjv8juYkDPsc4HHfCH6QUaMuQr32aHb4AuJWBZQv (base58btc)
Code:       0x12 (sha2-256)
Length:     32

debugger dagcbor decode <file>

Decode dag-cbor encoded data, format it as dag-json and print to the console.

debugger did parse <did>

Parse a DID and print information to the console.

$ debugger did parse did:key:z6MksdurUPk5bnKg34ZhRoCH6yrRdQzCTpSy8EvnheVJT7bE
DID:    did:key:z6MksdurUPk5bnKg34ZhRoCH6yrRdQzCTpSy8EvnheVJT7bE
PeerID: 12D3KooWP11ydH5MT96hLTERNpyn2gPGJAkz5dH6PpNtFMgBRqXn

debugger delegation extract [car-file]

Extract a delegation that has been archived to a CAR. You can pipe directly to this command.

e.g.

$ debugger delegation extract ucan.car
bafyreib5ygdak2sc6fd3coryjql6u4gcmjg7co5w2rbpvb6lqkqbnzehti
  Issuer: did:web:staging.up.storacha.network
  Audience: did:web:staging.indexer.storacha.network
  Capabilities:
    Can: assert/index
    With: did:web:staging.indexer.storacha.network
    Nb: &{map[content:0x140003497e0 index:0x140003497c0] [{index 0x140003497c0} {content 0x140003497e0}]}
...

debugger delegation parse <value>

Parse and print a UCAN delegation.

debugger flatfs path <blob-cid-or-multihash>

Given a blob CID or multibase encoded multihash, convert it to a FlatFS datastore path (Piri edition).

e.g.

$ debugger flatfs path bagbaiera3f6ylgq5yqop4scfkgxibtbfzfgegm5gzrssdxv37zdkmxz2j4vq
/6k/ciqns7mftio4ihh6jbcvdluazqs4stcdgotmyzjb32574rvgl45e6ky.data

$ debugger flatfs path zQmQE3fBFV8xQKeA34gspkmoWyyvJKKJYzybPGq6zLu4pTw
/od/ciqbybsb3rvglosb2m6pfdnweid6dp7mk4tnp6mimilduuwa4v4hodq.data

debugger ipni metadata parse <value>

Parse a base64 encoded IPNI metadata.

e.g.

$ debugger ipni metadata parse gID4AaNhY9gqWCUAAXESID3BhgVqQvFHsTo4TBfqcMJiTfE7ttRC+ofLgqAW5IeaYWUAYWnYKlgmAAGCBBIgUX8wwCPTHNNAl3QqAdrM+j5wl47D87QWT+Ps3ZlKQ4Y=
ID: 0x3e0000 (index claim)
Claim: bafyreib5ygdak2sc6fd3coryjql6u4gcmjg7co5w2rbpvb6lqkqbnzehti
Index: bagbaierakf7tbqbd2mongqexoqvadwwm7i7hbf4oypz3ifsp4pwn3gkkioda
Expiration: 1970-01-01 01:00:00 +0100 BST

debugger message extract [car-file]

Extract a Ucanto agent message CAR and print information.

debugger message parse <value>

Parse a multibase encoded Ucanto agent message CAR and print information.

debugger peer parse <libp2p-peer-id>

Parse a libp2p peer ID and print information to the console.

$ debugger peer parse 12D3KooWP11ydH5MT96hLTERNpyn2gPGJAkz5dH6PpNtFMgBRqXn
PeerID: 12D3KooWP11ydH5MT96hLTERNpyn2gPGJAkz5dH6PpNtFMgBRqXn
DID:    did:key:z6MksdurUPk5bnKg34ZhRoCH6yrRdQzCTpSy8EvnheVJT7bE

debugger retrieve <url> <auth>

Attempt to retrieve data from the passed URL using the provided authorization, which is expected to be an X-Agent-Message header.

Note: when providing auth as a X-Agent-Message, it is expected to be gzipped and multibase encoded.

debugger xagentmessage parse <value>

Parse a gzipped and multibase encoded X-Agent-Message header.