feat/constrain-ids

[kanej]

We do not enforce any rules on the types of ids that can be used for modules or actions. This is a problem because we use those ids when writing to the file system (including on windows).

This PR introduces rules on module ids, user provided action ids and all of the components that can be used as fallbacks to generate an id.

Module ids and user provided action ids are only allowed to start with a letter and then include only alphanumerics and underscores:

/^[a-zA-Z][a-zA-Z0-9_]*$/

The contract names, event names, args are validated based on Solidity's identifier rules:

/^[a-zA-Z$_][a-zA-Z0-9$_]*$/

Function names and event names are slightly looser than the Solidity identifier rule to support ethers style function/event + params myfun(uint256,bool):

/^[a-zA-Z$_][a-zA-Z0-9$_,()]*$/

With constraints on the parts that are used to build up the surrogate ids, and by ensuring our combination separators are valid we can ensure that all our ids are valid for filenames on windows/linux.

As such we are changing the separator symbols to those that can work as windows filenames, specifically:

• : -> #
• # -> .

| Future                      | Before                                 | After                                  | User Provided ID         |
| --------------------------- | -------------------------------------- | -------------------------------------- | ------------------------ |
| contract/library/contractAt | MyModule:MyContract                    | MyModule#MyContract                    | MyModule#MyId            |
| call/staticCall             | MyModule:MyContract#MyFunction         | MyModule#MyContract.MyFunction         | MyModule#MyContract.MyId |
| readEventArgument           | MyModule:MyContract#MyFunction#MyArg#2 | MyModule#MyContract.MyFunction.MyArg.2 | MyModule#MyId            |
| send                        | MyModule:MyId                          | MyModule#MyId                          | MyModule#MyId            |

This PR also:

• removes options id from send
• changes namespacing on calls to just be MyModule#Call1 for user provided ids matching the other rules

Review

I would suggest taking the commits in order. The first commits refactor our code to pull the id and validation code into one place. The final commit swaps the separators (but this ends up touching quite a few files, mainly tests).