From 7d95b5e0f7a96547b04bfca8a49dfbd44050e4b3 Mon Sep 17 00:00:00 2001
From: callebtc <93376500+callebtc@users.noreply.github.com>
Date: Fri, 12 Jul 2024 18:17:25 +0200
Subject: [PATCH] Instructions for .env

---
 CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++----
 1 file changed, 28 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6e5a3d01..5f9f073a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,6 +5,9 @@ Please contribute to Nutshell! You can open issues if you find bugs and pull req
 ## Contributing
 Pick an issue you would like to work on. Those with the tag `good first issue` are great for getting started. When you open a pull request, make sure that you've run tests and formatting locally before you push code.
 
+## Formatting
+We use [Ruff](https://docs.astral.sh/ruff/formatter/) for formatting. To make sure that your tests succeed, please run `make format` before you push code. You can find the Ruff parameters in `pyproject.toml`.
+
 ## Setting up your environment
 
 We use [Poetry](https://python-poetry.org/) as a dependency and environment manager. Currently, Nutshell supports Python `3.10.4` which you can install using `pyenv` (see README.md). To install all dependencies, run `poetry install`. After install, you can activate the shell with `poetry shell`. Now you can execute `cashu --help` to use the wallet or `mint` to run the mint.
@@ -29,6 +32,22 @@ LOG_LEVEL=TRACE
 
 To run the tests, run `make test` or `pytest tests` in the poetry environment.
 
+### FakeWallet
+
+We use the `FakeWallet` backend for most of the tests. `FakeWallet` acts like a Lightning node where all (fake) invoices are always automatically paid. It's great for testing code that does not affect the Lightning functionality of the mint. To use it, set:
+
+```
+MINT_BACKEND_BOLT11_SAT=FakeWallet
+```
+
+You can control how fast payments should succeed by setting these flags
+
+```
+FAKEWALLET_DELAY_PAYMENT=TRUE
+FAKEWALLET_DELAY_OUTGOING_PAYMENT=3
+FAKEWALLET_DELAY_INCOMING_PAYMENT=3
+```
+
 ### Lightning regtest
 
 There are many tests that also run in regtest, a simulated Lightning network environment. To run the regtest, clone [this repository](https://github.com/callebtc/cashu-regtest) and run `./start.sh`. This will start your regtest environment with several Lightning node implementations.
@@ -36,9 +55,9 @@ There are many tests that also run in regtest, a simulated Lightning network env
 You can choose one of the nodes as a backend for nutshell using the `.env` variable:
 ```
 # Choose one from:
-# LNbitsWallet, LndRestWallet, CLNRestWallet, CoreLightningRestWallet
+# LndRestWallet, CLNRestWallet, CoreLightningRestWallet, LNbitsWallet
 
-MINT_BACKEND_BOLT11_SAT=FakeWallet
+MINT_BACKEND_BOLT11_SAT=LndRestWallet
 ```
 
 The Nutshell settings to connect to the provided nodes are given below
@@ -59,5 +78,10 @@ MINT_CORELIGHTNING_REST_MACAROON=../cashu-regtest-enviroment/data/clightning-2-r
 MINT_CORELIGHTNING_REST_CERT=../cashu-regtest-enviroment/data/clightning-2-rest/certificate.pem
 ```
 
-## Formatting
-We use [Ruff](https://docs.astral.sh/ruff/formatter/) for formatting. To make sure that your tests succeed, please run `make format` before you push code. You can find the Ruff parameters in `pyproject.toml`.
+### Profiling
+
+If you'd like to profile your code (measure how long steps take to execute), run the mint using `DEBUG_PROFILING=TRUE`. Make sure to turn this off again, as your application will be significantly slower with profiling enabled.
+
+### V0 API only
+
+To run the mint with only V0 API support (deprecated), use `DEBUG_MINT_ONLY_DEPRECATED=TRUE`