Update lum prefix constants

Author: Fabrice Bascoulergue

docs/lib/modules/lumconstants.md

@@ -5,7 +5,12 @@
 ### Variables
 
 - [HDPath](lumconstants.md#hdpath)
-- [LumAddressPrefix](lumconstants.md#lumaddressprefix)
+- [LumBech32PrefixAccAddr](lumconstants.md#lumbech32prefixaccaddr)
+- [LumBech32PrefixAccPub](lumconstants.md#lumbech32prefixaccpub)
+- [LumBech32PrefixConsAddr](lumconstants.md#lumbech32prefixconsaddr)
+- [LumBech32PrefixConsPub](lumconstants.md#lumbech32prefixconspub)
+- [LumBech32PrefixValAddr](lumconstants.md#lumbech32prefixvaladdr)
+- [LumBech32PrefixValPub](lumconstants.md#lumbech32prefixvalpub)
 - [LumDenom](lumconstants.md#lumdenom)
 - [PrivateKeyLength](lumconstants.md#privatekeylength)
 
@@ -23,13 +28,55 @@ Lum Network HDPath
 
 **`see`** https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki
 
+**`see`** https://github.com/satoshilabs/slips/blob/master/slip-0044.md
+
+___
+
+### LumBech32PrefixAccAddr
+
+• `Const` **LumBech32PrefixAccAddr**: *lum*= 'lum'
+
+Lum Network Bech32 prefix of an account's address
+
+___
+
+### LumBech32PrefixAccPub
+
+• `Const` **LumBech32PrefixAccPub**: *lumpub*= 'lumpub'
+
+Lum Network Bech32 prefix of an account's public key
+
+___
+
+### LumBech32PrefixConsAddr
+
+• `Const` **LumBech32PrefixConsAddr**: *lumvalcons*= 'lumvalcons'
+
+Lum Network Bech32 prefix of a consensus node address
+
+___
+
+### LumBech32PrefixConsPub
+
+• `Const` **LumBech32PrefixConsPub**: *lumvalconspub*= 'lumvalconspub'
+
+Lum Network Bech32 prefix of a consensus node public key
+
+___
+
+### LumBech32PrefixValAddr
+
+• `Const` **LumBech32PrefixValAddr**: *lumvaloper*= 'lumvaloper'
+
+Lum Network Bech32 prefix of a validator's operator address
+
 ___
 
-### LumAddressPrefix
+### LumBech32PrefixValPub
 
-• `Const` **LumAddressPrefix**: *lum*= 'lum'
+• `Const` **LumBech32PrefixValPub**: *lumvaloperpub*= 'lumvaloperpub'
 
-Lum Network address prefix
+Lum Network Bech32 prefix of a validator's operator public key
 
 ___
 

src/constants/index.ts

@@ -4,14 +4,40 @@
 export const LumDenom = 'lum';
 
 /**
- * Lum Network address prefix
+ * Lum Network Bech32 prefix of an account's address
  */
-export const LumAddressPrefix = 'lum';
+export const LumBech32PrefixAccAddr = 'lum';
+
+/**
+ * Lum Network Bech32 prefix of an account's public key
+ */
+export const LumBech32PrefixAccPub = 'lumpub';
+
+/**
+ * Lum Network Bech32 prefix of a validator's operator address
+ */
+export const LumBech32PrefixValAddr = 'lumvaloper';
+
+/**
+ * Lum Network Bech32 prefix of a validator's operator public key
+ */
+export const LumBech32PrefixValPub = 'lumvaloperpub';
+
+/**
+ * Lum Network Bech32 prefix of a consensus node address
+ */
+export const LumBech32PrefixConsAddr = 'lumvalcons';
+
+/**
+ * Lum Network Bech32 prefix of a consensus node public key
+ */
+export const LumBech32PrefixConsPub = 'lumvalconspub';
 
 /**
  * Lum Network HDPath
  *
  * @see https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki
+ * @see https://github.com/satoshilabs/slips/blob/master/slip-0044.md
  */
 export const HDPath = "m/44'/837'/0'/0/";
 

src/utils/keys.ts

@@ -3,15 +3,15 @@ import { Any } from '..//codec/google/protobuf/any';
 import { Secp256k1, sha256, ripemd160, EnglishMnemonic, Bip39, Slip10, Slip10Curve, stringToPath, Random } from '@cosmjs/crypto';
 
 import { Bech32 } from './encoding';
-import { LumAddressPrefix, getLumHdPath, PrivateKeyLength } from '../constants';
+import { LumBech32PrefixAccAddr, getLumHdPath, PrivateKeyLength } from '../constants';
 
 /**
  * Derives a bech32 wallet address from a public key (secp256k1)
  *
  * @param publicKey public key to derive the address from
  * @param prefix address prefix to use (ex: lum)
  */
-export const getAddressFromPublicKey = (publicKey: Uint8Array, prefix = LumAddressPrefix) => {
+export const getAddressFromPublicKey = (publicKey: Uint8Array, prefix = LumBech32PrefixAccAddr) => {
     if (publicKey.length !== 33) {
         throw new Error(`Invalid Secp256k1 pubkey length (compressed): ${publicKey.length}`);
     }
@@ -78,7 +78,7 @@ export const generatePrivateKey = (): Uint8Array => {
  * @param address address to check
  * @param prefix prefix to check (will not be checked if not provided)
  */
-export const isAddressValid = (address: string, prefix: string | undefined = LumAddressPrefix): boolean => {
+export const isAddressValid = (address: string, prefix: string | undefined = LumBech32PrefixAccAddr): boolean => {
     try {
         const decoded = Bech32.decode(address);
         return (!prefix || prefix === decoded.prefix) && decoded.data.length === 20;

src/wallet/LumWallet.ts

@@ -25,7 +25,7 @@ export class LumWallet {
      * @param publicKey wallet public key (secp256k1)
      * @param addressPrefix prefix to use to derive the address from the public key (ex: lum)
      */
-    constructor(privateKey: Uint8Array, publicKey: Uint8Array, addressPrefix = constants.LumAddressPrefix) {
+    constructor(privateKey: Uint8Array, publicKey: Uint8Array, addressPrefix = constants.LumBech32PrefixAccAddr) {
         this.publicKey = publicKey;
         this.privateKey = privateKey;
         this.address = utils.getAddressFromPublicKey(publicKey, addressPrefix);
@@ -37,7 +37,7 @@ export class LumWallet {
      * @param privateKey wallet private key (secp256k1)
      * @param addressPrefix prefix to use to derive the address from the public key (ex: lum)
      */
-    static fromPrivateKey = async (privateKey: Uint8Array, addressPrefix = constants.LumAddressPrefix) => {
+    static fromPrivateKey = async (privateKey: Uint8Array, addressPrefix = constants.LumBech32PrefixAccAddr) => {
         const publicKey = await utils.getPublicKeyFromPrivateKey(privateKey);
         return new LumWallet(privateKey, publicKey, addressPrefix);
     };
@@ -49,7 +49,7 @@ export class LumWallet {
      * @param hdPath BIP44 derivation path
      * @param addressPrefix prefix to use to derive the address from the public key (ex: lum)
      */
-    static fromMnemonic = async (mnemonic: string, hdPath = constants.getLumHdPath(0), addressPrefix = constants.LumAddressPrefix) => {
+    static fromMnemonic = async (mnemonic: string, hdPath = constants.getLumHdPath(0), addressPrefix = constants.LumBech32PrefixAccAddr) => {
         const privateKey = await utils.getPrivateKeyFromMnemonic(mnemonic, hdPath);
         return LumWallet.fromPrivateKey(privateKey, addressPrefix);
     };
@@ -61,7 +61,7 @@ export class LumWallet {
      * @param password keystore password
      * @param addressPrefix prefix to use to derive the address from the public key (ex: lum)
      */
-    static fromKeyStore = async (keystore: string | utils.KeyStore, password: string, addressPrefix = constants.LumAddressPrefix) => {
+    static fromKeyStore = async (keystore: string | utils.KeyStore, password: string, addressPrefix = constants.LumBech32PrefixAccAddr) => {
         const privateKey = utils.getPrivateKeyFromKeystore(keystore, password);
         return LumWallet.fromPrivateKey(privateKey, addressPrefix);
     };

tests/wallet.test.ts

@@ -12,7 +12,7 @@ describe('LumWallet', () => {
         const w3 = await LumWallet.fromKeyStore(keystore, 'lumiere');
 
         expect(LumUtils.isAddressValid(w1.address)).toBe(true);
-        expect(LumUtils.isAddressValid(w1.address, LumConstants.LumAddressPrefix)).toBe(true);
+        expect(LumUtils.isAddressValid(w1.address, LumConstants.LumBech32PrefixAccAddr)).toBe(true);
         expect(LumUtils.isAddressValid(w1.address, undefined)).toBe(true);
         expect(LumUtils.isAddressValid(w1.address, 'cosmos')).toBe(false);
         expect(w1.address).toEqual(w2.address);