Skip to content
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.

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

Add examples for other IPLD formats #62

Open
lidel opened this issue May 28, 2020 · 5 comments
Open

Add examples for other IPLD formats #62

lidel opened this issue May 28, 2020 · 5 comments
Labels
effort/days Estimated to take multiple days, but less than a week exp/novice Someone with a little familiarity can pick up help wanted Seeking public contribution on this issue kind/discussion Topical discussion; usually not changes to codebase kind/maintenance Work required to avoid breaking changes or harm to project's status quo need/community-input Needs input from the wider community P1 High: Likely tackled by core team if no one steps up topic/design-content Content design, writing, information architecture

Comments

@lidel
Copy link
Collaborator

lidel commented May 28, 2020

Figuring this out feels like a subtask of #55 – cc @jessicaschilling

Right now only three formats are demoed at https://explore.ipld.io (and in ipfs-webui):
ipld-dag-pb (unixfvs1), ipld-git and ipld-ethereum:

Screen Shot 2020-05-28 at 13 50 51

The app itself imports more codecs, most of them remain unused, which also makes it harder to detect any regressions:

https://github.com/ipfs-shipyard/ipld-explorer/blob/56de6933669fb7e1dd7422616f265c3392ee9a24/src/bundles/index.js#L10-L16

@mikeal @vmx would appreciate your thoughts on:

  • Would it be beneficial to IPLD project if https://explore.ipld.io provided more examples?
    • Do you have good/preferred examples of CID for each format?
  • What is the canonical term for IPLD formats?
    (I've seen people mentioning "IPLD format", "codec", "multicodec" and even "block type", clarifying this in IPLD Explorer would make it easier for folks to use a single term)
@lidel lidel added exp/novice Someone with a little familiarity can pick up P3 Low: Not priority right now kind/discussion Topical discussion; usually not changes to codebase kind/maintenance Work required to avoid breaking changes or harm to project's status quo need/triage Needs initial labeling and prioritization need/community-input Needs input from the wider community topic/design-content Content design, writing, information architecture effort/days Estimated to take multiple days, but less than a week labels May 28, 2020
@jessicaschilling
Copy link
Contributor

+1 to this. Looking forward to hearing from @mikeal and @vmx 😊

@mikeal
Copy link

mikeal commented May 28, 2020

@rvagg if we can pin the bitcoin dataset we should include it here as well, and zcash and eth once they are imported.

What is the canonical term for IPLD formats?

The terminology we solidified about a year ago is “codec.” We only use “format” when talking about the internal format of a codec.

@vmx
Copy link
Member

vmx commented May 29, 2020

The terminology we solidified about a year ago is “codec.”

I was asked a similar thing recently and answered: "I haven't used the word 'format' for for a long time". Which is a sign that we indeed use "codec" these days.

@rvagg
Copy link
Member

rvagg commented May 30, 2020

We could build a bitcoin block explorer with this, but we'd need to pin some blocks in IPFS to make it usable. Probably shouldn't pin the entire blockchain because we're talking about many millions of IPLD blocks but we can have a selection for example purposes. (Although, if we did a good enough job and made a decent block explorer that people wanted to use we could store them locally and load them outside of IPFS, but maybe that's another user story to consider later).

How would we go about pinning a set of blocks (I have them in CAR files and can add them somewhere), is that managed here?

Also ... @mikeal, the new BTC work depends on the new multiformats work, which is not what's being used here, so it might be a bit of a rabbit hole to try and integrate it, no?

@lidel
Copy link
Collaborator Author

lidel commented Apr 2, 2021

I propose we focus on things that are actually useful out-of-the-box, namely, adding examples for raw and dag-cbor. While git-raw and eth-* are cute, they have very narrow usefulness to people when compared to those. Every codec that is included by default with go-ipfs and js-ipfs should have an example in IPLD Explorer, but that is not the case at the moment.

raw is easy (echo -n "hello" | ipfs add --cid-version) but unsure what would be a good example for dag-cbor – any prior art? If not, I can create dag-cbor with fake NFT metadata or something.

@lidel lidel added help wanted Seeking public contribution on this issue P1 High: Likely tackled by core team if no one steps up and removed need/triage Needs initial labeling and prioritization P3 Low: Not priority right now labels Nov 19, 2021
@lidel lidel added this to Weekly Candidates in Maintenance Priorities - JS Nov 19, 2021
@BigLep BigLep removed this from Weekly Candidates in Maintenance Priorities - JS May 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/days Estimated to take multiple days, but less than a week exp/novice Someone with a little familiarity can pick up help wanted Seeking public contribution on this issue kind/discussion Topical discussion; usually not changes to codebase kind/maintenance Work required to avoid breaking changes or harm to project's status quo need/community-input Needs input from the wider community P1 High: Likely tackled by core team if no one steps up topic/design-content Content design, writing, information architecture
Projects
None yet
Development

No branches or pull requests

5 participants