Annex of CIP-0108 - test-vector

Test Vector for CIP-0108

Here we create some useful definitions and some examples.

Common Context

Common Fields

The context fields which could be added to CIP-108 compliant jsonld files. See cip-0108.common.jsonld.

Common Fields Schema

A json schema for the common context fields. See cip-0108.common.schema.json.

Examples

Treasury Withdrawal

Example metadata document file: treasury-withdrawal.jsonld. Blake2b-256 of the file content (to go onchain): 311b148ca792007a3b1fee75a8698165911e306c3bc2afef6cf0145ecc7d03d4

Intermediate files

Files produced to articulate process, these are not necessary in implementations.

Body files, used to correctly generate author's witness:

Blake2b-256 hash digest of canonicalized body: 68d6fe27087457acf0164e65414238c43573192c99f30341926d1524924d71ca

Motion of No-Confidence

Example metadata document file: no-confidence.jsonld. Blake2b-256 of the file content (to go onchain): 87ba5c10c89484c52265b50d669b4acf116aaeb8a6fa35fbf06e5ec67cda9270

Intermediate files

Files produced to articulate process, these are not necessary in implementations.

Body files, used to correctly generate author's witness:

Blake2b-256 hash digest of canonicalized body: 4a7ecc544559df67ece3f7f90f76c4e3e7e329a274c79a06dcfbf28351db600e

How-to Recreate Examples

This tutorial creates additional intermediate files, these are not required in implementations but are shown here to articulate the process.

Author

Keys used for author property, provided here for convenience.

Private extended signing key (hex): 105d2ef2192150655a926bca9cccf5e2f6e496efa9580508192e1f4a790e6f53de06529129511d1cacb0664bcf04853fdc0055a47cc6d2c6d205127020760652

Public verification key (hex): 7ea09a34aebb13c9841c71397b1cabfec5ddf950405293dee496cac2f437480a

Public verification key hash (hex): 0fdc780023d8be7c9ff3a6bdc0d8d3b263bd0cc12448c40948efbf42

Mainnet public enterprize address (hex): 610fdc780023d8be7c9ff3a6bdc0d8d3b263bd0cc12448c40948efbf42

1. Create the example.jsonld's body

Create the example.jsonld file adding in all available values. Then remove from this document any top-level field that is not @context or body.

If recreating the Treasury Withdrawal, this will result in the intermediate file of treasury-withdrawal.body.jsonld.

2. Canonicalize the body

Using a tool which complies with the RDF Dataset Canonicalization, create a canonicalized representation of example.body.jsonld. One such tool is the JSON-LD Playground. Ensure the results ends in a newline.

This creates example.body.nq.

For Treasury Withdrawal, this will result in the intermediate file of treasury-withdrawal.body.nq.

3. Hash the canonicalized body

Using a tool create a Blake2b-256 hash of the canonicalized example.body.nq. One such tool is the ToolKit Bay.

For Treasury Withdrawal, this will result in: 68d6fe27087457acf0164e65414238c43573192c99f30341926d1524924d71ca.

4. Authors witness over the hash of canonicalized body

Use the hash produced in 3. as the payload for the witnessing. For a witnessAlgorithm of ed25519 refer to CIP-100 Hashing and Signatures, for CIP-0008 refer to CIP-108 New Witness Type.

One tool for Ed25519 signatures is Ed25519 Online Tool.

For Treasury Withdrawal, we use the keys described in Author resulting in: a476985b4cc0d457f247797611799a6f6a80fc8cb7ec9dcb5a8223888d0618e30de165f3d869c4a0d9107d8a5b612ad7c5e42441907f5b91796f0d7187d64a01.

5. Add other properties to example.jsonld

We can go back to our example.body.jsonld and now add in all missing properties, from outside of body.

  • Adding the hashAlgorithm of blake2b-256.
  • Adding the authors with a single entry, including information of our witness goes into the signature.

By adding this information we create our example.jsonld.

For Treasury Withdrawal, this will result in treasury-withdrawal.jsonld.

6. Hash example.jsonld

To be able to create a final metadata hash which can be attached on-chain we simply hash the content of the file Treasury Withdrawal as is.

This results is: 311b148ca792007a3b1fee75a8698165911e306c3bc2afef6cf0145ecc7d03d4.

7. Submit to chain

We can then host example.jsonld somewhere easily accessible following CIP-100 Best Practices.

Then at submission time of the governance metadata anchor we can provide the on-chain transaction both the URI to the hosted example.jsonld but also the hash generated via 6..