Eve library

Lilith Platform Audit Package

Guide

Revision 1

On this page

For External Auditors#

Welcome to the Lilith Platform smart contract audit package. This directory contains all documentation needed for a comprehensive security audit.


Quick Start#

  1. Read ARCHITECTURE.md - System overview
  2. Review THREAT_MODEL.md - Security analysis
  3. Understand TRUST_ASSUMPTIONS.md - What we trust
  4. Check KNOWN_ISSUES.md - Already identified issues
  5. Reference AUDITOR_FAQ.md - Common questions

Document Index#

Document Description Priority
ARCHITECTURE.md System architecture, contracts, flow HIGH
THREAT_MODEL.md Threat actors, attack scenarios HIGH
TRUST_ASSUMPTIONS.md Trust boundaries, invariants HIGH
KNOWN_ISSUES.md Identified issues and mitigations MEDIUM
AUDITOR_FAQ.md Common questions and answers MEDIUM

Contract Overview#

Core Contracts (In Scope)#

Contract LOC Description
AccessToken.sol ~300 ERC-1155 access tokens
ContentLicenseNFT.sol ~250 ERC-721 content licenses
CreatorRoyalties.sol ~200 Royalty distribution
IdentityReputation.sol ~350 Identity & staking

Upgradeable Variants (In Scope)#

Contract Description
AccessTokenUpgradeable.sol UUPS upgradeable version
ContentLicenseNFTUpgradeable.sol UUPS upgradeable version
CreatorRoyaltiesUpgradeable.sol UUPS upgradeable version
IdentityReputationUpgradeable.sol UUPS upgradeable version

Security Modules (In Scope)#

Module Description
FlashLoanGuard Flash loan protection
PullPayment patterns DoS-resistant withdrawals

Out of Scope#

  • Test contracts (in contracts/mocks/)
  • Deployment scripts
  • Frontend code

Audit Focus Areas#

Priority 1: Critical Path#

  1. ETH Handling

    • purchaseTokens() payment flow
    • withdrawRoyalty() withdrawal pattern
    • stake() / unstake() operations
  2. Access Control

    • Ownership transfer (Ownable2Step)
    • Role-based permissions
    • Upgrade authorization
  3. Reentrancy Protection

    • All external call paths
    • CEI pattern compliance
    • Guard effectiveness

Priority 2: Security Features#

  1. Flash Loan Guard

    • Block-based protection
    • Coverage completeness
  2. Upgrade Mechanism

    • UUPS implementation
    • Storage layout safety
    • Timelock integration
  3. Pause Functionality

    • Coverage of critical functions
    • Admin bypass where needed

Priority 3: Economic Security#

  1. Fee Calculations

    • Platform fee accuracy
    • Royalty distribution
  2. Staking Logic

    • Minimum requirements
    • Slashing mechanics

Test Execution#

bash
# Install dependencies
npm install

# Run all tests
npm test

# Run security-specific tests
npm run test:security

# Generate coverage report
npm run coverage

# Run Slither analysis
npm run slither

Repository Structure#

text
contracts/
├── contracts/
│   ├── AccessToken.sol
│   ├── ContentLicenseNFT.sol
│   ├── CreatorRoyalties.sol
│   ├── IdentityReputation.sol
│   ├── security/
│   │   └── FlashLoanGuard.sol
│   ├── upgradeable/
│   │   ├── AccessTokenUpgradeable.sol
│   │   └── ...
│   └── mocks/
│       └── ... (out of scope)
├── test/
│   ├── AccessToken.test.ts
│   ├── ... (security tests)
│   └── ...
├── scripts/
│   ├── deployment-security.ts
│   ├── emergency-pause.ts
│   └── monitoring/
│       └── ...
└── docs/
    └── audit/
        └── (this directory)

Communication#

During Audit#

  • Primary Contact: [Technical Lead]
  • Response Time: < 4 hours during business hours
  • Emergency Contact: [Security Lead]

Reporting Findings#

Please report via secure channel with:

  1. Severity (Critical/High/Medium/Low/Informational)
  2. Description
  3. Impact
  4. Proof of concept (if applicable)
  5. Recommended fix

Remediation#

We commit to:

  • Acknowledge findings within 4 hours
  • Triage within 24 hours
  • Begin Critical/High fixes immediately
  • Re-audit of fixes included in scope

Previous Audits#

This is the first external audit of the Lilith Platform.


Version Information#

Component Version
Solidity 0.8.20+
OpenZeppelin 5.x
Hardhat 2.x
Node.js 18.x+

Appendix#

Deployment Configuration#

json
{
  "network": "mainnet",
  "initialOwner": "0x... (Gnosis Safe)",
  "treasury": "0x... (Treasury Safe)",
  "platformFee": 250,
  "minimumStake": "10000000000000000"
}

Key Addresses (Testnet)#

Contract Sepolia Address
AccessToken 0x...
ContentLicenseNFT 0x...
CreatorRoyalties 0x...
IdentityReputation 0x...

Last Updated: 2024-Q4