MIT licensed by Jared Tobin
Maintained by [email protected]
This version can be pinned in stack with:urbit-hob-0.3.3@sha256:ff8dae3844881cd979fee96bcb3ab3d5ea95f7c3ad2302dbc4b2dc417ff6595b,3849

Module documentation for 0.3.3

Here you can primarily find functions for dealing with the "patp" and "patq" phonetic bases used by Urbit. The @p encoding is used for naming ships, while the @q encoding is used for arbitrary data; they each uniquely represent an underlying natural number (or atom) in a memorable and pronounceable fashion.

The @p encoding is an obfuscated representation of an underlying atom, in particular, hence the "ob" in the library's name.

The Urbit.Ob module exposes two families of functions, patp and fromPatp, and then patq and fromPatq, for converting between representations. You can also render a Patp or Patq value as Text via the renderPatp and renderPatq functions, or parse them from Text via parsePatp and parsePatq.

Since @p values represent ships, some utilities for dealing with ships are also exposed. The clan and sein functions are useful for determining a ship's class and (default) parent, respectively.

Some quick examples:

:set -XOverloadedStrings
import qualified Urbit.Ob as Ob
let nidsut = Ob.patp 15663360
let marzod = Ob.patq (Ob.fromPatp nidsut)
Ob.renderPatp nidsut
Ob.renderPatq marzod
Ob.fromPatp nidsut
Ob.parsePatp "~nidsut-tomdun"
Right ~nidsut-tomdun
Ob.clan nidsut
Ob.sein nidsut