PiFinance-Core

PiFinance by KOSASIH is licensed under Creative Commons Attribution 4.0 International

PiFinance-Core

The core backend implementation of the PiFinance platform, including the stablecoin mechanism, smart contracts for savings and loans, and the peer-to-peer lending system.

PiFinance-Core

PiFinance-Core is a decentralized finance (DeFM application designed for managing stablecoins. It provides features for minting, burning, trading stablecoins, and monitoring system health. Built on the Ethereum blockchain, it aims to facilitate seamless financial transactions in a secure and efficient manner.

Table of Contents

• Features
• Installation
• Usage
• API Endpoints
• Testing
• Monitoring
• Contributing
• License

Features

• Mint and burn stablecoins
• Liquidity management
• Price oracle integration
• Monitoring and alerting mechanisms
• Comprehensive logging
• Health checks for service availability

Installation

Prerequisites

• Node.js (version 14 or higher)
• MongoDB (for data storage)
• Redis (for caching, optional)
• An Ethereum provider (e.g., Infura)

Steps

1. Clone the repository:

   git clone https://github.com/KOSASIH/PiFinance-Core.git
   cd PiFinance-Core
   

2. Install dependencies:

   npm install
   

3. Create a .env file in the root directory and configure your environment variables. You can use the provided .env.example as a reference.

4. Start the application:

   npm start
   

Usage

Once the application is running, you can interact with it through the API endpoints. Use tools like Postman or cURL to make requests.

Example Request to Mint Stablecoins

curl -X POST http://localhost:3000/mint -H "Content-Type: application/json" -d '{"amount": 100}'

API Endpoints

Method	Endpoint	Description
POST	/mint	Mint stablecoins
POST	/burn	Burn stablecoins
POST	/liquidity/add	Add liquidity to the pool
GET	/health	Check the health of the application
GET	/metrics	Get application metrics

Testing

To run the tests for the application, use the following command:

npm test

You can also generate a coverage report with:

npm run coverage

Monitoring

The application includes built-in monitoring features. Metrics can be accessed at the /metrics endpoint, and health checks can be performed at the /health endpoint.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Make your changes and commit them (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.

This site is open source. Improve this page.