RFC-0152/EmojiId

Emoji Id specification

status: stable

Maintainer(s):Cayle Sharrock

Licence

The 3-Clause BSD Licence.

Copyright 2022. The Tari Development Community

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of this document must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS DOCUMENT IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS", AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Language

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY" and "OPTIONAL" in this document are to be interpreted as described in BCP 14 (covering RFC2119 and RFC8174) when, and only when, they appear in all capitals, as shown here.

Disclaimer

This document and its content are intended for information purposes only and may be subject to change or update without notice.

This document may include preliminary concepts that may or may not be in the process of being developed by the Tari community. The release of this document is intended solely for review and discussion by the community regarding the technological merits of the potential system outlined herein.

Goals

This document describes the specification for Emoji Ids. Emoji Ids are encoded node ids used for humans to verify peer node addresses easily and for machines to verify that the address is being used in the correct context.

None

Description

Tari Communication Nodes are identified on the network via their Node ID; which in turn are derived from the node's public key. Both the node id and public key are simple large integer numbers.

The most common practice for human beings to copy large numbers in cryptocurrency software is scanning a QR code or copying and pasting a value from one application to another. These numbers are typically encoded using hexadecimal or Base58 encoding. The user will then typically scan (parts) of the string by eye to ensure that the value was transferred correctly.

For Tari, we propose encoding values, the node ID in particular and masking the network identifier, for Tari, using emojis. The advantages of this approach are:

  • Emoji are more easily identifiable; and, if selected carefully, less prone to identification errors (e.g., mistaking an O for a 0).
  • The alphabet can be considerably larger than hexadecimal (16) or Base58 (58), resulting in shorter character sequences in the encoding.
  • Should be be able to detect if the address used belongs to the correct network.

The specification

Emoji map

An emoji alphabet of 256 characters is selected. Each emoji is assigned a unique index from 0 to 255 inclusive. The list of selected emojis is:

๐Ÿฆ‹๐Ÿ“Ÿ๐ŸŒˆ๐ŸŒŠ๐ŸŽฏ๐Ÿ‹๐ŸŒ™๐Ÿค”๐ŸŒ•โญ๐ŸŽ‹๐ŸŒฐ๐ŸŒด๐ŸŒต๐ŸŒฒ๐ŸŒธ
๐ŸŒน๐ŸŒป๐ŸŒฝ๐Ÿ€๐Ÿ๐Ÿ„๐Ÿฅ‘๐Ÿ†๐Ÿ‡๐Ÿˆ๐Ÿ‰๐ŸŠ๐Ÿ‹๐ŸŒ๐Ÿ๐ŸŽ
๐Ÿ๐Ÿ‘๐Ÿ’๐Ÿ“๐Ÿ”๐Ÿ•๐Ÿ—๐Ÿš๐Ÿž๐ŸŸ๐Ÿฅ๐Ÿฃ๐Ÿฆ๐Ÿฉ๐Ÿช๐Ÿซ
๐Ÿฌ๐Ÿญ๐Ÿฏ๐Ÿฅ๐Ÿณ๐Ÿฅ„๐Ÿต๐Ÿถ๐Ÿท๐Ÿธ๐Ÿพ๐Ÿบ๐Ÿผ๐ŸŽ€๐ŸŽ๐ŸŽ‚
๐ŸŽƒ๐Ÿค–๐ŸŽˆ๐ŸŽ‰๐ŸŽ’๐ŸŽ“๐ŸŽ ๐ŸŽก๐ŸŽข๐ŸŽฃ๐ŸŽค๐ŸŽฅ๐ŸŽง๐ŸŽจ๐ŸŽฉ๐ŸŽช
๐ŸŽฌ๐ŸŽญ๐ŸŽฎ๐ŸŽฐ๐ŸŽฑ๐ŸŽฒ๐ŸŽณ๐ŸŽต๐ŸŽท๐ŸŽธ๐ŸŽน๐ŸŽบ๐ŸŽป๐ŸŽผ๐ŸŽฝ๐ŸŽพ
๐ŸŽฟ๐Ÿ€๐Ÿ๐Ÿ†๐Ÿˆโšฝ๐Ÿ ๐Ÿฅ๐Ÿฆ๐Ÿญ๐Ÿฐ๐Ÿ€๐Ÿ‰๐ŸŠ๐ŸŒ๐Ÿ
๐Ÿฆ๐Ÿ๐Ÿ‘๐Ÿ”๐Ÿ™ˆ๐Ÿ—๐Ÿ˜๐Ÿ™๐Ÿš๐Ÿ›๐Ÿœ๐Ÿ๐Ÿž๐Ÿข๐Ÿฃ๐Ÿจ
๐Ÿฆ€๐Ÿช๐Ÿฌ๐Ÿญ๐Ÿฎ๐Ÿฏ๐Ÿฐ๐Ÿฆ†๐Ÿฆ‚๐Ÿด๐Ÿต๐Ÿถ๐Ÿท๐Ÿธ๐Ÿบ๐Ÿป
๐Ÿผ๐Ÿฝ๐Ÿพ๐Ÿ‘€๐Ÿ‘…๐Ÿ‘‘๐Ÿ‘’๐Ÿงข๐Ÿ’…๐Ÿ‘•๐Ÿ‘–๐Ÿ‘—๐Ÿ‘˜๐Ÿ‘™๐Ÿ’ƒ๐Ÿ‘›
๐Ÿ‘ž๐Ÿ‘Ÿ๐Ÿ‘ ๐ŸฅŠ๐Ÿ‘ข๐Ÿ‘ฃ๐Ÿคก๐Ÿ‘ป๐Ÿ‘ฝ๐Ÿ‘พ๐Ÿค ๐Ÿ‘ƒ๐Ÿ’„๐Ÿ’ˆ๐Ÿ’‰๐Ÿ’Š
๐Ÿ’‹๐Ÿ‘‚๐Ÿ’๐Ÿ’Ž๐Ÿ’๐Ÿ’”๐Ÿ”’๐Ÿงฉ๐Ÿ’ก๐Ÿ’ฃ๐Ÿ’ค๐Ÿ’ฆ๐Ÿ’จ๐Ÿ’ฉโž•๐Ÿ’ฏ
๐Ÿ’ฐ๐Ÿ’ณ๐Ÿ’ต๐Ÿ’บ๐Ÿ’ป๐Ÿ’ผ๐Ÿ“ˆ๐Ÿ“œ๐Ÿ“Œ๐Ÿ“Ž๐Ÿ“–๐Ÿ“ฟ๐Ÿ“กโฐ๐Ÿ“ฑ๐Ÿ“ท
๐Ÿ”‹๐Ÿ”Œ๐Ÿšฐ๐Ÿ”‘๐Ÿ””๐Ÿ”ฅ๐Ÿ”ฆ๐Ÿ”ง๐Ÿ”จ๐Ÿ”ฉ๐Ÿ”ช๐Ÿ”ซ๐Ÿ”ฌ๐Ÿ”ญ๐Ÿ”ฎ๐Ÿ”ฑ
๐Ÿ—ฝ๐Ÿ˜‚๐Ÿ˜‡๐Ÿ˜ˆ๐Ÿค‘๐Ÿ˜๐Ÿ˜Ž๐Ÿ˜ฑ๐Ÿ˜ท๐Ÿคข๐Ÿ‘๐Ÿ‘ถ๐Ÿš€๐Ÿš๐Ÿš‚๐Ÿšš
๐Ÿš‘๐Ÿš’๐Ÿš“๐Ÿ›ต๐Ÿš—๐Ÿšœ๐Ÿšข๐Ÿšฆ๐Ÿšง๐Ÿšจ๐Ÿšช๐Ÿšซ๐Ÿšฒ๐Ÿšฝ๐Ÿšฟ๐Ÿงฒ

The emoji have been selected such that:

  • Similar-looking emoji are excluded from the map. For example, neither ๐Ÿ˜ or ๐Ÿ˜„ should be included. Similarly, the Irish and Cรดte d'Ivoire flags look very similar, and both should be excluded.
  • Modified emoji (skin tones, gender modifiers) are excluded. Only the "base" emoji are considered.

The selection of an alphabet with 256 symbols means there is a direct mapping between bytes and emoji.

Encoding

The emoji ID is calculated from a node public key B (serialized as 32 bytes) and a network identifier N (serialized as 8 bits) as follows:

  • Use the DammSum algorithm with k = 8 and m = 32 to compute an 8-bit checksum C using B as input.
  • Compute the masked checksum C' = C XOR N.
  • Encode B into an emoji string using the emoji map.
  • Encode C' into an emoji character using the emoji map.
  • Concatenate B and C' as the emoji ID.

The result is 33 emoji characters.

Decoding

The node public key is obtained from an emoji ID and a network identifier N (serialized to 8 bits) as follows:

  • Assert that the emoji ID contains exactly 33 valid emoji characters from the emoji alphabet. If not, return an error.
  • Decode the emoji ID as an emoji string by mapping each emoji character to a byte value using the emoji map, producing 33 bytes. Let B be the first 32 bytes and C' be the last byte.
  • Compute the unmasked checksum C = C' XOR N.
  • Use the DammSum validation algorithm on B to assert that C is the correct checksum. If not, return an error.
  • Attempt to deserialize B as a public key. If this fails, return an error. If it succeeds, return the public key.

Checksum effectiveness

It is important to note that masking the checksum reduces its effectiveness. Namely, if an emoji ID is presented with a different network identifier, and if there is a transmission error, it is possible for the result to decode in a seemingly valid way with a valid checksum after unmasking. If both conditions occur randomly, the likelihood of this occurring is n / 256 for n possible network identifiers.

Since emoji ID will typically be copied digitally and therefore not particularly subject to transmission errors, so it seems unlikely for these conditions to coincide in practice.

Change Log

DateChangeAuthor
2022-11-10Initial stableSWvHeerden
2022-11-11Algorithm improvementsAaronFeickert