accordproject / Ergo

Introduction

This is the source code for the Ergo compiler. Ergo is the Accord Project language for Smart Legal Contracts.

The Ergo compiler is distributed as an npm package.

The Ergo compiler is written using the Coq proof assistant, with parsing and support code written in OCaml. It makes extensive use of the Q*cert compiler for code generation and type checking.

Both the Ergo language and its compiler are in early development phase. If you would like to build from source or to contribute, consult the DEVELOPERS file.

Try Ergo online

If you want to take a peek at Ergo without installing anything, check out the interactive REPL (read-eval-print-loop) for Ergo stand-alone, or the Accord Project Template Studio which illustrates Ergo in Accord Project templates.

Documentation

The most recent Ergo documentation is in the Ergo Language Guide.

Structure of the Code Repository

Top level repository (ergo), with sub packages. Each sub-package is published as an independent npm module using lerna:

• ergo-cli : Command line interface for the Ergo compiler
• ergo-compiler : Core classes for the Ergo compiler
• ergo-engine : A Node.js VM based execution engine for Ergo
• ergo-test : Cucumber based testing for Ergo

Installation

The easiest way to install Ergo is as a Node.js package. Once you have Node.js installed on your machine, you can get the Ergo compiler and command-line using the Node.js package manager by typing the following in a terminal:

$ npm install -g @accordproject/ergo-cli

This will install the Ergo command-line (ergo) and Read-Eval-Print-Loop (ergotop). Those will allow you to create, test and compile Ergo contracts. You can check your installed version by typing the following in a terminal:

$ ergo --version

Or to get command line help:

$ ergo --help
ergo <command>

Commands:
  ergo draft       create a contract text from data
  ergo trigger     send a request to the contract
  ergo invoke      invoke a clause of the contract
  ergo initialize  initialize the state for a contract
  ergo compile     compile a contract

Options:
  --help         Show help                                             [boolean]
  --version      Show version number                                   [boolean]
  --verbose, -v                                                 [default: false]

Create contract text

To create a contract text from a contract:

$ ergo draft --template ./examples/volumediscount --data ./examples/volumediscount/data.json

Initialize a contract

To obtain the initial state of the contract:

$ ergo initialize --template ./examples/volumediscount --data ./examples/volumediscount/data.json
06:40:29 - info:

Send a request to a contract

To send a request to a contract:

$ ergo trigger --template ./examples/volumediscount --data ./examples/volumediscount/data.json --request ./examples/volumediscount/request.json --state ./examples/volumediscount/state.json
06:40:01 - info:
{
  "clause": "orgXaccordprojectXvolumediscountXVolumeDiscount",
  "request": {
    "$class": "org.accordproject.volumediscount.VolumeDiscountRequest",
    "netAnnualChargeVolume": 10.4
  },
  "response": {
    "$class": "org.accordproject.volumediscount.VolumeDiscountResponse",
    "discountRate": 2.8,
    "transactionId": "13fa7cb6-03fc-4fd8-8e12-9a85ac8d5eb7",
    "timestamp": "2019-10-12T23:56:33.688Z"
  },
  "state": {
    "$class": "org.accordproject.cicero.contract.AccordContractState",
    "stateId": "1"
  },
  "emit": []
}

Invoke a clause

To invoke a specific clause of the contract:

$ ergo invoke --template ./examples/volumediscount --clauseName volumediscount --data ./examples/volumediscount/data.json --params ./examples/volumediscount/params.json --state ./examples/volumediscount/state.json

Compile a contract

To compile your first Ergo contract to JavaScript:

$ ergo compile ./examples/volumediscount/model/model.cto ./examples/volumediscount/logic/logic.ergo
Processing file: ./examples/volumediscount/logic.ergo -- compiled to: ./examples/volumediscount/logic.js

By default, Ergo compiles to JavaScript for execution. You can inspect the compiled JavaScript code in ./examples/volumediscount/logic.js

Accord Project is an open source, non-profit, initiative working to transform contract management and contract automation by digitizing contracts. Accord Project operates under the umbrella of the Linux Foundation. The technical charter for the Accord Project can be found here.

Learn More About Accord Project

Overview

• Accord Project
• Accord Project News
• Accord Project Blog
• Accord Project Slack
• Accord Project Technical Documentation
• Accord Project GitHub

Documentation

• Getting Started with Accord Project
• Concepts and High-level Architecture
• How to use the Cicero Templating System
• How to Author Accord Project Templates
• Ergo Language Guide

Ecosystem

Core libraries:

Projects	Package name	Version	Description
Cicero	cicero-core		Templates Core
	cicero-cli		Cicero CLI
	cicero-engine		Node.js VM based implementation of Accord Project Template Specification execution
	cicero-server		Wraps the Cicero Engine and exposes it as a RESTful service
	cicero-test		Testing support for Cicero based on cucumber
	cicero-tools		Cicero Tools
	generator-cicero-template		Code generator for a Cicero Template
Concerto	concerto-core		Core Implementation for the Concerto Modeling Language
	concerto-tools		Tools for the Concerto Modeling Language
	concerto-cli		command-line interface for Concerto
Ergo	ergo-cli		Ergo CLI
	ergo-compiler		Ergo compiler
	ergo-test		Ergo test
	ergo-engine		Ergo engine
Markdown	markdown-common		A framework for transforming markdown
	markdown-slate		Transform markdown to/from CommonMark DOM
	markdown-cli		CLI for markdown transformations.
	markdown-cicero		Markdown extensions for contracts, clauses, variables etc.
	markdown-html		Transform CiceroDOM to HTML

UI Components:

Projects	Package name	Version	Description
Markdown Editor	markdown-editor		WYSIWYG rich text web editor for markdown based on Slate.js
Cicero UI	cicero-ui		React UI components for Cicero
Concerto UI	concerto-ui		Dynamic web forms generated from Concerto models

Template Editors:

Public templates and models:

Documentation:

Contributing

The Accord Project technology is being developed as open source. All the software packages are being actively maintained on GitHub and we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code.

Find out what’s coming on our blog.

Join the Accord Project Technology Working Group Slack channel to get involved!

For code contributions, read our CONTRIBUTING guide and information for DEVELOPERS.

README Badge

Using Accord Project? Add a README badge to let everyone know:

[![accord project](https://img.shields.io/badge/powered%20by-accord%20project-19C6C8.svg)](https://www.accordproject.org/)

License

Accord Project source code files are made available under the Apache License, Version 2.0. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0).

Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See LF Projects Trademark Policy.