Core GovTool

Core GovTool

Core Govtool is comprised of the frontend, backend and metadata services which will allow you to view

• Home,

• Governance Actions Live Voting,

• Drep Directory,

• Guides

• FAQs

with or without a wallet connected

Prerequisites

To run Core GovTool you will need access to a DB-Sync Instance, this can be run locally or via a third party e.g. Demeter. This is a dependency of the backend service which will query the information stored in DB-Sync to retrieve and populate the respective pages with information checking for any issues using the Metadata Validation service

Notice

As the instance of Cardano GovTool uses a DB-Sync with which leverages some of the insert options available in the config file everything may not display identically when running locally e.g. 3rd party providers may not have access to the pool stat table meaning SPO voting may not shown/be accurate

The Backend service heavily utilises the utxo_view shipped as standard with db-sync, however in some instances, depending on the config used, it can encounter issues. Below are two examples of how this view can be re-created if required:

13.6.0.4

CREATE OR REPLACE VIEW public.utxo_view AS SELECT tx_out.id, tx_out.tx_id, tx_out.index, address.address, address.has_script AS address_has_script, address.payment_cred, tx_out.stake_address_id, tx_out.value, tx_out.data_hash, tx_out.inline_datum_id, tx_out.reference_script_id, tx_out.consumed_by_tx_id FROM tx_out LEFT JOIN tx_in ON tx_out.tx_id = tx_in.tx_out_id AND tx_out.index::smallint = tx_in.tx_out_index::smallint LEFT JOIN tx ON tx.id = tx_out.tx_id LEFT JOIN address ON address.id = tx_out.address_id LEFT JOIN block ON tx.block_id = block.id WHERE tx_in.tx_in_id IS NULL AND block.epoch_no IS NOT NULL AND tx_out.consumed_by_tx_id IS NULL;

previous versions

CREATE OR REPLACE VIEW public.utxo_view AS SELECT tx_out.id, tx_out.tx_id, tx_out.index, tx_out.stake_address_id, tx_out.value, tx_out.data_hash, tx_out.inline_datum_id, tx_out.reference_script_id, tx_out.consumed_by_tx_id, tx_out.address_id FROM tx_out LEFT JOIN tx_in ON tx_out.tx_id = tx_in.tx_out_id AND tx_out.index::smallint = tx_in.tx_out_index::smallint LEFT JOIN tx ON tx.id = tx_out.tx_id LEFT JOIN block ON tx.block_id = block.id WHERE tx_out.consumed_by_tx_id is NULL AND tx_in.tx_in_id IS NULL AND block.epoch_no IS NOT NULL;

Setting up Core GovTool

1. Review the frontend -> fe-env-vars.yaml and the backend -> config.json files and add your custom env vars

2. Review frontend.yaml, backend.yaml and metadata.yaml ensuring to update the Deployment Containers Image Spec (example) with the associated image for the service (these can be custom or the images referenced in the current deployments) and metadata -> namespace (example) if not using the default govtool namespace

3. Create the Kubernetes Secrets which will house the env vars using kubectl apply and kubectl create secret (this will be used with the config.json) in your chosen namespace

4. Use kubectl apply to launch the frontend backend and metadata services in the same namespace as your secrets -- (kubectl links)