heat-sdk
TypeScript icon, indicating that this package has built-in type declarations

2.1.0 • Public • Published

HEAT Nodejs / Browser libraries

Travis styled with prettier Dev Dependencies NPM version

HEAT support libraries for Node.js and the browser

Links

HEAT-SDK API browse all classes, interfaces, methods includes links to their source code implementation.

HEAT REST API OpenAPI, heat server

GITHUB Heat-Ledger-Ltd/heat-sdk

Functionality

With HEAT-SDK you get full client-side/offline functionality of everything involving HEAT cryptocurrency. This includes but is not limited to:

  • Full HEAT API wrapper
  • Support for real-time updates through HEAT websocket API
  • Complete client side support for both constructing and parsing binary transaction data
  • Full client side encryption/decryption support for transaction attachments
  • Support for all other low-level HEAT functionality. But all client side, no server needed! (publickeys, accountids, transaction signatures etc.)

Samples

All samples open in https://runkit.com/ which gives you a live Nodejs environment, feel free to play around change the code samples, click RUN and see the output.

NODEJS | API ACCESS

NODEJS | GENERATE ACCOUNT

BROWSER | GENERATE ACCOUNT

NODEJS | DEX USD to HEAT

BROWSER | DEX USD to HEAT

BROWSER | BLOCK WHEN?

BROWSER | WEBSOCKETS

Usage

Node

Install heat-sdk

npm install heat-sdk --save

When using TypeScript install @typings with

npm install @types/heat-sdk --save

Require heat-sdk and use it in your project

var {HeatSDK} = require('heat-sdk')
var sdk = new HeatSDK()
sdk.payment("mike@heatwallet.com","99.95")
   .publicMessage("Happy birthday!")
   .sign("my secret phrase")
   .broadcast()

Browser

heat-sdk comes as an UMD module which means you could either require or import {heatsdk} from 'heat-sdk' or simply load as <script src=""> and access it through window.heatsdk

<html>
  <head>
    <script src="heat-sdk.js"></script> 
    <script>
      var sdk = new heatsdk.HeatSDK()
      sdk.payment("mike@heatwallet.com","99.95")
         .publicMessage("Happy birthday!")
         .sign("my secret phrase")
         .broadcast()
    </script> 
  </head>
</html>

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
2.1.03latest

Version History

VersionDownloads (Last 7 Days)Published
2.1.03
2.0.02
1.0.11
1.0.01
0.12.71
0.12.61
0.12.50
0.12.41
0.12.31
0.12.21
0.12.11
0.12.00
0.11.00
0.10.01
0.9.01
0.8.01
0.7.00
0.6.01
0.5.01
0.4.21
0.4.11
0.4.00
0.3.31
0.3.20
0.3.10
0.3.00
0.2.01
0.1.01
0.0.20
0.0.10
0.0.00
0.0.0-development1

Package Sidebar

Install

npm i heat-sdk

Weekly Downloads

5

Version

2.1.0

License

MIT

Unpacked Size

55.2 MB

Total Files

306

Last publish

Collaborators

  • heatledger