mjhouse / rechain Goto Github PK

Description

Logger needs unit tests. Coveralls.io reports 100% coverage because it's used everywhere, but it isn't really being tested alone.

Description

The current linux/osx configure script needs to be moved into a <ROOT>/scripts/ directory and a new script that can configure an environment (with RECHAIN_HOME set etc.) for a manual build/testing needs to be created.

Might need one for windows as well.

Description

CPack can generate installers for Windows/OSX/Linux- it should be automated so that new installers are created every time the latest version tag changes. Probably need to set up VMs to do this and use a github webhook to pull the latest master commit.

CPack information

Description

Logger has an issue with level checking:

• output debug, info, warnings and errors if Level::debug
• output info, warnings, error if Level::info
• output warnings, error if Level::warning
• output error if Level::error
• and nothing if a Log is Level::none

Currently, it won't log warnings, error or debug if level is info.

Description

CMake is the most heavily supported cross-platform build automation system, so the build workflow is going to use it. This needs to be done before continuous integration on all platforms can happen.

Description

Test failures on windows builds:

===================================================
test cases: 14 | 8 passed | 6 failed
assertions: 134 | 115 passed | 19 failed
Command exited with code -1073741819

Full build output here: https://ci.appveyor.com/project/mjhouse/rechain

Description

Need to get builds working on Windows and then set up AppVeyor to run tests on commit.

Description

The blockchain holds publishing information for each document, but on top of this, ReChain needs to be able to distribute the published documents themselves to clients. This will be done through a torrent-based peer-to-peer network.

1. When a document is published, the published document will be copied to a temporary location in RECHAIN_HOME and ReChain will begin seeding.

2. A miner will accept the publish request, add it to the current mining operation, and torrent the document for reseeding when the block is mined.

3. Clients that request the published document will torrent it locally to view it, check the hash against the publishing record, and depending on their settings, begin to re-seed.

Tracking will be provided by a standalone mini-client (which hasn't been created yet) that should be host-able anywhere with almost no configuration, and will connect new clients with up-to-date seeders.

The tracking client will be in a different repo.

Possible libraries

• libtorrent

Description

Build the project on Windows, OSX and Linux. Currently, development is entirely on Linux, and the build process reflects that. This will probably involve switching from standard make to a build tool that is friendlier with other platforms, tweaking the code and finding a way to build unit tests for each platform.

Platforms

Linux

Nothing to see here. Unit tests already build on Ubuntu with travis-ci, make comes with Linux.

Windows

Possible build tools: CMake, build2, NMake
Unit tests: Appveyor

OSX

Possible build tools: CMake, build2, make
Unit tests: travis-ci

Description

Write a contribution guide that includes development setup, general application design ideas and some general guidelines (i.e. "don't use raw pointers unless absolutely necessary").

Start adding small issues that are tagged good-first-issue or up-for-grabs ().

Description

CLI is already in progress, but is tightly bound to the application. It needs to be abstracted enough that different interfaces (GUI specifically) can be plugged in without changing behavior. So a general interface will accept command line arguments and then launch either the CLI or the GUI to handle the given arguments.

This is going to be a large addition, so tests, cross-platform CLI and the p2p publishing system (#5) need to be implemented, stable and documented before the GUI can be written.

Possible cross-platform GUI/widget libraries

• Qt
• wxWidgets.

Description

Enums are scattered all over the project, and it's difficult to tell when they're available and when they aren't. They should be moved into a single header at inc/enums.hpp.

Description

Right now files that are hashed in order to publish records on the blockchain are read as strings. This needs to be changed to hash the file from binary so that the file type becomes irrelevant. This will allow any file type to be published on the blockchain.

Files

src/record.cpp