Documentation enhancement

[mikekeke]

Plutip keeps getting new features, but some of them either not mentioned in README at all or not too visible.
Some of things that could be improved/mentioned listed below.

‼️There will be significant changes in wallets initialization - see #104 <-- work on this was pushed back

Usage example

• need to be updated, doesn't reflect current DSL

Tasty integration

Mention key features:

• assertions against result of contract execution
• execution budget assertions for regression testing
• upcoming tracing capabilities Add assertAndTraceExecution. #77

Local cluster capabilities

Mention available use-cases:

• launching private testnet for safe experiments with another tools from cardano ecosystem
• launching private testnet and setting up some funded wallets using eDSL, arbitrary contracts execution also possible
  • upcoming tracing capabilities (Add assertAndTraceExecution. #77) can be handy here as well; brief explanation of logs collecting <-- tracing works with contract execution, local cluster alone doesn't execute contracts

Configuration

• provide some info on how things like slot length and max transaction budgets can be set up

Caveats

• Users should be aware about collateral handling mechanism if they want to use assertions on Values. Currently it is handled by withCollateral (see Paradox/add bpi collateral #100), but will change in future due to Alternative syntax for wallet initialisation #104

Pitfalls

• note that each assertExecution in list of tests runs under same cluster - it creates new wallet(s) for each contract run, but if same validator is used in different assertExecution calls, the address will stay same and whatever utxos created there will stay also - tests are not isolated in that sense

[cortsf]

Doc request: Explain the precise behavior of withContractAs with respect to n and pkhs:

void $  withContractAs n (\pkhs -> ...)

[IAmPara0x]

due to #104, plutip will have major changes in syntax of wallet initialization and contracts functions (such as withContractAs). Hence, imo we should hold off on adding docs for that part, until #104 is completed.

[mikekeke]

@IAmPara0x thanks for pointing that out. I've updated description.