Support signTypedData

Author: llwslc

.editorconfig

@@ -14,6 +14,7 @@ indent_size = 4
 
 [*.js]
 indent_size = 4
+quote_type = single
 
 [*.html]
 indent_size = 4

README.md

@@ -172,6 +172,9 @@ In order to contribute you can
 
 ## Recent History
 
+__4.3.0__
+- Support `signTypedData`
+
 __4.2.0__
 - Add the name key when the `call()` and `send()` methods has only one return value
 - Optimize the `TriggerConstantContract()` method
@@ -279,7 +282,7 @@ __2.5.4__
 * Adds cache in Trx to cache Contracts locally and make the process more efficient
 
 __2.5.2__
-* Adds static methods `Trx.signString` and `Trx.verifySignature
+* Adds static methods `Trx.signString` and `Trx.verifySignature`
 
 __2.5.0__
 * Allows freeBandwidth, freeBandwidthLimit, frozenAmount and frozenDuration to be zero

karma.conf.js

@@ -11,7 +11,7 @@ const basePlugins = [
     'source-map-support'
 ];
 
-const files = globby.sync([ 'test/**/*.test.js', '!test/**/abi.test.js' ]);
+const files = globby.sync([ 'test/**/*.test.js', '!test/**/abi.test.js', '!test/**/typedData.test.js' ]);
 
 module.exports = function (config) {
     config.set({

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "tronweb",
-    "version": "4.2.0",
+    "version": "4.3.0",
     "description": "JavaScript SDK that encapsulates the TRON HTTP API",
     "main": "dist/TronWeb.node.js",
     "scripts": {

package.json

@@ -647,6 +647,37 @@ export default class Trx {
         return base58Address == TronWeb.address.fromHex(address);
     }
 
+    verifyTypedData(domain, types, value, signature, address = this.tronWeb.defaultAddress.base58, callback = false) {
+        if (utils.isFunction(address)) {
+            callback = address;
+            address = this.tronWeb.defaultAddress.base58;
+        }
+
+        if (!callback)
+            return this.injectPromise(this.verifyTypedData, domain, types, value, signature, address);
+
+        if (Trx.verifyTypedData(domain, types, value, signature, address))
+            return callback(null, true);
+
+        callback('Signature does not match');
+    }
+
+    static verifyTypedData(domain, types, value, signature, address) {
+        signature = signature.replace(/^0x/, '');
+
+        const messageDigest = utils.TypedDataEncoder.hash(domain, types, value);
+        const recovered = recoverAddress(messageDigest, {
+            recoveryParam: signature.substring(128, 130) == '1c' ? 1 : 0,
+            r: '0x' + signature.substring(0, 64),
+            s: '0x' + signature.substring(64, 128),
+        });
+
+        const tronAddress = ADDRESS_PREFIX + recovered.substr(2);
+        const base58Address = TronWeb.address.fromHex(tronAddress);
+
+        return base58Address == TronWeb.address.fromHex(address);
+    }
+
     async sign(transaction = false, privateKey = this.tronWeb.defaultPrivateKey, useTronHeader = true, multisig = false, callback = false) {
 
         if (utils.isFunction(multisig)) {
@@ -732,6 +763,27 @@ export default class Trx {
         return signatureHex
     }
 
+    signTypedData(domain, types, value, privateKey = this.tronWeb.defaultPrivateKey, callback = false) {
+        if (utils.isFunction(privateKey)) {
+            callback = privateKey;
+            privateKey = this.tronWeb.defaultPrivateKey;
+        }
+
+        if (!callback)
+            return this.injectPromise(this.signTypedData, domain, types, value, privateKey);
+
+        try {
+            const signatureHex = Trx.signTypedData(domain, types, value, privateKey);
+            return callback(null, signatureHex);
+        } catch (ex) {
+            callback(ex);
+        }
+    }
+
+    static signTypedData(domain, types, value, privateKey) {
+        return utils.crypto.signTypedData(domain, types, value, privateKey);
+    }
+
     async multiSign(transaction = false, privateKey = this.tronWeb.defaultPrivateKey, permissionId = false, callback = false) {
 
         if (utils.isFunction(permissionId)) {

src/lib/trx.js

@@ -4,7 +4,8 @@ import {base64DecodeFromString, hexStr2byteArray} from './code';
 import {encode58, decode58} from './base58';
 import {byte2hexStr, byteArray2hexStr} from './bytes';
 import {ec as EC} from 'elliptic';
-import {keccak256, sha256} from './ethersUtils';
+import {keccak256, sha256, SigningKey} from './ethersUtils';
+import {TypedDataEncoder} from './typedData';
 
 export function getBase58CheckAddress(addressBytes) {
     const hash0 = SHA256(addressBytes);
@@ -76,6 +77,26 @@ export function signBytes(privateKey, contents) {
     return signBytes;
 }
 
+export function signTypedData(domain, types, value, privateKey) {
+    const key = {
+        toHexString: function () {
+            return '0x' + privateKey;
+        },
+        value: privateKey,
+    };
+    const signingKey = new SigningKey(key);
+
+    const messageDigest = TypedDataEncoder.hash(domain, types, value);
+    const signature = signingKey.signDigest(messageDigest);
+    const signatureHex = [
+        '0x',
+        signature.r.substring(2),
+        signature.s.substring(2),
+        Number(signature.v).toString(16),
+    ].join('');
+    return signatureHex;
+}
+
 export function getRowBytesFromTransactionBase64(base64Data) {
     const bytesDecode = base64DecodeFromString(base64Data);
     const transaction = proto.protocol.Transaction.deserializeBinary(bytesDecode);

src/utils/crypto.js

@@ -10,6 +10,8 @@ const AbiCoder = utils.AbiCoder;
 const Interface = utils.Interface;
 const FormatTypes = utils.FormatTypes;
 const arrayify = utils.arrayify;
+const splitSignature = utils.splitSignature;
+const joinSignature = utils.joinSignature;
 
 export {
     keccak256,
@@ -21,5 +23,7 @@ export {
     AbiCoder,
     Interface,
     FormatTypes,
+    splitSignature,
+    joinSignature,
     arrayify
 };

src/utils/ethersUtils.js

@@ -5,6 +5,7 @@ import * as crypto from './crypto';
 import * as code from './code';
 import * as abi from './abi';
 import * as ethersUtils from './ethersUtils';
+import {TypedDataEncoder} from './typedData'
 
 import validator from 'validator';
 import BigNumber from 'bignumber.js';
@@ -150,5 +151,6 @@ export default {
     bytes,
     crypto,
     abi,
+    TypedDataEncoder,
     ethersUtils
 };