Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blinklabs-io/bluefin
A Fortuna (TUNA) miner, written in Go
https://github.com/blinklabs-io/bluefin
blockchain cardano go golang proof-of-work
Last synced: 23 days ago
JSON representation
A Fortuna (TUNA) miner, written in Go
- Host: GitHub
- URL: https://github.com/blinklabs-io/bluefin
- Owner: blinklabs-io
- License: apache-2.0
- Created: 2023-08-27T21:06:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-17T18:25:35.000Z (about 1 month ago)
- Last Synced: 2024-11-17T19:27:52.128Z (about 1 month ago)
- Topics: blockchain, cardano, go, golang, proof-of-work
- Language: Go
- Homepage:
- Size: 541 KB
- Stars: 16
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# bluefin
A $TUNA miner, written in Go
## Running the miner
Bluefin is self-contained and runs with no external dependencies. You can run it via
the [Docker images](https://ghcr.io/blinklabs-io/bluefin) or binaries from the
[releases page](https://github.com/blinklabs-io/bluefin/releases).
Bluefin is designed to take its configuration from environment variables. All examples below
show running the bluefin binary directly from the shell and will need to be adapted for use
with Docker.
When run with no configuration, bluefin defaults to mining TUNA v1 on `mainnet`. It will generate a new
wallet and write the seed phrase to the `seed.txt` file in the current directory.
```
$ ./bluefin
...
{"level":"info","timestamp":"2024-07-04T20:13:53-05:00","caller":"wallet/wallet.go:62","msg":"wrote generated mnemonic to seed.txt"}
{"level":"info","timestamp":"2024-07-04T20:13:53-05:00","caller":"bluefin/main.go:73","msg":"loaded mnemonic for address: addr1..."}
{"level":"info","timestamp":"2024-07-04T20:13:53-05:00","caller":"bluefin/main.go:79","msg":"starting indexer on mainnet"}
```
You can use the `NETWORK` and `PROFILE` environment variables to change the mode that bluefin operates in.
For example, to mine TUNA v2 on `preview`:
```
$ NETWORK=preview PROFILE=tuna-v2 ./bluefin
```
If you want to provide your own wallet seed phrase, you can set the `MNEMONIC` environment variable or create the `seed.txt` file before
running bluefin.
### Seeding the wallet
If allowing bluefin to generate a new wallet, you will need to seed the wallet with some initial funds using the wallet address
logged at startup. If the wallet already exists, you may need to send funds back to your own wallet so that they're visible to bluefin.
The wallet will need at least 2 available UTxOs, one to cover TX fees, and another of at least 5 (t)ADA to use as collateral.
### Submitting TXs
By default, bluefin will use the NtN (node-to-node) TxSubmission protocol to submit transactions directly to the Cardano network.
This method has the downside of not providing any feedback if a transaction fails. You can use the `SUBMIT_URL` environment variable
to specify the URL for a submit API to use instead, which will provide feedback about any transaction validation issues.
### Clearing the local data
Bluefin stores its local data in `.bluefin/` in the current directory. If you run into a problem that requires clearing the data, you can
delete this data and bluefin will re-sync from scratch.
## Development / Building
This requires Go 1.19 or better is installed. You also need `make`.
```bash
# Build
make
# Run
./bluefin
```
You can also run the code without building a binary, first
```bash
go run ./cmd/bluefin
```
## WE WANT YOU!!!
We're looking for people to join this project and help get it off the ground.
Discussion is on Discord at https://discord.gg/5fPRZnX4qW