trait WalletKeyApiAlgebra[F[_]] extends AnyRef

Defines a storage API for fetching and storing Topl Main Key Vault Store.

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

Abstract Value Members

  1. abstract def deleteMainKeyVaultStore(name: String): F[Either[WalletKeyException, Unit]]

    Delete a persisted VaultStore for the Topl Main Secret Key.

    Delete a persisted VaultStore for the Topl Main Secret Key.

    name

    The name identifier of the VaultStore to delete. This is used to manage multiple wallet identities. Most commonly, only one wallet identity will be used. It is the responsibility of the dApp to manage the names of the wallet identities if multiple will be used.

    returns

    nothing if successful. If the deletion fails due to an underlying cause (for ex does not exist), return a DataApiException

  2. abstract def getMainKeyVaultStore(name: String): F[Either[WalletKeyException, VaultStore[F]]]

    Return the VaultStore for the Topl Main Secret Key.

    Return the VaultStore for the Topl Main Secret Key.

    name

    The name identifier of the VaultStore. This is used to manage multiple wallet identities. Most commonly, only one wallet identity will be used. It is the responsibility of the dApp to manage the names of the wallet identities if multiple will be used.

    returns

    The VaultStore for the Topl Main Secret Key if it exists. If retrieving fails due to an underlying cause, return a DataApiException

  3. abstract def saveMainKeyVaultStore(mainKeyVaultStore: VaultStore[F], name: String): F[Either[WalletKeyException, Unit]]

    Persist a VaultStore for the Topl Main Secret Key.

    Persist a VaultStore for the Topl Main Secret Key.

    mainKeyVaultStore

    The VaultStore to persist

    name

    The name identifier of the VaultStore. This is used to manage multiple wallet identities. Most commonly, only one wallet identity will be used. It is the responsibility of the dApp to manage the names of the wallet identities if multiple will be used.

    returns

    nothing if successful. If persisting fails due to an underlying cause, return a DataApiException

  4. abstract def saveMnemonic(mnemonic: IndexedSeq[String], mnemonicName: String): F[Either[WalletKeyException, Unit]]

    Persist a mnemonic used to recover a Topl Main Secret Key.

    Persist a mnemonic used to recover a Topl Main Secret Key.

    mnemonic

    The mnemonic to persist

    mnemonicName

    The name identifier of the mnemonic.

    returns

    nothing if successful. If persisting fails due to an underlying cause, return a WalletKeyException

  5. abstract def updateMainKeyVaultStore(mainKeyVaultStore: VaultStore[F], name: String): F[Either[WalletKeyException, Unit]]

    Update a persisted VaultStore for the Topl Main Secret Key.

    Update a persisted VaultStore for the Topl Main Secret Key.

    name

    The name identifier of the VaultStore to update. This is used to manage multiple wallet identities. Most commonly, only one wallet identity will be used. It is the responsibility of the dApp to manage the names of the wallet identities if multiple will be used.

    returns

    nothing if successful. If the update fails due to an underlying cause (for ex does not exist), return a DataApiException

Concrete 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]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped