Skip to content

Commit fbda1db

Browse files
authored
Update README.md
1 parent ce6e3df commit fbda1db

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ An encoding/decoding method that allows users to compress their human-readable d
1313

1414
## Warning:
1515

16-
This software is still in its experimental phase (including debugging, redesign and error-checking/testing) and should not be relied upon for production.
16+
This software is still in its experimental phase (including debugging, redesign and error-checking/testing) and should not be relied upon for production. For example, as of April 30 before the conclusion of the Ethereal Hackathon our Javascript versions of the Decoder were still being debugged. And while our Python versions were fully functional and working correctly, when encoding a binary string that contains leading padded-zeroes (i.e. empty placeholder values not part of an actual number but simply indicating a potential range of numbers that the acutal number is within) those zeroes are not mapped and therefore when decoding Hatnotated data that originally contained such numbers, they will be lost (i.e. were lost on encoding and thus are not there when decoding either). There is a workaround for this that is being considered, but the onus is on the user to know such data when initially encoding any aribtrary string. For the sake of mnemonics used in this example the solution is easy, but other cases could be more complex. See this issue for more on leading zeroes: https://github.com/hatgit/hatnotation/issues/6
1717

1818
## Background on Mnemonics (private keys) and Human vs Machine-readable code
1919

@@ -49,6 +49,8 @@ In terms of actual pre-image resistance, the initial entropy should be generated
4949
5050
- >Hatnotation format:
5151
> `9$B_,4-C$T(W_O;-)B'0N`
52+
53+
NOTE: The above binary string contains two leading zeroes (from a total of four) which are lost during encoding.
5254

5355

5456
## Important
@@ -171,8 +173,6 @@ In Python version 3.7 using the strings library, the following steps can be take
171173

172174
- And the following four remain excluded/reserved ~~```"\/|~"```~~).
173175

174-
175-
176176
## Requirements
177177

178178
Python 3 or higher

0 commit comments

Comments
 (0)