/ 
App-BIP39Utils-0.001
River stage one • 1 direct dependent • 1 total dependent
/ App::BIP39Utils

NAME

App::BIP39Utils - Collection of CLI utilities related to BIP39

VERSION

This document describes version 0.001 of App::BIP39Utils (from Perl distribution App-BIP39Utils), released on 2018-01-01.

DESCRIPTION

This distribution provides the following command-line utilities related to BIP39:

Keywords: bitcoin, cryptocurrency, BIP, bitcoin improvement proposal, mnemonic phrase.

FUNCTIONS

gen_bip39_mnemonic_phrase

Usage:

gen_bip39_mnemonic_phrase(%args) -> [status, msg, result, meta]

Generate BIP39 mnemonic phrase.

This function is not exported.

Arguments ('*' denotes required arguments):

  • language => str (default: "en")

    Pick which language wordlist to use.

    Will retrieve wordlist from WordList::<LANG_CODE>::BIP39 Perl module.

    For Chinese (simplified), use zh-simplified. For Chinese (traditional), use zh-traditional.

  • length => posint (default: 12)

    Number of words to produce.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-BIP39Utils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-BIP39Utils.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-BIP39Utils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

https://en.bitcoin.it/wiki/Mnemonic_phrase

https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki

WordList::EN::BIP39 and BIP39 for the other languages in WordList::*::BIP39.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.