urbit-ob
v5.0.1
Published
Utilities for Hoon-style atom printing and conversion
Downloads
653
Readme
urbit-ob
Utilities for phonetic base wrangling.
What
Here you can primarily find functions for dealing with the phonetic bases
used by Urbit. The @p
encoding is used for naming ships, while the @q
encoding is used for representing arbitrary data in a memorable and
pronounceable fashion.
The @p
encoding is an obfuscated representation of an underlying 32-bit
number, in particular, hence the 'ob' in the library's name.
Install
You can grab the library from npm via:
npm install urbit-ob
Otherwise you can just clone the repo, and a simple npm install
will pull
down the dependencies.
Usage
The library exposes two families of functions:
patp / patp2dec / patp2hex / hex2patp / isValidPatp
patq / patq2dec / patq2hex / hex2patq / isValidPatq
They are pretty self-explanatory. Use patp
or patq
to convert base-10
numbers (or strings encoding base-10 numbers) to @p
or @q
respectively.
Use patp2dec
or patq2dec
to go in reverse. patp2hex
, patq2hex
, and
their inverses work similarly. isValidPat{p, q}
can be used to check the
validity of a @p
or @q
string.
Some examples:
> const ob = require('urbit-ob')
> ob.patp('0')
'~zod'
> ob.patp2dec('~nidsut-tomdun')
'15663360'
> ob.hex2patq('010203')
'~doznec-binwes'
> ob.patq2hex('~marned-wismul-nilsev-botnyt')
'01ca0e51d20462f3'
> ob.isValidPatq('~marned-wismul-nilsev-botnyt')
> true
There are a few other noteworthy functions exposed as well:
clan
, for determining the ship class of a@p
valuesein
, for determining the parent of a@p
valueeqPatq
, for comparing@q
values for equalityisValidPat
, for a faster/weaker check of@p
or@q
-ness that only validates syllables (and not proper dash formatting)
For example, you can check that ~marzod
is a star with parent ~zod
:
> ob.clan('~marzod')
'star'
> ob.sein('~marzod')
'~zod'
And note that @q
values are considered equal modulo the existence of leading
zero bytes:
> '~doznec-marzod' === '~nec-marzod'
false
> ob.eqPatq('~doznec-marzod', '~nec-marzod')
true
Testing
A simple npm test
will run the test suite.
Building
npm run build
will build the library for the browser.
See Also
- urbit-hob -- Haskell bindings