Skip to content

Latest commit

 

History

History
84 lines (54 loc) · 3.8 KB

README.md

File metadata and controls

84 lines (54 loc) · 3.8 KB
Raw

Armory

Created by Alan Reiner on 13 July, 2011

Forked by goatpig in February 2016

Armory is a full-featured Bitcoin client, offering a dozen innovative features not found in any other client software! Manage multiple wallets (deterministic and watching-only), print paper backups that work forever, import or sweep private keys, and keep your savings in a computer that never touches the internet, while still being able to manage incoming payments, and create outgoing payments with the help of a USB key.

Multi-signature transactions are accommodated under-the-hood about 80%, and will be completed and integrated into the UI soon.

Armory has no independent networking components built in. Instead, it relies on on the Satoshi client to securely connect to peers, validate blockchain data, and broadcast transactions for us. Although it was initially planned to cut the umbilical cord to the Satoshi client and implement independent networking, it has turned out to be an inconvenience worth having. Reimplementing all the networking code would be fraught with bugs, security holes, and possible blockchain forking. The reliance on Bitcoin Core right now is actually making Armory more secure!

Development

Unlike most open source projects, development takes place in the dev branch and only tagged releases are merged back into master.

Donations

Will post an address eventually for donations

Building Armory From Source

Instructions for Windows Instructions for macOS Instructions for Ubuntu and Arch Linux

Dependencies

  • GNU Compiler Collection
    Linux: Install package g++

  • Crypto++
    Linux: Install package libcrypto++-dev
    Windows: Download

  • SWIG
    Linux: Install package swig
    Windows: Download
    MSVS: Copy swigwin-2.x directory next to cryptopp as swigwin

  • Python 2.6/2.7
    Linux: Install package python-dev
    Windows: Download

  • Python Twisted -- asynchronous networking
    Linux: Install package python-twisted
    Windows: Download

  • PyQt 4 (for Python 2.X)
    Linux: Install packages libqtcore4, libqt4-dev, python-qt4, and pyqt4-dev-tools
    Windows: Download

  • qt4reactor.py -- combined eventloop for PyQt and Twisted
    All OS: Download

  • pywin32
    Windows Only: qt4reactor relies on pywin32 (for win32event module). Download

  • py2exe
    (OPTIONAL - if you want to make a standalone executable in Windows)
    Windows: Download

  • LMDB - database engine, modified to suit Armory's use cases LMDB page

  • macOS Instructions for downloading, verifying, and running Armory on macOS.

Sample Code

Armory contains over 25,000 lines of code, between the C++ and python libraries. This can be very confusing for someone unfamiliar with the code (you). Below I have attempted to illustrate the CONOPS (concept of operations) that the library was designed for, so you know how to use it in your own development activities. There is a TON of sample code in the following:

License

Distributed partially under the GNU Affero General Public License (AGPL v3)
and the MIT License See LICENSE file

Copyright

Copyright (C) 2011-2015, Armory Technologies, Inc.