Files
mev-beta/pkg/types/swap.go
Administrator 5d9a1d72a0
Some checks failed
V2 CI/CD Pipeline / Pre-Flight Checks (push) Has been cancelled
V2 CI/CD Pipeline / Build & Dependencies (push) Has been cancelled
V2 CI/CD Pipeline / Code Quality & Linting (push) Has been cancelled
V2 CI/CD Pipeline / Unit Tests (100% Coverage Required) (push) Has been cancelled
V2 CI/CD Pipeline / Integration Tests (push) Has been cancelled
V2 CI/CD Pipeline / Performance Benchmarks (push) Has been cancelled
V2 CI/CD Pipeline / Decimal Precision Validation (push) Has been cancelled
V2 CI/CD Pipeline / Modularity Validation (push) Has been cancelled
V2 CI/CD Pipeline / Final Validation Summary (push) Has been cancelled
feat(foundation): create V2 foundation with core interfaces and types
Created complete V2 foundation infrastructure for modular MEV bot:

Core Types (pkg/types/):
- swap.go: SwapEvent with protocol support for 13+ DEXs
- pool.go: PoolInfo with multi-index cache support
- errors.go: Comprehensive error definitions
- Full validation methods and helper functions
- Proper decimal scaling (18 decimals internal representation)

Parser Interface (pkg/parsers/):
- Parser interface for protocol-specific implementations
- Factory interface for routing and registration
- Support for single log and full transaction parsing
- SupportsLog() for dynamic protocol identification

Cache Interface (pkg/cache/):
- PoolCache interface with multi-index support
- O(1) lookups by: address, token pair, protocol, liquidity
- Add, Update, Remove, Count, Clear operations
- Context-aware for cancellation support

Validation Interface (pkg/validation/):
- Validator interface for swap events and pools
- ValidationRules with configurable thresholds
- FilterValid() for batch validation
- Zero address, zero amount, decimal precision checks

Observability (pkg/observability/):
- Logger interface with structured logging (slog)
- Metrics interface with Prometheus integration
- Performance tracking (parse latency, execution)
- Business metrics (arbitrage opportunities, profit)

Project Files:
- go.mod: Module definition with ethereum and prometheus deps
- README.md: Complete project overview and documentation

Architecture Principles:
- Interface-first design for testability
- Single responsibility per interface
- Dependency injection ready
- Observable by default
- 18 decimal internal representation

Ready for Phase 1 implementation:
- All interfaces defined
- Error types established
- Core types validated
- Logging and metrics infrastructure ready

Next: Implement protocol-specific parsers (P2-001 through P2-055)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-10 14:43:36 +01:00

116 lines
3.1 KiB
Go

// Package types defines core data types for MEV Bot V2
package types
import (
"math/big"
"time"
"github.com/ethereum/go-ethereum/common"
)
// ProtocolType identifies the DEX protocol
type ProtocolType string
const (
ProtocolUniswapV2 ProtocolType = "uniswap-v2"
ProtocolUniswapV3 ProtocolType = "uniswap-v3"
ProtocolUniswapV4 ProtocolType = "uniswap-v4"
ProtocolCurve ProtocolType = "curve"
ProtocolBalancerV2 ProtocolType = "balancer-v2"
ProtocolBalancerV3 ProtocolType = "balancer-v3"
ProtocolKyberClassic ProtocolType = "kyber-classic"
ProtocolKyberElastic ProtocolType = "kyber-elastic"
ProtocolCamelotV2 ProtocolType = "camelot-v2"
ProtocolCamelotV3AlgebraV1 ProtocolType = "camelot-v3-algebra-v1"
ProtocolCamelotV3AlgebraV19 ProtocolType = "camelot-v3-algebra-v1.9"
ProtocolCamelotV3AlgebraIntegral ProtocolType = "camelot-v3-algebra-integral"
ProtocolCamelotV3AlgebraDirectional ProtocolType = "camelot-v3-algebra-directional"
ProtocolUnknown ProtocolType = "unknown"
)
// SwapEvent represents a parsed swap event from any protocol
type SwapEvent struct {
// Event metadata
TxHash common.Hash
BlockNumber uint64
LogIndex uint
Timestamp time.Time
// Pool information
PoolAddress common.Address
Protocol ProtocolType
// Token information
Token0 common.Address
Token1 common.Address
Token0Decimals uint8
Token1Decimals uint8
// Swap amounts (scaled to 18 decimals internally)
Amount0In *big.Int
Amount1In *big.Int
Amount0Out *big.Int
Amount1Out *big.Int
// Additional protocol-specific data
Fee *big.Int // Fee amount (if applicable)
SqrtPriceX96 *big.Int // UniswapV3/Camelot V3 price
Liquidity *big.Int // Current liquidity
Tick *int32 // UniswapV3/Camelot V3 tick
// Sender and recipient
Sender common.Address
Recipient common.Address
}
// Validate checks if the swap event is valid
func (s *SwapEvent) Validate() error {
if s.TxHash == (common.Hash{}) {
return ErrInvalidTxHash
}
if s.PoolAddress == (common.Address{}) {
return ErrInvalidPoolAddress
}
if s.Token0 == (common.Address{}) {
return ErrInvalidToken0Address
}
if s.Token1 == (common.Address{}) {
return ErrInvalidToken1Address
}
if s.Protocol == ProtocolUnknown {
return ErrUnknownProtocol
}
// At least one amount should be non-zero
if isZero(s.Amount0In) && isZero(s.Amount1In) && isZero(s.Amount0Out) && isZero(s.Amount1Out) {
return ErrZeroAmounts
}
return nil
}
// GetInputToken returns the token being swapped in
func (s *SwapEvent) GetInputToken() (common.Address, *big.Int) {
if !isZero(s.Amount0In) {
return s.Token0, s.Amount0In
}
return s.Token1, s.Amount1In
}
// GetOutputToken returns the token being swapped out
func (s *SwapEvent) GetOutputToken() (common.Address, *big.Int) {
if !isZero(s.Amount0Out) {
return s.Token0, s.Amount0Out
}
return s.Token1, s.Amount1Out
}
// isZero checks if a big.Int is nil or zero
func isZero(n *big.Int) bool {
return n == nil || n.Sign() == 0
}