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

Enhance the metadata process structure with fields to better represent normal software #2147

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

Comments

@iramiller
Copy link
Member

Summary

The current Process structure is heavily influenced by the concept of a JVM jar file. Unfortunately this is not how most software is actually released and managed. This structure should be realigned around a software release/version style typically used by modern software.

Problem Definition

Currently the Process reference for software in the metadata object is limited and not useful as it presumes that there would be a single hash used to identify the binary used to generate the results. A more typical result such as the standard used by the provenanced protocol would be a source code location and a version.

message Process {
  option (gogoproto.goproto_stringer) = false;
  // unique identifier for this process
  oneof process_id {
    // the address of a smart contract used for this process
    string address = 1;
    // the hash of an off-chain process used
    string hash = 2;
  }
  // a name associated with the process (type_name, classname or smart contract common name)
  string name = 3;
  // method is a name or reference to a specific operation (method) within a class/contract that was invoked
  string method = 4;
}

Proposal

Update the Process data to capture information used in modern software versioning such as that used by go and others which points to a source code location, a version, and in some cases a hash. This could be added as another option to the one of directive for referencing the software.

github.com/provenance-io/cosmos-sdk v0.50.7-pio-1 h1:A4WC4LzcQj6jh+WdIIP4OIN3DCSW1t5qONtkYrJ77jg=

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

Optionally we could just use the hash string as a place to put the full GitHub/version/hash example from go.mod above.

@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