Add warning in client when not downloading ancillary files

[jpraynaud]

Why

When a database snapshot (Cardano DB v1 and Cardano DB v2) is restored without the inclusion of the ancillary files, the user of the client should be warned that the fast bootstrap of the Cardano node will not be fully available.

What

Warn the client user that the fast bootstrap of the Cardano node is not fully available when the ancillary files are not downloaded.

The message to display in the client CLI is:

The fast bootstrap of the Cardano node is not available with the current parameters used in this command: this means that the ledger state will be recomputed from genesis at startup of the Cardano node.

In order to activate the fast bootstrap of the Cardano node, add the following parameters to the command:

• --include-ancillary
• and --ancillary-verification-key (or environment variable ANCILLARY_VERIFICATION_KEY). Caution: The ancillary files, including the ledger state, are not currently signed by Mithril. As a mitigation, IOG owned keys are used to sign these files. For more information, please refer to the network configuration page of the documentation (https://mithril.network/doc/manual/getting-started/network-configurations).

The warn log to add in the library for Cardano DB v1 is:

The fast bootstrap of the Cardano node is not available with the current parameters used in this command:the ledger state will be recomputed from genesis at startup of the Cardano node. Use the extra function download_unpack_full to allow it..

The warn log to add in the library for Cardano DB v2 is:

The fast bootstrap of the Cardano node is not available with the current parameters used in this command:the ledger state will be recomputed from genesis at startup of the Cardano node. Set the include_ancillary entry to true in the DownloadUnpackOptions.

Warn the client user that the ancillary signature is not done with Mithril when the ancillary files are downloaded:

The message to display and warn log in the client CLI is (for both Cardano DB v1 and v2):

Ancillary verification does not use the Mithril certification: as a mitigation, IOG owned keys are used to sign these files.

How

• Add a log in the client library:
  • when downloading the ancillary files:
    • Cardano DB v1 (Replace existing sentence)
    • Cardano DB v2
  • when not downloading the ancillary files:
    • Cardano DB v1
    • Cardano DB v2
• Add a printed warning in the terminal output for the client CLI:
  • when downloading the ancillary files:
    • Cardano DB v1
    • Cardano DB v2
  • when not downloading the ancillary files:
    • Cardano DB v1
    • Cardano DB v2

[jpraynaud]

@rezabaram can you confirm tha the warning messages are OK for you?

[rezabaram]

@jpraynaud, consider making the second bullet more explicit, something like this (please rephrase to your liking):

• and --ancillary-verification-key (or environment variable ANCILLARY_VERIFICATION_KEY). Caution: The ancillary files, including the ledger state, are not currently signed by Mithril. As a mitigation, IOG keys are used to sign these files. For more information, please refer to the network configuration page of the documentation (https://mithril.network/doc/manual/getting-started/network-configurations).

[jpraynaud]

@jpraynaud, consider making the second bullet more explicit, something like this (please rephrase to your liking):

• and --ancillary-verification-key (or environment variable ANCILLARY_VERIFICATION_KEY). Caution: The ancillary files, including the ledger state, are not currently signed by Mithril. As a mitigation, IOG keys are used to sign these files. For more information, please refer to the network configuration page of the documentation (https://mithril.network/doc/manual/getting-started/network-configurations).

Thanks @rezabaram, I have updated the message with your suggestion 👍