Class DerivationPath

java.lang.Object
com.codename1.crypto.hd.DerivationPath

public final class DerivationPath extends Object
A BIP-32 derivation path such as m/44'/60'/0'/0/0: a list of child indices, each hardened when written with ', h or H.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    The offset that marks a hardened index.
  • Method Summary

    Modifier and Type
    Method
    Description
    bip44(int coinType, int account, int change, long index)
    The BIP-44 path m/44'/coin'/account'/change/index.
    child(long index)
    This path with one more index.
    boolean
    Indicates whether some other object is "equal to" this one.
    long
    get(int position)
    The index at a position, including HARDENED when hardened.
    int
    Returns a hash code value for the object.
    boolean
    Tells whether every index is hardened, which Slip10 requires for Ed25519.
    int
    The number of indices.
    of(long[] indices)
    A path from raw indices, each already including HARDENED where wanted.
    parse(String path)
    Parses a path.
    The path in m/44'/60'/0' form.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • HARDENED

      public static final long HARDENED
      The offset that marks a hardened index.
      See Also:
  • Method Details

    • parse

      public static DerivationPath parse(String path)

      Parses a path. A leading m (or m/) is optional; an empty path or m alone is the master key itself.

      Throws
      • IllegalArgumentException: for a component that is not a number below 2^31
    • of

      public static DerivationPath of(long[] indices)
      A path from raw indices, each already including HARDENED where wanted.
    • bip44

      public static DerivationPath bip44(int coinType, int account, int change, long index)
      The BIP-44 path m/44'/coin'/account'/change/index.
    • child

      public DerivationPath child(long index)
      This path with one more index.
    • length

      public int length()
      The number of indices.
    • get

      public long get(int position)
      The index at a position, including HARDENED when hardened.
    • isFullyHardened

      public boolean isFullyHardened()
      Tells whether every index is hardened, which Slip10 requires for Ed25519.
    • toString

      public String toString()
      The path in m/44'/60'/0' form.
      Overrides:
      toString in class Object
    • equals

      public boolean equals(Object o)
      Description copied from class: Object
      Indicates whether some other object is "equal to" this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Description copied from class: Object
      Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables. As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)
      Overrides:
      hashCode in class Object