org.lightningj.lnd.walletkit.proto

Interface WalletKitOuterClass.PendingSweepOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

WalletKitOuterClass.PendingSweep, WalletKitOuterClass.PendingSweep.Builder

Enclosing class:

WalletKitOuterClass

public static interface WalletKitOuterClass.PendingSweepOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getAmountSat() The value of the output we're attempting to sweep.
int	getBroadcastAttempts() The number of broadcast attempts we've made to sweep the output.
boolean	getForce() Whether this input must be force-swept.
int	getNextBroadcastHeight() The next height of the chain at which we'll attempt to broadcast the sweep transaction of the output.
LightningApi.OutPoint	getOutpoint() The outpoint of the output we're attempting to sweep.
LightningApi.OutPointOrBuilder	getOutpointOrBuilder() The outpoint of the output we're attempting to sweep.
int	getRequestedConfTarget() The requested confirmation target for this output.
int	getRequestedSatPerByte() Deprecated. walletrpc.PendingSweep.requested_sat_per_byte is deprecated. See wallet.kit.proto;l=977
long	getRequestedSatPerVbyte() The requested fee rate, expressed in sat/vbyte, for this output.
int	getSatPerByte() Deprecated. walletrpc.PendingSweep.sat_per_byte is deprecated. See wallet.kit.proto;l=961
long	getSatPerVbyte() The fee rate we'll use to sweep the output, expressed in sat/vbyte.
WalletKitOuterClass.WitnessType	getWitnessType() The witness type of the output we're attempting to sweep.
int	getWitnessTypeValue() The witness type of the output we're attempting to sweep.
boolean	hasOutpoint() The outpoint of the output we're attempting to sweep.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasOutpoint

boolean hasOutpoint()

 The outpoint of the output we're attempting to sweep.
 

.lnrpc.OutPoint outpoint = 1;

Returns:

Whether the outpoint field is set.

getOutpoint

LightningApi.OutPoint getOutpoint()

 The outpoint of the output we're attempting to sweep.
 

.lnrpc.OutPoint outpoint = 1;

Returns:

The outpoint.

getOutpointOrBuilder

LightningApi.OutPointOrBuilder getOutpointOrBuilder()

 The outpoint of the output we're attempting to sweep.
 

.lnrpc.OutPoint outpoint = 1;

getWitnessTypeValue

int getWitnessTypeValue()

 The witness type of the output we're attempting to sweep.
 

.walletrpc.WitnessType witness_type = 2;

Returns:

The enum numeric value on the wire for witnessType.

getWitnessType

WalletKitOuterClass.WitnessType getWitnessType()

 The witness type of the output we're attempting to sweep.
 

.walletrpc.WitnessType witness_type = 2;

Returns:

The witnessType.

getAmountSat

int getAmountSat()

 The value of the output we're attempting to sweep.
 

uint32 amount_sat = 3;

Returns:

The amountSat.

getSatPerByte

@Deprecated
int getSatPerByte()

Deprecated. walletrpc.PendingSweep.sat_per_byte is deprecated. See wallet.kit.proto;l=961

Deprecated, use sat_per_vbyte.
The fee rate we'll use to sweep the output, expressed in sat/vbyte. The fee
rate is only determined once a sweeping transaction for the output is
created, so it's possible for this to be 0 before this.
 

uint32 sat_per_byte = 4 [deprecated = true];

Returns:

The satPerByte.

getBroadcastAttempts

int getBroadcastAttempts()

 The number of broadcast attempts we've made to sweep the output.
 

uint32 broadcast_attempts = 5;

Returns:

The broadcastAttempts.

getNextBroadcastHeight

int getNextBroadcastHeight()

The next height of the chain at which we'll attempt to broadcast the
sweep transaction of the output.
 

uint32 next_broadcast_height = 6;

Returns:

The nextBroadcastHeight.

getRequestedConfTarget

int getRequestedConfTarget()

 The requested confirmation target for this output.
 

uint32 requested_conf_target = 8;

Returns:

The requestedConfTarget.

getRequestedSatPerByte

@Deprecated
int getRequestedSatPerByte()

Deprecated. walletrpc.PendingSweep.requested_sat_per_byte is deprecated. See wallet.kit.proto;l=977

 Deprecated, use requested_sat_per_vbyte.
 The requested fee rate, expressed in sat/vbyte, for this output.
 

uint32 requested_sat_per_byte = 9 [deprecated = true];

Returns:

The requestedSatPerByte.

getSatPerVbyte

long getSatPerVbyte()

The fee rate we'll use to sweep the output, expressed in sat/vbyte. The fee
rate is only determined once a sweeping transaction for the output is
created, so it's possible for this to be 0 before this.
 

uint64 sat_per_vbyte = 10;

Returns:

The satPerVbyte.

getRequestedSatPerVbyte

long getRequestedSatPerVbyte()

 The requested fee rate, expressed in sat/vbyte, for this output.
 

uint64 requested_sat_per_vbyte = 11;

Returns:

The requestedSatPerVbyte.

getForce

boolean getForce()

Whether this input must be force-swept. This means that it is swept even
if it has a negative yield.
 

bool force = 7;

Returns:

The force.