Show / Hide Table of Contents

    Class Mnemonic

    Provides an easy way to create mnemonics from 32-byte length keys.

    Inheritance
    System.Object
    Mnemonic
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Algorand
    Assembly: Algorand.dll
    Syntax
    public class Mnemonic

    Methods

    | Improve this Doc View Source

    FromKey(Byte[])

    Converts a 32-byte key into a 25 word mnemonic. The generated mnemonic includes a checksum. Each word in the mnemonic represents 11 bits of data, and the last 11 bits are reserved for the checksum.

    Declaration
    public static string FromKey(byte[] key)
    Parameters
    Type Name Description
    System.Byte[] key

    32 byte length key

    Returns
    Type Description
    System.String

    the mnemonic

    | Improve this Doc View Source

    ToKey(String)

    toKey converts a mnemonic generated using this library into the source key used to create it. It returns an error if the passed mnemonic has an incorrect checksum, if the number of words is unexpected, or if one of the passed words is not found in the words list.

    Declaration
    public static byte[] ToKey(string mnemonicStr)
    Parameters
    Type Name Description
    System.String mnemonicStr

    words delimited by MNEMONIC_DELIM

    Returns
    Type Description
    System.Byte[]

    32 byte array key

    • Improve this Doc
    • View Source
    Back to top Generated by DocFX