crypto | signumjs - The Javascript SDK for Signum Network

This package contains all cryptographic functions needed for Burstcoin.

Index

Functions

Interfaces

Classes

PassPhraseGenerator

Functions

Const decryptAES

decryptAES(encryptedBase64: string, key: string): string

- Defined in packages/crypto/src/decryptAES.ts:11
Decrypt an encrypted message

see

encryptAES

Parameters
- encryptedBase64: string
  
  encrypted data in base64 format
- key: string
  
  The secret key
Returns string

The decrypted content, or undefined if failed

decryptData

decryptData(encryptedData: EncryptedData, senderPublicKeyHex: string, recipientPrivateKeyHex: string): Uint8Array

- Defined in packages/crypto/src/decryptData.ts:54
Decrypts an encrypted cipher text

Parameters
- encryptedData: EncryptedData
  
  The encrypted data
- senderPublicKeyHex: string
  
  The senders public key in hex format
- recipientPrivateKeyHex: string
  
  The recipients private (agreement) key in hex format
Returns Uint8Array

The original plain text

decryptMessage

decryptMessage(encryptedMessage: EncryptedMessage, senderPublicKeyHex: string, recipientPrivateKeyHex: string): string

- Defined in packages/crypto/src/decryptMessage.ts:17
Decrypts an encrypted Message

Parameters
- encryptedMessage: EncryptedMessage
  
  The encrypted message
- senderPublicKeyHex: string
  
  The senders public key in hex format
- recipientPrivateKeyHex: string
  
  The recipients private (agreement) key in hex format
Returns string

The original message

Const encryptAES

encryptAES(text: string, key: string): string

- Defined in packages/crypto/src/encryptAES.ts:11
Symmetrically encrypts a text using an arbitrary key

see

decryptAES

Parameters
- text: string
  
  The message/text to be encrypted
- key: string
  
  The key used
Returns string

The encrypted message as Base64 string

encryptData

encryptData(plaintext: Uint8Array, recipientPublicKeyHex: string, senderPrivateKeyHex: string): EncryptedData

- Defined in packages/crypto/src/encryptData.ts:47
Encrypts arbitrary data for P2P message/data exchange using asymmetric encryption

see

decryptData

Parameters
- plaintext: Uint8Array
  
  Data to be encrypted
- recipientPublicKeyHex: string
  
  The recipients public key in hexadecimal format
- senderPrivateKeyHex: string
  
  The senders private (agreement) key hexadecimal format
Returns EncryptedData

The encrypted Data

encryptMessage

encryptMessage(plaintext: string, recipientPublicKeyHex: string, senderPrivateKeyHex: string): EncryptedMessage

- Defined in packages/crypto/src/encryptMessage.ts:18
Encrypts arbitrary message (UTF-8 compatible) for P2P message/data exchange using asymmetric encryption

see

decryptMessage

Parameters
- plaintext: string
  
  Message to be encrypted
- recipientPublicKeyHex: string
  
  The recipients public key hexadecimal format
- senderPrivateKeyHex: string
  
  The senders private (agreement) key hexadecimal format
Returns EncryptedMessage

The encrypted Message

Const generateMasterKeys

generateMasterKeys(passPhrase: string): Keys

- Defined in packages/crypto/src/generateMasterKeys.ts:12
Generate the Master Public Key and Master Private Keys for a new passphrase

Parameters
- passPhrase: string
  
  The passphrase
Returns Keys

EC-KCDSA sign key pair + agreement key

Const generateSignature

generateSignature(messageHex: string, privateKey: string): string

Generate a signature for a 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)

Parameters

messageHex: string

The data in hexadecimal representation
privateKey: string

The private key for signing

Returns string

The signature in hexadecimal format

Const generateSignedTransactionBytes

generateSignedTransactionBytes(unsignedTransactionHex: string, signature: string): string

- Defined in packages/crypto/src/generateSignedTransactionBytes.ts:8
Generates a signed message digest, which can be sent to BRS API then

Parameters
- unsignedTransactionHex: string
  
  The unsigned message
- signature: string
  
  The signature
Returns string

The signed message digest

Const getAccountIdFromPublicKey

getAccountIdFromPublicKey(publicKey: string): string

- Defined in packages/crypto/src/getAccountIdFromPublicKey.ts:10
Convert hex string of the public key to the account id

Parameters
- publicKey: string
  
  The public key
Returns string

The numeric account Id

Const hashSHA256

hashSHA256(input: string): string

- Defined in packages/crypto/src/hashSHA256.ts:9
Hash string into hex string

Parameters
- input: string
  
  An arbitrary text
Returns string

the hash for that string in hex format

Const verifySignature

verifySignature(signature: string, messageHex: string, publicKey: string): boolean

- Defined in packages/crypto/src/verifySignature.ts:21
Verify a signature for given message
- Method:
```
* h1 = sha256(sha256(transactionHex)_keygen(sha256(transactionHex_privateKey)).publicKey)
==
sha256(sha256(transactionHex)_verify(v, h1, publickey)) = h2
```
see

generateSignature
Parameters
- signature: string
  
  The signature to be verified
- messageHex: string
  
  The message data in hexadecimal representation
- publicKey: string
  
  The public key
Returns boolean

true, if signature is valid, otherwise false

Index

Functions

Interfaces

Classes

Functions

Const decryptAES

Parameters

encryptedBase64: string

key: string

Returns string

decryptData

Parameters

encryptedData: EncryptedData

senderPublicKeyHex: string

recipientPrivateKeyHex: string

Returns Uint8Array

decryptMessage

Parameters

encryptedMessage: EncryptedMessage

senderPublicKeyHex: string

recipientPrivateKeyHex: string

Returns string

Const encryptAES

Parameters

text: string

key: string

Returns string

encryptData

Parameters

plaintext: Uint8Array

recipientPublicKeyHex: string

senderPrivateKeyHex: string

Returns EncryptedData

encryptMessage

Parameters

plaintext: string

recipientPublicKeyHex: string

senderPrivateKeyHex: string

Returns EncryptedMessage

Const generateMasterKeys

Parameters

passPhrase: string

Returns Keys

Const generateSignature

Parameters

messageHex: string

privateKey: string

Returns string

Const generateSignedTransactionBytes

Parameters

unsignedTransactionHex: string

signature: string

Returns string

Const getAccountIdFromPublicKey

Parameters

publicKey: string

Returns string

Const hashSHA256

Parameters

input: string

Returns string

Const verifySignature

Parameters

signature: string

messageHex: string

publicKey: string

Returns boolean