lnrpc: replace /// and /** with // and /*
This commit is contained in:
22 files changed
+2096
-2098
No files matched your search
+22
-22
@@ -24,12 +24,12 @@ var _ = math.Inf
|
||||
const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package
|
||||
|
||||
type GenSeedRequest struct {
|
||||
//*
|
||||
//
|
||||
//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.
|
||||
AezeedPassphrase []byte `protobuf:"bytes,1,opt,name=aezeed_passphrase,json=aezeedPassphrase,proto3" json:"aezeed_passphrase,omitempty"`
|
||||
//*
|
||||
//
|
||||
//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.
|
||||
@@ -79,14 +79,14 @@ func (m *GenSeedRequest) GetSeedEntropy() []byte {
|
||||
}
|
||||
|
||||
type GenSeedResponse struct {
|
||||
//*
|
||||
//
|
||||
//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.
|
||||
//Otherwise, then the daemon will attempt to recover the wallet state linked
|
||||
//to this cipher seed.
|
||||
CipherSeedMnemonic []string `protobuf:"bytes,1,rep,name=cipher_seed_mnemonic,json=cipherSeedMnemonic,proto3" json:"cipher_seed_mnemonic,omitempty"`
|
||||
//*
|
||||
//
|
||||
//enciphered_seed are the raw aezeed cipher seed bytes. This is the raw
|
||||
//cipher text before run through our mnemonic encoding scheme.
|
||||
EncipheredSeed []byte `protobuf:"bytes,2,opt,name=enciphered_seed,json=encipheredSeed,proto3" json:"enciphered_seed,omitempty"`
|
||||
@@ -135,30 +135,30 @@ func (m *GenSeedResponse) GetEncipheredSeed() []byte {
|
||||
}
|
||||
|
||||
type InitWalletRequest struct {
|
||||
//*
|
||||
//
|
||||
//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
|
||||
//must be encoded as base64.
|
||||
WalletPassword []byte `protobuf:"bytes,1,opt,name=wallet_password,json=walletPassword,proto3" json:"wallet_password,omitempty"`
|
||||
//*
|
||||
//
|
||||
//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.
|
||||
CipherSeedMnemonic []string `protobuf:"bytes,2,rep,name=cipher_seed_mnemonic,json=cipherSeedMnemonic,proto3" json:"cipher_seed_mnemonic,omitempty"`
|
||||
//*
|
||||
//
|
||||
//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.
|
||||
AezeedPassphrase []byte `protobuf:"bytes,3,opt,name=aezeed_passphrase,json=aezeedPassphrase,proto3" json:"aezeed_passphrase,omitempty"`
|
||||
//*
|
||||
//
|
||||
//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
|
||||
//window of zero indicates that no addresses should be recovered, such after
|
||||
//the first initialization of the wallet.
|
||||
RecoveryWindow int32 `protobuf:"varint,4,opt,name=recovery_window,json=recoveryWindow,proto3" json:"recovery_window,omitempty"`
|
||||
//*
|
||||
//
|
||||
//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
|
||||
@@ -263,19 +263,19 @@ func (m *InitWalletResponse) XXX_DiscardUnknown() {
|
||||
var xxx_messageInfo_InitWalletResponse proto.InternalMessageInfo
|
||||
|
||||
type UnlockWalletRequest struct {
|
||||
//*
|
||||
//
|
||||
//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.
|
||||
WalletPassword []byte `protobuf:"bytes,1,opt,name=wallet_password,json=walletPassword,proto3" json:"wallet_password,omitempty"`
|
||||
//*
|
||||
//
|
||||
//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
|
||||
//window of zero indicates that no addresses should be recovered, such after
|
||||
//the first initialization of the wallet.
|
||||
RecoveryWindow int32 `protobuf:"varint,2,opt,name=recovery_window,json=recoveryWindow,proto3" json:"recovery_window,omitempty"`
|
||||
//*
|
||||
//
|
||||
//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
|
||||
@@ -366,11 +366,11 @@ func (m *UnlockWalletResponse) XXX_DiscardUnknown() {
|
||||
var xxx_messageInfo_UnlockWalletResponse proto.InternalMessageInfo
|
||||
|
||||
type ChangePasswordRequest struct {
|
||||
//*
|
||||
//
|
||||
//current_password should be the current valid passphrase used to unlock the
|
||||
//daemon. When using REST, this field must be encoded as base64.
|
||||
CurrentPassword []byte `protobuf:"bytes,1,opt,name=current_password,json=currentPassword,proto3" json:"current_password,omitempty"`
|
||||
//*
|
||||
//
|
||||
//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.
|
||||
NewPassword []byte `protobuf:"bytes,2,opt,name=new_password,json=newPassword,proto3" json:"new_password,omitempty"`
|
||||
@@ -516,7 +516,7 @@ const _ = grpc.SupportPackageIsVersion4
|
||||
//
|
||||
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
|
||||
type WalletUnlockerClient interface {
|
||||
//*
|
||||
//
|
||||
//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
|
||||
@@ -526,7 +526,7 @@ type WalletUnlockerClient interface {
|
||||
//method should be used to commit the newly generated seed, and create the
|
||||
//wallet.
|
||||
GenSeed(ctx context.Context, in *GenSeedRequest, opts ...grpc.CallOption) (*GenSeedResponse, error)
|
||||
//*
|
||||
//
|
||||
//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
|
||||
@@ -540,11 +540,11 @@ type WalletUnlockerClient interface {
|
||||
//seed, then present it to the user. Once it has been verified by the user,
|
||||
//the seed can be fed into this RPC in order to commit the new wallet.
|
||||
InitWallet(ctx context.Context, in *InitWalletRequest, opts ...grpc.CallOption) (*InitWalletResponse, error)
|
||||
//* lncli: `unlock`
|
||||
// lncli: `unlock`
|
||||
//UnlockWallet is used at startup of lnd to provide a password to unlock
|
||||
//the wallet database.
|
||||
UnlockWallet(ctx context.Context, in *UnlockWalletRequest, opts ...grpc.CallOption) (*UnlockWalletResponse, error)
|
||||
//* lncli: `changepassword`
|
||||
// lncli: `changepassword`
|
||||
//ChangePassword changes the password of the encrypted wallet. This will
|
||||
//automatically unlock the wallet database if successful.
|
||||
ChangePassword(ctx context.Context, in *ChangePasswordRequest, opts ...grpc.CallOption) (*ChangePasswordResponse, error)
|
||||
@@ -596,7 +596,7 @@ func (c *walletUnlockerClient) ChangePassword(ctx context.Context, in *ChangePas
|
||||
|
||||
// WalletUnlockerServer is the server API for WalletUnlocker service.
|
||||
type WalletUnlockerServer interface {
|
||||
//*
|
||||
//
|
||||
//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
|
||||
@@ -606,7 +606,7 @@ type WalletUnlockerServer interface {
|
||||
//method should be used to commit the newly generated seed, and create the
|
||||
//wallet.
|
||||
GenSeed(context.Context, *GenSeedRequest) (*GenSeedResponse, error)
|
||||
//*
|
||||
//
|
||||
//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
|
||||
@@ -620,11 +620,11 @@ type WalletUnlockerServer interface {
|
||||
//seed, then present it to the user. Once it has been verified by the user,
|
||||
//the seed can be fed into this RPC in order to commit the new wallet.
|
||||
InitWallet(context.Context, *InitWalletRequest) (*InitWalletResponse, error)
|
||||
//* lncli: `unlock`
|
||||
// lncli: `unlock`
|
||||
//UnlockWallet is used at startup of lnd to provide a password to unlock
|
||||
//the wallet database.
|
||||
UnlockWallet(context.Context, *UnlockWalletRequest) (*UnlockWalletResponse, error)
|
||||
//* lncli: `changepassword`
|
||||
// lncli: `changepassword`
|
||||
//ChangePassword changes the password of the encrypted wallet. This will
|
||||
//automatically unlock the wallet database if successful.
|
||||
ChangePassword(context.Context, *ChangePasswordRequest) (*ChangePasswordResponse, error)
|
||||
|
||||
Reference in new issue
Block a user