cbschuld / php-uuid-base58
Generates a RFC4122 compliant v4 UUID and returns it encoded in base-58. This is great for creating unique IDs which only consume 22 characters of storage. Also provides base-58 encoding and decoding.
Installs: 8 181
Dependents: 2
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 0
Requires
- ramsey/uuid: ^4.0
Requires (Dev)
- phpunit/phpunit: ^9.1
This package is auto-updated.
Last update: 2024-10-11 14:53:54 UTC
README
Generates a RFC4122 compliant v4 UUID and returns it encoded in base-58. This is great for creating unique IDs which only consume 22 characters of storage. Also provides base-58 encoding and decoding.
Installation
composer require cbschuld/php-uuid-base58
Usage
use cbschuld\UuidBase58; $id = UuidBase58::id();
API
The UuidBase58 class provides three static functions
id
- creates the RFC4122 v4 UUID encoded in base-58encode(string)
- encodes a base-16 string in base-58decode(string)
- decodes a string from base-58 to base-16
Testing
npm run test
Performance Hit
There is an additional performance hit to translate a v4 UUID into base58. In testing I found the overhead for the translation to base58 adds an additional 31%. In 100k calculation batches I found that v4 uuid calculation took 1.606s/100k vs 2.319s/100k for uuid58. Thus, 69% of the runtime was consumed calculating a v4 uuid. Additional work could be done to bring the uuid calculation internal and attempt to increase performance.
Base58 Alphabet
This solution uses the Bitcoin / IPFS hash alphabet: 123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz
Additional information on Base-58.
Contact
Twitter - @cbschuld
Contributing
Yes, thank you! Please update the docs and tests and add your name to the package.json file.