From 10292b043dec3e487ca542e6f17f3730fdbb9380 Mon Sep 17 00:00:00 2001
From: Mark Tyneway <mark@purse.io>
Date: Fri, 15 Mar 2019 16:43:50 -0700
Subject: [PATCH] test: document bech32 test vectors

adds additional information about the test vectors
pulled from https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki
---
 test/bech32-test.js | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/test/bech32-test.js b/test/bech32-test.js
index d780956f..51720e4a 100644
--- a/test/bech32-test.js
+++ b/test/bech32-test.js
@@ -80,17 +80,30 @@ const validAddresses = [
   ]
 ];
 
+// see https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki
+// for test cases
 const invalidAddresses = [
+  // invalid hrp
   'tc1qw508d6qejxtdg4y5r3zarvary0c5xw7kg3g4ty',
+  // invalid checksum
   'bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t5',
+  // invalid witness version
   'BC13W508D6QEJXTDG4Y5R3ZARVARY0C5XW7KN40WF2',
+  // invalid program length
   'bc1rw5uspcuh',
+  // invalid program length
   'bc10w508d6qejxtdg4y5r3zarvary0c5xw7kw508d'
   + '6qejxtdg4y5r3zarvary0c5xw7kw5rljs90',
+  // invalid program length for witness version 0
   'BC1QR508D6QEJXTDG4Y5R3ZARVARYV98GJ9P',
+  // mixed case
   'tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q0sL5k7',
+  // zero padding of more than 4 bits
   'tb1pw508d6qejxtdg4y5r3zarqfsj6c3',
-  'tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3pjxtptv'
+  // non zero padding in 8 to 5 conversion
+  'tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3pjxtptv',
+  // empty data section
+  'bc1gmk9yu'
 ];
 
 function createProgram(version, program) {