Caliper Ethereum documentation overhaul

[rmarede]

Checklist

• A link to the issue/user story that the pull request relates to
• How to recreate the problem without the fix
• Design of the fix
• How to prove that the fix works
• Automated tests that prove the fix keeps on working
• Documentation

Issue/User story

Caliper Ethereum documentation was outdated and did not provide information on using the --caliper-flow-skip-install that skips the smart contract installation phase.

Existing issues

• GitHub Issues

Issue #1589 - Caliper ethereum documentation needs a complete overhaul

Design of the fix

• Added information on how to use the --caliper-flow-skip-install to use pre-deployed contracts. Since the contract configuration on the network config file will differ depending on whether this flag is used, I added a subsection for each use case;
• Added a warning regarding the mandatory usage of fromAddressSeed when using more than 1 worker;
• Fixed name mismatches between the network config file keys;
• Added information about the TxStatus type - getResut() was not documented;
• Updated references to the old invokeSmartContract and queryState functions, with the new sendRequests function;
• Moved besu-specific warnings to the appropriate sections;
• Removed reference to a "special registry contract", which I haven't found any information about anywhere else.

[davidkel]

@rmarede Many thanks for the contribution, I've asked @aklenik to take a look as he has more knowledge than me in this area but it looks good to me so far.

[davidkel]

Going to try closing and re-opening to see if it fixes the DCO issue

[davidkel]

@rmarede Due to a github problem where DCO wasn't recognised, could you try doing a force push to your PR to see if it now forces github to recognise the DCO please ?

[rmarede]

@davidkel I amended the last commit and force pushed it, seems like it worked

[davidkel]

Just a couple of minor issues here, looks really good. As this is relevant to the latest version of caliper, could you also take this and apply it to the v0.6.0 directory.
Really a great improvement to the docs, many thanks

[davidkel]

For the contract configuration, we still want to refer to the path property. It's required if you want to install the smart contract but not required if the contract is already deployed. This unfortunately was the only reference to path outside of the example

[rmarede]

there's also a reference to path in line 195, in the appropriate Contracts to Deploy section. Isn't that enough?

Contracts to Deploy

Contracts to be deployed by Caliper require the specification of a contract definition file for each. In the contract configuration you must include a path field pointing to each contract definition file. It's in this new file that you will define the contract's ABI and bytecode, as well as the gas required to deploy it.

[davidkel]

yep, must have missed that in the PR, sorry

[davidkel]

@rmarede merged, thank you, really much appreciated