KeyManager

interface KeyManager
Content copied to clipboard

Types

Companion
Link copied to clipboard
common
object Companion
Content copied to clipboard

Functions

channelKeyPath
Link copied to clipboard
common
open fun channelKeyPath(fundingKeyPath: KeyPath, channelConfig: ChannelConfig): KeyPath
Content copied to clipboard
open fun channelKeyPath(localParams: LocalParams, channelConfig: ChannelConfig): KeyPath
Content copied to clipboard
channelKeys
Link copied to clipboard
common
abstract fun channelKeys(fundingKeyPath: KeyPath): ChannelKeys
Content copied to clipboard

generate channel-specific keys and secrets

closingPubkeyScript
Link copied to clipboard
common
abstract fun closingPubkeyScript(fundingPubKey: PublicKey): Pair<PublicKey, ByteArray>
Content copied to clipboard
commitmentPoint
Link copied to clipboard
common
abstract fun commitmentPoint(shaSeed: ByteVector32, index: Long): PublicKey
Content copied to clipboard
abstract fun commitmentPoint(channelKeyPath: KeyPath, index: Long): PublicKey
Content copied to clipboard
commitmentSecret
Link copied to clipboard
common
abstract fun commitmentSecret(shaSeed: ByteVector32, index: Long): PrivateKey
Content copied to clipboard
abstract fun commitmentSecret(channelKeyPath: KeyPath, index: Long): PrivateKey
Content copied to clipboard
delayedPaymentPoint
Link copied to clipboard
common
abstract fun delayedPaymentPoint(channelKeyPath: KeyPath): DeterministicWallet.ExtendedPublicKey
Content copied to clipboard
fundingPublicKey
Link copied to clipboard
common
abstract fun fundingPublicKey(keyPath: KeyPath): DeterministicWallet.ExtendedPublicKey
Content copied to clipboard
htlcPoint
Link copied to clipboard
common
abstract fun htlcPoint(channelKeyPath: KeyPath): DeterministicWallet.ExtendedPublicKey
Content copied to clipboard
newFundingKeyPath
Link copied to clipboard
common
abstract fun newFundingKeyPath(isFunder: Boolean): KeyPath
Content copied to clipboard
paymentPoint
Link copied to clipboard
common
abstract fun paymentPoint(channelKeyPath: KeyPath): DeterministicWallet.ExtendedPublicKey
Content copied to clipboard
recoverChannelKeys
Link copied to clipboard
common
abstract fun recoverChannelKeys(fundingPubKey: PublicKey): RecoveredChannelKeys
Content copied to clipboard

generate channel-specific keys and secrets (note that we cannot re-compute the channel's funding private key)

revocationPoint
Link copied to clipboard
common
abstract fun revocationPoint(channelKeyPath: KeyPath): DeterministicWallet.ExtendedPublicKey
Content copied to clipboard
sign
Link copied to clipboard
common
abstract fun sign(tx: Transactions.TransactionWithInputInfo, privateKey: PrivateKey): ByteVector64
Content copied to clipboard
abstract fun sign(tx: Transactions.TransactionWithInputInfo, privateKey: PrivateKey, remoteSecret: PrivateKey): ByteVector64
Content copied to clipboard

Ths method is used to spend revoked transactions, with the corresponding revocation key

abstract fun sign(tx: Transactions.TransactionWithInputInfo, privateKey: PrivateKey, remotePoint: PublicKey, sigHash: Int): ByteVector64
Content copied to clipboard

This method is used to spend funds send to htlc keys/delayed keys

Properties

legacyNodeKey
Link copied to clipboard
common
abstract val legacyNodeKey: DeterministicWallet.ExtendedPrivateKey
Content copied to clipboard

The node key that the same seed would have produced on the legacy eclair-based Phoenix implementation on Android. Useful to automate the migration.

nodeId
Link copied to clipboard
common
abstract val nodeId: PublicKey
Content copied to clipboard
nodeKey
Link copied to clipboard
common
abstract val nodeKey: DeterministicWallet.ExtendedPrivateKey
Content copied to clipboard

Inheritors

LocalKeyManager
Link copied to clipboard