@burstjs/crypto NPM

@burstjs/crypto

Cryptographic functions for building Burstcoin apps.

Installation

burstJS can be used with NodeJS or Web. Two formats are available

Using with NodeJS and/or modern web frameworks

Install using npm:

npm install @burstjs/crypto

or using yarn:

yarn add @burstjs/crypto

Example

import {encryptAES, decryptAES, hashSHA256} from '@burstjs/crypto'

const encrypted = encryptAES('test', 'key')
const decrypted = decryptAES(encrypted, 'key')
console.log(hashSHA256('test'))
console.log(decrypted)

Using in classic `<script>`

Each package is available as bundled standalone library using IIFE. This way burstJS can be used also within <script>-Tags. This might be useful for Wordpress and/or other PHP applications.

Just import the package using the HTML <script> tag.

<script src='https://cdn.jsdelivr.net/npm/@burstjs/crypto/dist/burstjs.crypto.min.js'></script>

Example

const encrypted = b$crypto.encryptAES("test", "key");
const decrypted = b$crypto.decryptAES(encrypted, "key");
console.log(b$crypto.hashSHA256("test"));
console.log(decrypted);

See more here:

@burstjs/crypto Online Documentation

API Reference

Modules

Classes

Constants

crypto ⇒

Returns: The decrypted content
See: [encryptAES]

Param	Description
encryptedBase64	encrypted data in base64 format
key	The secret key

crypto ⇒

Returns: The original plain text

Param	Description
encryptedData	The encrypted data
senderPublicKeyHex	The senders public key in hex format
recipientPrivateKeyHex	The recipients private (agreement) key in hex format

crypto ⇒

Returns: The original message

Param	Description
encryptedMessage	The encrypted message
senderPublicKeyHex	The senders public key in hex format
recipientPrivateKeyHex	The recipients private (agreement) key in hex format

crypto ⇒

Returns: The encrypted message as Base64 string
See: [decryptAES]

Param	Description
text	The message/text to be encrypted
key	The key used

crypto ⇒

Returns: The encrypted Data
See: [decryptData]

Param	Description
plaintext	Data to be encrypted
recipientPublicKeyHex	The recipients public key in hexadecimal format
senderPrivateKeyHex	The senders private (agreement) key hexadecimal format

crypto ⇒

Returns: The encrypted Message
See: [decryptMessage]

Param	Description
plaintext	Message to be encrypted
recipientPublicKeyHex	The recipients public key hexadecimal format
senderPrivateKeyHex	The senders private (agreement) key hexadecimal format