Notional Trade Module

[ckoopmann]

Code Review Processes

New Feature Review

Before submitting a pull request for new review, make sure the following is done:

• Design doc is created and posted here: [https://hackmd.io/@r1OYOYxYSP-6k15CBaosBQ/rJ2jgYU4q]
• Code cleanliness and completeness is addressed via guidelines

README Checks

• [] README has proper context for the reviewer to understand what the code includes, any important design considerations, and areas to pay more attention to

Code Checks

• [] Add explanatory comments. If there is complex code that requires specific context or understanding, note that in a comment
• [] Remove unncessary comments. Any comments that do not add additional context, information, etc. should be removed
• [x] Add javadocs.
• [] Scrub through the code for inconsistencies (e.g. removing extra spaces)
• [] Ensure there are not any .onlys in spec files

Broader Considerations

• [] Ensure variable, function and event naming is clear, consistent, and reflective for the scope of the code.
• [] Consider if certain pieces of logic should be placed in a different library, module

[ckoopmann]

@ckoopmann This looks really nice! Integration tests look solid.

Have left some (mostly nit) comments and a couple smaller questions.

(Would it be possible to regenerate the abi JSON files added in this PR so they don't add 200k lines? They can't be inspected on Github and had trouble opening them locally as well.)

Those are abis that I didn't generate but were shared with me by @jeffywu. Maybe he can direct me to the smart contract source code from which those abis were generated so I can try to regenerate them in the repo.

EDIT: After rereading your comment it seems you were mostly concerned about the number of new lines. So for now I went for the easiest "solution" of just combining those files to a single line. Lmk if that alleviates the problem or makes it worse. (obviously the files are unreadable for humans now). Either way these files will be removed from the repo when the respective upgrades of the notional proxy were performed on mainnet.

[cgewecke]

:tada: This PR is included in version 0.11.0-hhat.1 :tada:

The release is available on:

• npm package (@hardhat dist-tag)
• GitHub release

Your semantic-release bot :package::rocket: