Skip to main content

Cryptography Utils

Cryptography-Utils is a collection of cryptography utility functions. This library is used by kadena.js to hash your transactions. If you have private keys available, you can also sign them with this library.

API Reference can be found here cryptography-utils.api.md

Usage Examples

import { IKeyPair } from '@kadena/types';
import { hash, sign } from '@kadena/cryptography-utils';
 
// Create a command
let commandPayload: string = 'Hello world!';
 
// Get the has of the command
let h: string = hash(commandPayload);
 
// Signing is normally handled by wallets, but if you have the private key
// available to you, you can also sign in this way:
let keyPair: IKeyPair = {
  publicKey: 'ba54b224d1924dd98403f5c751abdd10de6cd81b0121800bf7bdbdcfaec7388d',
  secretKey: '8693e641ae2bbe9ea802c736f42027b03f86afe63cae315e7169c9c496c17332',
};
 
let sig: string = sign(commandPayload, keyPair);
import { IKeyPair } from '@kadena/types';
import { hash, sign } from '@kadena/cryptography-utils';
 
// Create a command
let commandPayload: string = 'Hello world!';
 
// Get the has of the command
let h: string = hash(commandPayload);
 
// Signing is normally handled by wallets, but if you have the private key
// available to you, you can also sign in this way:
let keyPair: IKeyPair = {
  publicKey: 'ba54b224d1924dd98403f5c751abdd10de6cd81b0121800bf7bdbdcfaec7388d',
  secretKey: '8693e641ae2bbe9ea802c736f42027b03f86afe63cae315e7169c9c496c17332',
};
 
let sig: string = sign(commandPayload, keyPair);

Available Functions

crypto:

  • binToHex
  • hexToBin
  • base64UrlEncode
  • base64UrlDecode
  • base64UrlEncodeArr
  • base64UrlDecodeArr
  • strToUint8Array
  • uint8ArrayToStr
  • hash
  • hashBin
  • genKeyPair
  • restoreKeyPairFromSecretKey
  • sign
  • signHash
  • verifySig
  • unique
  • toTweetNaclSecretKey
Edit this pageprevious:
API Report File for "@kadena/kda-cli"next:
API Report File for "@kadena/cryptography-utils"
Receive important developer updates