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

+20 -24
View File
@@ -7,15 +7,11 @@ package lnrpc;
option go_package = "github.com/lightningnetwork/lnd/lnrpc";
/**
/*
* Comments in this file will be directly parsed into the API
* Documentation as descriptions of the associated method, message, or field.
* These descriptions should go right above the definition of the object, and
* can be in either block or /// comment format.
*
* One edge case exists where a // comment followed by a /// comment in the
* next line will cause the description not to show up in the documentation. In
* that instance, simply separate the two comments with a blank line.
* can be in either block or // comment format.
*
* An RPC method can be matched to an lncli command by placing a line in the
* beginning of the description in exactly the following format:
@@ -32,7 +28,7 @@ option go_package = "github.com/lightningnetwork/lnd/lnrpc";
// WalletUnlocker is a service that is used to set up a wallet password for
// lnd at first startup, and unlock a previously set up wallet.
service WalletUnlocker {
/**
/*
GenSeed is the first method that should be used to instantiate a new lnd
instance. This method allows a caller to generate a new aezeed cipher seed
given an optional passphrase. If provided, the passphrase will be necessary
@@ -48,7 +44,7 @@ service WalletUnlocker {
};
}
/**
/*
InitWallet is used when lnd is starting up for the first time to fully
initialize the daemon and its internal wallet. At the very least a wallet
password must be provided. This will be used to encrypt sensitive material
@@ -69,7 +65,7 @@ service WalletUnlocker {
};
}
/** lncli: `unlock`
/* lncli: `unlock`
UnlockWallet is used at startup of lnd to provide a password to unlock
the wallet database.
*/
@@ -80,7 +76,7 @@ service WalletUnlocker {
};
}
/** lncli: `changepassword`
/* lncli: `changepassword`
ChangePassword changes the password of the encrypted wallet. This will
automatically unlock the wallet database if successful.
*/
@@ -94,14 +90,14 @@ service WalletUnlocker {
}
message GenSeedRequest {
/**
/*
aezeed_passphrase is an optional user provided passphrase that will be used
to encrypt the generated aezeed cipher seed. When using REST, this field
must be encoded as base64.
*/
bytes aezeed_passphrase = 1;
/**
/*
seed_entropy is an optional 16-bytes generated via CSPRNG. If not
specified, then a fresh set of randomness will be used to create the seed.
When using REST, this field must be encoded as base64.
@@ -109,7 +105,7 @@ message GenSeedRequest {
bytes seed_entropy = 2;
}
message GenSeedResponse {
/**
/*
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed
cipher seed obtained by the user. This field is optional, as if not
provided, then the daemon will generate a new cipher seed for the user.
@@ -118,7 +114,7 @@ message GenSeedResponse {
*/
repeated string cipher_seed_mnemonic = 1;
/**
/*
enciphered_seed are the raw aezeed cipher seed bytes. This is the raw
cipher text before run through our mnemonic encoding scheme.
*/
@@ -126,7 +122,7 @@ message GenSeedResponse {
}
message InitWalletRequest {
/**
/*
wallet_password is the passphrase that should be used to encrypt the
wallet. This MUST be at least 8 chars in length. After creation, this
password is required to unlock the daemon. When using REST, this field
@@ -134,21 +130,21 @@ message InitWalletRequest {
*/
bytes wallet_password = 1;
/**
/*
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed
cipher seed obtained by the user. This may have been generated by the
GenSeed method, or be an existing seed.
*/
repeated string cipher_seed_mnemonic = 2;
/**
/*
aezeed_passphrase is an optional user provided passphrase that will be used
to encrypt the generated aezeed cipher seed. When using REST, this field
must be encoded as base64.
*/
bytes aezeed_passphrase = 3;
/**
/*
recovery_window is an optional argument specifying the address lookahead
when restoring a wallet seed. The recovery window applies to each
individual branch of the BIP44 derivation paths. Supplying a recovery
@@ -157,7 +153,7 @@ message InitWalletRequest {
*/
int32 recovery_window = 4;
/**
/*
channel_backups is an optional argument that allows clients to recover the
settled funds within a set of channels. This should be populated if the
user was unable to close out all channels and sweep funds before partial or
@@ -171,14 +167,14 @@ message InitWalletResponse {
}
message UnlockWalletRequest {
/**
/*
wallet_password should be the current valid passphrase for the daemon. This
will be required to decrypt on-disk material that the daemon requires to
function properly. When using REST, this field must be encoded as base64.
*/
bytes wallet_password = 1;
/**
/*
recovery_window is an optional argument specifying the address lookahead
when restoring a wallet seed. The recovery window applies to each
individual branch of the BIP44 derivation paths. Supplying a recovery
@@ -187,7 +183,7 @@ message UnlockWalletRequest {
*/
int32 recovery_window = 2;
/**
/*
channel_backups is an optional argument that allows clients to recover the
settled funds within a set of channels. This should be populated if the
user was unable to close out all channels and sweep funds before partial or
@@ -201,13 +197,13 @@ message UnlockWalletResponse {
}
message ChangePasswordRequest {
/**
/*
current_password should be the current valid passphrase used to unlock the
daemon. When using REST, this field must be encoded as base64.
*/
bytes current_password = 1;
/**
/*
new_password should be the new passphrase that will be needed to unlock the
daemon. When using REST, this field must be encoded as base64.
*/