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 off-chain URI fields, raw data to metadata record input/outputs. #2146

Open
4 tasks
iramiller opened this issue Sep 11, 2024 · 1 comment
Open
4 tasks
Labels
enhancement New feature or request metadata Metadata Module
Milestone

Comments

@iramiller
Copy link
Member

Summary

Records in the provenance metadata module are created around the assumption of an off-chain data store that holds the record information. In non-Figure use cases there are typically three different scenarios; directly on chain data, off-chain data referenced by URI+HASH, and off-chain object storage. Our record feature should be extended to support these other two common use cases.

Problem Definition

Not all users follow the object store approach used by Figure for NFT records. In order to better match other use cases such as the simplified ERC721 model the metadata record objects should be extended with support for the other two [more] common use cases of on-chain data and off-chain at URI location with an on-chain hash.

Proposal

Expand the record input and record output structures to include support for URI locations and (limited) inline data.

      "record": {
        "name": "digital_signature_packets",
        "session_id": "session1qyru935fkw9y7yasfkanzg946dz3e3nx4jgxjjluh793an73knqcx2l0hy5",
        "process": {
          "hash": "AC6hBXSVmLXgJKgPvxzgnQgFP7bghdVaB9yQHpdB640=",
          "name": "io.provenance.proto.common.DocumentProtos$DocumentWithDataList",
          "method": "digitalSignaturePackets"
        },
        "inputs": [
          {
            "name": "digital_signature_packets",
            "hash": "LZseyssJ/pplLtCbmmlEx3hy0kdsH9WJvOXaJzfmLac=",
            "type_name": "io.provenance.proto.common.DocumentProtos$DocumentWithDataList",
            "status": "RECORD_INPUT_STATUS_PROPOSED"
          }
        ],
        "outputs": [
          {
            "hash": "LZseyssJ/pplLtCbmmlEx3hy0kdsH9WJvOXaJzfmLac=",
            "status": "RESULT_STATUS_PASS"
          }
        ],
        "specification_id": "recspec1qhe5jmlq8n9mm09el5dnuytz625j2vnjxcq5qn4t62ld7tu9djvq50cgcrv"
      }

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@iramiller iramiller added enhancement New feature or request metadata Metadata Module labels Sep 11, 2024
@iramiller iramiller added this to the v1.20.0 milestone Sep 11, 2024
@iramiller
Copy link
Member Author

We should also review ZK proof output and see if it makes sense to add or adjust these fields to show this.

@SpicyLemon SpicyLemon modified the milestones: v1.20.0, v1.21.0 Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request metadata Metadata Module
Projects
Development

No branches or pull requests

2 participants