Git Product home page Git Product logo

mnemonic's Introduction

Mnemonic

Mnemonic is a Go library which which generates mnemonics, which is a way of representing a large randomly-generated number as a sequence of words. A mnemonic gives us a convenient way to store this number, these words then may be used to create a seed. For example we could represent a 128 bit number as the following sequence of words:

"window pig filter walk eye damage arena turtle loyal lobster live act"

The greater the number the larger the sequence of words will be, a 256 bit number would generate a sequence of 24 words.

Installation

$ go get github.com/umahmood/mnemonic

Usage

package main

import (
    "fmt"

    "github.com/umahmood/mnemonic"
)

func main() {
    m, err := mnemonic.New(mnemonic.DefaultConfig) // default 128 bits
    if err != nil {
        // ...
    }
    words, err := m.Words()
    if err != nil {
        // ...
    }
    fmt.Println(words)
}

Output:

[wild cause filter walk eye damage arena turtle loyal lobster live add]

Specifying a non-default config.:

m, err := mnemonic.New(mnemonic.Config{ 
    Bits: 256, // must be a multiple of 32
})

You can specify a passphrase which will be used in generating a seed:

m, err := mnemonic.New(mnemonic.Config{ 
    Bits:       256,
    Passphrase: "To the moon!",
})

Documentation

https://pkg.go.dev/github.com/umahmood/mnemonic

License

See the LICENSE file for license rights and limitations (MIT).

mnemonic's People

Contributors

umahmood avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.