Masterchest wallet user_doco_initial_draft
0 likes181 views
This document provides documentation on using the Masterchest Wallet software, including: - It requires .NET Framework 4.0 and a Bitcoin client with transaction indexing enabled. - Users can view balances of supported currencies like Mastercoin and send currencies to other addresses. The wallet interfaces with the local Bitcoin client. - Additional features include a currency exchange, transaction history, and syncing with the blockchain to detect user balances and transactions.
Masterchest wallet user_doco_initial_draft
- 1. Masterchest Wallet User Documentation Second Zathras Feb/2014 Masterchest Wallet User Documentation Second Initial Draft Zathras Feb/2014
- 2. DISCLAIMER This software is pre-release software for testing only. The protocol and transaction processing rules for the Master Protocol are still under active development and are subject to change in future. DO NOT USE IT WITH A LARGE AMOUNT OF MASTERCOINS AND/OR BITCOINS. IT IS ENTIRELY POSSIBLE YOU MAY LOSE ALL YOUR COINS. INFORMATION DISPLAYED MAY BE INCORRECT. A fraction of a bitcoin and a fraction of a mastercoin are the suggested testing amounts. Preferably use a fresh bitcoin wallet.dat. MASTERCHEST OFFERS ABSOLUTELY NO GUARANTEES OF ANY KIND. This software is provided open-source at no cost. You are responsible for knowing the law in your country and determining if your use of this software contravenes any local laws. DEPENDENCIES Masterchest Wallet requires that the following dependencies are met: • .NET Framework 4.0 installed • Bitcoin reference client installed • Bitcoin reference client transaction index enabled INSTALLATION Installation is as simple as extracting the compressed wallet download into a folder of your choosing. An installation package will be available soon. The wallet features auto-detection for configuration so usually no setup will be required, you may simply launch the wallet by running the executable 'Masterchest_Wallet.exe'. NOTE: The transaction index is disabled by default in versions 0.8 and above of the Bitcoin reference client. You may re-enable by closing the reference client, adding the line: txindex=1 to bitcoin.conf and then restarting the reference client with the -reindex flag. It may take some time to rebuild the transaction index and progress can be checked with the 'getinfo' call (you should see 'blocks' increasing). You only need to reindex once and the -reindex flag is not needed on subsequent launches of the reference client. NOTE: If you have customized your bitcoin installation (for example by using the --datadir flag to change the location of your bitcoin configuration and database) you may need to specify your configuration manually. To do so simply change the four values in wallet.cfg from empty to your chosen bitcoin RPC server configuration.
- 3. USAGE - OVERVIEW When launching the wallet, it will first perform some sanity checks such as making sure it can talk to your bitcoin installation (and verifying you have a transaction index) and checking the wallet database is accessible. Providing these tests are passed you should be presented with an overview panel as follows: The wallet will now use your bitcoin installation to scan the blockchain for Master Protocol messages. You may check the status of synchronization using the debug panel. Once synchronization is complete (note on first run this may take a number of hours depending on the speed of your hardware) the network status label will show 'Synchronized' and you should see an overview of your Mastercoin balance displayed. Your addresses are retrieved from your bitcoin installation, and any that have participated in Master Protocol transactions and/or hold a Mastercoin balance will automatically become available in the wallet interface. NOTE: Transaction processing occurs following completion of blockchain scanning. Therefore you will only see your balances once synchronization has completed.
- 4. USAGE - CURRENCIES The currencies panel provides a total of your balances for each currency supported by the wallet. It can be used to easily determine your summary position. USAGE - ADDRESSES The addresses panel provides a list of the addresses retrieved from your bitcoin installation and their respective balances. By default addresses with empty balances are filtered.
- 5. USAGE - SEND The send panel allows you to transact any currency supported by the wallet by sending it to your chosen recipient. Simply select your sending address from the list on the left and enter (or paste) the recipient address into the right hand box. Select the currency and enter the amount you wish to send - the available amount of your chosen currency at the sending address is displayed for your convenience. Once you are happy your transaction details are correct (it's always best to check twice!) you may click the 'Send' button. You will be prompted for your bitcoin wallet passphrase and once entered, the wallet will create, sign & broadcast your Master Protocol transaction using your bitcoin installation. You should then be presented with information about your transaction including the transaction ID. You may use this transaction ID to verify your transaction on any of the various Master Protocol implementations available on the web.
- 6. USAGE - HISTORY The history panel provides a view of your previous transactions. These do not necessarily have to be transactions conducted by the wallet - any transactions conducted by addresses detected in your bitcoin installation will be displayed.
- 7. USAGE - EXCHANGE The exchange panel provides a way to buy and sell currency in a trust-less fashion directly from the wallet. NOTE: Current builds support exchanging Test Mastercoins and Bitcoins only. TO SELL CURRENCY: Create a sell offer by clicking the 'sell' button. Select the address holding the currency you wish to sell, then choose your sell parameters such as the amount and unit price. The total price will be calculated automatically. When you are sure you have entered the correct details, click the 'Sell' button. A Master Protocol message will be broadcast using your bitcoin client to advertise your sell offer on the network. The wallet will then synchronize and you should see your sell in a pending state in your open order list. Once the sell has been confirmed in the blockchain the status will change to 'open' and potential buyers may transact with your sell offer. To cancel a sell in the 'open' state simply right click on the sell and choose 'Cancel'.
- 8. TO BUY CURRENCY: Select any of the available sell offers and click the 'Buy' button. Choose your buying address and the amount you wish to purchase. When you are sure you have entered the correct details, click the 'buy' button. A Master Protocol message will be broadcast accepting your selected amount of currency. The wallet will then synchronize and you should see your buy accept in a pending state in your open order list. Once the accept has been confirmed in the blockchain the status will change to 'unpaid' and you may now proceed to payment. To submit payment for a buy in the 'unpaid' state simply right click on the sell and choose 'Send Payment'. Verify the details to be sure before sending the payment. The buy will re-enter a pending state and once your payment has been confirmed the buy will be completed. To cancel a buy in the unpaid state simply allow it to expire without payment.
- 9. USAGE - CONTRACTS This panel is disabled in current builds.