Generate extended contract metadata#62
Merged
Merged
Conversation
This reverts commit 0929ce8
Robbepop
reviewed
Jul 8, 2020
# Conflicts: # src/cmd/metadata.rs
# Conflicts: # src/workspace/metadata.rs # templates/new/_Cargo.toml
ascjones
changed the title
Robbepop
reviewed
Jul 21, 2020
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #57. Part of use-ink/ink#299.
Generates extended metadata described here: use-ink/ink#299 (comment) (reproduced below)
metadata_version: Required semantic version for the smart contract metadata.sourcesection:hash: Required of the associated Wasm file using BLAKE2 256-bitlanguage: e.g. Solidity, AssemblyScript or Rust (including version X.Y.Z (semantic versioning))compiler: e.g. Solang, ink!/Rust (including version X.Y.Z (semantic versioning))contractsection:name: Required identifier for the smart contract name. (https://crates.io/crates/unicode-xid)version: Required semantic version field for the smart contract.authors: Required non-empty sequence of strings.description:Optional short description about the smart contract.documentation: Optional URL to link to API-level documentation of the smart contract.repository: Optional URL to link to the repository.homepage: Optional URL to link to the smart contract's associated homepage.license: Optional field to identify the license of the smart contract given in SPDX license list 3.6 format OR a URL to a user provided non-standard license.usersection for custom metadata fields that are generally ignored by standard tools.Types for the extended metadata are defined in
cargo-contractand combined with metadata generated byink_lang. This maintains minimal coupling withink!allowing for forwards/backwards compatibility. See the reasoning here use-ink/ink#299 (comment).