Skip to main content

A mining client for Fiducia blockchain

Project description

Fiducia Mining Client

A Python package for mining Fiducia blockchain.

Installation

From PyPI

pip install fiducia-miner

From Source

git clone https://github.com/yourusername/fiducia-miner.git
cd fiducia-miner
pip install -e .

Requirements

  • Python 3.6+
  • Git
  • Internet connection

Quick Start

After installation, you can run the miner using the command:

fiducia-miner --repo-url https://github.com/username/fiducia.git --miner-address YOUR_WALLET_ADDRESS

Usage

usage: fiducia-miner [-h] --repo-url REPO_URL --miner-address MINER_ADDRESS
                     [--db DB] [--p2p-port P2P_PORT] [--api-port API_PORT]
                     [--connect-to CONNECT_TO] [--mining-threads MINING_THREADS]
                     [--clean]

Fiducia Blockchain Mining Client

options:
  -h, --help            show this help message and exit
  --repo-url REPO_URL   URL of the Fiducia repository
  --miner-address MINER_ADDRESS
                        Address to receive mining rewards
  --db DB               Database filename (default: mining.db)
  --p2p-port P2P_PORT   P2P port (default: 8333)
  --api-port API_PORT   API port (default: 8545)
  --connect-to CONNECT_TO
                        Connect to an existing node (format: host:port)
  --mining-threads MINING_THREADS
                        Number of mining threads
  --clean               Clean existing installation before setup

Features

  • Automatically clones the Fiducia repository
  • Sets up the environment with all required dependencies
  • Configures and starts a mining node
  • Handles clean shutdowns when interrupted
  • Dashboard access via web browser
  • Connect to existing nodes or run standalone

Examples

Basic Mining

fiducia-miner --repo-url https://github.com/username/fiducia.git --miner-address 1A2B3C4D5E6F7G8H9I0J

Mine with Custom Settings

fiducia-miner --repo-url https://github.com/username/fiducia.git \
            --miner-address 1A2B3C4D5E6F7G8H9I0J \
            --db custom_blockchain.db \
            --p2p-port 9000 \
            --api-port 9001 \
            --mining-threads 4

Connect to Existing Node

fiducia-miner --repo-url https://github.com/username/fiducia.git \
            --miner-address 1A2B3C4D5E6F7G8H9I0J \
            --connect-to 192.168.1.100:8333

Clean Installation

fiducia-miner --repo-url https://github.com/username/fiducia.git \
            --miner-address 1A2B3C4D5E6F7G8H9I0J \
            --clean

Dashboard Access

Once the miner is running, access the dashboard at:

http://localhost:8545/dashboard

(Or whichever API port you specified with --api-port)

Notes

  • All mining rewards will be sent to the address specified with --miner-address
  • The miner runs in the foreground by default; use Ctrl+C to stop
  • To run in the background, consider using tools like nohup, screen, or tmux

Development

To develop on this package:

git clone https://github.com/yourusername/fiducia-miner.git
cd fiducia-miner
pip install -e .

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fiducia-miner-0.1.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fiducia_miner-0.1.0-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file fiducia-miner-0.1.0.tar.gz.

File metadata

  • Download URL: fiducia-miner-0.1.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.6

File hashes

Hashes for fiducia-miner-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d53faeb2ec4fc3893ae7a15120eae297f1609fdc143b1d03c374cb66e0cdcfb4
MD5 a3b6e85bc134f44d80a5798c4c8fcce2
BLAKE2b-256 a4571643b15e2ff48260a2e33032a1627362308b7c9ca9fdb3395ae8e7734cd7

See more details on using hashes here.

File details

Details for the file fiducia_miner-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: fiducia_miner-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.6

File hashes

Hashes for fiducia_miner-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a34937ada1e4e058531a7f11cb44b420200faec966459558be4e2c7a56a11e32
MD5 200ecbff86e2d2f21faac5c91fb0253e
BLAKE2b-256 535ec03c74105de2c1871861b695b3acb9d2495ad30f8cdeca5a03080a7433a0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page