diff --git a/README.md b/README.md index 87d20e1..126f1f0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # cashu +**The author is NOT a cryptographer and has not tested the libraries used or the code nor has anyone reviewed the work. This means it's very likely a fatal flaw somewhere. This is meant only as educational and is not production ready.** + +Ecash implementation based on David Wagner's variant of Chaumian blinding. Token logic based on [minicash](https://github.com/phyro/minicash) ([description](https://gist.github.com/phyro/935badc682057f418842c72961cf096c)) which implements a [Blind Diffie-Hellman Key Exchange](https://gist.github.com/RubenSomsen/be7a4760dd4596d06963d67baf140406) protocol written down by Ruben Somsen. + ## Install ```bash @@ -9,17 +13,17 @@ sudo apt install -y build-essential pkg-config libffi-dev libpq-dev zlib1g-dev l # install python using pyenv curl https://pyenv.run | bash -echo export PYENV_ROOT="$HOME/.pyenv" >> .bashrc -echo command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH" >> .bashrc -echo eval "$(pyenv init -)" >> .bashrc -echo eval "$(pyenv virtualenv-init -)" >> .bashrc -source .bashrc +echo export PYENV_ROOT="$HOME/.pyenv" >> ~/.bashrc +echo command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH" >> ~/.bashrc +echo eval "$(pyenv init -)" >> ~/.bashrc +echo eval "$(pyenv virtualenv-init -)" >> ~/.bashrc +source ~/.bashrc pyenv install 3.9.13 # install poetry curl -sSL https://install.python-poetry.org | python3 - -echo export PATH="$HOME/.local/bin:$PATH" >> .bashrc -source .bashrc +echo export PATH="$HOME/.local/bin:$PATH" >> ~/.bashrc +source ~/.bashrc # install cashu cd cashu