Smart Contract Development

Developing and testing the Nomial smart contracts

Source Code

• https://github.com/nomial-io/nomial-contracts-v1

Development Environment Setup

To work with Nomial V1 contracts, ensure you have the following dependencies installed:

# Install Foundry (if not installed)
curl -L https://foundry.paradigm.xyz | bash
foundryup

# Clone the repository
git clone https://github.com/nomial-io/nomial-contracts-v1.git
cd nomial-contracts-v1

# Install dependencies
yarn install

Project Structure

Nomial V1 follows a modular structure:

nomial-contracts-v1/
│── src/                # Core smart contracts
│   ├── CollateralPool.sol  # Manages solver collateral
│   ├── InventoryPool.sol   # Manages solver borrowing
│   ├── deployment/         # Deployment logic & interfaces
│── test/               # Contains test cases for all contracts
│── scripts/            # Deployment and interaction scripts
│── foundry.toml        # Foundry configuration file
│── package.json        # Dependencies and scripts

Build & Compilation

To compile the contracts:

forge build

If compilation fails, ensure all dependencies are installed and run:

forge clean && forge build

Testing

Nomial V1 uses Foundry for testing. To run all tests:

forge test

For verbose output:

forge test -vvv

Writing & Running Custom Tests

Tests are located in the test/ directory and follow Foundry's testing conventions. To write a new test:

1. Create a new file in test/

2. Import Test from forge-std

3. Write test functions prefixed with test

Example:

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;

import "forge-std/Test.sol";
import "../src/CollateralPool.sol";

contract CollateralPoolTest is Test {
    CollateralPool pool;
    
    function setUp() public {
        pool = new CollateralPool();
    }
    
    function testDeposit() public {
        uint256 amount = 1000;
        pool.deposit(address(this), amount);
        assertEq(pool.getBalance(address(this)), amount);
    }
}

Debugging & Troubleshooting

• Out-of-gas errors? Increase gas limits in foundry.toml.

• Missing dependencies? Run forge install or yarn install.

• Tests failing? Run forge test -vvv for detailed logs.