Disclaimer: The author is NOT a cryptographer and this work has not been reviewed. This means that there is very likely a fatal flaw somewhere. Cashu is still experimental and not production-ready.
Don't be reckless: This project is in early development; it does, however, work with real sats! Always use amounts you don't mind losing.
This project is in active development; it has not gone through optimization and refactoring yet.
Cashu protocol mint focused on ease of use and feature completeness.
Please test in Mutinynet at: https://mutinynet.nutmix.cash
This is an alternative Cashu mint written in go. It's specifically just a mint with the objective to minimize the code and complexity.
The mint includes it's proper dashboard to manage administration and logs.
This project is thought to be able to be ran on a docker container or locally.
Here is what you need to know to change to run nutmix in docker: Most of the setup process will happen inside the Admin dashboard.
You'll need the correct variables in an .env
file first. Use the env.example file as reference.
-
You need to make sure to use a strong
POSTGRES_PASSWORD
and make user the username and password are the same in theDATABASE_URL
-
Add private key using the
MINT_PRIVATE_KEY
enviroment variable or pick connect to a remote signer. -
To login into the admin dashboard and change the rest of settings add your npub to
ADMIN_NOSTR_NPUB
enviroment variable.
The mint will stop and Print out what you are missing if you don't have this 4 Items setup.
In case you want to run the docker compose file using traefik and you also need to fill variables below HOSTING
for your domains.
If you have this correctly setup it should be as easy as running a simple docker command on linux:
docker compose up -d
Right now there are two remote signer implementations.
There is a new enviroment variable called SIGNER_TYPE
. If you want to use the remote signer you need to set the
options abstract_socket
or network
. This will then will look for the signer to connect. If you pick network you
will also need to set the NETWORK_SIGNER_ADDRESS
env variable.
The mint communicates with the remote signer using mTLS. You will need to set environment variables for signaling the routes for mTLS.
SIGNER_CLIENT_TLS_KEY=<route to file>
SIGNER_CLIENT_TLS_CERT=<route to file>
SIGNER_CA_CERT=<route to file>
- NUT-00 - Cryptography and Models
- NUT-01 - Mint public keys
- NUT-02 - Keysets and fees
- NUT-03 - Swapping tokens
- NUT-04 - Minting tokens
- NUT-05 - Melting tokens
- NUT-06 - Mint info
- NUT-07 - Token state check
- NUT-08 - Overpaid Lightning fees
- NUT-09 - Signature restore
- NUT-10 - Spending conditions
- NUT-11 - Pay-To-Pubkey (P2PK)
- NUT-12 - DLEQ proofs
- NUT-14 - Hashed Timelock Contracts (HTLCs)
- NUT-15 - Partial multi-path payments (MPP)
- NUT-17 - WebSocket subscriptions
- NUT-19 - Cached Responses
- NUT-20 - Signature on Mint Quote
- NUT-21 - Clear authentication
- NUT-22 - Blind authentication
Non official NUT:
If you want to develop for the project I personally run a hybrid setup. I run the mint locally and the db on docker.
I have a special development docker compose called: docker-compose-dev.yml
. This is for simpler development without having traefik in the middle.
- run the database in docker. Please check you have the necessary info in the
.env
file.
docker compose -f docker-compose-dev.yml up db
- Run the mint locally.
# build the project go run cmd/nutmix/*.go
protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative --experimental_allow_proto3_optional internal/gen/signer.proto
Pull requests and suggestions are always welcomed. The more people have eyes on this the better.
If you can donate monetarily it would be greatly appreciated. The funds would go to the development of the mint and servers for testing.
on-chain silent payments
sp1qq0fju879lh2rgvwjjd7e78pg4gnr7a8aumth8qlezdgjs2rwzk7ssq5jm7v27cuuk5dyjfurdy8t8jflkcx0sluwez350kjjd45y7nnx3vgmjqjq
Donate with lightning
Donate with on-chain
bc1qp7lswgftpgrkt00vszrm63dmkq3nuxjv60czk6
Donate with Monero
84yCRZY6BXebs8xWE6Yzj6S6cE17uLhkTSynneVPmejjWAcgBtnV7UEUiZqJNLE4pXaPmXNkJuhcAYbpu49zAdVsEZqqxac