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

Expand documentation on Metadata #451

Open
5 tasks
6r1d opened this issue Dec 15, 2023 · 1 comment
Open
5 tasks

Expand documentation on Metadata #451

6r1d opened this issue Dec 15, 2023 · 1 comment
Labels
A-important High-impact, important change I-concepts Core Iroha concepts (data model, operations, mechanics) M-epic Issues/PRs that depend on other items (e.g. tracking issues)
Milestone

Comments

@6r1d
Copy link
Contributor

6r1d commented Dec 15, 2023

Following #450, I believe we should also refresh documentation on metadata. I will list the details I believe are worth documenting.

  • Metadata entity access aspects: who sees the keys and values, who could limit the visibility of data? According to @Mingela, this is defined by the executor and one should have a look at a list of the default permissions here hyperledger/iroha@7523a69/smart_contract/executor/src/default/tokens.rs#L66
  • Make sure there are iroha_client_cli examples of working with Metadata
  • Make sure there is a Rust-based example for working with Metadata: adding keys with values of different types, reading them, removing them, transferring them between different entities
  • Make sure there's a WASM example for working with Metadata. Demonstrate the transfer of metadata as pointed out by @takemiyamakoto in the community chat: "The object's metadata can be transferred one by one, or in bulk via a WASM transaction."
  • Explain an "object"'s Metadata fields can't be accessed directly, given the question from Matias about the Store asset: "Should I use an object's metadata, but not the Store type directly if I need to store key/value type data?". He asked it after reading "There is also the Store asset type, which is used for storing key-values in object's metadata." in asset documentation and got confused.

This list may not cover some important aspects of Metadata behaviour. Please feel free to comment so it is expanded and our documentation provides enough material to work with it.

@dmitrivenger
Copy link

Will discuss this request during our next call

@6r1d 6r1d added the M-epic Issues/PRs that depend on other items (e.g. tracking issues) label Dec 15, 2023
@nxsaken nxsaken removed the iroha2 label May 16, 2024
@nxsaken nxsaken added this to the 2.0.0-rc.1.0 milestone May 20, 2024
@nxsaken nxsaken added I-concepts Core Iroha concepts (data model, operations, mechanics) and removed documentation labels May 20, 2024
@nxsaken nxsaken added M-faq A-important High-impact, important change and removed M-faq labels May 24, 2024
@nxsaken nxsaken changed the title Metadata behaviour details Expand documentation on Metadata May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-important High-impact, important change I-concepts Core Iroha concepts (data model, operations, mechanics) M-epic Issues/PRs that depend on other items (e.g. tracking issues)
Projects
None yet
Development

No branches or pull requests

3 participants