Package: bchosttrust
BCHostTrust - Reference ImplementationThis repository is the reference implementation of BCHostTrust, a distributed database of domain name trustworthiness. It uses the concept ofblockchain, a growing list of records linked together viacryptographic hashes, in whichSHA3-256 is used in BCHostTrust. More detailed information can be found atdocuments/tech_paper/README.md.DISCLAIMER: DESPITE USING SIMILAR TECHNOLOGIES, THIS PROJECT IS NOT RELATED TO CRYPTOCURRENCY!InstallationTo use BCHostTrust, Python 3.11 is required.Via pipx (recommended for end users)In order to use the command-line tool, it is recommended to install it viapipx, which runs BCHostTrust in an dedicated virtual environment, isolating it from potential dependency problems. pipx is usually provided via your operating system's package repository, after installing it, run the following command:pipxensurepath# This ensures pipx is properly configuredpipxinstallbchosttrustAfter that, you can run the following command to verify if the installation is working properly:$bchtversionBCHostTrust Reference Implementation, version 0.0.0Via pip (recommended for application developers)To import BCHostTrust into your projects, install the package via pip after activating thevirtual environment:pipinstallbchosttrustAfter that, run the following in a Python console to verify the installation:>>>importbchosttrust>>>bchosttrust.__version__"0.0.0"Installing BCHostTrust directly user-wide or system-wide is discouraged as it may cause conflicts between versions or system packages.API UsageThe API of BCHostTrust is well-documented in their respectivedocstrings. Take a look before writing your code on top of BCHostTrust.All parameters passed into the functions are forced to follow thehinted type, thanks to the usage oftypeguard. You should run your code in debug mode (the default in most cases) to see if your code is violating any of the type hints. After that, you may run your well-tested code in optimized mode to avoid performance overheads.ContributionWe welcome all kinds of contributions to the BCHostTrust project. You may join in the following ways:Opening an issue.This can be either requesting for new features or reporting misbehaviors. By sending feedback to us, we can improve the protocol and the application.Submiting your codes.If you are keen on working on codes, you can submit your own by opening a pull request. By doing so, the codebase can be improved collectively.Recommended develpoment setupIt is recommended to have the following before starting your journey in development:Visual Studio Code, an highly customizable code editor with built-in git integration and a broad of extensions.Pylint, astatic code analyzerthat can detect more potential errors and mistakes than other analyzers. It can be integrated into VSCode by thePylint extension.autopep8, an extension of VSCode automatically formats your code to fit the standard as specified inPEP 8. It should be configured properly in accordance with its documentation.To start, create your own fork to work on. Refer toGitHub's documentationfor how to operate with forks.After that, clone the repository to your local machine:# Using SSHgitclonessh://git@github.com/[yourusername]/bchosttrust# Using GitHub CLIghrepoclone[yourusername]/bchosttrustAfter that, create an virtual environment and install BCHostTrust indevelopment mode:# Go into BCHostTrust directorycdbchosttrust# Create and activate a virtual environmentpython-mvenv.venvsource.venv/bin/activate# or .venv\Scripts\activate on Windows# Install BCHostTrust in develpoment modepipinstall--editable.Done! Now you can work on BCHostTrust. Don't forget to push your changes to your fork and file a pull request.RoadmapPrototypeBlockchain CoreBasic Proof-of-work MechanismChain Search and AnalysisCommand-line clientConfiguration file for command-lineBlock exchange protocolBrowser integration (probably in dedicated repository)