Governance Scripts

This repository holds shell scripts that Intersect uses to engage in Cardano on-chain governance.

Navigation

Scripts

2025 Budget Scripts

• budget-metadata-validate.sh
  • Runs correctness and validity checks for budget treasury withdrawal CIP108 metadata.
  • Uses a combination of the other scripts
• budget-metadata-create.sh
  • Creates Intersect budget metadata file from a .docx
  • This expects certain structure within the .docx

Governance Action Scripts

• action-create-tw.sh
  • Creates a treasury withdrawal governance action from a Intersect metadata
  • Uses a local cardano node socket file

IPFS Scripts

• ipfs-check.sh
  • Checks if a file is accessible via free IPFS gateways
• ipfs-pin.sh
  • Allows user to pin JSONLD file(s) on a number of pinning services
  • Optionally allows the user to check file's discoverability first

Governance (CIP-100+) Metadata Scripts

• metadata-validate.sh
  • Compares governance metadata against the established schema(s)
  • Applies a spell check to CIP108 metadata fields

CIP-108 Scripts

• cip-108-create-human-readable.sh
  • Creates a markdown file from CIP108 metadata

CIP-100 Author Scripts

• author-create.sh
  • Adds an author witness to CIP100/CIP108 metadata
• author-validate.sh
  • Checks the correctness of CIP100/CIP108 metadata with a author(s) witness(es)

Other Scripts

• hash.sh
  • Performs a blake2b-256 hash on provided file
• pdf-remove-metadata.sh
  • Removes PDF metadata from PDF files

Documentation

• 2025 Budget Treasury Withdrawals
  • Documents the scripts and high level process to create the treasury withdrawal governance actions for the Intersect 2025 budget.

Dependencies

In order to run all of these scripts you will need

• ajv-cli
• aspell
• b2sum
• cardano-cli
• cardano-signer
• ipfs
• jq

probably more I have missed...

Environment Variables

Cardano Node

The only script that uses secrets is action-create-tw.sh.

This expects CARDANO_NODE_NETWORK_ID and CARDANO_NODE_SOCKET_PATH to be set. So you'll need a local cardano node socket path.

Secrets

The only script that uses secrets is ipfs-pin.sh.

Secrets can be stored via ./scripts/.env and based on ./scripts/.env.example.

This is setup so you can run:

source ./scripts/.env

License

See License.