package watchonlyrpc

Get desktop application:
View/edit binary Protocol Buffers messages

WatchOnly exposes RPCs used by a remote signer to connect to a watch-only node.

• rpc SignCoordinatorStreams (stream SignCoordinatorResponse, stream SignCoordinatorRequest)

  watchonly.proto:16

  SignCoordinatorStreams dispatches a bi-directional streaming RPC that allows a remote signer to connect to a watch-only node and remotely provide signatures and ECDH results on demand.

  message SignCoordinatorResponse

  watchonly.proto:107

  • uint64 ref_request_id = 1

    The request ID this response refers to.

  • oneof sign_response_type

    The remote signer responses can only be of certain types.

    • SignerRegistration signer_registration = 2

      The Signer Registration message is sent by the remote signer when it connects to the watch-only lnd node, to initialize a handshake between the nodes.

    • bool pong = 3

      To ensure that the remote signer is still active and alive, the watch-only node can send a Ping message to remote signer. This Pong message should then be sent by the remote signer to respond to the Ping message.

    • signrpc.SharedKeyResponse shared_key_response = 4

      The remote signer's corresponding response to a Shared Key request.

    • signrpc.SignMessageResp sign_message_resp = 5

      The remote signer's corresponding response to a Sign Message request.

    • signrpc.MuSig2SessionResponse mu_sig2_session_response = 6

      The remote signer's corresponding response to a Mu Sig2 Session request.

    • signrpc.MuSig2RegisterNoncesResponse mu_sig2_register_nonces_response = 7

      The remote signer's corresponding response to a Mu Sig2 Register Nonces request.

    • signrpc.MuSig2RegisterCombinedNonceResponse mu_sig2_comb_nonces_resp = 8

      The remote signer's corresponding response to a Mu Sig2 Register Combined Nonces request.

    • signrpc.MuSig2GetCombinedNonceResponse mu_sig2_get_comb_nonces_resp = 9

      The remote signer's corresponding response to a Mu Sig2 Get Combined Nonces request.

    • signrpc.MuSig2SignResponse mu_sig2_sign_response = 10

      The remote signer's corresponding response to a Mu Sig2 Sign request.

    • signrpc.MuSig2CombineSigResponse mu_sig2_combine_sig_response = 11

      The remote signer's corresponding response to a Mu Sig2 Combine Sig request.

    • signrpc.MuSig2CleanupResponse mu_sig2_cleanup_response = 12

      The remote signer's corresponding response to a Mu Sig2 Cleanup request.

    • walletrpc.SignPsbtResponse sign_psbt_response = 13

      The remote signer's corresponding response to a Sign Psbt request.

    • SignerError signer_error = 14

      If the remote signer encounters an error while processing a request, it will respond with a SignerError message that details the error.

  message SignCoordinatorRequest

  watchonly.proto:20

  • uint64 request_id = 1

    A unique request ID of a SignCoordinator gRPC request. Useful for mapping requests to responses. Note that request_id 1 is reserved for the handshake with between watch-only node and the remote signer.

  • oneof sign_request_type

    Messages between the watch-only node and the remote signer can only be of certain types.

    • RegistrationResponse registration_response = 2

      The Registration Response message is returned by the watch-only lnd as a response to SignerRegistration message.

    • bool ping = 3

      To ensure that the remote signer is still active and alive, the watch-only lnd can send a Ping message to the remote signer, which should then respond with the respective Pong message.

    • signrpc.SharedKeyRequest shared_key_request = 4

      Requests a shared public key from the remote signer.

    • signrpc.SignMessageReq sign_message_req = 5

      Requests that the remote signer signs the passed message.

    • signrpc.MuSig2SessionRequest mu_sig2_session_request = 6

      Requests a MuSig2 Session of the remote signer.

    • signrpc.MuSig2RegisterNoncesRequest mu_sig2_register_nonces_request = 7

      Requests that the remote signer registers a nonce with the referenced MuSig2 Session.

    • signrpc.MuSig2RegisterCombinedNonceRequest mu_sig2_combined_nonces_req = 8

      Requests that the remote signer registers a combined nonce with the referenced MuSig2 Session.

    • signrpc.MuSig2GetCombinedNonceRequest mu_sig2_get_combined_nonces_req = 9

      Requests that the remote signer gets a combined nonce with the referenced MuSig2 Session.

    • signrpc.MuSig2SignRequest mu_sig2_sign_request = 10

      Requests that the remote signer signs the passed message digest with the referenced MuSig2 Session.

    • signrpc.MuSig2CombineSigRequest mu_sig2_combine_sig_request = 11

      Requests that the remote signer combines and adds the passed partial signatures for the referenced MuSig2 Session.

    • signrpc.MuSig2CleanupRequest mu_sig2_cleanup_request = 12

      Requests that the remote signer removes/cleans up the referenced MuSig2 session.

    • walletrpc.SignPsbtRequest sign_psbt_request = 13

      Requests that the remote signer signs the passed PSBT.

Used in: RegistrationResponse

• string signature = 1

  Holds the signature generated by the watch-only node when signing the registration_challenge provided by the remote signer in SignerRegistration.

• string registration_info = 2

  Contains information about the watch-only lnd that may be useful for the remote signer.

Used in: SignCoordinatorRequest

• oneof registration_response_type

  The registration response indicates either a successful registration or an error.

  • RegistrationComplete registration_complete = 1

    Sent by the watch-only lnd when the remote signer registration is successful.

  • string registration_error = 2

    Contains details about any errors that occurred during remote signer registration.

Used in: SignCoordinatorResponse

• string error = 1

  Details an error which occurred on remote signer.

Used in: SignCoordinatorResponse

• bytes registration_challenge = 1

  The registration challenge allows the remote signer to pass data that will be signed by the watch-only lnd. The resulting signature will be returned in the RegistrationResponse message.

• string registration_info = 2

  The registration info contains details about the remote signer that may be useful for the watch-only lnd.