/test

Primary LanguageTypeScriptOtherNOASSERTION

FaaS (Farm as a Service) Open in Gitpod Github Actions Github Actions Hardhat

FaaS (Farm as a Service) is a smart contract-based project that allows users to create their own FarmingRewards contracts to distribute rewards to liquidity providers. This repository contains the Solidity contracts, tests, and necessary scripts for the FaaS system.

This project was built with hardhat.

Table of Contents

Features

  • Create FarmingRewards contracts for distributing rewards to liquidity providers
  • Permissioned FarmingRewards contracts for added security and control
  • Fee collection for creating new FarmingRewards contracts
  • Integration with ElkFinance's ecosystem

Getting Started

Follow these instructions to set up the FaaS repository on your local machine.

Prerequisites

  • Node.js and npm (Node Package Manager) installed on your system. You can download Node.js from https://nodejs.org/.

Installation

  1. Clone the repository to your local machine:
git clone https://github.com/elkfinance/faas
  1. Navigate to the project folder:
cd faas
  1. Install the project dependencies:
npm install

Running Tests

  1. Run the tests:
npm run test

Usage

The FaaS system is comprised of two main contracts: "ElkFarmFactory" (located at ./contracts/ElkFarmFactory.sol) and "FarmingRewards" (located at ./contracts/FarmingRewards.sol). The ElkFarmFactory contract is the main contract that users interact with to create new FarmingRewards contracts. The FarmingRewards contract is the contract that distributes rewards to liquidity providers.

Authors

License

See included LICENSE.