Yield farming, also referred to as liquidity mining, is a way to generate rewards with cryptocurrency holdings. In simple terms, it means locking up cryptocurrencies and getting rewards.
This project is funded by the Cardano Treasury in Catalyst Fund 10.
Yield farming is a key concept in the decentralized finance (DeFi) space. It involves providing liquidity to a DeFi protocol, typically through a pair of crypto assets, in exchange for rewards. These rewards often come in the form of additional digital tokens or interest payments. Here's a brief introduction to the concept:
-
Decentralized Finance (DeFi): Yield farming is a practice within the DeFi ecosystem, which aims to recreate traditional financial systems (like banks and exchanges) in a decentralized manner using blockchain technology.
-
Liquidity Provision: Users, often called liquidity providers (LPs), add their crypto assets to liquidity pools. These pools power a marketplace where users can lend, borrow, or exchange tokens. The use of these pools can vary from simple token swaps to more complex financial activities like borrowing and lending.
-
Earning Rewards: In return for providing liquidity, users earn rewards. These rewards can be in the form of transaction fees generated from the underlying DeFi platform or additional tokens issued by the protocol. The return is often denominated as an annual percentage yield (APY) or annual percentage rate (APR).
-
Smart Contracts: Yield farming uses smart contracts, which are self-executing contracts with the terms of the agreement directly written into code. These smart contracts manage the liquidity pools and the distribution of rewards.
-
Liquidity Pools: A liquidity pool is a collection of funds locked in a smart contract. Users contribute tokens to the pool.
-
Staking and Pooling: After depositing their tokens into a pool, LPs receive liquidity tokens or proof of their stake in return. These tokens can sometimes be staked in additional platforms to earn more rewards.
-
Smart Contract Risk: As yield farming relies on smart contracts, any bugs or vulnerabilities in the contract code can lead to loss of funds.
-
Impermanent Loss: This occurs when the price of your deposited assets changes compared to when you deposited them. The greater the change, the more you're exposed to impermanent loss.
-
Market Risk: The volatile nature of cryptocurrency markets can lead to significant fluctuations in yield farming returns.
- The project uses Plutarch, a language for writing Plutus scripts that run on the Cardano blockchain.
- It provides functions like
pterminateYieldFarming,pharvestYieldFarm, andpaddYieldFarmRewardsto manage yield farming operations. - It includes data types
YieldFarmingDatumandYieldFarmRedeemerto represent the data associated with a yield farming transaction.
Before you begin, ensure you have Nix installed on your system. Nix is used for package management and to provide a consistent development environment. To install run the following command:
sh <(curl -L https://nixos.org/nix/install) --daemonand follow the instructions.
$ nix --version
nix (Nix) 2.18.1Make sure to enable Nix Flakes by editing either ~/.config/nix/nix.conf or /etc/nix/nix.conf on
your machine and add the following configuration entries:
experimental-features = nix-command flakes ca-derivations
allow-import-from-derivation = trueOptionally, to improve build speed, it is possible to set up binary caches maintained by IOHK and Plutonomicon by setting additional configuration entries:
substituters = https://cache.nixos.org https://iohk.cachix.org https://cache.iog.io
trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= iohk.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo=To facilitate seamlessly moving between directories and associated Nix development shells we use direnv and nix-direnv:
Your shell and editors should pick up on the .envrc files in different directories and prepare the environment accordingly. Use direnv allow to enable the direnv environment and direnv reload to reload it when necessary. Otherwise, the .envrc file contains a proper Nix target you can use with the nix develop command.
To install both using nixpkgs:
nix profile install nixpkgs#direnv
nix profile install nixpkgs#nix-direnvOnce Nix is installed, you should be able to seamlessly use the repository to develop, build and run packages.
Download the Git repository:
git clone https://github.com/Anastasia-Labs/yieldfarming.gitNavigate to the repository directory:
cd yieldfarming
direnv allowActivate the development environment with Nix:
nix develop .Additionally, when you run nix run .#help you'll get a list of scripts you can run, the Github CI (nix flake check) is setup in a way where it checks the project builds successfully, haskell format is done correctly, and commit message follows conventional commits. Before pushing you should run cabal run , nix run .#haskellFormat (automatically formats all haskell files, including cabal), if you want to commit a correct format message you can run cz commit
Build:
cabal build allExecute the test suite:
cabal test
To provide a seamless experience for running and trying out our application, click the workspace button below. This will start a workspace in Demeter with our repository code automatically cloned.
For comprehensive information on testing the Yield Farming implementation, including unit tests and property-based tests, please refer to our test documentation.
For an in-depth real-world case study on the application of Yeild Farmings within the Cardano blockchain environment, refer to the following resource:
This case study provides valuable insights into how Yeild Farmings are integrated into blockchain transactions, offering practical examples and detailed workflows.