@burstjs/crypto
Advanced tools
Cryptographic functions for building Burstcoin apps.
burstJS can be used with NodeJS or Web. Two formats are available
Install using npm:
npm install @burstjs/crypto
or using yarn:
yarn add @burstjs/crypto
import {encryptAES, decryptAES, hashSHA256} from '@burstjs/crypto'
const encrypted = encryptAES('test', 'key')
const decrypted = decryptAES(encrypted, 'key')
console.log(hashSHA256('test'))
console.log(decrypted)
<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>
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
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
Arbitrary length hexadecimal to decimal conversion https://stackoverflow.com/questions/21667377/javascript-hexadecimal-string-to-decimal-string
Kind: static property of crypto
Returns:
A decimal string
| Param | Description |
|---|---|
| s | A hexadecimal string |
A set of useful converter methods for crypto operations.
Kind: inner class of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Original work Copyright (c) 2018 PoC-Consortium Modified work Copyright (c) 2019 Burst Apps Team
Kind: inner constant of crypto
Decrypt an encrypted message
Kind: inner method of crypto
Returns:
The decrypted content
| Param | Description |
|---|---|
| encryptedBase64 | encrypted data in base64 format |
| key | The secret key |
Decrypts an encrypted cipher text
Kind: inner method of 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 |
Decrypts an encrypted Message
Kind: inner method of 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 |
Encrypts arbitrary data
Kind: inner method of crypto
Returns:
The encrypted Data
| Param | Description |
|---|---|
| plaintext | Data to be encrypted |
| recipientPublicKeyHex | The recipients public key in hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Encrypts a message (UTF-8 compatible)
Kind: inner method of crypto
Returns:
The encrypted Message
| Param | Description |
|---|---|
| plaintext | Message to be encrypted |
| recipientPublicKeyHex | The recipients public key hexadecimal format |
| senderPrivateKeyHex | The senders private (agreement) key hexadecimal format |
Generate the Master Public Key and Master Private Key for a new passphrase
Kind: inner method of crypto
Returns:
EC-KCDSA sign key pair + agreement key
| Param | Description |
|---|---|
| passPhrase | The passphrase |
Generate a signature for the transaction
Method:
s = sign(sha256(sha256(transactionHex)_keygen(sha256(sha256(transactionHex)_privateKey)).publicKey),
sha256(sha256(transactionHex)_privateKey),
privateKey)
p = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
Kind: inner method of crypto
| Param | Description |
|---|---|
| messageHex | The data in hexadecimal representation |
| privateKey | The private key for signing |
Generates a signed message digest
Kind: inner method of crypto
Returns:
The signed message digest
| Param | Description |
|---|---|
| unsignedTransactionHex | The unsigned message |
| signature | The signature |
Convert hex string of the public key to the account id
Kind: inner method of crypto
Returns:
The numeric account Id
| Param | Description |
|---|---|
| publicKey | The public key |
Verify a signature for given message
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
Kind: inner method of crypto
| Param | Description |
|---|---|
| signature | The signature to be verified |
| messageHex | The message data in hexadecimal representation |
| publicKey | The public key |
FAQs
Cryptographic functions for building Burstcoin apps.
The npm package @burstjs/crypto receives a total of 18 weekly downloads. As such, @burstjs/crypto popularity was classified as not popular.
We found that @burstjs/crypto demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.