Packages

class KeyRing[S <: Secret, KF <: Keyfile[S]] extends AnyRef

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

Instance Constructors

  1. new KeyRing(keyDirectory: Option[File], secrets: Set[S] = Set())(implicit networkPrefix: NetworkPrefix, secretGenerator: SecretGenerator[S], keyfileCompanion: KeyfileCompanion[S, KF])

Type Members

  1. type PK = S.PK
  2. type PR = S.PR

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. def addresses: Set[Address]

    Retrieves a list of public images for the secrets currently held in the keyring

    Retrieves a list of public images for the secrets currently held in the keyring

    returns

    - the public keys as ProofOfKnowledgePropositions

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def generateAttestation(addresses: Set[Address])(messageToSign: Array[Byte]): Map[PK, PR]
  11. def generateAttestation(addr: Address)(messageToSign: Array[Byte]): Map[PK, PR]

    Generate an attestation map using the given address and message to sign

    Generate an attestation map using the given address and message to sign

    addr

    address to lookup the proposition associated with the proof that is needed

    messageToSign

    the message that should be committed to

    returns

    a map that can be inserted into a transaction

  12. def generateNewKeyPairs(num: Int = 1, seedOpt: Option[String] = None): Try[Set[S]]

    Generates a new keypair and updates the key ring with the new secret

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def importKeyPair(keyfile: KF, password: String): Try[Address]

    Attempts to import a keyfile into the key ring

    Attempts to import a keyfile into the key ring

    keyfile

    encrypted keyfile that will be added

    password

    password for decrypting the keyfile

    returns

    the address of the key pair for this network

  16. def importPhrase(password: String, mnemonic: String, lang: String)(implicit sg: SecretGenerator[S]): Try[Address]

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def lookupPublicKey(addr: Address): Try[PK]

    Lookup the public key associated with an address

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def removeFromKeyring(address: Address): Try[Unit]

    Removes an address from the keyring so that it is not available for signing any longer

    Removes an address from the keyring so that it is not available for signing any longer

    address

    network specific address to be removed

    returns

    a try indicating whether the key ring was successfully mutated or not

  23. def signWithAddress(addr: Address)(messageToSign: Array[Byte]): Try[PR]

    Generate a signature using the secret key associated with an Address

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

Inherited from AnyRef

Inherited from Any

Ungrouped