Improve error messages displayed to end users

[jstolarek]

User's unfamiliar with Haskell and Cardano complain about incomprehensible error messages. For example:

We need to design a better error reporting mechanism so that user's who deploy the sidechain get easy to understand error messages they can act upon. It is also probably a good idea to have a flag that allows to display raw messages as we see them now - this will be useful for us, the developers.

[jstolarek]

Another example:

nix run .#sidechain-main-cli -- addresses \
 --sidechain-genesis-hash c510b4c5a4f3bae8790861bf556870df383a83b0ffb2a98d4e32f654c65feba5 \
 --sidechain-id 0 \
 --genesis-committee-hash-utxo f17e6d3aa72095e04489d13d776bf05a66b5a8c49d89397c28b18a1784b9950e#0 \
 --threshold-numerator 2 \
 --threshold-denominator 3 \
 --payment-signing-key-file /home/lglo/iohk/sidechains-substrate-node/substrate-poc-env/keys/alice/payment.skey | jq .
/nix/store/6fmfmk2cy60q01bx32x6h81w0slli8k7-trustless-sidechain-ctl/output/Effect.Aff/foreign.js:532
                throw util.fromLeft(step);
                ^

Error: [object Object]
    at Object.exports.error (/nix/store/6fmfmk2cy60q01bx32x6h81w0slli8k7-trustless-sidechain-ctl/output/Effect.Exception/foreign.js:8:10)
    at __do (/nix/store/6fmfmk2cy60q01bx32x6h81w0slli8k7-trustless-sidechain-ctl/output/Ctl.Internal.QueryM/index.js:484:81)
    at listener (/nix/store/6fmfmk2cy60q01bx32x6h81w0slli8k7-trustless-sidechain-ctl/output/Ctl.Internal.JsWebSocket/foreign.js:48:25)
    at ReconnectingWebSocket._callEventListener (/nix/store/phgmjdqqm8hyzc677s48spiaffnggxjn-node-dependencies-ctl-scaffold-0.1.0/lib/node_modules/reconnecting-websocket/dist/reconnecting-websocket-cjs.js:557:13)
    at /nix/store/phgmjdqqm8hyzc677s48spiaffnggxjn-node-dependencies-ctl-scaffold-0.1.0/lib/node_modules/reconnecting-websocket/dist/reconnecting-websocket-cjs.js:185:79
    at Array.forEach (<anonymous>)
    at NoPerMessageDeflateWebSocket.ReconnectingWebSocket._handleError (/nix/store/phgmjdqqm8hyzc677s48spiaffnggxjn-node-dependencies-ctl-scaffold-0.1.0/lib/node_modules/reconnecting-websocket/dist/reconnecting-websocket-cjs.js:185:36)
    at NoPerMessageDeflateWebSocket.onError (/nix/store/phgmjdqqm8hyzc677s48spiaffnggxjn-node-dependencies-ctl-scaffold-0.1.0/lib/node_modules/ws/lib/event-target.js:220:18)
    at NoPerMessageDeflateWebSocket.emit (events.js:400:28)
    at emitErrorAndClose (/nix/store/phgmjdqqm8hyzc677s48spiaffnggxjn-node-dependencies-ctl-scaffold-0.1.0/lib/node_modules/ws/lib/websocket.js:922:13)

[jstolarek]

Another example from @alexromanov. Running:

node main.js init \
--payment-signing-key-file init.skey \
--genesis-committee-hash-utxo 9e5a89575ec13cc020ef7c300b5980f6a3b490f01e6c8c433641bec736cf40d4#0 \
--sidechain-genesis-hash 03be8e56b493b98d396a789255823cb4adebd69e1df88559e3481612f67a0bd7 \
--sidechain-id 2 \
--committee-pub-key 03b827f4da9711bab7292e5695576a841a4d20af9a07b1ba7a230168d2a78e9df4 \
--committee-pub-key 02ef5bcd94d54a18ad199559782cd72ac3ccd850976aaaafbca8f9d2625afbf7c4 \
--committee-pub-key 02f2762ab6e1a125dc03908a7b738f8023d13763f28a11d7633c6c8bc463478430 \
--committee-pub-key 025e19f82c5e2bac5e8869d49ff26359e442628bc5cfa38eeb5275f43d04015da8 \
--committee-pub-key 03f38a062a4b372c045c1dddc4fe98a2c9cb1d6eec8bf02f973fd29b1096cd8155 \
--committee-pub-key 033d3a2e581821fdd222581f6015eaabc798dd4dc0f7eeb3d6630b84449d76c9c9 \
--committee-pub-key 0232ebed4c0c742fa951b471fe6f6f2f09a2d235bf7e9992fbf786cf032c97247e \
--sidechain-epoch 0 \
--threshold-numerator 2 \
--threshold-denominator 3 \
--governance-authority 0774613f089ae454770933cb75b98ffbee4096e2347f76045b3cae76 \
--atms-kind plain-ecdsa-secp256k1 \
--version 1

produces

/home/alex/sidechains-tools/trustless/20240111-4a50b6294d738336f15f0fd03e7410aae470fde2/main.js:9240
                  throw util.fromLeft(step);
                  ^

Error: (InternalError (BalanceTxError CouldNotGetCollateral))

The cause was the missing stake key on the command line.

[rsporny]

Another example from @alexromanov. Running

./sidechain-main-cli register --sidechain-id 11 --genesis-committee-hash-utxo 0000000000000000000000000000000000000000000000000000000000000000#0 --threshold-numerator 2 --threshold-denominator 3 --governance-authority 0x1f0977bc0f57c67ca6d77296c1b575fe05a6dc2c5fa38056ba63c50c --atms-kind plain-ecdsa-secp256k1 --registration-utxo abe0ddb43c14b8505887335b24cdb114a85546e71f9003349002a2f4ca2c1219#1 --sidechain-public-keys 0x026ef9e512988a1e0dae82b6330e7437e9c87dca7da9aa49962d3b24cc67135a73:0x1c692b7f2c45fa4096b0c29dc972756751b78fdcdfe8d3153cdb81961253cf16:0xaaf281d65ae5370902a348b23de239ba2757220838f98fb01fcf98233e1e258f --sidechain-signature cb95c6c3539490bd41e80e60b0135b6d615893417e028f9b7477583be8a5e50f6b33d20ad81d3f6e3108b7ee8c9f0ced1cca14c286fc61cc19b39555ad549f1f --spo-public-key d25a7f974e93a0a270abc7ab2f1a81121d63b8b20d644cb87ee0e4de1824f4ff --spo-signature 6bf5ccd48df6ffcabcf526583c9a8fe5831899549ffcd5af254600b8211e69bd3fbc36646e5ba0b5cf8f3af43b8fbe8f62288d153ae033305b76b2974f286c0f --ada-based-staking --kupo-host localhost --kupo-port 1442  --ogmios-host localhost --ogmios-port 1337  --payment-signing-key-file /Users/oromanov/iohk/repos/sidechains-substrate-node/staging/keys/validator-2/payment.skey

while kupo and ogmios are down, produces

The registration transaction could not be submitted: (UnknownContractError "An error occurred when running CTL base monad: AggregateError")

on trustless v6.0.0