A Scala (Scorex 2) client for the Topl blockchain protocol
Clone or download

README.md

Project-Bifrost:
A Scala Client for the Topl Blockchain Protocol CircleCI

Project Bifrost is a Scala client designed over a cryptocurrency/blockchain protocol developed to achieve three specific goals:

  • Facilitate movement and investment of capital from investors in developed economies to businesses in developing economies
  • Create a commodity market that collateralizes a stable currency via storage and redemption
  • Develop a reputation system and historical reference of business behaviour

Begin interacting with the Topl network with the Bifrost client alpha testnet release

Whitepaper

The latest version of the Topl whitepaper can be found here.

Documentation

Topl protocol technical specification ("Yellow Paper") (in development)

Alpha testnet documentation

Installation

Check out our Installation Instructions

Testing

Go to the project directory

cd Project-Bifrost

Type

sbt test

NOTE: Using sbt to run tests using the Windows command line may error. Either use Intellij IDEA's test runner or run sbt in a Unix environment. Alternatively, if you have the Linux Subsystem for Windows enabled, you can just use bash.

Contributions

We appreciate your interest in this project and welcome contributions!

If you'd like to contribute to Project Bifrost, please fork, fix, commit and send a pull request so that we can review your code and merge it when it is complete. For more complex changes, please contact us via Gitter or Slack to ensure those changes are reasonable and/or get some early feedback to expedite the review and merge process.

Please read our Contributing Guide for more information before submitting any pull requests, as the submission of any content to Topl's repositories constitutes your understanding of and agreement to our Contributor License Agreement and Code of Conduct.

To keep up with our development

License

Project Bifrost is licensed under the Mozilla Public License 2.0 (MPL 2.0), also included in our repository in the LICENSE file.