Final updates before public last call for v3 freeze - Githubissues

ethpm / ethpm-spec

Ethereum Package Manager http://ethpm.github.io/ethpm-spec/

165 stars 30 forks source link

Final updates before public last call for v3 freeze #146

Closed njgheorghita closed 4 years ago

njgheorghita commented 4 years ago

Final changes from sync implemented into docs and schema.

Includes...

Remove requirement for brackets to surround contract alias identifiers. It was felt that this was an unnecessarily strict requirement.
Update contract type name regex to include _ and $ which are valid solidity contract names.
Update docs to reflect natspec -> userdoc & devdoc
Add source field to a contract type object to point towards the respective source file.
Some refactoring in schema to reduce duplicated regex
update v3 examples

TODO (in future prs):

comprehensive tests for machine readable schema / regex