Action Models

[bh2smith]

To extend our current web3 action, we prepare the foundational modeling and parsing logic behind processing a Settlement Transaction. In particular this PR introduces

Part of #177

Models

• TransferEvent, TradeEvent and SettlementEventcontaining only the foreseeable relevant information for Slippage accounting purposes (e.g. TradeEvent only contains owner) which will be used to classify transfers as AMM_{IN/OUT} vs USER_{IN/OUT}

Utilities

• Parse Address from bytes32 (which converts event topics like 0x0000000000000000000000009008d19f58aabd9ed0d60971565aa8510560ab41 into addresses like 0x9008d19f58aabd9ed0d60971565aa8510560ab41
• TransferEvent.involves(address) used to filter out only relevant transfers during transaction processing.

Functionality

• partitionEventLogsa method which transforms transaction event logs into the relevant events defined above.

Test Plan

Will add CI that runs all the new tests.

[fleupold]

Looks good (would have been nice to split out testing setup and CI logic from the rest of the code).
I believe most of the parsing code could be replaced by depending on the contracts npm package und using ethers parsing library (which I'd prefer a lot) but isn't mandatory.

[fedgiac]

The code works, but I also prefer to use a library rather than doing manual event parsing.

[bh2smith]

The code works, but I also prefer to use a library rather than doing manual event parsing.

I added an issue for this already. I'm not sure it makes sense to add all that into this PR, but rather as an improvement later. See here

#186

What do you think? Now or later?

[gentrexha]

I left some nitpicky discussion comments and agreed with some of the issues raised.

Other than that, LGTM.

[github-actions]

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

[socket-security]

New dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No new dependency issues detected in pull request

Bot Commands

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@* or ignore all packages with @SocketSecurity ignore-all

Pull request alert summary

Issue	Status
Install scripts	✅ 0 issues
Native code	✅ 0 issues
Bin script shell injection	✅ 0 issues
Unresolved require	✅ 0 issues
Invalid package.json	✅ 0 issues
HTTP dependency	✅ 0 issues
Git dependency	✅ 0 issues
Potential typo squat	✅ 0 issues
Known Malware	✅ 0 issues
Telemetry	✅ 0 issues
Protestware/Troll package	✅ 0 issues

📊 Modified Dependency Overview:

➕ Added Package	Capability Access	+/- Transitive Count	Publisher
@cowprotocol/contracts@1.3.2	network	+7	cowprotocol_dev
ethers@6.0.3	network, filesystem	+6	ricmoo
ts-jest@29.0.5	filesystem, environment	+280	kul
eslint@8.27.0	filesystem, environment	+96	eslintbot
jest@29.4.1	None	+276	simenb
@types/jest@29.4.0	None	+49	types
prettier@2.7.1	eval, filesystem, environment	+0	prettier-bot

[bh2smith]

@fedgiac - I have addressed your concerns in the PR #193 - which has since been merged here. Would you like to take another look?

[fedgiac]

A bit late, but it looks good to me!

As an improvement I'd suggest to check that the emitter address is the settlement contract for events where settlementEventLog != null.