Mastercoin Web Wallet Design

High-level design overview

Our end goal is to provide Mastercoin users with a client-side encrypted web-wallet to store funds and make/view Class A/B transactions. To that end our plan is to leverage My-Wallet as a source of truth in building a browser client-side implementation of the Mastercoin web-wallet. We would additionally like to include a Mastercoin block-explorer on the website, so users can view A/B transactions on the Masterchain with extensions for user-currency block-exploration.

Stage 1 Features

• Nest existing masterchain.info website code in npm/grunt-based install & run framework.
• Allow users to check balances.
• Allow users to send funds provided the appropriate private keys are stored on their local machine.
• Show the status of sell offers outstanding.
• Show available sell offers from others
• client-side private key import/export
• Client-side AES wallet encryption

Stage 2 Features

• Web wallet in a box, ready to deploy MSC web wallet.
• Extend Block-Explorer such that all MSC user-derived currencies can be displayed.
• export wallet file
• import bitcoin-qt wallets

Stage 3 Features

• Message signing and taint analysis
• Double encryption, encrypted serverside backups
• Allow users to create an account and associate bitcoin addresses with that account.
• Payment notifications
• Paper wallets
• Offline transactions

Stage 4 Features

• Marking addresses as 'savings' accounts (tx type=10)
• Add API support for currency creation (tx type 100)
• Heroku & Docker buildpacks for automatic deployments. See http://blog.docker.io/2013/05/heroku-buildpacks-on-docker/#more-79

Design Notes

• Crypto provided by https://github.com/bitcoinjs/bitcoinjs-lib
• BTC Webwallet base provided by https://github.com/blockchain/My-Wallet with API Docs @ https://blockchain.info/api
• MSC Block-Explorer base provided by https://github.com/grazcoin/mastercoin-tools/

More Specific Design (Living Document)

Endpoints

Mastercoin Explorer API

GET /transactions Get all available transaction types for this system.

GET /transactions/:id Retrieve transaction information for transaction 'id'

POST /create/:tx_type Create a new transaction of type 'tx_type'

Wallet API

/wallet/:id/send Simple send transaction.

/wallet/:id/balance Get MSC balance.

Common API

GET /mastercoin_verify/addresses?currency_id=#currency_id# You supply this URL a currency_id, initially 1 or 2, and it should return an JSON array of objects with two keys: address and balance.

GET /mastercoin_verify/transactions/#address#?currency_id=#currency_id# This URL takes an address and currency_id as arguments and should return an JSON object with an address and a transactions key for this given address.