example: turn directory into UnixFS DAG

ipfs / boxo

A set of reference libraries for building IPFS applications and implementations in Go.

https://github.com/ipfs/boxo#readme

Other

213 stars 95 forks source link

example: turn directory into UnixFS DAG #663

Open lidel opened 2 months ago

lidel commented 2 months ago

Problem

We have many unixfs implementations, and it is extremely confusing for new developers to understand what they should use and why. (cc @2color)

Proposed improvement

The ./exmaples should have an example of ipfs add + ipfs dag export equivalent for reading a file or a directory from local filesystem, and turning it into a CAR with UnixFS DAG that was properly chunked / HAMT-sharded.

The example should be a CLI tool that accepts same flags as ipfs add, demonstrating how to adjust chunker, hash function, or decide if mode/mtime should be preserved.

lidel commented 2 months ago

Triage notes:

we are missing high level api, may need to create new ones first
could be an example with existing APIs and opinionated as ipfs add from Kubo + document default settings

mostcute commented 1 month ago

maybe show only server side will be more simple,like the bitswap transfer ,no need a CLI+daemon or client/server mode example

mostcute commented 1 month ago

client side can show how to get/download the whole dir and single file in a dir. show how client to parse the dag from dir-cid and choose a file to get

lidel commented 2 weeks ago

PRs with example ideas are welcome. Feel free to open PR drafts + comment on identified gaps + refer this issue in description.