HEAT support libraries for Node.js and the browser
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
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.)
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.
Install heat-sdk
npm install heat-sdk --saveWhen using TypeScript install @typings with
npm install @types/heat-sdk --saveRequire heat-sdk and use it in your project
var {HeatSDK} = require('heat-sdk')
var sdk = new HeatSDK()
sdk.payment("[email protected]","99.95")
.publicMessage("Happy birthday!")
.sign("my secret phrase")
.broadcast()To use on testnet or use different endpoints pass a Configuration object to the HeatSDK constructor. The sample below connects to heat testnet to a local running server.
const config = new heatsdk.Configuration({
isTestnet: true,
// baseURL: "http://localhost:7733/api/v1",
// websocketURL: "ws://localhost:7755/ws/"
})
const sdk = new heatsdk.HeatSDK(config)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("[email protected]","99.95")
.publicMessage("Happy birthday!")
.sign("my secret phrase")
.broadcast()
</script>
</head>
</html>