Metadata-Version: 1.1
Name: multicrypto
Version: 0.1.8
Summary: Tool for translating and creating custom addresses for various cryptocurrencies
Home-page: https://github.com/tompin/multicrypto
Author: tompin
Author-email: tompin@tuta.io
License: http://opensource.org/licenses/MIT
Description: # README
        
        [![Build Status](https://travis-ci.org/tompin/multicrypto.svg?branch=master)](https://travis-ci.org/tompin/multicrypto)
        [![Coverage Status](https://coveralls.io/repos/github/tompin/multicrypto/badge.svg?branch=master)](https://coveralls.io/github/tompin/multicrypto?branch=master)
        [![Latest Version](https://pypip.in/version/multicrypto/badge.svg)](https://pypi.python.org/pypi/multicrypto/)
        [![Python Version](https://img.shields.io/pypi/pyversions/multicrypto.svg)](https://www.python.org/)
        [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
        
        Experimental Tool for sending funds (for now only P2PKH transaction type is supported), creating custom look 
        addresses and translating addresses and private keys between various cryptocurrencies.
        
        Address translation produce address for different coin, which will have the same private key as
        translated address. Of course private key is not needed or revealed during translation.
        
        Creating address gives us possibility to generate private key and corresponding address with
        specified prefix.
        
        ## INSTALLATION
        
        If you don't have Python 3 install it by following instructions from python.org. 
        Supported Python versions are 3.5, 3.6, 3.7. Then Run:
        ```bash
        pip3 install multicrypto
        ```
        The package contains four commands `sendcrypto`, `transaddress`, `transprivkey`, `genaddress`
        described below.
        ### Additional packages on Ubuntu
        ```bash
        sudo apt-get install build-essential python3-dev libgmp3-dev
        ```
        ## USAGE
        
        ### Run
        
         1. Combining many small inputs to larger ones.
         ```bash
         sweepaddress --coin_symbol=<COIN_SYMBOL> --address=<ADDRESS> --private_key=<PRIVATE KEY> --minimum_input_threshold=<INT> --maximum_input_threshold=<INT>
         ```
         After mining some currency for longer period we could end up with address having a lot of small inputs. 
         In such case it is very likely it will be not possible to send the funds in one transaction and it could
          be difficult to cope with. Let say for Zen Cash we have private key of the address which inputs 
          we want to combine, but we want only combine inputs which are smaller than 0.1 ZEN:
          ```bash
         sweepaddress -c ZEN --private_key --maximum_input_threshold==10000000
         ```
         This will create appropriate number of transactions (by default one transaction for each 200 inputs, you can 
         override this value by setting parameter --batch_size, but setting it to high will result in too big transaction error),
         transaction fee will be set to default 0.00001 ZEN (you can override it using --fee parameter) and the
         funds will be sent back to original address (you can override the output address using --address parameter) 
        
         2. Sending funds (P2PKH):
         ```bash
         sendcrypto --coin_symbol=<COIN_SYMBOL> --satoshis=<INT> --address=<ADDRESS> --private_key=<PRIVATE KEY> --minimum_input_threshold=<INT> --maximum_input_threshold=<INT>
         ```
         Sending 0.25 BTC to address 1BTC1NNjeiAmFqe2n1QJjkEa4aMyAhkpKG with default fee 10000 satoshis
         and only using inputs containing not more than 100000 satoshis:
         ```bash
         sendcrypto -c BTC -s 25000000 -x 100000 -a 1BTC1NNjeiAmFqe2n1QJjkEa4aMyAhkpKG -p KwDiDMtpksBAcfyHsVS5XzmirtyjKWSeaeM9U1QppugixMUeKMqp
         ```
         3. Listing address inputs with total amount:
         ```bash
         checkaddress --coin_symbol=<COIN_SYMBOL> --address=<ADDRESS> --minimum_input_threshold=<INT> --maximum_input_threshold=<INT>
         ``` 
         For example:
         ```bash
         checkaddress -c BTC -a 14YK4mzJGo5NKkNnmVJeuEAQftLt795Gec
         ```
         4. Translating address between coins:
          ```bash
          transaddress --address=<ADDRESS> --input_symbol=<COIN SYMBOL> --output_symbol=<COIN SYMBOL>
          ```
          For example to translate Bitcoin address 1BTC1NNjeiAmFqe2n1QJjkEa4aMyAhkpKG to Hush address we enter:
          ```bash
          transaddress -a 1BTC1NNjeiAmFqe2n1QJjkEa4aMyAhkpKG -i BTC -o HUSH
          ```
         5. Translating private key in wif format between coins
          ```bash
          transprivkey --private_key=<PRIVATE_KEY> --output_symbol=<COIN SYMBOL>
          ```
          For example to translate Bitcoin private key KwDiDMtpksBAcfyHsVS5XzmirtyjKWSeaeM9U1QppugixMUeKMqp
           to Hush private key we enter:
          ```bash
          transprivkey -p KwDiDMtpksBAcfyHsVS5XzmirtyjKWSeaeM9U1QppugixMUeKMqp -o HUSH
          ```
         6. Generating address with given pattern and corresponding private key:
          ```bash
         genaddress --pattern=<PATTERN> --symbol=<COIN SYMBOL>
         ```
         For example for Hush coin and prefix t1aaaa we enter:
          ```bash
         genaddress -p t1aaaa -s Hush
         ```
         For Bitcoin segwit address we put:
         ```bash
         genaddress -p 3BTC -s BTC -w
         ```
        ### Import
        Created private key should be imported using bitcoin-cli program 
        or corresponding tool (importing in Qt wallet doesn't always work)
        ```bash
          bitcoin-cli importprivkey <GENERATED_PRIV_KEY>
        ```
        To verify the key was imported successfully:
        ```bash
         bitcoin-cli dumpprivkey <GENERATED_ADDRESS>
        ```
        
        ### Supported coins
        * Bitcoin (BTC)
        * Bitcoin Gold (BTG)
        * Bitcoin Hush (BTCH)
        * Bitcoin Private (BTCP)
        * BitcoinZ (BTCZ)
        * Bitstar (BITS)
        * Buck (BUCK)
        * Crave (CRAVE)
        * Dash (DASH)
        * Diamond (DMD)
        * Dogecoin (DOGE)
        * Elite (1337)
        * Hush (HUSH)
        * Komodo (KMD)
        * Litecoin (LTC)
        * Mooncoin (MOON)
        * Qtum (QTUM)
        * Safecoin (SAFE)
        * Snow Gem (SNG)
        * Sirius (SIRX)
        * Smartcash (SMART)
        * Unify (UNIFY)
        * Unobtanium (UNO)
        * Vertcoin (VTC)
        * Zcash (ZEC)
        * Zclassic (ZCL)
        * Zeitcoin (ZEIT)
        * ZenCash (ZEN)
        * Zero (ZERO)
        * Zoin (ZOIN)
        
        If you find this tool useful please donate to BTC address: 1BTC1NNjeiAmFqe2n1QJjkEa4aMyAhkpKG
        
        ## Tests
        Install pytest ,pytest-cov and tox packages:
        ```bash
         pip3 install -r requirements_dev.txt
        ```
        Run tests and check report htmlcov/index.html:
        ```bash
         python3 -m pytest --cov=./ --cov-report=html
        ```
        To run tests on various python versions run:
        ```bash
        tox
        ```
        
        ## Adding new coin
        1. Add new entry in `settings.py`. Prefix bytes are usually defined in chainparams.cpp or 
        base58.h files.
         Exemplary for Zen we have:
        ```bash
        'ZEN': {'name': 'zen cash', 'address_prefix_bytes': b'\x20\x89', 'secret_prefix_bytes': b'\x80'}
        ```
        2. Update this readme with new supported coin
        3. Create pull request
        
Keywords: cryptocurrency,address,transaction
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
