refactor: events must emit addresses involved in the operation for better dApp indexing

0xneves commented 7 months ago

Refactor Request

Describe the Refactor Request

We need more context in the logs because we won't have a backend managing past history in the v1.0.0. This means when your wallet is connected to the dApp, we will check for indexed events in your address. We can fetch the swapId from such events, even the arguments used to call the function - for instance the createSwap bidding and asked assets. This is thanks to function handlers from SubGraph. However we need to know which user is part of which swap.

Describe Preferred Solution

Every Swap event needs to be followed by the swap.owner or swap.allowed, or both. The wanted solution is described below in the code scope.
Renaming acceptee to allowed.
Refactor tests involving such events.

  event SwapCreated(uint256 indexed swapId, address indexed owner, address indexed allowed);
  event SwapAccepted(uint256 indexed swapId, address indexed owner, address indexed allowed);
  event SwapCanceled(uint256 indexed swapId, address indexed owner);

Related Code

Current events are the following...

event SwapCreated(uint256 indexed swapId);
event SwapAccepted(uint256 indexed swapId, address indexed accepted);
event SwapCanceled(uint256 indexed swapId);