Improve the naming of utils.

This commit is contained in:
kayibal
2024-03-13 12:28:10 +00:00
parent 4b2437dab6
commit 0d621a4545
4 changed files with 38 additions and 20 deletions

View File

@@ -4,8 +4,13 @@ package tycho.evm.v1;
import "tycho/evm/v1/common.proto";
// A struct for following the changes of Total Value Locked (TVL).
// A message containing relative balance changes.
//
// Used to track token balances of protocol components in case they are only
// available as relative values within a block.
message BalanceDelta {
// The ordinal of the balance change. Must be unique & deterministic over all balances
// changes within a block.
uint64 ord = 1;
// The tx hash of the transaction that caused the balance change.
Transaction tx = 2;
@@ -14,19 +19,23 @@ message BalanceDelta {
// The delta balance of the token.
bytes delta = 4;
// The id of the component whose TVL is tracked.
// If the protocol component includes multiple contracts, the balance change must be aggregated to reflect how much tokens can be traded.
// If the protocol component includes multiple contracts, the balance change must be
// aggregated to reflect how much tokens can be traded.
bytes component_id = 5;
}
message BalanceDeltas {
// A set of balances deltas, usually a group of changes within a single block.
message BlockBalanceDeltas {
repeated BalanceDelta balance_deltas = 1;
}
// A message containing protocol components that were created by a single tx.
message TransactionProtocolComponents {
Transaction tx = 1;
repeated ProtocolComponent components = 2;
}
message GroupedTransactionProtocolComponents {
// All protocol components that were created within a block with their corresponding tx.
message BlockTransactionProtocolComponents {
repeated TransactionProtocolComponents tx_components = 1;
}