Skip to main content

Feedback

Loading...

Creating Raw Document

Every TradeTrust document has a checksum that provides it a tamper-proof property. At the same time, because the checksum can be used to uniquely identify a document, the checksum (or its derived value) is stored onto the document store as evidence of issuance. To compute the checksum, a raw document goes through a process known as wrapping to become a wrapped document. Only then, the document is ready to be issued onto the blockchain.

In this guide, we will learn how to create one raw document that conforms to the OpenAttestation v2 Schema.

Understanding TradeTrust Document Schema​

Because TradeTrust is build using Open Attestation, we will be using OpenAttestation v2.0 schema. It defines the shape of data for the raw document - the data before the wrapping process. It is defined in JSON Schema format.

The official OpenAttestation v2.0 schema can be found at https://schema.openattestation.com/2.0/schema.json

Using Online Schema Validator​

For this guide, we will be using an online JSON Schema validator to help us write the raw document.

Setting up the JSON Schema Validator with OA Schema​

Visit https://www.jsonschemavalidator.net/

Paste the contents from https://schema.openattestation.com/2.0/schema.json into the left panel under "Select Schema".

This will setup the JSON schema validator to validate the JSON inputs on the right against the defined schema.

Validator Preview

If you start editing the JSON data on the right you should see errors if the data does not conform to the OpenAttestation v2.0 schema. A summary of the number of errors is found on top of the right panel and the details of the errors are found below the two panels.

Creating raw document​

We will now create the data for your document. Paste the following JSON data into the right panel of the JSON schema validator tool:

{
  "$template": {
    "name": "main",
    "type": "EMBEDDED_RENDERER",
    "url": "https://tutorial-renderer.openattestation.com"
  },
  "recipient": {
    "name": "John Doe"
  },
  "issuers": [
    {
      "name": "Demo Issuer",
      "tokenRegistry": "0x8431012Bc040942B59e3C5bf428221eab0b2f723",
      "identityProof": {
        "type": "DNS-TXT",
        "location": "automatic-orange-grouse.sandbox.openattestation.com"
      }
    }
  ]
}

To makes things simple, we will use an existing deployed renderer (at https://tutorial-renderer.openattestation.com). However you will still need to replace the following values for your own document:

1. issuers[0].tokenRegistry​

Replace the value of issuers[0].tokenRegistry from 0x8431012Bc040942B59e3C5bf428221eab0b2f723 to the smart contract address of your token registry in the previous steps

1. issuers[0].identityProof.location​

Replace the value of issuers[0].identityProof.location from few-green-cat.sandbox.openattestation.com to the dns name used to bind the token registry's identity in the previous steps

Validator Completed

Once all the values are configured and the raw document conforms to the schema, you will see the message No errors found. JSON validates against the schema

Saving the raw document​

Near the wallet.json file, create a folder named raw-documents. Inside that folder create a file names certificate-1.json and paste the validated JSON from above.

For transferable record, you may not batch process it with other documents. Your directory raw-documents may only contain one file.

At this point in time, your directory should look like the following:

wallet.json
raw-documents
  |-- certificate-1.json

We are now ready to wrap the documents.

The tutorial will now require you to choose between the following options: