trait SignerClient extends Signer with SignerClientPowerApi with PekkoGrpcClient

Annotations
@PekkoGrpcGenerated()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SignerClient
  2. PekkoGrpcClient
  3. SignerClientPowerApi
  4. Signer
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def close(): Future[Done]
    Definition Classes
    PekkoGrpcClient
  2. abstract def closed: Future[Done]
    Definition Classes
    PekkoGrpcClient
  3. abstract def computeInputScript(in: SignReq): Future[InputScriptResp]

    ComputeInputScript generates a complete InputIndex for the passed transaction with the signature as defined within the passed SignDescriptor.

    ComputeInputScript generates a complete InputIndex for the passed transaction with the signature as defined within the passed SignDescriptor. This method should be capable of generating the proper input script for both regular p2wkh/p2tr outputs and p2wkh outputs nested within a regular p2sh output. Note that when using this method to sign inputs belonging to the wallet, the only items of the SignDescriptor that need to be populated are pkScript in the TxOut field, the value in that same field, and finally the input index.

    Definition Classes
    Signer
  4. abstract def deriveSharedKey(in: SharedKeyRequest): Future[SharedKeyResponse]

    DeriveSharedKey returns a shared secret key by performing Diffie-Hellman key derivation between the ephemeral public key in the request and the node's key specified in the key_desc parameter.

    DeriveSharedKey returns a shared secret key by performing Diffie-Hellman key derivation between the ephemeral public key in the request and the node's key specified in the key_desc parameter. Either a key locator or a raw public key is expected in the key_desc, if neither is supplied, defaults to the node's identity private key: P_shared = privKeyNode * ephemeralPubkey The resulting shared public key is serialized in the compressed format and hashed with sha256, resulting in the final key length of 256bit.

    Definition Classes
    Signer
  5. abstract def muSig2Cleanup(in: MuSig2CleanupRequest): Future[MuSig2CleanupResponse]

    MuSig2Cleanup (experimental!) allows a caller to clean up a session early in cases where it's obvious that the signing session won't succeed and the resources can be released.

    MuSig2Cleanup (experimental!) allows a caller to clean up a session early in cases where it's obvious that the signing session won't succeed and the resources can be released. NOTE: The MuSig2 BIP is not final yet and therefore this API must be considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming releases. Backward compatibility is not guaranteed!

    Definition Classes
    Signer
  6. abstract def muSig2CombineKeys(in: MuSig2CombineKeysRequest): Future[MuSig2CombineKeysResponse]

    MuSig2CombineKeys (experimental!) is a stateless helper RPC that can be used to calculate the combined MuSig2 public key from a list of all participating signers' public keys.

    MuSig2CombineKeys (experimental!) is a stateless helper RPC that can be used to calculate the combined MuSig2 public key from a list of all participating signers' public keys. This RPC is completely stateless and deterministic and does not create any signing session. It can be used to determine the Taproot public key that should be put in an on-chain output once all public keys are known. A signing session is only needed later when that output should be _spent_ again. NOTE: The MuSig2 BIP is not final yet and therefore this API must be considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming releases. Backward compatibility is not guaranteed!

    Definition Classes
    Signer
  7. abstract def muSig2CombineSig(in: MuSig2CombineSigRequest): Future[MuSig2CombineSigResponse]

    MuSig2CombineSig (experimental!) combines the given partial signature(s) with the local one, if it already exists.

    MuSig2CombineSig (experimental!) combines the given partial signature(s) with the local one, if it already exists. Once a partial signature of all participants is registered, the final signature will be combined and returned. NOTE: The MuSig2 BIP is not final yet and therefore this API must be considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming releases. Backward compatibility is not guaranteed!

    Definition Classes
    Signer
  8. abstract def muSig2CreateSession(in: MuSig2SessionRequest): Future[MuSig2SessionResponse]

    MuSig2CreateSession (experimental!) creates a new MuSig2 signing session using the local key identified by the key locator.

    MuSig2CreateSession (experimental!) creates a new MuSig2 signing session using the local key identified by the key locator. The complete list of all public keys of all signing parties must be provided, including the public key of the local signing key. If nonces of other parties are already known, they can be submitted as well to reduce the number of RPC calls necessary later on. NOTE: The MuSig2 BIP is not final yet and therefore this API must be considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming releases. Backward compatibility is not guaranteed!

    Definition Classes
    Signer
  9. abstract def muSig2RegisterNonces(in: MuSig2RegisterNoncesRequest): Future[MuSig2RegisterNoncesResponse]

    MuSig2RegisterNonces (experimental!) registers one or more public nonces of other signing participants for a session identified by its ID.

    MuSig2RegisterNonces (experimental!) registers one or more public nonces of other signing participants for a session identified by its ID. This RPC can be called multiple times until all nonces are registered. NOTE: The MuSig2 BIP is not final yet and therefore this API must be considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming releases. Backward compatibility is not guaranteed!

    Definition Classes
    Signer
  10. abstract def muSig2Sign(in: MuSig2SignRequest): Future[MuSig2SignResponse]

    MuSig2Sign (experimental!) creates a partial signature using the local signing key that was specified when the session was created.

    MuSig2Sign (experimental!) creates a partial signature using the local signing key that was specified when the session was created. This can only be called when all public nonces of all participants are known and have been registered with the session. If this node isn't responsible for combining all the partial signatures, then the cleanup flag should be set, indicating that the session can be removed from memory once the signature was produced. NOTE: The MuSig2 BIP is not final yet and therefore this API must be considered to be HIGHLY EXPERIMENTAL and subject to change in upcoming releases. Backward compatibility is not guaranteed!

    Definition Classes
    Signer
  11. abstract def signMessage(in: SignMessageReq): Future[SignMessageResp]

    SignMessage signs a message with the key specified in the key locator.

    SignMessage signs a message with the key specified in the key locator. The returned signature is fixed-size LN wire format encoded. The main difference to SignMessage in the main RPC is that a specific key is used to sign the message instead of the node identity private key.

    Definition Classes
    Signer
  12. abstract def signOutputRaw(in: SignReq): Future[SignResp]

    SignOutputRaw is a method that can be used to generated a signature for a set of inputs/outputs to a transaction.

    SignOutputRaw is a method that can be used to generated a signature for a set of inputs/outputs to a transaction. Each request specifies details concerning how the outputs should be signed, which keys they should be signed with, and also any optional tweaks. The return value is a fixed 64-byte signature (the same format as we use on the wire in Lightning). If we are unable to sign using the specified keys, then an error will be returned.

    Definition Classes
    Signer
  13. abstract def verifyMessage(in: VerifyMessageReq): Future[VerifyMessageResp]

    VerifyMessage verifies a signature over a message using the public key provided.

    VerifyMessage verifies a signature over a message using the public key provided. The signature must be fixed-size LN wire format encoded. The main difference to VerifyMessage in the main RPC is that the public key used to sign the message does not have to be a node known to the network.

    Definition Classes
    Signer

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]) @native()
  6. def computeInputScript(): SingleResponseRequestBuilder[SignReq, InputScriptResp]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer computeInputScript(signrpc.SignReq) if possible.

    Definition Classes
    SignerClientPowerApi
  7. def deriveSharedKey(): SingleResponseRequestBuilder[SharedKeyRequest, SharedKeyResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer deriveSharedKey(signrpc.SharedKeyRequest) if possible.

    Definition Classes
    SignerClientPowerApi
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def muSig2Cleanup(): SingleResponseRequestBuilder[MuSig2CleanupRequest, MuSig2CleanupResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer muSig2Cleanup(signrpc.MuSig2CleanupRequest) if possible.

    Definition Classes
    SignerClientPowerApi
  15. def muSig2CombineKeys(): SingleResponseRequestBuilder[MuSig2CombineKeysRequest, MuSig2CombineKeysResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer muSig2CombineKeys(signrpc.MuSig2CombineKeysRequest) if possible.

    Definition Classes
    SignerClientPowerApi
  16. def muSig2CombineSig(): SingleResponseRequestBuilder[MuSig2CombineSigRequest, MuSig2CombineSigResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer muSig2CombineSig(signrpc.MuSig2CombineSigRequest) if possible.

    Definition Classes
    SignerClientPowerApi
  17. def muSig2CreateSession(): SingleResponseRequestBuilder[MuSig2SessionRequest, MuSig2SessionResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer muSig2CreateSession(signrpc.MuSig2SessionRequest) if possible.

    Definition Classes
    SignerClientPowerApi
  18. def muSig2RegisterNonces(): SingleResponseRequestBuilder[MuSig2RegisterNoncesRequest, MuSig2RegisterNoncesResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer muSig2RegisterNonces(signrpc.MuSig2RegisterNoncesRequest) if possible.

    Definition Classes
    SignerClientPowerApi
  19. def muSig2Sign(): SingleResponseRequestBuilder[MuSig2SignRequest, MuSig2SignResponse]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer muSig2Sign(signrpc.MuSig2SignRequest) if possible.

    Definition Classes
    SignerClientPowerApi
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def signMessage(): SingleResponseRequestBuilder[SignMessageReq, SignMessageResp]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer signMessage(signrpc.SignMessageReq) if possible.

    Definition Classes
    SignerClientPowerApi
  24. def signOutputRaw(): SingleResponseRequestBuilder[SignReq, SignResp]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer signOutputRaw(signrpc.SignReq) if possible.

    Definition Classes
    SignerClientPowerApi
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def verifyMessage(): SingleResponseRequestBuilder[VerifyMessageReq, VerifyMessageResp]

    Lower level "lifted" version of the method, giving access to request metadata etc.

    Lower level "lifted" version of the method, giving access to request metadata etc. prefer verifyMessage(signrpc.VerifyMessageReq) if possible.

    Definition Classes
    SignerClientPowerApi
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  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()

Inherited from PekkoGrpcClient

Inherited from SignerClientPowerApi

Inherited from Signer

Inherited from AnyRef

Inherited from Any

Ungrouped