From 343cd05363166a7a93fca361d5547b39f3e83d99 Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Fri, 3 Aug 2018 21:27:01 +0200
Subject: Add missing comments

---
 packages/order-utils/src/eip712_utils.ts | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

(limited to 'packages/order-utils/src/eip712_utils.ts')

diff --git a/packages/order-utils/src/eip712_utils.ts b/packages/order-utils/src/eip712_utils.ts
index 2594e6d6d..c7b20f824 100644
--- a/packages/order-utils/src/eip712_utils.ts
+++ b/packages/order-utils/src/eip712_utils.ts
@@ -40,15 +40,37 @@ export const EIP712Utils = {
         const messageBuff = crypto.solSHA3([EIP191_PREFIX, domainSeparatorHashBuffer, hashStruct]);
         return messageBuff;
     },
+    /**
+     * Pad an address to 32 bytes
+     * @param address Address to pad
+     * @return padded address
+     */
     pad32Address(address: string): Buffer {
         const addressBuffer = ethUtil.toBuffer(address);
         const addressPadded = EIP712Utils.pad32Buffer(addressBuffer);
         return addressPadded;
     },
+    /**
+     * Pad an buffer to 32 bytes
+     * @param buffer Address to pad
+     * @return padded buffer
+     */
     pad32Buffer(buffer: Buffer): Buffer {
         const bufferPadded = ethUtil.setLengthLeft(buffer, EIP712_VALUE_LENGTH);
         return bufferPadded;
     },
+    /**
+     * Hash together a EIP712 schema with the corresponding data
+     * @param schema EIP712-compliant schema
+     * @param data Data the complies to the schema
+     * @return A buffer containing the SHA256 hash of the schema and encoded data
+     */
+    structHash(schema: EIP712Schema, data: { [key: string]: any }): Buffer {
+        const encodedData = EIP712Utils._encodeData(schema, data);
+        const schemaHash = EIP712Utils.compileSchema(schema);
+        const hashBuffer = crypto.solSHA3([schemaHash, ...encodedData]);
+        return hashBuffer;
+    },
     _getDomainSeparatorSchemaBuffer(): Buffer {
         return EIP712Utils.compileSchema(EIP712_DOMAIN_SCHEMA);
     },
@@ -84,10 +106,4 @@ export const EIP712Utils = {
         }
         return encodedValues;
     },
-    structHash(schema: EIP712Schema, data: { [key: string]: any }): Buffer {
-        const encodedData = EIP712Utils._encodeData(schema, data);
-        const schemaHash = EIP712Utils.compileSchema(schema);
-        const hashBuffer = crypto.solSHA3([schemaHash, ...encodedData]);
-        return hashBuffer;
-    },
 };
-- 
cgit