Source: blockchains/ethereum/common.js

  1. 'use strict';
  2. /**
  3.  * @module lib/blockchains/ethereum/accounts
  4.  * @summary Whiteflag API Ethereum common functions module
  5.  * @description Module for common functions used by all Ethereum wub-modules
  6.  */
  7. module.exports = {
  8.     formatAddressApi,
  9.     formatPubkeyApi,
  10.     formatHexApi,
  11.     formatHexEthereum
  12. };
  14. // Module constants //
  15. const ETHHEXPREFIX = '0x';
  16. const SECPUBKEYPREFIX = '04';
  18. // KEY AND ADDRESS FORMATTERS //
  19. /**
  20.  * Ensures that addresses are in generic api format
  21.  * @function formatAddressApi
  22.  * @returns {string} The Ethereum address without 0x hex prefix
  23.  */
  24. function formatAddressApi(addressHexString) {
  25.     // The api addresses keys WITHOUT 0x prefix
  26.     // Note that Ethereum addresses use capitials as a checksum, so no toLowerCase()
  27.     if (!addressHexString) return null;
  28.     if (addressHexString.substring(0, 2) === ETHHEXPREFIX) {
  29.         return addressHexString.substr(2);
  30.     }
  31.     return addressHexString;
  32. }
  34. /**
  35.  * Ensures that public keys are in generic api format
  36.  * @function formatPubkeyApi
  37.  * @returns {string} The Ethereum public key without 0x hex prefix but with prefix byte
  38.  */
  39. function formatPubkeyApi(pubkeyHexString) {
  40.     // The api uses uncompressed keys, WITHOUT 0x prefix, but WITH the SEC 0x04 prefix byte
  41.     if (!pubkeyHexString) return null;
  42.     pubkeyHexString = formatHexApi(pubkeyHexString);
  43.     if (pubkeyHexString.length === 128) {
  44.         pubkeyHexString = SECPUBKEYPREFIX + pubkeyHexString;
  45.     }
  46.     return pubkeyHexString;
  47. }
  49. /**
  50.  * Ensures that keys are in generic api format
  51.  * @function formatHexApi
  52.  * @returns {string} The Ethereum key without 0x hex prefix
  53.  */
  54.  function formatHexApi(hexString) {
  55.     // The api uses keys WITHOUT 0x prefix
  56.     if (!hexString) return null;
  57.     if (hexString.substring(0, 2) === ETHHEXPREFIX) {
  58.         return hexString.substr(2).toLowerCase();
  59.     }
  60.     return hexString.toLowerCase();
  61. }
  63. /**
  64.  * Ensures that addresses and keys are in Ethereum format
  65.  * @function formatHexEthereum
  66.  * @returns {string} The Ethereum address or key with the 0x hex prefix
  67.  */
  68. function formatHexEthereum(hexString) {
  69.     // Ethereum uses all hex strings WITH 0x prefix
  70.     if (hexString.substring(0, 2) !== ETHHEXPREFIX) {
  71.         return (ETHHEXPREFIX + hexString);
  72.     }
  73.     return hexString;
  74. }