Skip to content

Commit

Permalink
precommit formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
dni committed Jul 28, 2023
1 parent 59569cb commit 1c47ef7
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 19 deletions.
17 changes: 8 additions & 9 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ TOR=TRUE

# use custom proxy, this will only work with TOR=false
#SOCKS_PROXY=socks5://localhost:9050
#HTTP_PROXY=http://localhost:8088
#HTTP_PROXY=http://localhost:8088

# NOSTR
# nostr private key to which to receive tokens to
Expand Down Expand Up @@ -44,24 +44,23 @@ MINT_DERIVATION_PATH="0/0/0/0"

MINT_DATABASE=data/mint

# Lightning
# Lightning
# Supported: LNbitsWallet, FakeWallet
MINT_LIGHTNING_BACKEND=LNbitsWallet
MINT_LIGHTNING_BACKEND=LNbitsWallet

# for use with LNbitsWallet
MINT_LNBITS_ENDPOINT=https://legend.lnbits.com
MINT_LNBITS_KEY=yourkeyasdasdasd

# fee to reserve in percent of the amount
LIGHTNING_FEE_PERCENT=1.0
LIGHTNING_FEE_PERCENT=1.0
# minimum fee to reserve
LIGHTNING_RESERVE_FEE_MIN=2000
LIGHTNING_RESERVE_FEE_MIN=2000

# Management
# max peg-in amount in satoshis
# MINT_MAX_PEG_IN=100000
# MINT_MAX_PEG_IN=100000
# max peg-out amount in satoshis
# MINT_MAX_PEG_OUT=100000
# MINT_MAX_PEG_OUT=100000
# use to allow only peg-out to LN
# MINT_PEG_OUT_ONLY=FALSE

# MINT_PEG_OUT_ONLY=FALSE
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Please contribute to Nutshell! You can open issues if you find bugs and pull req

## Testing

We are using the `black` formatter and `mypy --ignore-missing` in the CI. To make sure that your tests succeed, please run `make format` before you push code.
We are using the `black` formatter and `mypy --ignore-missing` in the CI. To make sure that your tests succeed, please run `make format` before you push code.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ COPY . .
RUN poetry config virtualenvs.create false
RUN poetry install --no-dev --no-root
EXPOSE 3338
CMD ["poetry", "run", "mint", "--port", "3338", "--host", "0.0.0.0"]
CMD ["poetry", "run", "mint", "--port", "3338", "--host", "0.0.0.0"]
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ recursive-include cashu/tor *
recursive-include cashu/wallet *
exclude tests/*
global-exclude *.py[cod]
prune tests/* */__pycache__/*
prune tests/* */__pycache__/*
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Cashu is an Ecash implementation based on David Wagner's variant of Chaumian bli
- Wallet: Send and receive tokens on nostr

## The Cashu protocol
There are ongoing efforts to implement alternative Cashu clients that use the same protocol. See the [documentation page](https://docs.cashu.space/) for more information on other projects. If you are interested in helping with Cashu development, please refer to the protocol specs [protocol specs](https://github.com/cashubtc/nuts).
There are ongoing efforts to implement alternative Cashu clients that use the same protocol. See the [documentation page](https://docs.cashu.space/) for more information on other projects. If you are interested in helping with Cashu development, please refer to the protocol specs [protocol specs](https://github.com/cashubtc/nuts).

## Easy Install

Expand All @@ -38,7 +38,7 @@ The easiest way to use Cashu is to install the package it via pip:
pip install cashu
```

To update Cashu, use `pip install cashu -U`.
To update Cashu, use `pip install cashu -U`.

If you have problems running the command above on Ubuntu, run `sudo apt install -y pip pkg-config` and `pip install wheel`. On macOS, you might have to run `pip install wheel` and `brew install pkg-config`.

Expand Down Expand Up @@ -97,7 +97,7 @@ mv .env.example .env
vim .env
```

To use the wallet with the [public test mint](#test-instance), you need to change the appropriate entries in the `.env` file.
To use the wallet with the [public test mint](#test-instance), you need to change the appropriate entries in the `.env` file.

#### Test instance
*Warning: this instance is just for demonstration only. The server could vanish at any moment so consider any Satoshis you deposit a donation.*
Expand Down Expand Up @@ -126,7 +126,7 @@ Mint URL: https://8333.space:3338
cashu balance
```

#### Generate a Lightning invoice
#### Generate a Lightning invoice

This command will return a Lightning invoice that you need to pay to mint new ecash tokens.

Expand Down Expand Up @@ -185,7 +185,7 @@ You can turn off Lightning support and mint as many tokens as you like by settin


# Running tests
To run the tests in this repository, first install the dev dependencies with
To run the tests in this repository, first install the dev dependencies with
```bash
poetry install --with dev
```
Expand Down
2 changes: 1 addition & 1 deletion cashu/tor/LICENCE_tor
Original file line number Diff line number Diff line change
Expand Up @@ -1606,4 +1606,4 @@ The externally maintained libraries used by Node.js are:
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""
"""
2 changes: 1 addition & 1 deletion mypy.ini
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ python_version = 3.9
ignore_missing_imports = True

[mypy-cashu.nostr.*]
ignore_errors = True
ignore_errors = True

0 comments on commit 1c47ef7

Please sign in to comment.