Package com.kryptokrauts.aeternity.sdk.service.keypair

Interface KeyPairService

All Known Implementing Classes:
KeyPairServiceImpl
public interface KeyPairService

  • Method Summary

    Modifier and Type Method Description
    HdWallet generateHdWallet​(java.lang.String mnemonicSeedPassword)
    creates a keyPair as well as a list of mnemonic seed words wrapped into HdWallet object, which can be used to restore the key (derived from BIP32/39 HD-Wallet generation) the number of seed words depends on the parameter defined in KeyPairServiceConfiguration
    KeyPair generateKeyPair()  
    HdKeyPair getNextKeyPair​(HdWallet hdWallet)
    derives the next hardened key.
    HdWallet recoverHdWallet​(java.util.List<java.lang.String> mnemonicSeedWords, java.lang.String mnemonicSeedPassword)
    recover keypair from given mnemonic seed word list with given seed password
    KeyPair recoverKeyPair​(java.lang.String privateKey)  

  • Method Details

    • generateKeyPair

      KeyPair generateKeyPair()
      Returns:
      a byte arrayed keypair

    • recoverKeyPair

      KeyPair recoverKeyPair​(java.lang.String privateKey)
      Parameters:
      privateKey - private key (hex)
      Returns:
      the recovered keypair

    • generateHdWallet

      HdWallet generateHdWallet​(java.lang.String mnemonicSeedPassword) throws AException
      creates a keyPair as well as a list of mnemonic seed words wrapped into HdWallet object, which can be used to restore the key (derived from BIP32/39 HD-Wallet generation) the number of seed words depends on the parameter defined in KeyPairServiceConfiguration
      Parameters:
      mnemonicSeedPassword - password or null which is used to seed the list of mnemonics
      Returns:
      keypair with private and public key as well as the generated list of mnemonic seed words wrapped into HdWallet
      Throws:
      AException - in case of an error

    • recoverHdWallet

      HdWallet recoverHdWallet​(java.util.List<java.lang.String> mnemonicSeedWords, java.lang.String mnemonicSeedPassword) throws AException
      recover keypair from given mnemonic seed word list with given seed password
      Parameters:
      mnemonicSeedWords - the words to recover the Hdwallet
      mnemonicSeedPassword - the password that protects the keypair(s) generated with the seed phrase (can be null)
      Returns:
      instance of HdWallet
      Throws:
      AException - in case of an error

    • getNextKeyPair

      HdKeyPair getNextKeyPair​(HdWallet hdWallet) throws AException
      derives the next hardened key. The derived keys are generated according to the deterministic tree saved within the given menomincKeyPair stated in BIP32
      Parameters:
      hdWallet - mnemonicKeyPair containing the deterministic tree of keys necessary for derivation
      Returns:
      a new derived child raw keypair
      Throws:
      AException - in case of an error