lnrpc: replace /// and /** with // and /*

This commit is contained in:
Oliver Gugger committed 2020-05-08 14:33:34 +02:00
1 parent 0800386138
commit 71c58c2c04
22 files changed
+2096 -2098

No files matched your search

+31 -31
View File
@@ -7,7 +7,7 @@ option go_package = "github.com/lightningnetwork/lnd/lnrpc/signrpc";
// Signer is a service that gives access to the signing functionality of the
// daemon's wallet.
service Signer {
/**
/*
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
@@ -19,7 +19,7 @@ service Signer {
*/
rpc SignOutputRaw (SignReq) returns (SignResp);
/**
/*
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
@@ -33,7 +33,7 @@ service Signer {
*/
rpc ComputeInputScript (SignReq) returns (InputScriptResp);
/**
/*
SignMessage signs a message with the key specified in the key locator. The
returned signature is fixed-size LN wire format encoded.
@@ -42,7 +42,7 @@ service Signer {
*/
rpc SignMessage (SignMessageReq) returns (SignMessageResp);
/**
/*
VerifyMessage verifies a signature over a message using the public key
provided. The signature must be fixed-size LN wire format encoded.
@@ -64,21 +64,21 @@ service Signer {
}
message KeyLocator {
/// The family of key being identified.
// The family of key being identified.
int32 key_family = 1;
/// The precise index of the key being identified.
// The precise index of the key being identified.
int32 key_index = 2;
}
message KeyDescriptor {
/**
/*
The raw bytes of the key being identified. Either this or the KeyLocator
must be specified.
*/
bytes raw_key_bytes = 1;
/**
/*
The key locator that identifies which key to use for signing. Either this
or the raw bytes of the target key must be specified.
*/
@@ -86,22 +86,22 @@ message KeyDescriptor {
}
message TxOut {
/// The value of the output being spent.
// The value of the output being spent.
int64 value = 1;
/// The script of the output being spent.
// The script of the output being spent.
bytes pk_script = 2;
}
message SignDescriptor {
/**
/*
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.
*/
KeyDescriptor key_desc = 1;
/**
/*
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:
@@ -110,7 +110,7 @@ message SignDescriptor {
*/
bytes single_tweak = 2;
/**
/*
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
@@ -123,40 +123,40 @@ message SignDescriptor {
*/
bytes double_tweak = 3;
/**
/*
The full script required to properly redeem the output. This field will
only be populated if a p2wsh or a p2sh output is being signed.
*/
bytes witness_script = 4;
/**
/*
A description of the output being spent. The value and script MUST be
provided.
*/
TxOut output = 5;
/**
/*
The target sighash type that should be used when generating the final
sighash, and signature.
*/
uint32 sighash = 7;
/**
/*
The target input within the transaction that should be signed.
*/
int32 input_index = 8;
}
message SignReq {
/// The raw bytes of the transaction to be signed.
// The raw bytes of the transaction to be signed.
bytes raw_tx_bytes = 1;
/// A set of sign descriptors, for each input to be signed.
// A set of sign descriptors, for each input to be signed.
repeated SignDescriptor sign_descs = 2;
}
message SignResp {
/**
/*
A set of signatures realized in a fixed 64-byte format ordered in ascending
input order.
*/
@@ -164,10 +164,10 @@ message SignResp {
}
message InputScript {
/// The serializes witness stack for the specified input.
// The serializes witness stack for the specified input.
repeated bytes witness = 1;
/***
/**
The optional sig script for the specified witness that will only be set if
the input specified is a nested p2sh witness program.
*/
@@ -175,39 +175,39 @@ message InputScript {
}
message InputScriptResp {
/// The set of fully valid input scripts requested.
// The set of fully valid input scripts requested.
repeated InputScript input_scripts = 1;
}
message SignMessageReq {
/// The message to be signed.
// The message to be signed.
bytes msg = 1;
/// The key locator that identifies which key to use for signing.
// The key locator that identifies which key to use for signing.
KeyLocator key_loc = 2;
}
message SignMessageResp {
/**
/*
The signature for the given message in the fixed-size LN wire format.
*/
bytes signature = 1;
}
message VerifyMessageReq {
/// The message over which the signature is to be verified.
// The message over which the signature is to be verified.
bytes msg = 1;
/**
/*
The fixed-size LN wire encoded signature to be verified over the given
message.
*/
bytes signature = 2;
/// The public key the signature has to be valid for.
// The public key the signature has to be valid for.
bytes pubkey = 3;
}
message VerifyMessageResp {
/// Whether the signature was valid over the given message.
// Whether the signature was valid over the given message.
bool valid = 1;
}
@@ -215,7 +215,7 @@ message SharedKeyRequest {
// The ephemeral public key to use for the DH key derivation.
bytes ephemeral_pubkey = 1;
/**
/*
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.
*/