🛑 Important BREAKING fix in Bytewords and UR

[wolfmcnally]

@gorazdko filed an issue with Bytewords that I have dubbed the Bytewords wordlist alphabetizing error. Due to last-minute tweaks, I neglected to properly maintain the master Bytewords list in alphabetical order, which is one of the guarantees the spec makes. As a result, I inadvertently left two sequencing errors in the word list:

• The word list is out of sequence.

INCORRECT: 0x80: lava lazy leaf legs liar list limp lion
CORRECTED: 0x80: lava lazy leaf legs liar limp lion list

• The word zero is out of sequence.

INCORRECT: 0xf8: yoga yurt zaps zest zinc zone zoom zero
CORRECTED: 0xf8: yoga yurt zaps zero zest zinc zone zoom

The old, incorrect word list ends with the word zero. The new, corrected word list ends with the word zoom.

As this correction changes the word list that all Bytewords is based on, all the code based on it directly or indirectly, MUST be updated ASAP. I have already updated bc-bytewords (C), bc-ur (C++), and URKit (Swift), all of which directly encode and decode Bytewords. Indirectly, I have also updated seedtool (C++) and URDemo (Swift), which depend on the lower-level libraries. In addition, I have updated all the examples in the Blockchain Commons research repo to use the fixed version of Bytewords, including and especially the Bytewords spec itself.

Please make sure that you are using the latest tagged versions of these libraries, which are as of this writing:

• https://github.com/BlockchainCommons/bc-bytewords/releases/tag/0.2.0
• https://github.com/BlockchainCommons/bc-ur/releases/tag/0.2.0
• https://github.com/BlockchainCommons/URKit/releases/tag/2.0.0
• https://github.com/BlockchainCommons/bc-seedtool-cli/releases/tag/0.9.0
• https://github.com/BlockchainCommons/URDemo/releases/tag/2.0.0

If your work currently depends on Bytewords or Uniform Resources (URs) it is imperative you update your code now. I sincerely apologize for any inconvenience this oversight has caused, but thanks to our community testing our code, we are actively catching and fixing everything that comes to our attention.

🐺 Wolf McNally