Rules for emitted events

[smol-ninja]

I think there are a few inconsistencies among the events emitted. So I decided to make rules for them.

Rules

1. All events must contain streamId as the first entry and it must always be indexed.
2. If there is a transfer of asset, the counterparty, which is sending/receiving the asset, must be indexed.
3. As an exception, create must have asset, streamId and sender indexed, regardless.
4. No indexing otherwise.

Here is the revised version:

event AdjustFlowStream(
    uint256 indexed streamId, uint128 amountOwed, uint128 newRatePerSecond, uint128 oldRatePerSecond
);

event CreateFlowStream(
    uint256 indexed streamId,
    IERC20 indexed asset,
    address indexed sender,
    address recipient,
    uint40 lastTimeUpdate,
    uint128 ratePerSecond
);

event DepositFlowStream(
    uint256 indexed streamId, address indexed funder, uint128 depositAmount
);

event PauseFlowStream(
    uint256 indexed streamId, address recipient, address sender, uint128 amountOwed
);

event RefundFromFlowStream(
    uint256 indexed streamId, address indexed sender, uint128 refundAmount
);

event RestartFlowStream(
    uint256 indexed streamId, address recipient, address sender, uint128 ratePerSecond
);

event VoidFlowStream(
    uint256 indexed streamId, address recipient, address sender, uint128 forfeitedDebt, uint128 newAmountOwed
);

event WithdrawFromFlowStream(
    uint256 indexed streamId, address indexed to, uint128 withdrawnAmount
);

RFC @andreivladbrg.

[andreivladbrg]

I pretty much agree with your proposed rules and don't have any objections.

Let's also see @razgraf 's opinion since the events are relevant to the subgraph.
Question, would it be useful to have the asset indexed in each event?

[razgraf]

Regarding the rules suggested by @smol-ninja , they seem great! If indexing asset provides for some extra consistency, we can keep it (although in data indexers, it's not used for most events).

[smol-ninja]

Thanks for your feedback.

1. Lets not index asset then except in create.
2. In create, to be able to index asset, we will have to un-index either of streamId, recipient or sender because only 3 are allowed. Which one is the least useful?

[smol-ninja]

although in data indexers, it's not used for most events

Then if we remove asset from the events, will that be OK? My argument is why to include any data if its not important.

[andreivladbrg]

since the ERC721 also indexes the ID minted and to (i.e., recipient), between these two, i would un-index the recipient. wdyt?

[smol-ninja]

In create, yes.

[smol-ninja]

@andreivladbrg updated the OP. Lmk if it looks good, I will create an issue and handle it in my next PR.

[smol-ninja]

Issue

• Refactor events emitted by the protocol #169