0xabdou / metastreet-contracts

MetaStreet Contracts

Prerequisites

Node v16 or below. Hardhat doesn't work with Node v17 currently: hardhat#1988.

Usage

Install:

npm install

Compile contracts:

npm run build

Run unit tests:

npm test

Start hardhat network:

npm run node

Additional Targets

• Format contracts (prettier): npm run format
• Lint contracts (solhint): npm run lint
• Run unit tests with gas reporter: npm run test:gas
• Run unit tests with coverage (solidity-coverage): npm run test:coverage
• Run static analyzer (slither, requires external installation): npm run analyze
• Format tests and scripts (prettier): npm run format:ts
• Lint tests and scripts (eslint): npm run lint:ts

File Structure

• contracts/ - Smart Contracts
  • interfaces/ - Interfaces
    • INoteAdapter.sol - NoteAdapter interface
    • ILoanPriceOracle.sol - LoanPriceOracle interface
    • ILoanReceiver.sol - LoanReceiver interface
    • IVault.sol - Vault interface
    • IVaultRegistry.sol - VaultRegistry interface
  • LoanPriceOracle.sol - LoanPriceOracle implementation
  • LPToken.sol - LPToken implementation
  • Vault.sol - Vault implementation
  • VaultRegistry.sol - VaultRegistry implementation
  • integrations/ - Thirdparty integration contracts
    • NFTfiV2/ - NFTfiV2 Note Adapter
    • ArcadeV1/ - ArcadeV1 Note Adapter
  • test/ - Testing contracts
    • lending/ - Test lending platform
      • TestNoteToken.sol - Note token for TestLendingPlatform
      • TestLendingPlatform.sol - TestLendingPlatform implementation
      • TestNoteAdapter.sol - Note adapter for TestLendingPlatform
    • TestERC20.sol - Test ERC20 token
    • TestERC721.sol - Test ERC721 token
    • MockLoanPriceOracle.sol - Mock LoanPriceOracle
    • TestLPTokenUpgrade.sol - Test LPToken upgrade
    • TestVaultUpgrade.sol - Test Vault upgrade
• test/ - Unit tests
  • TestLendingPlatform.spec.ts - TestLendingPlatform unit tests
  • LoanPriceOracle.spec.ts - LoanPriceOracle unit tests
  • LPToken.spec.ts - LPToken unit tests
  • Vault.spec.ts - Vault unit tests
  • Vault.accounting.spec.ts - Vault accounting unit tests
  • Vault.keeper.spec.ts - Vault keeper integration unit tests
  • Integration.spec.ts - Integration test
  • helpers/ - Test helpers
    • EventUtilities.ts - Event helper functions
    • FixedPointHelpers.ts - Fixed point math helper functions
    • RandomHelpers.ts - Random number helper functions
    • LoanPriceOracleHelpers.ts - Loan price oracle helper functions
    • VaultHelpers.ts - Vault helper functions
• scripts/ - Scripts
  • deploy-simulation.ts - Simulation deployment
  • deployment-manager.ts - Deployment manager
• deployments/ - Deployments
• docs/ - Documentation
  • SECURITY.md - Security notes
• 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 v1 Contracts are primary BUSL-1.1 licensed. Interfaces are MIT licensed.