trait WalletKeyApiAlgebra[F[_]] extends AnyRef
Defines a storage API for fetching and storing Topl Main Key Vault Store.
- Alphabetic
- By Inheritance
- WalletKeyApiAlgebra
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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
- 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
- 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
- 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
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)