Skip to main content

Memorable Unique Identifier

Project description

muid

Memorable Unique Identifiers

Wait you say ... that's an oxymoron

Memorable unique identifiers are a provocative misnomer. When generating unique identifiers such as privately used keys, memorability is antithetical to uniqueness. MUIDs might be better termed "hash-memorable" identifiers. They form a subset of UUIDs whose SHA-256 hashes are memorable.

Start mining now

Just want to mine? Run this bash script.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/microprediction/muid/master/examples/mine_from_venv.sh)"

The script will explain itself and the motivation, as it mines. If it doesn't work then maybe try

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install python

although we'd rather not get into a debate about the "best" way to install Python on a mac.

Using the library directly

As per https://muid.readthedocs.io/en/latest/ ...

Install

pip install muid

MUIDs are just like UUIDs (uuid.uuid4)

import muid
key  = muid.muid4(min_len=8)  

Only they take much, much longer to generate because ...

... the SHA-256 hash is memorable

Try this:

print( muid.mhash(key) )    

Don't see it yet? Look closer. Here's an example I just happenned to have lying around:

f01dab1eca70403aa0c700f6c29596c4

This reads a bit like:

Foldable Cat  

Mining

It is trivial to mine for MUIDs.

muid.mine()

At time of writing, mining MUIDs is roughly one order of magnitude more profitable than mining bitcoin even if you use this lousy library to do your mining. With a little work, you should be able to mine with 100x the economics of bitcoin ... at least for a while!

Caching in

There is a bid for MUIDs of len at least min_len where:

min_len = int(requests.get("http://www.microprediction.com/config.json").json()['min_len'])

More details on that soon.

An example of the use of MUIDs

We hope you have your own uses and would love to hear about them. Many applications can benefit from one less join.

Implementation decisions

We welcome thoughtful suggestions at https://github.com/microprediction/muid/issues or https://algorithmia.com/algorithms/microprediction/mverify/discussion.

Choice of hash

muid.mhash() 

Uses SHA-256 hash from hashlib.sha256

Readable hex

Hex strings are just a,b,e,d,e,f plus digits and hyphens, which makes for a sucky game of scrabble. We introduce readable hex as follows:

word.replace('0', 'o').replace('1', 'l').replace('2', 'z').replace('3', 'm').replace('4', 'y').replace(
    '5', 's').replace('6', 'h').replace('7', 't').replace('8', 'x').replace('9', 'g')

which is to say

Hex Human Hex HUman Hex Human
1 l 5 s 9 g
2 z 6 h 0 o
3 m 7 t
4 y 8 x

with a,b,c,d,e,f unchanged of course.

Collisions (forgettaboutit)

It is well appreciated that approximately 2.71 quintillion uuid4() can be generated before the risk of collision exceeds fifty percent (Wikipedia). Thus UUID collisions are a non-issue. But since an MUID collision requires an underlying collision in UUIDs which are generated while mining, a moment's reflection should convince the reader that the computational capacity required to create MUID collisions over any interval of time is at least as large as the computational capacity employed to create UUID collisions. In short, the thing to worry about is the relatively short supply of MUIDs (an obvious limitation) not collisions between them.

Stupid dog trick

https://vimeo.com/396819347

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

muid-0.2.7.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

muid-0.2.7-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file muid-0.2.7.tar.gz.

File metadata

  • Download URL: muid-0.2.7.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for muid-0.2.7.tar.gz
Algorithm Hash digest
SHA256 86fafd85d23d5f4effd35940bc659248fe68ada532a5695affd30a2a9706161e
MD5 9809fdc6427e0d7f645ffd59331ea074
BLAKE2b-256 e95e08cb60a20405451663a1776acec1c716165a4caf16481d7b3fe3ee47d3de

See more details on using hashes here.

File details

Details for the file muid-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: muid-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for muid-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 25dcadc316b0039c57faa0cc6766cf2b15d0eb795819afda07d6feee974d4785
MD5 90a1606c26f55a2fef8ffd45b81ae014
BLAKE2b-256 46ae3e62fbf97ba9d3dc5a94d23e970ca7a5f716a119837446d6d8697e2f292b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page