HeatSDK | heat-sdk

Hierarchy

HeatSDK

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HeatSDK(config?: Configuration): HeatSDK

- Defined in heat-sdk.ts:99
Parameters
- Optional config: Configuration
Returns HeatSDK

Properties

api

config

config: Configuration

converters

converters: "converters" = converters

crypto

crypto: "crypto" = crypto

rpc

secretGenerator

secretGenerator: SecretGenerator = new SecretGenerator()

setRandomSource

setRandomSource: setRandomSource = setRandomSource

subscriber

subscriber: HeatSubscriber

types

types: "types" = types

utils

utils: "utils" = utils

Methods

arbitraryMessage

arbitraryMessage(recipientOrRecipientPublicKey: string, message: string): Transaction

- Defined in heat-sdk.ts:138
Parameters
- recipientOrRecipientPublicKey: string
- message: string
Returns Transaction

assetIssuance

assetIssuance(descriptionUrl: string, descriptionHash: number[], quantity: string, decimals: number, dillutable: boolean, feeHQT?: string): Transaction

- Defined in heat-sdk.ts:174
Parameters
- descriptionUrl: string
- descriptionHash: number[]
- quantity: string
- decimals: number
- dillutable: boolean
- Optional feeHQT: string
Returns Transaction

assetTransfer

assetTransfer(recipientOrRecipientPublicKey: string, assetId: string, quantity: string, feeHQT?: string): Transaction

- Defined in heat-sdk.ts:193
Parameters
- recipientOrRecipientPublicKey: string
- assetId: string
- quantity: string
- Optional feeHQT: string
Returns Transaction

atomicMultiTransfer

atomicMultiTransfer(recipientOrRecipientPublicKey: string, transfers: AtomicTransfer[], feeHQT?: string): Transaction

- Defined in heat-sdk.ts:208
Parameters
- recipientOrRecipientPublicKey: string
- transfers: AtomicTransfer[]
- Optional feeHQT: string
Returns Transaction

cancelAskOrder

cancelAskOrder(orderId: string): Transaction

- Defined in heat-sdk.ts:258
Parameters
- orderId: string
Returns Transaction

cancelBidOrder

cancelBidOrder(orderId: string): Transaction

- Defined in heat-sdk.ts:268
Parameters
- orderId: string
Returns Transaction

parseTransactionBytes

parseTransactionBytes(transactionBytesHex: string): TransactionImpl

- Defined in heat-sdk.ts:109
Parameters
- transactionBytesHex: string
Returns TransactionImpl

parseTransactionJSON

parseTransactionJSON(json: object): TransactionImpl

- Defined in heat-sdk.ts:113
Parameters
- json: object
  - [key: string]: any
Returns TransactionImpl

passphraseDecrypt

passphraseDecrypt(cipherText: string, passphrase: string): string

- Defined in heat-sdk.ts:121
Parameters
- cipherText: string
- passphrase: string
Returns string

passphraseEncrypt

passphraseEncrypt(plainText: string, passphrase: string): string

- Defined in heat-sdk.ts:117
Parameters
- plainText: string
- passphrase: string
Returns string

payment

payment(recipientOrRecipientPublicKey: string, amount: string): Transaction

- Defined in heat-sdk.ts:126
Parameters
- recipientOrRecipientPublicKey: string
- amount: string
Returns Transaction

placeAskOrder

placeAskOrder(currencyId: string, assetId: string, quantity: string, price: string, expiration: number): Transaction

- Defined in heat-sdk.ts:222
Parameters
- currencyId: string
- assetId: string
- quantity: string
- price: string
- expiration: number
Returns Transaction

placeBidOrder

placeBidOrder(currencyId: string, assetId: string, quantity: string, price: string, expiration: number): Transaction

- Defined in heat-sdk.ts:240
Parameters
- currencyId: string
- assetId: string
- quantity: string
- price: string
- expiration: number
Returns Transaction

privateMessage

privateMessage(recipientPublicKey: string, message: string): Transaction

- Defined in heat-sdk.ts:150
Parameters
- recipientPublicKey: string
- message: string
Returns Transaction

privateMessageToSelf

privateMessageToSelf(message: string): Transaction

- Defined in heat-sdk.ts:162
Parameters
- message: string
Returns Transaction

Generated using TypeDoc