README.md

Noir

What is Noir?

Noir is the implementation of the Sigma Protocol guaranteeing true financial anonymity.

• 2.5 minute block target
• No hardcap
• 2.2 coins per block as subsidy

For more information, as well as an immediately useable, binary version of the noir client sofware, see https://github.com/noirofficial/noir/releases.

License

Noir is released under the terms of the MIT license. See COPYING for more information or see http://opensource.org/licenses/MIT.

Development process

Developers work in their own trees, then submit pull requests when they think their feature or bug fix is ready.

If it is a simple/trivial/non-controversial change, then one of the Noir development team members simply pulls it.

If it is a more complicated or potentially controversial change, then the patch submitter will be asked to start a discussion (if they haven't already) on the Discord.

The patch will be accepted if there is broad consensus that it is a good thing. Developers should expect to rework and resubmit patches if the code doesn't match the project's coding conventions (see doc/coding.txt) or are controversial.

The master branch is regularly built and tested, but is not guaranteed to be completely stable. Tags are created regularly to indicate new official, stable release versions of Noir.

Linux Build Instructions and Notes

Dependencies

1. Update packages

   sudo apt-get update
   

2. Install required packagages

   sudo apt-get install build-essential libtool autotools-dev automake pkg-config libssl-dev libevent-dev bsdmainutils libboost-all-dev
   

3. Install Berkeley DB 4.8

   sudo apt-get install software-properties-common
   sudo add-apt-repository ppa:bitcoin/bitcoin
   sudo apt-get update
   sudo apt-get install libdb4.8-dev libdb4.8++-dev
   

4. Install QT 5

   sudo apt-get install libminiupnpc-dev libzmq3-dev
   sudo apt-get install libqt5gui5 libqt5core5a libqt5dbus5 qttools5-dev qttools5-dev-tools libprotobuf-dev protobuf-compiler libqrencode-dev
   

Build

1. Clone the source:

   git clone https://github.com/noirofficial/noir
   

2. Build Noir-core:

   Configure and build the headless noir binaries as well as the GUI (if Qt is found).

   You can disable the GUI build by passing --without-gui to configure.

   ./autogen.sh
   ./configure
   make
   

3. It is recommended to build and run the unit tests:

   make check
   

Mac OS X Build Instructions and Notes

See doc/build-osx.md for instructions on building on Mac OS X.

Windows (64/32 bit) Build Instructions and Notes

See doc/build-windows.md for instructions on building on Windows 64/32 bit.

Copyright

Copyright (c) 2016-2019 Noir Developers Copyright (c) 2016 Zcoin Developers Copyright (c) 2013-2015 Bitcoin Developers