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.

Sign up for GitHub

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

Develop to master #12

Merged
merged 8 commits into from
Apr 15, 2019
Merged

Develop to master #12

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cbb2529
Removing JSON support reference
TaraTritt Apr 15, 2019
439c6e8
Fix example to user YAML not JSON format
TaraTritt Apr 15, 2019
f625b4e
Removing extra new line in example
TaraTritt Apr 15, 2019
0a88689
Update formatting of example
TaraTritt Apr 15, 2019
738d2b6
Remove resource mention in icon metadata
TaraTritt Apr 15, 2019
e83b290
Remove extra new line from example
TaraTritt Apr 15, 2019
d410d5e
Update version
TaraTritt Apr 15, 2019
3372a31
Merge pull request #11 from EOSIO/remove-json-refs
TaraTritt Apr 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## EOSIO.CDT Ricardian Contract Specification ![EOSIO Alpha](https://img.shields.io/badge/EOSIO-Alpha-blue.svg)

**Spec Version**: v0.1.0
**Spec Version**: v0.1.1

### General Information
In conjunction with [Ricardian Template Toolkit](https://github.com/EOSIO/ricardian-template-toolkit/), this specification is a new addition to the [EOSIO.CDT](https://github.com/EOSIO/eosio.cdt) suite of tooling.
Expand All @@ -9,7 +9,7 @@ The Ricardian Contract Specification gives a set of requirements that a Ricardia

By conforming to a common specification, contracts can be validated and presented in a common way. For instance, Resources must contain a SHA-256 hash value which will allow a validating user agent to check the resource contents and ensure that the resource at the URL has not been altered. Since resources can be used to represent the user or company that is proposing the contract, it is important that the resource URL for the contract is correct and has not been altered since the contract was published.

Ricardian contracts should be written in the English language. The contract itself consists of a set of metadata values supplied in JSON format or YAML format, followed by the body of the contract, written using a subset of [CommonMark](https://commonmark.org/) with [Handlebars](https://handlebarsjs.com/)-based variable substitution.
Ricardian contracts should be written in the English language. The contract itself consists of a set of metadata values supplied in YAML format, followed by the body of the contract, written using a subset of [CommonMark](https://commonmark.org/) with [Handlebars](https://handlebarsjs.com/)-based variable substitution. Future versions may add support for metadata values supplied in JSON format.

### Metadata Fields

Expand All @@ -29,7 +29,6 @@ Ricardian contracts should be written in the English language. The contract itse
* `icon` -- *Required*
* Provides a user-friendly graphical representation of the intent of the action
* Is required to be a 256x256 pixel PNG image
* Must be a valid Resource (*see below*)
* Must include the SHA-256 hash. Contracts containing an icon without hashes will be rejected.
* This icon may be displayed alongside the Ricardian contract

Expand Down Expand Up @@ -120,8 +119,6 @@ icon: https://app.com/create-post.png#00506E08A55BCF269FE67F202BBC08CFF55F9E3C7C
---
I, {{author}}, author of the blog post "{{title}}", certify that I am the original author of the contents of this blog post and have attributed all external sources appropriately.

{{$resources.content}}

{{$clauses.legalese}}
```

Expand All @@ -132,7 +129,7 @@ I, {{author}}, author of the blog post "{{title}}", certify that I am the origin
{
"name": "createpost",
"type": "createpost",
"ricardian_contract": "---\n{\n \"title\": \"Create Post\",\n \"summary\": \"Create a blog post \\\"{{title}}\\\" by {{author}} tagged as \\\"{{tag}}\\\"\",\n \"icon\": {\n \"type\": \"image\",\n \"hash\": \"00506E08A55BCF269FE67F202BBC08CFF55F9E3C7CD4459ECB90205BF3C3B562\",\n \"urls\": [\n \"https://app.com/create-post.png\",\n \"https://dev.app.com/create-post.png\"\n ]\n },\n \"resources\": {\n \"content\": {\n \"type\": \"image\",\n \"hash\": \"1324FECCDDBB89089089090\",\n \"urls\": [\n \"https://app.com/user-1/profile-pic.jpg\",\n ]\n }\n }\n}\n---\nI, {{author}}, author of the blog post \"{{title}}\", certify that I am the original author of the contents of this blog post and have attributed all external sources appropriately.\n\n{{$resources.content}}\n\n{{$clauses.legalese}}"
"ricardian_contract": "---\ntitle: Create Post\nsummary: Create a blog post \"{{title}}\" by {{author}} tagged as \"{{tag}}\"\nicon: https://app.com/create-post.png#00506E08A55BCF269FE67F202BBC08CFF55F9E3C7CD4459ECB90205BF3C3B562\n---\nI, {{author}}, author of the blog post \"{{title}}\", certify that I am the original author of the contents of this blog post and have attributed all external sources appropriately.\n\n{{$clauses.legalese}}"
}
],

Expand Down