Packages

object KeyPair extends Serializable

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyPair
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def decodeXdr(pk: org.stellar.xdr.PublicKey): PublicKey
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def fromAccountId(accountId: String): PublicKey

    Creates a new Stellar PublicKey from a strkey encoded Stellar account ID.

    Creates a new Stellar PublicKey from a strkey encoded Stellar account ID.

    accountId

    The strkey encoded Stellar account ID.

    returns

    { @link PublicKey}

  10. def fromAddress(address: String)(implicit ec: ExecutionContext): Future[PublicKey]

    Returns the public key associated with the federated address.

    Returns the public key associated with the federated address.

    address

    formatted as name*domain, as per https://www.stellar.org/developers/guides/concepts/federation.html#stellar-addresses

    returns

    Future[{ @link PublicKey }]

  11. def fromMnemonic(mnemonic: Mnemonic, passphrase: ByteString = new ByteString(Array.empty[Byte]), wordList: WordList = EnglishWords, index: Int = 0): KeyPair

    Creates a new Stellar keypair from a BIP-39 mnemonic phrase.

    Creates a new Stellar keypair from a BIP-39 mnemonic phrase.

    mnemonic

    the mnemonic phrase.

    passphrase

    used when encoding the mnemonic. Defaults to empty String.

    wordList

    the list of words to decode with. Defaults to English.

    index

    of the deterministic wallet address. Defaults to zero.

    returns

    ( @link KeyPair }

  12. def fromMnemonicPhrase(phrase: String, passphrase: ByteString = new ByteString(Array.empty[Byte]), wordList: WordList = EnglishWords, index: Int = 0): KeyPair

    Creates a new Stellar keypair from a BIP-39 mnemonic phrase.

    Creates a new Stellar keypair from a BIP-39 mnemonic phrase.

    phrase

    the mnemonic phrase.

    passphrase

    used when encoding the mnemonic. Defaults to empty String.

    wordList

    the list of words to decode with. Defaults to English.

    index

    of the deterministic wallet address. Defaults to zero.

    returns

    ( @link KeyPair }

  13. def fromPassphrase(passphrase: String): KeyPair

    Creates a new Stellar keypair from a passphrase.

    Creates a new Stellar keypair from a passphrase.

    passphrase

    the secret passphrase.

    returns

    ( @link KeyPair }

  14. def fromPublicKey(publicKey: Seq[Byte]): PublicKey
  15. def fromPublicKey(publicKey: Array[Byte]): PublicKey

    Creates a new Stellar verifying key from a 32 byte address.

    Creates a new Stellar verifying key from a 32 byte address.

    publicKey

    The 32 byte public key.

    returns

    { @link PublicKey }

  16. def fromSecretSeed(seed: Array[Byte]): KeyPair

    Creates a new Stellar keypair from a raw 32 byte secret seed.

    Creates a new Stellar keypair from a raw 32 byte secret seed.

    seed

    The 32 byte secret seed.

    returns

    { @link KeyPair}

  17. def fromSecretSeed(seed: ByteString): KeyPair

    Creates a new Stellar keypair from a raw 32 byte secret seed.

    Creates a new Stellar keypair from a raw 32 byte secret seed.

    seed

    The 32 byte secret seed.

    returns

    { @link KeyPair}

  18. def fromSecretSeed(seed: String): KeyPair

    Insecure Creates a new Stellar KeyPair from a strkey encoded Stellar secret seed.

    Insecure Creates a new Stellar KeyPair from a strkey encoded Stellar secret seed. This method is <u>insecure</u>. Use only if you are aware of security implications.

    seed

    The strkey encoded Stellar secret seed.

    returns

    { @link KeyPair}

    See also

    Using Password-Based Encryption

  19. def fromSecretSeed(seed: Seq[Char]): KeyPair

    Creates a new Stellar KeyPair from a strkey encoded Stellar secret seed.

    Creates a new Stellar KeyPair from a strkey encoded Stellar secret seed.

    seed

    Char array containing strkey encoded Stellar secret seed.

    returns

    { @link KeyPair}

  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def random: KeyPair

    Generates a random Stellar keypair.

    Generates a random Stellar keypair.

    returns

    a random Stellar keypair.

  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped