Blockchains Module
Please note that it is BitcoinJS-Lib that makes most of these functions possible.
The framework currently supports the following blockchains (and their corrresponding testnets):
| Blockchain | Homepage | Active Chain Code | Test-Net Code |
|---|---|---|---|
| Bitecoin | http://bitcoin.org | btc | btct |
| Litecoin | http://litecoin.org | ltc | ltct |
| Dogecoin | http://dogecoin.com | doge | doget |
| Dash | http://dashpay.io | dash | dasht |
Blockchains Functions & Variables
The Blockchains Module features the following functions:
$.fn.blockstrap.blockchains.check(input)$.fn.blockstrap.blockchains.key(code)$.fn.blockstrap.blockchains.keys(secret, blockchain)$.fn.blockstrap.blockchains.raw(return_to, privkey, inputs, outputs, this_fee, amount_to_send)$.fn.blockstrap.blockchains.send(to_address, to_amount, from_address, keys, callback, blockchain)$.fn.blockstrap.blockchains.validate(address)$.fn.blockstrap.blockchains.which(address)
blockchains.check(input) - back to top
This function will return the first character of a validated address.
blockchains.key(code) - back to top
This function will return the BitcoinJS-Lib formatted blockchain code if provided with the Blockstrap blockchain code.
For example, btc becomes bitcoin and doget becomes dogecointestnet.
blockchains.keys(secret, blockchain) - back to top
This function takes the secret seed and blockchain and returns an object containing the public and private keys generated from the secret.
Please note that by default, Blockstrap DOES NOT store the private keys anywhere.
blockchains.raw(return_to, privkey, inputs, outputs, this_fee, amount_to_send) - back to top
This function returns a raw transaction Hex-string that can then be relayed.
It already requires you to have the inputs and outputs properly formed. The return_to variable is the change address that should be used to send-back the left-over inputs. You need to set the amount_to_send (as an integer) as well as the preferred mining fee by using this_fee.
blockchains.send(to_address, to_amount, from_address, keys, callback, blockchain) - back to top
This function is used to construct a raw transaction and then relay it. Basic settings such as who to send the coins to with to_address, or how much to send with to_amount and blockchain are clear enough. The from_address will be used as the returning change address. The keys should be a key object as returned by blockchains.keys, which contains both the public and private keys. Before proceeding, we first check locally to see if the account belongs to this user and it has the necessary balance required to perform the transaction. If it does, the public key is used in reference to an api.unspents call, the results from which are then used to construct the necessary available inputs. We then call blockchains.raw and use the returned object as the required variable in an api.relay call.
blockchains.validate(address) - back to top
This function returns a boolean and is used on conjunction with blockchains.check to validate an address.
blockchains.which(address) - back to top
This function will return the blockchain code (or false) for a given address.
However, please note that this IS NOT ACCURATE as it currently uses a very hacky method. Sorry about that.
- Related Articles
- Back to Modules
- Accounts
- API
- Buttons
- Contacts
- Blockchains
- Data
- Filters
- Forms
- Security
- Styles
- Templates
- Table of Contents