@alephium/web3 0.5.0-rc.12 → 0.5.0-rc.13

package/dist/src/signer/signer.d.ts

@@ -1,6 +1,6 @@
 import { ExplorerProvider, NodeProvider } from '../api';
 import { node } from '../api';
-import { Account, EnableOptionsBase, Destination, SignDeployContractTxParams, SignDeployContractTxResult, SignExecuteScriptTxParams, SignExecuteScriptTxResult, SignMessageParams, SignMessageResult, SignTransferTxParams, SignTransferTxResult, SignUnsignedTxParams, SignUnsignedTxResult, SubmissionResult, SubmitTransactionParams, KeyType } from './types';
+import { Account, EnableOptionsBase, Destination, SignDeployContractTxParams, SignDeployContractTxResult, SignExecuteScriptTxParams, SignExecuteScriptTxResult, SignMessageParams, SignMessageResult, SignTransferTxParams, SignTransferTxResult, SignUnsignedTxParams, SignUnsignedTxResult, SubmissionResult, SubmitTransactionParams, KeyType, MessageHasher } from './types';
 export declare abstract class SignerProvider {
     abstract get nodeProvider(): NodeProvider | undefined;
     abstract get explorerProvider(): ExplorerProvider | undefined;
@@ -52,7 +52,9 @@ export declare abstract class SignerProviderWithCachedAccounts<T extends Account
     getAccounts(): Promise<T[]>;
     getAccount(address: string): Promise<T>;
 }
-export declare function verifySignedMessage(message: string, publicKey: string, signature: string, keyType?: KeyType): boolean;
+export declare function extendMessage(message: string): string;
+export declare function hashMessage(message: string, hasher: MessageHasher): string;
+export declare function verifySignedMessage(message: string, messageHasher: MessageHasher, publicKey: string, signature: string, keyType?: KeyType): boolean;
 export declare function toApiDestination(data: Destination): node.Destination;
 export declare function toApiDestinations(data: Destination[]): node.Destination[];
 export declare function fromApiDestination(data: node.Destination): Destination;

package/dist/src/signer/signer.js

@@ -43,7 +43,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromApiDestination = exports.toApiDestinations = exports.toApiDestination = exports.verifySignedMessage = exports.SignerProviderWithCachedAccounts = exports.SignerProviderWithMultipleAccounts = exports.SignerProviderSimple = exports.InteractiveSignerProvider = exports.SignerProvider = void 0;
+exports.fromApiDestination = exports.toApiDestinations = exports.toApiDestination = exports.verifySignedMessage = exports.hashMessage = exports.extendMessage = exports.SignerProviderWithCachedAccounts = exports.SignerProviderWithMultipleAccounts = exports.SignerProviderSimple = exports.InteractiveSignerProvider = exports.SignerProvider = void 0;
+const buffer_1 = require("buffer/");
+const crypto_1 = require("crypto");
 const api_1 = require("../api");
 const utils = __importStar(require("../utils"));
 const blakejs_1 = __importDefault(require("blakejs"));
@@ -135,9 +137,8 @@ class SignerProviderSimple extends SignerProvider {
         return { signature, ...response };
     }
     async signMessage(params) {
-        const extendedMessage = extendMessage(params.message);
-        const messageHash = blakejs_1.default.blake2b(extendedMessage, undefined, 32);
-        const signature = await this.signRaw(params.signerAddress, utils.binToHex(messageHash));
+        const messageHash = hashMessage(params.message, params.messageHasher);
+        const signature = await this.signRaw(params.signerAddress, messageHash);
         return { signature: signature };
     }
 }
@@ -198,10 +199,27 @@ exports.SignerProviderWithCachedAccounts = SignerProviderWithCachedAccounts;
 function extendMessage(message) {
     return 'Alephium Signed Message: ' + message;
 }
-function verifySignedMessage(message, publicKey, signature, keyType) {
-    const extendedMessage = extendMessage(message);
-    const messageHash = blakejs_1.default.blake2b(extendedMessage, undefined, 32);
-    return utils.verifySignature(utils.binToHex(messageHash), publicKey, signature, keyType);
+exports.extendMessage = extendMessage;
+function hashMessage(message, hasher) {
+    switch (hasher) {
+        case 'alephium':
+            return utils.binToHex(blakejs_1.default.blake2b(extendMessage(message), undefined, 32));
+        case 'sha256':
+            const sha256 = (0, crypto_1.createHash)('sha256');
+            sha256.update(buffer_1.Buffer.from(message));
+            return utils.binToHex(sha256.digest());
+        case 'blake2b':
+            return utils.binToHex(blakejs_1.default.blake2b(message, undefined, 32));
+        case 'identity':
+            return message;
+        default:
+            throw Error(`Invalid message hasher: ${hasher}`);
+    }
+}
+exports.hashMessage = hashMessage;
+function verifySignedMessage(message, messageHasher, publicKey, signature, keyType) {
+    const messageHash = hashMessage(message, messageHasher);
+    return utils.verifySignature(messageHash, publicKey, signature, keyType);
 }
 exports.verifySignedMessage = verifySignedMessage;
 function toApiDestination(data) {

package/dist/src/signer/types.d.ts

@@ -88,10 +88,12 @@ export interface SignUnsignedTxResult {
     gasAmount: number;
     gasPrice: Number256;
 }
+export declare type MessageHasher = 'alephium' | 'sha256' | 'blake2b' | 'identity';
 export interface SignMessageParams {
     signerAddress: string;
     signerKeyType?: KeyType;
     message: string;
+    messageHasher: MessageHasher;
 }
 export interface SignMessageResult {
     signature: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.5.0-rc.12",
+  "version": "0.5.0-rc.13",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",

package/src/signer/signer.ts

@@ -16,6 +16,8 @@ You should have received a copy of the GNU Lesser General Public License
 along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
+import { Buffer } from 'buffer/'
+import { createHash } from 'crypto'
 import { ExplorerProvider, fromApiNumber256, fromApiTokens, NodeProvider, toApiNumber256, toApiTokens } from '../api'
 import { node } from '../api'
 import * as utils from '../utils'
@@ -38,7 +40,8 @@ import {
   SignUnsignedTxResult,
   SubmissionResult,
   SubmitTransactionParams,
-  KeyType
+  KeyType,
+  MessageHasher
 } from './types'
 import { TransactionBuilder } from './tx-builder'
 import { addressFromPublicKey, groupOfAddress } from '../utils'
@@ -176,9 +179,8 @@ export abstract class SignerProviderSimple extends SignerProvider {
   }
 
   async signMessage(params: SignMessageParams): Promise<SignMessageResult> {
-    const extendedMessage = extendMessage(params.message)
-    const messageHash = blake.blake2b(extendedMessage, undefined, 32)
-    const signature = await this.signRaw(params.signerAddress, utils.binToHex(messageHash))
+    const messageHash = hashMessage(params.message, params.messageHasher)
+    const signature = await this.signRaw(params.signerAddress, messageHash)
     return { signature: signature }
   }
 
@@ -242,14 +244,36 @@ export abstract class SignerProviderWithCachedAccounts<T extends Account> extend
   }
 }
 
-function extendMessage(message: string): string {
+export function extendMessage(message: string): string {
   return 'Alephium Signed Message: ' + message
 }
 
-export function verifySignedMessage(message: string, publicKey: string, signature: string, keyType?: KeyType): boolean {
-  const extendedMessage = extendMessage(message)
-  const messageHash = blake.blake2b(extendedMessage, undefined, 32)
-  return utils.verifySignature(utils.binToHex(messageHash), publicKey, signature, keyType)
+export function hashMessage(message: string, hasher: MessageHasher): string {
+  switch (hasher) {
+    case 'alephium':
+      return utils.binToHex(blake.blake2b(extendMessage(message), undefined, 32))
+    case 'sha256':
+      const sha256 = createHash('sha256')
+      sha256.update(Buffer.from(message))
+      return utils.binToHex(sha256.digest())
+    case 'blake2b':
+      return utils.binToHex(blake.blake2b(message, undefined, 32))
+    case 'identity':
+      return message
+    default:
+      throw Error(`Invalid message hasher: ${hasher}`)
+  }
+}
+
+export function verifySignedMessage(
+  message: string,
+  messageHasher: MessageHasher,
+  publicKey: string,
+  signature: string,
+  keyType?: KeyType
+): boolean {
+  const messageHash = hashMessage(message, messageHasher)
+  return utils.verifySignature(messageHash, publicKey, signature, keyType)
 }
 
 export function toApiDestination(data: Destination): node.Destination {

package/src/signer/types.ts

@@ -136,12 +136,19 @@ export interface SignUnsignedTxResult {
 }
 assertType<Eq<SignUnsignedTxResult, SignTransferTxResult>>
 
+export type MessageHasher =
+  | 'alephium' // Message is prefixed with 'Alephium signed message: ' before hashed with blake2b
+  | 'sha256'
+  | 'blake2b'
+  | 'identity' // No hash is used, the message to be 32 bytes
+
 export interface SignMessageParams {
   signerAddress: string
   signerKeyType?: KeyType
   message: string
+  messageHasher: MessageHasher
 }
-assertType<Eq<SignMessageParams, { message: string } & SignerAddress>>()
+assertType<Eq<SignMessageParams, { message: string; messageHasher: MessageHasher } & SignerAddress>>()
 export interface SignMessageResult {
   signature: string
 }