Documentation

Hoon's @p encoding.

This encoding is an obfuscated representation of some underlying number, but a pronounceable, memorable, and unique one.

The representation exists for any natural number, but it's typically used only for naming Azimuth points, and thus normal 32-bit Urbit ships.

(It's also used for naming comets, i.e. self-signed 128-bit Urbit ships.)

Hoon's @q encoding.

Unlike @p, the @q encoding is a non-obfuscated representation of an atom.

It's typically used for serializing arbitrary data in a memorable and pronounceable fashion.

Convert a Natural to @p.

>>> patp 0
~zod
>>> patp 256
~marzod
>>> patp 65536
~dapnep-ronmyl
>>> patp 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
~fipfes-fipfes-fipfes-fipfes--fipfes-fipfes-fipfes-fipfes

Convert a Natural to @q.

>>> patq 0
~zod
>>> patp 256
~marzod
>>> patp 65536
~nec-dozzod
>>> patp 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
~fipfes-fipfes-fipfes-fipfes-fipfes-fipfes-fipfes-fipfes

Convert a @p value to its corresponding Natural.

>>> let zod = patp 0
>>> fromPatp zod
0

Convert a @q value to its corresponding Natural.

>>> let zod = patq 0
>>> fromPatq zod
0

Render a @p value as Text.

>>> renderPatp (patp 0)
"~zod"
>>> renderPatp (patp 15663360)
"~nidsut-tomdun"

Render a @p value as Text.

>>> renderPatq (patq 0)
"~zod"
>>> renderPatq (patq 15663360)
"~mun-marzod"

Parse a @p value existing as Text.

>>> parsePatp "~nidsut-tomdun"
Right ~nidsut-tomdun
> parsePatp "~fipfes-fipfes-fipfes-doznec"
Right ~fipfes-fipfes-fipfes-doznec

Parse a @q value existing as Text.

>>> parsePatq "~nec-dozzod"
Right ~nec-dozzod
> parsePatq "~fipfes-fipfes-fipfes-doznec"
Right ~fipfes-fipfes-fipfes-doznec