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

Support of #arc3 in URL, MIME, CORS #33

Merged

Conversation

fabrice102
Copy link
Contributor

This PR applies the proposed changes in
#3 (comment)

as well as in:
#3 (comment)
#3 (comment)
(for MIME types)

More precisely:

  • allow to use #arc3 in URL
  • explicitly indicate that MIME types should not be relied upon from a
    security point of view
  • make MIME types STRONGLY RECOMMENDED

This PR applies the proposed changes in
algorandfoundation#3 (comment)

as well as in:
algorandfoundation#3 (comment)
algorandfoundation#3 (comment)
(for MIME types)

More precisely:
* allow to use `#arc3` in URL
* explicitly indicate that MIME types should not be relied upon from a
security point of view
* make MIME types STRONGLY RECOMMENDED
* **SHOULD** be persistent and allow to download the JSON Metadata file forever.
* **MAY** contain the string `{id}`. If `{id}` exists in the URI, clients **MUST** replace this with the asset ID in decimal form. The rules below applies after such a replacement.
* **MUST** follow [RFC-3986](https://www.ietf.org/rfc/rfc3986.txt) and **MUST NOT** contain any whitespace character
* **SHOULD** use one of the following URI schemes (for compatibility and security): *https* and *ipfs*:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to see acknowledgement of schemes like ipns:// - this was would allow mutable metadata but still all be backed by IPFS.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even if ipns was supported, this still would not allow for mutable metadata as the metadata hash cannot be changed.

In that regards, do we still think ipns is to be supported?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just wouldn't want to define a metadata hash as it wouldn't be fixed. The URL would point to an ipns link and the ARC3 metadata would be dereferenced via ipns [dnslink] -> ipfs CIDs. This data would intentionally be mutable but being stored via ipfs would have decentralization benefits.
Personally, I think if ARC3 is going to draw a line in the sand that the metadata must be completely immutable I think that's an issue for some use cases.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The metadata may be static if there is an IPFS url with a json metadata payload which further contains an IPNS link.

Another option is to make a new ARC-N to describe mutable NFTs which seems to be something a number of folks want.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We definitely need to allow mutable metadata in the future. But let's do it via another ARC.

Update example (that is non-normative) to match the text better
Mark the ARC final as announced in
algorandfoundation#3 (comment)
@fabrice102 fabrice102 merged commit 591a0b7 into algorandfoundation:main Oct 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants