Type Members

1.  final case class InputScript(witness: Seq[ByteString] = _root_.scala.Seq.empty, sigScript: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InputScript] with Product with Serializable
   witness

   The serializes witness stack for the specified input.

   sigScript

   The optional sig script for the specified witness that will only be set if the input specified is a nested p2sh witness program.

   Annotations

   @SerialVersionUID()

2.  final case class InputScriptResp(inputScripts: Seq[InputScript] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InputScriptResp] with Product with Serializable
   inputScripts

   The set of fully valid input scripts requested.

   Annotations

   @SerialVersionUID()

3.  final case class KeyDescriptor(rawKeyBytes: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, keyLoc: Option[KeyLocator] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[KeyDescriptor] with Product with Serializable
   rawKeyBytes

   The raw bytes of the public key in the key pair being identified. Either this or the KeyLocator must be specified.

   keyLoc

   The key locator that identifies which private key to use for signing. Either this or the raw bytes of the target public key must be specified.

   Annotations

   @SerialVersionUID()

4.  final case class KeyLocator(keyFamily: Int = 0, keyIndex: Int = 0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[KeyLocator] with Product with Serializable
   keyFamily

   The family of key being identified.

   keyIndex

   The precise index of the key being identified.

   Annotations

   @SerialVersionUID()

5.  final case class MuSig2CleanupRequest(sessionId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2CleanupRequest] with Product with Serializable
   sessionId

   The unique ID of the signing session that should be removed/cleaned up.

   Annotations

   @SerialVersionUID()

6.  final case class MuSig2CleanupResponse(unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2CleanupResponse] with Product with Serializable

   Annotations

   @SerialVersionUID()

7.  final case class MuSig2CombineKeysRequest(allSignerPubkeys: Seq[ByteString] = _root_.scala.Seq.empty, tweaks: Seq[TweakDesc] = _root_.scala.Seq.empty, taprootTweak: Option[TaprootTweakDesc] = _root_.scala.None, version: MuSig2Version = signrpc.MuSig2Version.MUSIG2_VERSION_UNDEFINED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2CombineKeysRequest] with Product with Serializable
   allSignerPubkeys

   A list of all public keys (serialized in 32-byte x-only format for v0.4.0 and 33-byte compressed format for v1.0.0rc2!) participating in the signing session. The list will always be sorted lexicographically internally. This must include the local key which is described by the above key_loc.

   tweaks

   A series of optional generic tweaks to be applied to the the aggregated public key.

   taprootTweak

   An optional taproot specific tweak that must be specified if the MuSig2 combined key will be used as the main taproot key of a taproot output on-chain.

   version

   The mandatory version of the MuSig2 BIP draft to use. This is necessary to differentiate between the changes that were made to the BIP while this experimental RPC was already released. Some of those changes affect how the combined key and nonces are created.

   Annotations

   @SerialVersionUID()

8.  final case class MuSig2CombineKeysResponse(combinedKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, taprootInternalKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, version: MuSig2Version = signrpc.MuSig2Version.MUSIG2_VERSION_UNDEFINED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2CombineKeysResponse] with Product with Serializable
   combinedKey

   The combined public key (in the 32-byte x-only format) with all tweaks applied to it. If a taproot tweak is specified, this corresponds to the taproot key that can be put into the on-chain output.

   taprootInternalKey

   The raw combined public key (in the 32-byte x-only format) before any tweaks are applied to it. If a taproot tweak is specified, this corresponds to the internal key that needs to be put into the witness if the script spend path is used.

   version

   The version of the MuSig2 BIP that was used to combine the keys.

   Annotations

   @SerialVersionUID()

9.  final case class MuSig2CombineSigRequest(sessionId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, otherPartialSignatures: Seq[ByteString] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2CombineSigRequest] with Product with Serializable
   sessionId

   The unique ID of the signing session to combine the signatures for.

   otherPartialSignatures

   The list of all other participants' partial signatures to add to the current session.

   Annotations

   @SerialVersionUID()

10.  final case class MuSig2CombineSigResponse(haveAllSignatures: Boolean = false, finalSignature: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2CombineSigResponse] with Product with Serializable
    haveAllSignatures

    Indicates whether all partial signatures required to create a final, full signature are known yet. If this is true, then the final_signature field is set, otherwise it is empty.

    finalSignature

    The final, full signature that is valid for the combined public key.

    Annotations

    @SerialVersionUID()

11.  final case class MuSig2RegisterNoncesRequest(sessionId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, otherSignerPublicNonces: Seq[ByteString] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2RegisterNoncesRequest] with Product with Serializable
    sessionId

    The unique ID of the signing session those nonces should be registered with.

    otherSignerPublicNonces

    A list of all public nonces of other signing participants that should be registered.

    Annotations

    @SerialVersionUID()

12.  final case class MuSig2RegisterNoncesResponse(haveAllNonces: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2RegisterNoncesResponse] with Product with Serializable
    haveAllNonces

    Indicates whether all nonces required to start the signing process are known now.

    Annotations

    @SerialVersionUID()

13.  final case class MuSig2SessionRequest(keyLoc: Option[KeyLocator] = _root_.scala.None, allSignerPubkeys: Seq[ByteString] = _root_.scala.Seq.empty, otherSignerPublicNonces: Seq[ByteString] = _root_.scala.Seq.empty, tweaks: Seq[TweakDesc] = _root_.scala.Seq.empty, taprootTweak: Option[TaprootTweakDesc] = _root_.scala.None, version: MuSig2Version = signrpc.MuSig2Version.MUSIG2_VERSION_UNDEFINED, pregeneratedLocalNonce: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2SessionRequest] with Product with Serializable
    keyLoc

    The key locator that identifies which key to use for signing.

    allSignerPubkeys

    A list of all public keys (serialized in 32-byte x-only format for v0.4.0 and 33-byte compressed format for v1.0.0rc2!) participating in the signing session. The list will always be sorted lexicographically internally. This must include the local key which is described by the above key_loc.

    otherSignerPublicNonces

    An optional list of all public nonces of other signing participants that might already be known.

    tweaks

    A series of optional generic tweaks to be applied to the the aggregated public key.

    taprootTweak

    An optional taproot specific tweak that must be specified if the MuSig2 combined key will be used as the main taproot key of a taproot output on-chain.

    version

    The mandatory version of the MuSig2 BIP draft to use. This is necessary to differentiate between the changes that were made to the BIP while this experimental RPC was already released. Some of those changes affect how the combined key and nonces are created.

    pregeneratedLocalNonce

    A set of pre generated secret local nonces to use in the musig2 session. This field is optional. This can be useful for protocols that need to send nonces ahead of time before the set of signer keys are known. This value MUST be 97 bytes and be the concatenation of two CSPRNG generated 32 byte values and local public key used for signing as specified in the key_loc field.

    Annotations

    @SerialVersionUID()

14.  final case class MuSig2SessionResponse(sessionId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, combinedKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, taprootInternalKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, localPublicNonces: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, haveAllNonces: Boolean = false, version: MuSig2Version = signrpc.MuSig2Version.MUSIG2_VERSION_UNDEFINED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2SessionResponse] with Product with Serializable
    sessionId

    The unique ID that represents this signing session. A session can be used for producing a signature a single time. If the signing fails for any reason, a new session with the same participants needs to be created.

    combinedKey

    The combined public key (in the 32-byte x-only format) with all tweaks applied to it. If a taproot tweak is specified, this corresponds to the taproot key that can be put into the on-chain output.

    taprootInternalKey

    The raw combined public key (in the 32-byte x-only format) before any tweaks are applied to it. If a taproot tweak is specified, this corresponds to the internal key that needs to be put into the witness if the script spend path is used.

    localPublicNonces

    The two public nonces the local signer uses, combined into a single value of 66 bytes. Can be split into the two 33-byte points to get the individual nonces.

    haveAllNonces

    Indicates whether all nonces required to start the signing process are known now.

    version

    The version of the MuSig2 BIP that was used to create the session.

    Annotations

    @SerialVersionUID()

15.  final case class MuSig2SignRequest(sessionId: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, messageDigest: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cleanup: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2SignRequest] with Product with Serializable
    sessionId

    The unique ID of the signing session to use for signing.

    messageDigest

    The 32-byte SHA256 digest of the message to sign.

    cleanup

    Cleanup indicates that after signing, the session state can be cleaned up, since another participant is going to be responsible for combining the partial signatures.

    Annotations

    @SerialVersionUID()

16.  final case class MuSig2SignResponse(localPartialSignature: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MuSig2SignResponse] with Product with Serializable
    localPartialSignature

    The partial signature created by the local signer.

    Annotations

    @SerialVersionUID()

17.  sealed abstract class MuSig2Version extends GeneratedEnum
18.  final case class SharedKeyRequest(ephemeralPubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, keyLoc: Option[KeyLocator] = _root_.scala.None, keyDesc: Option[KeyDescriptor] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SharedKeyRequest] with Product with Serializable
    ephemeralPubkey

    The ephemeral public key to use for the DH key derivation.

    keyLoc

    Deprecated. The optional key locator of the local key that should be used. If this parameter is not set then the node's identity private key will be used.

    keyDesc

    A key descriptor describes the key used for performing ECDH. Either a key locator or a raw public key is expected, if neither is supplied, defaults to the node's identity private key.

    Annotations

    @SerialVersionUID()

19.  final case class SharedKeyResponse(sharedKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SharedKeyResponse] with Product with Serializable
    sharedKey

    The shared public key, hashed with sha256.

    Annotations

    @SerialVersionUID()

20.  final case class SignDescriptor(keyDesc: Option[KeyDescriptor] = _root_.scala.None, singleTweak: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, doubleTweak: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, tapTweak: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, witnessScript: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, output: Option[TxOut] = _root_.scala.None, sighash: UInt32 = signrpc.SignDescriptor._typemapper_sighash.toCustom(0), inputIndex: Int = 0, signMethod: SignMethod = signrpc.SignMethod.SIGN_METHOD_WITNESS_V0, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SignDescriptor] with Product with Serializable
    keyDesc

    A descriptor that precisely describes *which* key to use for signing. This may provide the raw public key directly, or require the Signer to re-derive the key according to the populated derivation path. Note that if the key descriptor was obtained through walletrpc.DeriveKey, then the key locator MUST always be provided, since the derived keys are not persisted unlike with DeriveNextKey.

    singleTweak

    A scalar value that will be added to the private key corresponding to the above public key to obtain the private key to be used to sign this input. This value is typically derived via the following computation: derivedKey = privkey + sha256(perCommitmentPoint || pubKey) mod N

    doubleTweak

    A private key that will be used in combination with its corresponding private key to derive the private key that is to be used to sign the target input. Within the Lightning protocol, this value is typically the commitment secret from a previously revoked commitment transaction. This value is in combination with two hash values, and the original private key to derive the private key to be used when signing. k = (privKey*sha256(pubKey || tweakPub) + tweakPriv*sha256(tweakPub || pubKey)) mod N

    tapTweak

    The 32 byte input to the taproot tweak derivation that is used to derive the output key from an internal key: outputKey = internalKey + tagged_hash("tapTweak", internalKey || tapTweak). When doing a BIP 86 spend, this field can be an empty byte slice. When doing a normal key path spend, with the output key committing to an actual script root, then this field should be: the tapscript root hash.

    witnessScript

    The full script required to properly redeem the output. This field will only be populated if a p2tr, p2wsh or a p2sh output is being signed. If a taproot script path spend is being attempted, then this should be the raw leaf script.

    output

    A description of the output being spent. The value and script MUST be provided.

    sighash

    The target sighash type that should be used when generating the final sighash, and signature.

    inputIndex

    The target input within the transaction that should be signed.

    signMethod

    The sign method specifies how the input should be signed. Depending on the method, either the tap_tweak, witness_script or both need to be specified. Defaults to SegWit v0 signing to be backward compatible with older RPC clients.

    Annotations

    @SerialVersionUID()

21.  final case class SignMessageReq(msg: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, keyLoc: Option[KeyLocator] = _root_.scala.None, doubleHash: Boolean = false, compactSig: Boolean = false, schnorrSig: Boolean = false, schnorrSigTapTweak: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SignMessageReq] with Product with Serializable
    msg

    The message to be signed. When using REST, this field must be encoded as base64.

    keyLoc

    The key locator that identifies which key to use for signing.

    doubleHash

    Double-SHA256 hash instead of just the default single round.

    compactSig

    Use the compact (pubkey recoverable) format instead of the raw lnwire format. This option cannot be used with Schnorr signatures.

    schnorrSig

    Use Schnorr signature. This option cannot be used with compact format.

    schnorrSigTapTweak

    The optional Taproot tweak bytes to apply to the private key before creating a Schnorr signature. The private key is tweaked as described in BIP-341: privKey + h_tapTweak(internalKey || tapTweak)

    Annotations

    @SerialVersionUID()

22.  final case class SignMessageResp(signature: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SignMessageResp] with Product with Serializable
    signature

    The signature for the given message in the fixed-size LN wire format.

    Annotations

    @SerialVersionUID()

23.  sealed abstract class SignMethod extends GeneratedEnum
24.  final case class SignReq(rawTxBytes: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, signDescs: Seq[SignDescriptor] = _root_.scala.Seq.empty, prevOutputs: Seq[TxOut] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SignReq] with Product with Serializable
    rawTxBytes

    The raw bytes of the transaction to be signed.

    signDescs

    A set of sign descriptors, for each input to be signed.

    prevOutputs

    The full list of UTXO information for each of the inputs being spent. This is required when spending one or more taproot (SegWit v1) outputs.

    Annotations

    @SerialVersionUID()

25.  final case class SignResp(rawSigs: Seq[ByteString] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SignResp] with Product with Serializable
    rawSigs

    A set of signatures realized in a fixed 64-byte format ordered in ascending input order.

    Annotations

    @SerialVersionUID()

26.  trait Signer extends AnyRef

    Signer is a service that gives access to the signing functionality of the daemon's wallet.

    Signer is a service that gives access to the signing functionality of the daemon's wallet.

    Annotations

    @PekkoGrpcGenerated()

27.  trait SignerClient extends Signer with SignerClientPowerApi with PekkoGrpcClient

    Annotations

    @PekkoGrpcGenerated()

28.  trait SignerClientPowerApi extends AnyRef

    Annotations

    @PekkoGrpcGenerated()

29.  final case class TaprootTweakDesc(scriptRoot: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, keySpendOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TaprootTweakDesc] with Product with Serializable
    scriptRoot

    The root hash of the tapscript tree if a script path is committed to. If the MuSig2 key put on chain doesn't also commit to a script path (BIP-0086 key spend only), then this needs to be empty and the key_spend_only field below must be set to true. This is required because gRPC cannot differentiate between a zero-size byte slice and a nil byte slice (both would be serialized the same way). So the extra boolean is required.

    keySpendOnly

    Indicates that the above script_root is expected to be empty because this is a BIP-0086 key spend only commitment where only the internal key is committed to instead of also including a script root hash.

    Annotations

    @SerialVersionUID()

30.  final case class TweakDesc(tweak: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, isXOnly: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TweakDesc] with Product with Serializable
    tweak

    Tweak is the 32-byte value that will modify the public key.

    isXOnly

    Specifies if the target key should be converted to an x-only public key before tweaking. If true, then the public key will be mapped to an x-only key before the tweaking operation is applied.

    Annotations

    @SerialVersionUID()

31.  final case class TxOut(value: Long = 0L, pkScript: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[TxOut] with Product with Serializable
    value

    The value of the output being spent.

    pkScript

    The script of the output being spent.

    Annotations

    @SerialVersionUID()

32.  final case class VerifyMessageReq(msg: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, signature: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, pubkey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, isSchnorrSig: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[VerifyMessageReq] with Product with Serializable
    msg

    The message over which the signature is to be verified. When using REST, this field must be encoded as base64.

    signature

    The fixed-size LN wire encoded signature to be verified over the given message. When using REST, this field must be encoded as base64.

    pubkey

    The public key the signature has to be valid for. When using REST, this field must be encoded as base64. If the is_schnorr_sig option is true, then the public key is expected to be in the 32-byte x-only serialization according to BIP-340.

    isSchnorrSig

    Specifies if the signature is a Schnorr signature.

    Annotations

    @SerialVersionUID()

33.  final case class VerifyMessageResp(valid: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[VerifyMessageResp] with Product with Serializable
    valid

    Whether the signature was valid over the given message.

    Annotations

    @SerialVersionUID()