FiberCrypto wallet is a cryptocurrency software wallet aimed at:
Project files are organized as follows:
main.go
: Application entry pointCHANGELOG.md
: Project changelogMakefile
: Project build rulesREADME.md
: This file.*.qrc
: QML resource index files.qtquickcontrols2.conf
: QT Quick controls configuration file../resources
: Static resources../resources/images
: Graphics resources needed by the application../resources/images/icons
: Project and third-party icons./resources/fonts
: Font files needed to compile the application../src
: Application source code../src/ui
: QML definitions for application GUI components../src/ui/Dialogs
: QML definitions for reusable dialogs../src/ui/Delegates
: QML specs for partial views../src/core
: Core go-lang interfaces../src/main
: Project specific source code../src/util
: Reusable code../src/util/logging
: Event logging infrastructure../src/models
: QT models linking coin-specific models to application GUI../src/coin
: Source code for altcoin integrations../src/coin/mocks
: Types implementing core
interfaces for generic testing scenarios./src/coin/skycoin
: Skycoin wallet integration./src/coin/skycoin/models
: Skycoin implementation of golang core interfaces../src/coin/skycoin/blockchain
: Skycoin blockchain API../src/coin/skycoin/sign
: Skycoin sign API../vendor
: Project dependencies managed by dep
.FiberCrypto wallet supports multiple altcoins. In order to cope with this complexity GUI code and QT models rely on strict interfaces which shall be implemented to add support for a given coin. Each such integration must have two main components:
Models API
: Implements application core interfaces.Sign API
: Implements altcoin transaction and message signing primitives required by application code.Blockchain API
: Provides communication between application and altcoin service nodes to query for data via REST, JSON-RPC and other similar low-level client-server API.Peer-exchange API
(optional): Implements peer-to-peer interactions with altcoin blockchain nodes.The build system is Qt framework. The front-end is programmed in QML, and the back-end in Go, using therecipe/qt.
Windows requires the command line tool magick convert
, that comes with the open-source ImageMagick project in order to build the icons (not necessary as default icons are always provided)
Linux/X11 requirements
MacOS requirements
Windows requirements
The minimum Qt version required is Qt 5.12.0 LTS. However, is highly recommended using Qt 5.12.1 LTS or any later version of Qt5 due to some bugs:
We always recommend using the latest Qt version. See Qt Archive.
Common actions are automated with the help of make
. The following targets have been implemnented:
deps Add dependencies
run Run FiberCrypto Wallet.
install-deps-no-envs Install therecipe/qt with -tags=no_env set
install-docker-deps Install docker images for project compilation using docker
install-deps-Linux Install Linux dependencies
install-deps-Darwin Install osx dependencies
install-deps-Windows Install Windowns dependencies
install-deps Install dependencies
build-docker Build project using docker
build-icon-Windows_NT Build the application icon in Windows
build-icon-Darwin Build the application icon in Darwin
build-icon-Linux Build the application icon in Linux
build-icon Build the application icon (Windows_NT and Darwin systems)
build Build FiberCrypto Wallet
prepare-release Change the resources in the app and prepare to release the app
clean-test Remove temporary test files
clean-build Remove temporary files
clean Remove temporary files
gen-mocks-core Generate mocks for core interface types
gen-mocks-sky Generate mocks for internal Skycoin types
gen-mocks Generate mocks for interface types
test-sky Run Skycoin plugin test suite
test-core Run tests for API core and helpers
test-data Run tests for data package
test-cover Show more details of test coverage
test Run project test suite
run-docker Run CMD inside Docker container
install-linters Install linters
install-coveralls Install coveralls
lint Run linters. Use make install-linters first.
Type make help
in your console for details.
master
branch has commits that are not in develop
(e.g. due to a hotfix applied to master
), merge master
into develop
CHANGELOG.md
: move the "unreleased" changes to the version and add the datedevelop
develop
into master
master
branch with the version number. Version tags start with v
, e.g. v0.1.0
.
Sign the tag. If you have your GPG key in github, creating a release on the Github website will automatically tag the release.
It can be tagged from the command line with git tag -as v0.20.0 $COMMIT_ID
, but Github will not recognize it as a "release".master
branchmaster
branch and follow the create release builds instructions.If there are problems discovered after merging to master
, start over, and increment the 3rd version number.
For example, v0.1.0
becomes v0.1.1
, for minor fixes.
Performs these actions before releasing:
make test-sky
Run Skycoin plugin test suitemake test-core
Run tests for API core and helpersmake test-data
Run tests for data packagemake test-cover
Show more details of test coveragemake test
Run project test suiteTravis should build Linux and MacOS builds and upload to github releases
If you do it manually, you must follow the next steps:
make prepare-release
Change the resources in the app and prepare to release the appmake clean
Remove temporary filesmake build
Build FiberCrypto Walletdeploy
folder and inside that folder This is a Work-In-Progress.