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>

    Install

    npm i heat-sdk

    DownloadsWeekly Downloads

    4

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    55.2 MB

    Total Files

    306

    Last publish

    Collaborators

    • heatledger