Creating your first agreement

This page explains the basics of how to create a Ricardian Contract and deploy it on Ipfs.

Good to know: Smart contracts without semantics are notoriously hard to interpret and require a professional developer. One of the goals of Ricardian Fabric is to make this more easy. You should pay attention to describe how the smart contract works, if you are attaching one!

The basics

After logging into the application, there is a sidebar. Find the button to open the contract editor.

Your ricardian contract's terms are entered in the text field, where the placeholder shows "Type your legal contract".

Formatting

The text field comes with a built in formatter. After you have typed something, highlight it to format it:

You are able to format the text to bold, italic, underline, add a link, quote, add preformatted text, create lists, indent, outdent, align to left, right, center and create headings.

Always use full URL paths for the links.

Import a template

There is support for adding an external template. You can import it by clicking on the "Import template" button.

Clicking on the button will trigger the following popup:

You simply drag an drop a .docx file here and it will populate the text area. As the popup explains, it will override it. Ricardian Fabric converts docx formatted files to html.

Cooperate with others on the terms of the agreement using Google Docs and simply import it when you are done.

The conversion is not perfect. The app uses mammoth.js behind the scenes to convert the docx files.

Configuration

You need to add a smart contract. Click on the button Configure to move to the configuration page.

Deploy the agreement on Ipfs

After accepting the terms you can click on the Create button. The current version requires metamask to sign agreements.

The signed value is the hash of the Ricardian contract. It's the value that is always recalculated when the terms are accepted.

Congratulations

If you have signed the contract and deployed it! You have successfully deployed a Ricardian Contract to Ipfs. The link has been copied to your clipboard and you are ready to share it with the world.

Learn how to permapin your contract on Ipfs so it persisits, in the permaweb guide.

Last updated