Merge pull request #7 from lum-network/develop

Add support for easy message signature and verification

Author: Fabrice Bascoulergue

docs/README.md

@@ -39,12 +39,12 @@ const privateKey = LumUtils.generatePrivateKey();
 
 // Create a wallet instance based on this fresh private key
 const wallet = await LumWalletFactory.fromPrivateKey(mnemonic);
-console.log(`Wallet address: ${wallet.address}`);
+console.log(`Wallet address: ${wallet.getAddress()}`);
 
 // Create a wallet instance based on an hexadecimal private key (ex: user input - 0x is optional)
 const hexPrivateKey = '0xb8e62c34928025cdd3aef6cbebc68694b5ad9209b2aff6d3891c8e61d22d3a3b';
 const existingWallet = await LumWalletFactory.fromPrivateKey(LumUtils.keyFromHex(hexPrivateKey));
-console.log(`Existing wallet address: ${wallet.address}`);
+console.log(`Existing wallet address: ${wallet.getAddress()}`);
 ```
 
 #### Keystore
@@ -54,7 +54,7 @@ const privateKey = LumUtils.generatePrivateKey();
 // Create a keystore (or consume user input)
 const keystore = LumUtils.generateKeyStore(privateKey, 'some-password');
 const wallet = await LumWalletFactory.fromKeyStore(keystore, 'some-password');
-console.log(`Wallet address: ${wallet.address}`);
+console.log(`Wallet address: ${wallet.getAddress()}`);
 ```
 
 ### Hardware wallets
@@ -107,7 +107,7 @@ const testnetClient = await LumClient.connect('http://node0.testnet.lum.network/
 
 #### Get account information
 ```typescript
-const account = await testnetClient.getAccount(wallet.address);
+const account = await testnetClient.getAccount(wallet.getAddress());
 if (account === null) {
     console.log('Account: not found');
 } else {
@@ -117,7 +117,7 @@ if (account === null) {
 
 #### Get account balances
 ```typescript
-const balances = await testnetClient.getAllBalancesUnverified(wallet.address);
+const balances = await testnetClient.getAllBalancesUnverified(wallet.getAddress());
 if (balances.length === 0) {
     console.log('Balances: empty account');
 } else {
@@ -135,8 +135,8 @@ if (balances.length === 0) {
 ```typescript
 // The client search feature supports multiple searches and merge+sort the results
 const transactions = await testnetClient.searchTx([
-    LumUtils.searchTxFrom(wallet.address),
-    LumUtils.searchTxTo(wallet.address),
+    LumUtils.searchTxFrom(wallet.getAddress()),
+    LumUtils.searchTxTo(wallet.getAddress()),
 ]);
 console.log(`Transactions: ${transactions.map((tx) => tx.hash).join(', ')}`);
 ```
@@ -145,7 +145,7 @@ console.log(`Transactions: ${transactions.map((tx) => tx.hash).join(', ')}`);
 ```typescript
 // Build transaction message (Send 100 LUM)
 const sendMsg = LumMessages.BuildMsgSend(
-    wallet.address,
+    wallet.getAddress(),
     toAddress,
     [{ denom: LumConstants.LumDenom, amount: '100' }],
 );
@@ -155,7 +155,7 @@ const fee = {
     gas: '100000',
 };
 // Fetch account number and sequence
-const account = await testnetClient.getAccount(wallet.address);
+const account = await testnetClient.getAccount(wallet.getAddress());
 // Create the transaction document
 const doc = {
     accountNumber: account.accountNumber,
@@ -176,10 +176,10 @@ console.log(`Broadcast success: ${LumUtils.broadcastTxCommitSuccess(broadcastRes
 The underlying tendermint client is directly accessible via the `.tmClient` property of the LumClient.
 
 ```typescript
-    const health = await testnetClient.tmClient.health();
-    const status = await testnetClient.tmClient.status();
-    const genesis = await testnetClient.tmClient.genesis();
-    const latestBlock = await testnetClient.tmClient.block();
+const health = await testnetClient.tmClient.health();
+const status = await testnetClient.tmClient.status();
+const genesis = await testnetClient.tmClient.genesis();
+const latestBlock = await testnetClient.tmClient.block();
 ```
 
 ### Use all modules RPCs
@@ -189,6 +189,19 @@ The underlying query client is directly accessible via the `.queryClient` proper
 It allows to directly query all modules endpoints such as:
 
 ```typescript
-    const supplies = await clt.queryClient.bank.unverified.totalSupply();
-    // [{ denom: 'lum', amount: '1000000' }]
+const supplies = await clt.queryClient.bank.unverified.totalSupply();
+// [{ denom: 'lum', amount: '1000000' }]
+```
+
+### Message signature & verification
+
+#### Sign a message
+```typescript
+const message = 'Lum network is an awesome decentralized protocol';
+const signedPayload = await wallet.signMessage(message);
+// { address, publicKey, msg, sig, version, signer }
+const validSig = await LumUtils.verifySignMsg(signedPayload);
+// true
+const invalidSig = await LumUtils.verifySignMsg(Object.assign(signedPayload, { msg: 'Wrong message input' }));
+// false
 ```

docs/lib/classes/lumledgerwallet.md

@@ -25,6 +25,7 @@
 - [getAddress](lumledgerwallet.md#getaddress)
 - [getAppConfiguration](lumledgerwallet.md#getappconfiguration)
 - [getPublicKey](lumledgerwallet.md#getpublickey)
+- [signMessage](lumledgerwallet.md#signmessage)
 - [signTransaction](lumledgerwallet.md#signtransaction)
 - [signingMode](lumledgerwallet.md#signingmode)
 - [useAccount](lumledgerwallet.md#useaccount)
@@ -127,6 +128,22 @@ Inherited from: [LumWallet](lumwallet.md)
 
 ___
 
+### signMessage
+
+▸ **signMessage**(`msg`: *string*): *Promise*<[*SignMsg*](../interfaces/lumtypes.signmsg.md)\>
+
+#### Parameters:
+
+Name | Type |
+:------ | :------ |
+`msg` | *string* |
+
+**Returns:** *Promise*<[*SignMsg*](../interfaces/lumtypes.signmsg.md)\>
+
+Inherited from: [LumWallet](lumwallet.md)
+
+___
+
 ### signTransaction
 
 ▸ **signTransaction**(`doc`: [*Doc*](../interfaces/lumtypes.doc.md)): *Promise*<Uint8Array\>

docs/lib/classes/lumpaperwallet.md

@@ -24,6 +24,7 @@
 - [canChangeAccount](lumpaperwallet.md#canchangeaccount)
 - [getAddress](lumpaperwallet.md#getaddress)
 - [getPublicKey](lumpaperwallet.md#getpublickey)
+- [signMessage](lumpaperwallet.md#signmessage)
 - [signTransaction](lumpaperwallet.md#signtransaction)
 - [signingMode](lumpaperwallet.md#signingmode)
 - [useAccount](lumpaperwallet.md#useaccount)
@@ -120,6 +121,22 @@ Inherited from: [LumWallet](lumwallet.md)
 
 ___
 
+### signMessage
+
+▸ **signMessage**(`msg`: *string*): *Promise*<[*SignMsg*](../interfaces/lumtypes.signmsg.md)\>
+
+#### Parameters:
+
+Name | Type |
+:------ | :------ |
+`msg` | *string* |
+
+**Returns:** *Promise*<[*SignMsg*](../interfaces/lumtypes.signmsg.md)\>
+
+Inherited from: [LumWallet](lumwallet.md)
+
+___
+
 ### signTransaction
 
 ▸ **signTransaction**(`doc`: [*Doc*](../interfaces/lumtypes.doc.md)): *Promise*<Uint8Array\>

docs/lib/classes/lumwallet.md

@@ -24,6 +24,7 @@
 - [canChangeAccount](lumwallet.md#canchangeaccount)
 - [getAddress](lumwallet.md#getaddress)
 - [getPublicKey](lumwallet.md#getpublickey)
+- [signMessage](lumwallet.md#signmessage)
 - [signTransaction](lumwallet.md#signtransaction)
 - [signingMode](lumwallet.md#signingmode)
 - [useAccount](lumwallet.md#useaccount)
@@ -91,6 +92,23 @@ wallet public key (secp256k1)
 
 ___
 
+### signMessage
+
+▸ `Abstract`**signMessage**(`msg`: *string*): *Promise*<[*SignMsg*](../interfaces/lumtypes.signmsg.md)\>
+
+Sign a message using a LumWallet
+Provided for signature generation and verification as signature will depend on the wallet payload implementation
+
+#### Parameters:
+
+Name | Type | Description |
+:------ | :------ | :------ |
+`msg` | *string* | message to sign    |
+
+**Returns:** *Promise*<[*SignMsg*](../interfaces/lumtypes.signmsg.md)\>
+
+___
+
 ### signTransaction
 
 ▸ `Abstract`**signTransaction**(`doc`: [*Doc*](../interfaces/lumtypes.doc.md)): *Promise*<Uint8Array\>

docs/lib/enums/lumconstants.lummessagesigner.md

@@ -0,0 +1,24 @@
+# Enumeration: LumMessageSigner
+
+[LumConstants](../modules/lumconstants.md).LumMessageSigner
+
+Signing wallets
+
+## Table of contents
+
+### Enumeration members
+
+- [LEDGER](lumconstants.lummessagesigner.md#ledger)
+- [PAPER](lumconstants.lummessagesigner.md#paper)
+
+## Enumeration members
+
+### LEDGER
+
+• **LEDGER**: = "lum-sdk/ledger"
+
+___
+
+### PAPER
+
+• **PAPER**: = "lum-sdk/paper"

docs/lib/interfaces/lumtypes.signmsg.md

@@ -0,0 +1,62 @@
+# Interface: SignMsg
+
+[LumTypes](../modules/lumtypes.md).SignMsg
+
+## Table of contents
+
+### Properties
+
+- [address](lumtypes.signmsg.md#address)
+- [msg](lumtypes.signmsg.md#msg)
+- [publicKey](lumtypes.signmsg.md#publickey)
+- [sig](lumtypes.signmsg.md#sig)
+- [signer](lumtypes.signmsg.md#signer)
+- [version](lumtypes.signmsg.md#version)
+
+## Properties
+
+### address
+
+• **address**: *string*
+
+Address of the signer
+
+___
+
+### msg
+
+• **msg**: *string*
+
+Message
+
+___
+
+### publicKey
+
+• **publicKey**: *Uint8Array*
+
+publicKey of the signer
+
+___
+
+### sig
+
+• **sig**: *Uint8Array*
+
+Message signature
+
+___
+
+### signer
+
+• **signer**: [*LumMessageSigner*](../enums/lumconstants.lummessagesigner.md)
+
+Signer wallet identifier
+
+___
+
+### version
+
+• **version**: *string*
+
+Signing version

docs/lib/modules/lumconstants.md

@@ -2,6 +2,10 @@
 
 ## Table of contents
 
+### Enumerations
+
+- [LumMessageSigner](../enums/lumconstants.lummessagesigner.md)
+
 ### Variables
 
 - [HDPath](lumconstants.md#hdpath)
@@ -12,6 +16,7 @@
 - [LumBech32PrefixValAddr](lumconstants.md#lumbech32prefixvaladdr)
 - [LumBech32PrefixValPub](lumconstants.md#lumbech32prefixvalpub)
 - [LumDenom](lumconstants.md#lumdenom)
+- [LumWalletSigningVersion](lumconstants.md#lumwalletsigningversion)
 - [PrivateKeyLength](lumconstants.md#privatekeylength)
 
 ### Functions
@@ -88,6 +93,14 @@ Lum Coin denomination
 
 ___
 
+### LumWalletSigningVersion
+
+• `Const` **LumWalletSigningVersion**: *1*= '1'
+
+Signing version of the SDK
+
+___
+
 ### PrivateKeyLength
 
 • `Const` **PrivateKeyLength**: *32*= 32

docs/lib/modules/lumtypes.md

@@ -16,6 +16,7 @@
 - [LogEvent](../interfaces/lumtypes.logevent.md)
 - [PubKey](../interfaces/lumtypes.pubkey.md)
 - [SignDoc](../interfaces/lumtypes.signdoc.md)
+- [SignMsg](../interfaces/lumtypes.signmsg.md)
 - [Tx](../interfaces/lumtypes.tx.md)
 
 ### Variables

docs/lib/modules/lumutils.md

@@ -40,6 +40,7 @@
 - [sha3](lumutils.md#sha3)
 - [sortJSON](lumutils.md#sortjson)
 - [toJSON](lumutils.md#tojson)
+- [verifySignMsg](lumutils.md#verifysignmsg)
 - [verifySignature](lumutils.md#verifysignature)
 
 ## Functions
@@ -580,9 +581,23 @@ Name | Type | Description |
 
 ___
 
+### verifySignMsg
+
+▸ `Const`**verifySignMsg**(`msg`: [*SignMsg*](../interfaces/lumtypes.signmsg.md)): *Promise*<boolean\>
+
+#### Parameters:
+
+Name | Type |
+:------ | :------ |
+`msg` | [*SignMsg*](../interfaces/lumtypes.signmsg.md) |
+
+**Returns:** *Promise*<boolean\>
+
+___
+
 ### verifySignature
 
-▸ `Const`**verifySignature**(`signature`: *Uint8Array*, `signDocBytes`: *Uint8Array*, `publicKey`: *Uint8Array*): *Promise*<boolean\>
+▸ `Const`**verifySignature**(`signature`: *Uint8Array*, `signedBytes`: *Uint8Array*, `publicKey`: *Uint8Array*): *Promise*<boolean\>
 
 Verify that a transaction signature is valid
 
@@ -591,7 +606,7 @@ Verify that a transaction signature is valid
 Name | Type | Description |
 :------ | :------ | :------ |
 `signature` | *Uint8Array* | transaction signature (as generated by the generateSignature function)   |
-`signDocBytes` | *Uint8Array* | sign doc bytes (as generated by the generateSignDocBytes function)   |
+`signedBytes` | *Uint8Array* | signed bytes (as generated by the generateSignDocBytes function or by the signMessage function)   |
 `publicKey` | *Uint8Array* | public key of the signing key pair (secp256k1)    |
 
 **Returns:** *Promise*<boolean\>

src/constants/index.ts

@@ -54,3 +54,16 @@ export const getLumHdPath = (accountIndex = 0, walletIndex = 0): string => {
  * Private Key length
  */
 export const PrivateKeyLength = 32;
+
+/**
+ * Signing version of the SDK
+ */
+export const LumWalletSigningVersion = '1';
+
+/**
+ * Signing wallets
+ */
+export enum LumMessageSigner {
+    PAPER = 'lum-sdk/paper',
+    LEDGER = 'lum-sdk/ledger',
+}