@majinfi/contracts
v1.0.1
Published
🍧 Core and periphery smart contracts of Majin Finance
Downloads
3
Maintainers
Readme
Majin Finance
Majin Finance is a decentralized finance (DeFi) project inspired by Uniswap V3, purpose-built for Kakarot with enhanced features and optimizations.
Technology Stack
- Hardhat: Ethereum development environment
- Foundry: Testing framework and toolchain
Prerequisites
Setup
Clone the repository:
git clone https://github.com/majinfi/contracts.git cd contracts
Install dependencies:
bun install
Install Foundry dependencies:
forge install
Build
To compile the contracts:
bun run build
This command runs both Hardhat and Foundry builds.
Test
Run the test suite:
bun test
For Hardhat-specific tests:
bun x hardhat test --grep "TestSuite"
For Foundry-specific tests:
forge test
Deploy
To dry-deploy the contracts on local Hardhat network:
bun run deploy
This script deploys contracts to the network specified in your Hardhat config.
Format
To format Solidity files:
bun run fmt
Linting
To lint the codebase:
bun run lint
Documentation
For more detailed information about the project structure and contract interactions, please refer to our documentation.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the GPL-3.0-or-later License.