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

WIP: Grant Metadata Fleek Prototyping Spec #44

Closed
8 tasks
apbendi opened this issue Jul 26, 2021 · 1 comment
Closed
8 tasks

WIP: Grant Metadata Fleek Prototyping Spec #44

apbendi opened this issue Jul 26, 2021 · 1 comment
Assignees
Projects

Comments

@apbendi
Copy link
Collaborator

apbendi commented Jul 26, 2021

This issue is a spec for a proof of concept/prototype implementation of storing Metadata on IPFS via IPNS via the Fleek API. It's meant to demonstrate the end-to-end functionality, without including all details, such as the full Grant Schema or viewing past edits of the metadata.

Create Grant Flow

  • Update the /dgrants/new form to remove the Metadata URL field, and replace it with two new fields: Name & Description
  • When the user submits the form via "Create Grant":
    • Generate a new IPNS key via the /key/gen Fleek endpoint (TBD: What should the name be?)
    • Publish the name & description to IPFS via the appropriate Fleek IPFS endpoint using the schema below
    • Publish the IPFS CID generated above to the IPNS key using the /name/publish
  • After the Fleek API responds, use the response to store the appropriate identifier as the metadata ptr on the Grant that was created (TBD does the grant need to be created first, in order to get its identifier to use as the name, this would require a second tx to update the metaptr once IPNS was configured).

Grant Display

  • Update /dgrants to show the Grant Name & (possibly shortened) Description in each Grant Card; remove the Grant ID and mtaptr URL
  • Update /dgrants/:id to show Grant Name & Description, remove metadata URL and Grant ID
{
    "name": "My Grant Name",
    "description": "This is my Grant. There are many like it, but this one is mine."
}

Open Questions:

  • What should the IPNS name be for a give grant?
  • What is the "Arg" in the Publish IPNS key?
@phutchins phutchins added this to To Do in dGrants Jul 27, 2021
@apbendi
Copy link
Collaborator Author

apbendi commented Jul 30, 2021

closed in favor of #67. See #66 for more.

@apbendi apbendi closed this as completed Jul 30, 2021
dGrants automation moved this from To Do to Done Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant