SOFA Protocol

SOFA Protocol is a decentralized finance(DeFi) protocol designed to empower secure and efficient interactions within a blockchain ecosystem. This repository contains the core smart contracts and scripts built using Hardhat, along with supporting libraries and documentation.

Table of Contents

• Overview
• Audits
• Getting Started
• Usage
• Contributing
• Connect With the Community
• License

Overview

The SOFA protocols offer a new way to handle crypto by making transactions clear and safe. It lets you earn based on benefits without worrying about asset safety. All details are recorded transparently on the blockchain, supporting various products. Tokenized positions improve capital efficiency and can be used across DeFi and centralized platforms. Using ERC-1155 tokens saves on costs, and the system is designed to be sustainable and user-friendly.

For more details, please visit SOFA.org homepage and explore SOFA Documentation:

• SOFA.org

• SOFA Documentation

Audits

The SOFA protocols have been subjected to comprehensive and strict security audits conducted by several renowned independent organizations. For further details and insights, please refer to the full audit reports published by these organizations:

• Code4rena(Zenith)
• Peckshield
• SigmaPrime
• Automator audited by Code4rena(Zenith)
• Automator2.0 audited by Code4rena(Zenith)
• Automator2.0 & Dual Currency audited by yAudit

Getting Started

SOFA Protocol leverages Hardhat to streamline smart contract development, testing, and deployment. Our goal is to provide a modular, scalable, and secure framework that can integrate seamlessly with DeFi ecosystems.

Prerequisites

Ensure you have the following installed:

• Node.js (v18.x or later)
• npm
• Hardhat (installed via npm)

Installation

Clone the repository and install dependencies:

git clone https://github.com/sofa-org/sofa-protocol.git
cd sofa-protocol
npm install

Configuration

Set up .env file to set your configuration variables (e.g., network URLs, private keys) used in hardhat.config.ts for your development environment.

Usage

Compiling Contracts

Compile the smart contracts using Hardhat:

npx hardhat compile

Running Tests

Run the test suite to ensure everything is working as expected:

npx hardhat test

Contributing

Contributions are welcome. To contribute:

Fork the repository

Create a new branch

git checkout -b feature/your-feature-name

Make your changes

Update files as needed.

Add all your changes

git add .

Commit your changes

git commit -m "Describe your changes"

Push the branch to your fork

git push origin feature/your-feature-name

Submit a Pull Request on GitHub for review.

Please ensure that your contributions follow the existing style and structure, and that you test locally before submitting a pull request.

Connect With the Community

You can join the Discord to ask questions about the protocol or talk about SOFA with other peers.

License

This project is licensed under the MIT License.