Liquidity.Party/tycho-protocol-sdk
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readmes

Browse Source
This commit is contained in:
pistomat
2023-12-22 11:33:12 +01:00
parent e9ebf6f0c6
commit 03686d0dff
7 changed files with 29 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
proto/tycho/evm/v1/common.proto
View File

@@ -48,14 +48,14 @@ message Attribute {
}
// A struct describing a part of the protocol.
// Note: For example this can be a UniswapV2 pair, that would track the two ERC20 tokens used by the pair,
// the contract would be only the single sontract. The attributes would be empty for the VM integration,
// because we track all the relevant info via storage slots and balance changes.
// Note: For example this can be a UniswapV2 pair, that tracks the two ERC20 tokens used by the pair,
// the component would represent a single contract. In case of VM integration, such component would
// not need any attributes, because all the relevant info would be tracked via storage slots and balance changes.
// It can also be a wrapping contract, like WETH, that has a constant price, but it allows swapping tokens.
// This is why the name ProtocolComponent is used instead of "Pool" or "Pair".
message ProtocolComponent {
// A unique identifier for the component within the protocol.
// Can be a stringified address or a string describing the trading pair.
// Can be e.g. a stringified address or a string describing the trading pair.
string id = 1;
// Addresses of the ERC20 tokens used by the component.
repeated bytes tokens = 2;
@@ -70,7 +70,7 @@ message ProtocolComponent {
}
// A struct for following the changes of Total Value Locked (TVL) of a protocol component.
// Note that if the ProtocolComponent contains multiple contracts, the TVL is tracked for the component as a whole.
// Note that if a ProtocolComponent contains multiple contracts, the TVL is tracked for the component as a whole.
// E.g. for UniswapV2 pair WETH/USDC, this tracks the USDC and WETH balance of the pair contract.
message BalanceChange {
// The address of the ERC20 token whose balance changed.

2
proto/tycho/evm/v1/vm.proto
View File

@@ -18,7 +18,7 @@ message ContractSlot {
message ContractChange {
// The contract's address
bytes address = 1;
// The new balance of the contract, empty bytes indicates no change.
// The new native balance of the contract, empty bytes indicates no change.
bytes balance = 2;
// The new code of the contract, empty bytes indicates no change.
bytes code = 3;