org.lightningj.lnd.neutrino.proto

Class NeutrinoKitGrpc.NeutrinoKitBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<NeutrinoKitGrpc.NeutrinoKitBlockingStub>

org.lightningj.lnd.neutrino.proto.NeutrinoKitGrpc.NeutrinoKitBlockingStub

Enclosing class:

NeutrinoKitGrpc

public static final class NeutrinoKitGrpc.NeutrinoKitBlockingStub
extends io.grpc.stub.AbstractBlockingStub<NeutrinoKitGrpc.NeutrinoKitBlockingStub>

A stub to allow clients to do synchronous rpc calls to service NeutrinoKit.

 NeutrinoKit is a service that can be used to get information about the
 current state of the neutrino instance, fetch blocks and add/remove peers.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
Neutrino.AddPeerResponse	addPeer(Neutrino.AddPeerRequest request) AddPeer adds a new peer that has already been connected to the server.
protected NeutrinoKitGrpc.NeutrinoKitBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Neutrino.DisconnectPeerResponse	disconnectPeer(Neutrino.DisconnectPeerRequest request) DisconnectPeer disconnects a peer by target address.
Neutrino.GetBlockResponse	getBlock(Neutrino.GetBlockRequest request) GetBlock returns a block with a particular block hash.
Neutrino.GetBlockHashResponse	getBlockHash(Neutrino.GetBlockHashRequest request) Deprecated.
Neutrino.GetBlockHeaderResponse	getBlockHeader(Neutrino.GetBlockHeaderRequest request) GetBlockHeader returns a block header with a particular block hash.
Neutrino.GetCFilterResponse	getCFilter(Neutrino.GetCFilterRequest request) GetCFilter returns a compact filter from a block.
Neutrino.IsBannedResponse	isBanned(Neutrino.IsBannedRequest request) IsBanned returns true if the peer is banned, otherwise false.
Neutrino.StatusResponse	status(Neutrino.StatusRequest request) Status returns the status of the light client neutrino instance, along with height and hash of the best block, and a list of connected peers.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected NeutrinoKitGrpc.NeutrinoKitBlockingStub build(io.grpc.Channel channel,
                                                        io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<NeutrinoKitGrpc.NeutrinoKitBlockingStub>

status

public Neutrino.StatusResponse status(Neutrino.StatusRequest request)

Status returns the status of the light client neutrino instance,
along with height and hash of the best block, and a list of connected
peers.
 

addPeer

public Neutrino.AddPeerResponse addPeer(Neutrino.AddPeerRequest request)

AddPeer adds a new peer that has already been connected to the server.
 

disconnectPeer

public Neutrino.DisconnectPeerResponse disconnectPeer(Neutrino.DisconnectPeerRequest request)

DisconnectPeer disconnects a peer by target address. Both outbound and
inbound nodes will be searched for the target node. An error message will
be returned if the peer was not found.
 

isBanned

public Neutrino.IsBannedResponse isBanned(Neutrino.IsBannedRequest request)

IsBanned returns true if the peer is banned, otherwise false.
 

getBlockHeader

public Neutrino.GetBlockHeaderResponse getBlockHeader(Neutrino.GetBlockHeaderRequest request)

GetBlockHeader returns a block header with a particular block hash.
 

getBlock

public Neutrino.GetBlockResponse getBlock(Neutrino.GetBlockRequest request)

GetBlock returns a block with a particular block hash.
 

getCFilter

public Neutrino.GetCFilterResponse getCFilter(Neutrino.GetCFilterRequest request)

GetCFilter returns a compact filter from a block.
 

getBlockHash

@Deprecated
public Neutrino.GetBlockHashResponse getBlockHash(Neutrino.GetBlockHashRequest request)

Deprecated.

Deprecated, use chainrpc.GetBlockHash instead.
GetBlockHash returns the header hash of a block at a given height.