MetaStreet v2 Contracts

Usage

Install:

npm install

Compile contracts:

npm run build

Run unit tests:

npm test

Start hardhat network:

npm run node

Additional Targets

• Format contracts, tests, and scripts (prettier): npm run format
• Lint contracts, tests, and scripts (solhint + eslint): npm run lint
• Run static analyzer (slither, requires external installation): npm run analyze

File Structure

• contracts/ - Smart Contracts
  • Pool.sol - Pool base contract
  • PoolFactory.sol - Pool Factory
  • Tick.sol - Tick library
  • LoanReceipt.sol - Loan Receipt library
  • DepositLogic.sol - Deposit logic library
  • BorrowLogic.sol - Borrow logic library
  • LiquidityLogic.sol - Liquidity logic library
  • interfaces/ - Interfaces
    • IPool.sol - Pool interface
    • ILiquidity.sol - Liquidity interface
    • ICollateralWrapper.sol - Collateral Wrapper interface
    • ICollateralLiquidator.sol - Collateral Liquidator interface
    • ICollateralLiquidationReceiver.sol - Collateral Liquidation Receiver interface
    • IPoolFactory.sol - Pool Factory interface
  • configurations/ - Pool Configurations
    • WeightedRateCollectionPool.sol - Weighted Rate Collection Pool
    • WeightedRateRangedCollectionPool.sol - Weighted Rate Ranged Collection Pool
    • WeightedRateSetCollectionPool.sol - Weighted Rate Set Collection Pool
    • WeightedRateMerkleCollectionPool.sol - Weighted Rate Merkle Collection Pool
    • NoopPool.sol - Noop Pool
  • wrappers/ - Collateral Wrappers
    • BundleCollateralWrapper.sol - Bundle Collateral Wrapper
    • ERC1155CollateralWrapper.sol - ERC155 Collateral Wrapper
    • PunkCollateralWrapper.sol - CryptoPunks Collateral Wrapper
    • KongzBundleCollateralWrapper.sol - CyberKongz Bundle Collateral Wrapper
  • filters/ - Collateral Filters
    • CollateralFilter.sol - Collateral Filter abstract base contract
    • CollectionCollateralFilter.sol - Collection Collateral Filter
    • RangedCollectionCollateralFilter.sol - Ranged Collection Collateral Filter
    • SetCollectionCollateralFilter.sol - Set Collection Collateral Filter
    • MerkleCollectionCollateralFilter.sol - Merkle Collection Collateral Filter
  • rates/ - Interest Rate Models
    • InterestRateModel.sol - Interest Rate Model abstract base contract
    • WeightedInterestRateModel.sol - Weighted Interest Rate Model
  • tokenization/ - Tokenization
    • DepositToken.sol - Deposit Token abstract base contract
    • ERC20DepositToken.sol - ERC20 Deposit Token contract
    • ERC20DepositTokenImplementation.sol - ERC20 Deposit Token implementation contract
    • ERC20DepositTokenProxy.sol - ERC20 Deposit Token proxy contract
    • ERC20DepositTokenFactory.sol - ERC20 Deposit Token factory library contract
  • oracle/ - Price Oracle Support
    • PriceOracle.sol - Price Oracle abstract base contract
    • ExternalPriceOracle.sol - External Price Oracle contract
    • SimpleSignedPriceOracle.sol - (External) Simple Signed Price Oracle implementation contract
    • ReservoirPriceOracle.sol - (External) Reservoir Price Oracle implementation contract
    • ChainlinkPriceOracle.sol - (External) Chainlink Price Oracle implementation contract
  • liquidators/ - Collateral Liquidators
    • EnglishAuctionCollateralLiquidator.sol - English Auction Collateral Liquidator
  • integrations/ - Third-party Integrations
  • test/ - Testing Contracts
    • integrations/ - Third-Party Integrations
    • rates/ - Test Wrappers for Interest Rate Models
    • filters/ - Test Wrappers for Collateral Filters
    • tokens/ - Test Tokens
      • TestERC20.sol - Test ERC20
      • TestERC721.sol - Test ERC721
      • TestERC1155.sol - Test ERC71155
      • TestMaliciousERC20.sol - Test Malicious ERC20
    • TestTick.sol - Test Wrapper for Tick library
    • TestLoanReceipt.sol - Test Wrapper for Loan Receipt library
    • TestLiquidityLogic.sol - Test Wrapper for Liquidity logic library
    • TestCollateralLiquidatorJig.sol - Test Jig for Collateral Liquidators
    • TestCollateralLiquidatorJigTruncated.sol - Truncated Test Jig for Collateral Liquidators
    • TestProxy.sol - Test Proxy
    • ExternalCollateralLiquidator.sol - External Collateral Liquidator
• test/ - Unit tests
  • rates/ - Interest Rate Model tests
    • WeightedInterestRateModel.spec.ts - Weighted Interest Rate Model unit test
  • filters/ - Collateral Filter tests
    • CollectionCollateralFilter.spec.ts - Collection Collateral Filter unit test
    • RangedCollectionCollateralFilter.spec.ts - Ranged Collection Collateral Filter unit test
    • SetCollectionCollateralFilter.spec.ts - Set Collection Collateral Filter unit test
    • MerkleCollectionCollateralFilter.spec.ts - Merkle Collection Collateral Filter unit test
  • wrappers/ - Collateral Wrapper tests
    • BundleCollateralWrapper.spec.ts - Bundle Collateral Wrapper unit test
    • ERC1155CollateralWrapper.spec.ts - ERC1155 Collateral Wrapper unit test
  • liquidators/ - Collateral Liquidators tests
    • ExternalCollateralLiquidator.spec.ts - External Collateral Liquidator unit test
    • EnglishAuctionCollateralLiquidator.spec.ts - English Auction Collateral Liquidator unit test
  • models/ - Integration test models
    • PoolModel.ts - Pool model
  • helpers/ - Test helpers
    • Deploy.ts - Deploy with libraries helper
    • EventUtilities.ts - Event utilities
    • FixedPoint.ts - Fixed Point math utility class
    • Tick.ts - Tick utility class
    • MerkleTree.ts - Merkle tree utility class
  • Tick.spec.ts - Tick unit test
  • LoanReceipt.spec.ts - Loan Receipt unit test
  • LiquidityLogic.spec.ts - Liquidity logic unit test
  • PoolFactory.spec.ts - Pool Factory unit test
  • Pool.basic.spec.ts - Pool basic unit test
  • Pool.bundle.spec.ts - Pool bundle unit test
  • Pool.gas.spec.ts - Pool gas unit test
  • Integration.spec.ts - Integration test
  • Storage.spec.ts - Storage layout test
• scripts/ - Scripts
  • deploy-simulation.ts - Simulation deployment
  • deployment-manager.ts - Deployment manager
• deployments/ - Deployments
• docs/ - Documentation
• hardhat.config.ts - Hardhat configuration
• tsconfig.json - TypeScript configuration
• package.json - npm package metadata
• package-lock.json - npm package lock
• README.md - This README

License

MetaStreet v2 Contracts are primarily BUSL-1.1 licensed. Interfaces are MIT licensed.