Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Before you submit your pull request consider the following guidelines:

Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.

* Before creating the Pull Request, ensure your branch sits on top of main (as opposed to branch off a branch). This ensures the reviewer will need only minimal effort to integrate your work by fast-fowarding main:
* Before creating the Pull Request, ensure your branch sits on top of main (as opposed to branch off a branch). This ensures the reviewer will need only minimal effort to integrate your work by fast-forwarding main:

```text
git rebase upstream/main
Expand Down
2 changes: 1 addition & 1 deletion DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ npm run build:api
```

## Commits
When commiting your changes, it is required you adhere to the [commit message conventions]. This is important because the release notes are automatically generated from these messages.
When committing your changes, it is required you adhere to the [commit message conventions]. This is important because the release notes are automatically generated from these messages.

[commit message conventions]: https://www.conventionalcommits.org/en/v1.0.0/
6 changes: 3 additions & 3 deletions docs/assets/specification/ErgoSpec.Common.Result.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ <h1 class="title">Module ErgoSpec.Common.Result</h1>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="kwd">match</span> <span class="id"><a href="ErgoSpec.Common.Result.html#qe">qe</a></span> <span class="kwd">with</span><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| <span class="id"><a href="https://querycert.github.io/html/Qcert.Data.Model.DataResult.html#CompilationError">DataResult.CompilationError</a></span> <span class="id">msg</span> =&gt; <span class="id"><a href="ErgoSpec.Common.Result.html#ECompilationError">ECompilationError</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#prov">prov</a></span> <span class="id">msg</span><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| <span class="id"><a href="https://querycert.github.io/html/Qcert.Data.Model.DataResult.html#TypeError">DataResult.TypeError</a></span> <span class="id">msg</span> =&gt; <span class="id"><a href="ErgoSpec.Common.Result.html#ETypeError">ETypeError</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#prov">prov</a></span> <span class="id">msg</span><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| <span class="id"><a href="https://querycert.github.io/html/Qcert.Data.Model.DataResult.html#UserError">DataResult.UserError</a></span> <span class="id">msg</span> =&gt; <span class="id"><a href="ErgoSpec.Common.Result.html#ESystemError">ESystemError</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#prov">prov</a></span> "<span class="id">User</span> <span class="id">error</span> <span class="id">occured</span> <span class="kwd">in</span> <span class="id">backend</span>"<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;| <span class="id"><a href="https://querycert.github.io/html/Qcert.Data.Model.DataResult.html#UserError">DataResult.UserError</a></span> <span class="id">msg</span> =&gt; <span class="id"><a href="ErgoSpec.Common.Result.html#ESystemError">ESystemError</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#prov">prov</a></span> "<span class="id">User</span> <span class="id">error</span> <span class="id">occurred</span> <span class="kwd">in</span> <span class="id">backend</span>"<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="kwd">end</span>.<br/>
<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="kwd">Definition</span> <span class="id"><a name="eresult_of_qresult">eresult_of_qresult</a></span> {<span class="id">A</span>:<span class="kwd">Set</span>} (<span class="id">prov</span>:<span class="id"><a href="ErgoSpec.Common.Provenance.html#provenance">provenance</a></span>) (<span class="id">a</span>:<span class="id"><a href="https://querycert.github.io/html/Qcert.Data.Model.DataResult.html#qresult">qresult</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#A">A</a></span>) : <span class="id"><a href="ErgoSpec.Common.Result.html#eresult">eresult</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#A">A</a></span> :=<br/>
Expand Down Expand Up @@ -237,9 +237,9 @@ <h1 class="title">Module ErgoSpec.Common.Result</h1>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="kwd">Definition</span> <span class="id"><a name="eval_foreach_not_on_array_error">eval_foreach_not_on_array_error</a></span> {<span class="id">A</span>} <span class="id">prov</span> : <span class="id"><a href="ErgoSpec.Common.Result.html#eresult">eresult</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#A">A</a></span> :=<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="id"><a href="ErgoSpec.Common.Result.html#efailure">efailure</a></span> (<span class="id"><a href="ErgoSpec.Common.Result.html#ERuntimeError">ERuntimeError</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#prov">prov</a></span> "<span class="id">Foreach</span> <span class="id">needs</span> <span class="id">to</span> <span class="id">be</span> <span class="id">called</span> <span class="id">on</span> <span class="id">an</span> <span class="id">array</span>").<br/>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="kwd">Definition</span> <span class="id"><a name="template_type_not_found_error">template_type_not_found_error</a></span> {<span class="id">A</span>} <span class="id">prov</span> : <span class="id"><a href="ErgoSpec.Common.Result.html#eresult">eresult</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#A">A</a></span> :=<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="id"><a href="ErgoSpec.Common.Result.html#efailure">efailure</a></span> (<span class="id"><a href="ErgoSpec.Common.Result.html#ERuntimeError">ERuntimeError</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#prov">prov</a></span> ("<span class="id">Cannot</span> <span class="id">find</span> <span class="id">template</span> <span class="id">type</span> (<span class="id">one</span> <span class="id">declared</span> <span class="id">type</span> <span class="id">should</span> <span class="id">extend</span> <span class="id">either</span> <span class="id">AcccordContract</span> <span class="id">or</span> <span class="id">AccordClause</span>)")).<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="id"><a href="ErgoSpec.Common.Result.html#efailure">efailure</a></span> (<span class="id"><a href="ErgoSpec.Common.Result.html#ERuntimeError">ERuntimeError</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#prov">prov</a></span> ("<span class="id">Cannot</span> <span class="id">find</span> <span class="id">template</span> <span class="id">type</span> (<span class="id">one</span> <span class="id">declared</span> <span class="id">type</span> <span class="id">should</span> <span class="id">extend</span> <span class="id">either</span> <span class="id">AccordContract</span> <span class="id">or</span> <span class="id">AccordClause</span>)")).<br/>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="kwd">Definition</span> <span class="id"><a name="more_than_one_template_type_error">more_than_one_template_type_error</a></span> {<span class="id">A</span>} <span class="id">prov</span> <span class="id">msg</span> : <span class="id"><a href="ErgoSpec.Common.Result.html#eresult">eresult</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#A">A</a></span> :=<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="id"><a href="ErgoSpec.Common.Result.html#efailure">efailure</a></span> (<span class="id"><a href="ErgoSpec.Common.Result.html#ERuntimeError">ERuntimeError</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#prov">prov</a></span> ("<span class="id">Multiple</span> <span class="id">template</span> <span class="id">type</span> (<span class="tactic">at</span> <span class="id">most</span> <span class="id">one</span> <span class="id">of</span> " ++ <span class="id"><a href="ErgoSpec.Common.Result.html#msg">msg</a></span> ++ " <span class="id">should</span> <span class="id">extend</span> <span class="id">either</span> <span class="id">AcccordContract</span> <span class="id">or</span> <span class="id">AccordClause</span>)")).<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="id"><a href="ErgoSpec.Common.Result.html#efailure">efailure</a></span> (<span class="id"><a href="ErgoSpec.Common.Result.html#ERuntimeError">ERuntimeError</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#prov">prov</a></span> ("<span class="id">Multiple</span> <span class="id">template</span> <span class="id">type</span> (<span class="tactic">at</span> <span class="id">most</span> <span class="id">one</span> <span class="id">of</span> " ++ <span class="id"><a href="ErgoSpec.Common.Result.html#msg">msg</a></span> ++ " <span class="id">should</span> <span class="id">extend</span> <span class="id">either</span> <span class="id">AccordContract</span> <span class="id">or</span> <span class="id">AccordClause</span>)")).<br/>
<br/>
<div class="doc">System errors </div>
&nbsp;&nbsp;&nbsp;&nbsp;<span class="kwd">Definition</span> <span class="id"><a name="no_ergo_module_error">no_ergo_module_error</a></span> {<span class="id">A</span>} <span class="id">prov</span> : <span class="id"><a href="ErgoSpec.Common.Result.html#eresult">eresult</a></span> <span class="id"><a href="ErgoSpec.Common.Result.html#A">A</a></span> :=<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs/markup-commonmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ To create a list within another, indent each item in the sublist by four spaces.
- enter into any abnormal contracts...
2. Matters related to the assets
- sell or otherwise dispose...
- mortage, ...
- mortgage, ...
```

will be rendered as:
Expand Down
4 changes: 2 additions & 2 deletions docs/markup-templatemark.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: TemplateMark

TemplateMark is an extension to CommonMark used to write the text in Accord Project templates. The extension includes new markdown for variables, inline and container elements of the markdown and template formulas.

The kind of extension which can be used is based on the _type_ of the variable in the [Concerto Model](https://concerto.accordproject.org/docs/intro) for your template. For each type in your model differrent markdown elements apply: variable markdown for atomic types in the model, list blocks for array types in the model, optional blocks for optional types in the model, etc.
The kind of extension which can be used is based on the _type_ of the variable in the [Concerto Model](https://concerto.accordproject.org/docs/intro) for your template. For each type in your model different markdown elements apply: variable markdown for atomic types in the model, list blocks for array types in the model, optional blocks for optional types in the model, etc.

## Variables

Expand Down Expand Up @@ -261,7 +261,7 @@ The general format for the amount is `0{sep}0({sep}0+)?` where `{sep}` is a sing

#### Examples

The following examples show formating for `Integer` or `Long` values.
The following examples show formatting for `Integer` or `Long` values.

```
The manuscript shall be completed within {{days as "0,0"}} days.
Expand Down
4 changes: 2 additions & 2 deletions docs/ref-cicero-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ retrieve instances from [Template](#Template)</strong>
| readme | <code>String</code> | the README.md for the template (may be null) |
| samples | <code>object</code> | the sample markdown for the template in different locales, |
| request | <code>object</code> | the JS object for the sample request |
| logo | <code>Buffer</code> | the bytes data for the image represented as an object whose keys are the locales and whose values are the sample markdown. For example: { default: 'default sample markdown', en: 'sample text in english', fr: 'exemple de texte français' } Locale keys (with the exception of default) conform to the IETF Language Tag specification (BCP 47). THe `default` key represents sample template text in a non-specified language, stored in a file called `sample.md`. |
| logo | <code>Buffer</code> | the bytes data for the image represented as an object whose keys are the locales and whose values are the sample markdown. For example: { default: 'default sample markdown', en: 'sample text in english', fr: 'example de texte français' } Locale keys (with the exception of default) conform to the IETF Language Tag specification (BCP 47). THe `default` key represents sample template text in a non-specified language, stored in a file called `sample.md`. |

<a name="Metadata+getTemplateType"></a>

Expand Down Expand Up @@ -906,7 +906,7 @@ Create the CompositeArchiveLoader. Used to delegate to a set of ArchiveLoaders.
<a name="CompositeArchiveLoader+addArchiveLoader"></a>

### compositeArchiveLoader.addArchiveLoader(archiveLoader)
Adds a ArchiveLoader implemenetation to the ArchiveLoader
Adds a ArchiveLoader implementation to the ArchiveLoader

**Kind**: instance method of [<code>CompositeArchiveLoader</code>](#CompositeArchiveLoader)

Expand Down
2 changes: 1 addition & 1 deletion docs/ref-ergo-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Although this looks very similar to what `ergo trigger` returns, it is important
`ergo initialize` allows you to obtain the initial state of the contract. This is the state of the contract without requests or responses.

```md
Usage: ergo intialize --data [file] --params [file] [cto files] [ergo files]
Usage: ergo initialize --data [file] --params [file] [cto files] [ergo files]

Options:
--help Show help [boolean]
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ bash-3.2$ yo @accordproject/cicero-template

_-----_ ╭──────────────────────────╮
| | │ Welcome to the │
|--(o)--| │ generator-cicero-templat
|--(o)--| │ generator-cicero-template
`---------´ │ e generator! │
( _´U`_ ) ╰──────────────────────────╯
/___A___\ /
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Archive: helloworld@0.14.0.cta

## Template Components

Once you have unziped the archive, the directory should contain the following files and sub-directories:
Once you have unzipped the archive, the directory should contain the following files and sub-directories:

```text
package.json
Expand Down
2 changes: 1 addition & 1 deletion website/static/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -3180,7 +3180,7 @@ a:hover {
text-decoration: none;
}

/* Code Snipets */
/* Code Snippets */
.post article .hljs {
background-color: #15203c;
}
Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-0.30.1/accordproject-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ While the Accord Project technology is targeted at the development of smart lega

### How is an Accord Project "Smart Contract" different from "Smart Contracts" on the blockchain?

Accord Project Smart legal contracts should not be confused with so-called blockchain “smart contracts”, which are scripts that necesarily operate on a blockchain. On the blockchain a smart contract is often written in a specific language like solidity that executes and operates on the blockchain. It lives in a closed world. An Accord Project Smart Contract contains text based template that integrates with a data model and the Ergo language. The three components are integrated into a whole. Using Ergo an Accord Project Smart contract can communicate with other systems, it can send and receive data, it can perform calculations and it can interact with a blockchain.
Accord Project Smart legal contracts should not be confused with so-called blockchain “smart contracts”, which are scripts that necessarily operate on a blockchain. On the blockchain a smart contract is often written in a specific language like solidity that executes and operates on the blockchain. It lives in a closed world. An Accord Project Smart Contract contains text based template that integrates with a data model and the Ergo language. The three components are integrated into a whole. Using Ergo an Accord Project Smart contract can communicate with other systems, it can send and receive data, it can perform calculations and it can interact with a blockchain.

### What benefits do Smart Legal Contracts provide?

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-0.30.1/markup-templatemark.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ original_id: markup-templatemark

TemplateMark is an extension to CommonMark used to write the text in Accord Project templates. The extension includes new markdown for variables, inline and container elements of the markdown and template formulas.

The kind of extension which can be used is based on the _type_ of the variable in the [Concerto Model](https://concerto.accordproject.org/docs/intro) for your template. For each type in your model differrent markdown elements apply: variable markdown for atomic types in the model, list blocks for array types in the model, optional blocks for optional types in the model, etc.
The kind of extension which can be used is based on the _type_ of the variable in the [Concerto Model](https://concerto.accordproject.org/docs/intro) for your template. For each type in your model different markdown elements apply: variable markdown for atomic types in the model, list blocks for array types in the model, optional blocks for optional types in the model, etc.

## Variables

Expand Down Expand Up @@ -262,7 +262,7 @@ The general format for the amount is `0{sep}0({sep}0+)?` where `{sep}` is a sing

#### Examples

The following examples show formating for `Integer` or `Long` values.
The following examples show formatting for `Integer` or `Long` values.

```
The manuscript shall be completed within {{days as "0,0"}} days.
Expand Down