This is the BlockTrail NodeJS SDK. This SDK contains methods for easily interacting with the BlockTrail API. Below are examples to get you started. For additional examples, please see our official documentation at https://www.blocktrail.com/api/docs/lang/nodejs
The Blocktrail SDK is tested against;
We've seperated out the backup PDF generator because it contained a lot of dependencies while barely anyone uses it.
If you do want to use it, see the
v3.0.0 introduces a new DEFAULT wallet encryption, please make sure you upgrade the SDK everywhere you're using it!!
v2.0.0 has a few BC breaks, please check docs/CHANGELOG.md!!
The BlockTrail SDK has some easy to use functions to do this for you, we recommend using these and we also strongly recommend doing all Bitcoin calculation and storing of data in integers and only convert to/from Bitcoin float values for displaying it to the user.
var blocktrail = ;console;console;
A bit more about this can be found in our documentation.
You can install the package through NPM (https://www.npmjs.org/package/blocktrail-sdk).
npm install blocktrail-sdk
Please visit our official documentation at https://www.blocktrail.com/api/docs/lang/nodejs for the usage.
Personally we prefer good old callbacks over promises,
but to make everyone happy the SDK functions accept a callback argument and return a (Q)promise object, so you can use whatever you prefer!
Be sure to visit the BlockTrail API official documentation website for additional information about our API.
If you find a bug, please submit the issue in Github directly. BlockTrail-NodeJS-SDK Issues
As always, if you need additional assistance, drop us a note at firstname.lastname@example.org.
Unit Tests are created with Mocha and can be ran with
npm test (or
We also run jshint and jscs, these are automatically ran by travis-ci for every commit and pull request.
jshint main.js lib/ test/
jscs main.js lib/ test/
The BlockTrail NodeJS SDK can be browserified to use it in the browser, which we use ourselves for wallet actions from our webapp.
If you want to test or develop on the SDK in the browser you can use
grunt build (and
grunt watch) to build the browserify version.
You need to pull the git submodules before you can build the browserify version:
git submodule update --init --recursive
blocktrail-sdk.min.js) the blocktrailSDK browserified
jsPDF.min.js) dependancy for generating the backup PDF
blocktrail-sdk-full.min.js) the blocktrailSDK browserified + jsPDF bundled
If you use these browserified versions of our SDK it will be accessible as
window.blocktrailSDK or plain
Known Supported and Tested Browsers:
For the following any modern version will work just fine:
['Buffer', 'BitInteger', 'Point', 'Script', 'ECPubKey', 'ECKey']
The BlockTrail NodeJS SDK is released under the terms of the MIT license. See LICENCE.md for more information or see http://opensource.org/licenses/MIT.