org.lightningj.lnd.neutrino.proto

Class NeutrinoKitGrpc.NeutrinoKitFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<NeutrinoKitGrpc.NeutrinoKitFutureStub>

org.lightningj.lnd.neutrino.proto.NeutrinoKitGrpc.NeutrinoKitFutureStub

Enclosing class:

NeutrinoKitGrpc

public static final class NeutrinoKitGrpc.NeutrinoKitFutureStub
extends io.grpc.stub.AbstractFutureStub<NeutrinoKitGrpc.NeutrinoKitFutureStub>

A stub to allow clients to do ListenableFuture-style 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
com.google.common.util.concurrent.ListenableFuture<Neutrino.AddPeerResponse>	addPeer(Neutrino.AddPeerRequest request) AddPeer adds a new peer that has already been connected to the server.
protected NeutrinoKitGrpc.NeutrinoKitFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Neutrino.DisconnectPeerResponse>	disconnectPeer(Neutrino.DisconnectPeerRequest request) DisconnectPeer disconnects a peer by target address.
com.google.common.util.concurrent.ListenableFuture<Neutrino.GetBlockResponse>	getBlock(Neutrino.GetBlockRequest request) GetBlock returns a block with a particular block hash.
com.google.common.util.concurrent.ListenableFuture<Neutrino.GetBlockHashResponse>	getBlockHash(Neutrino.GetBlockHashRequest request) Deprecated.
com.google.common.util.concurrent.ListenableFuture<Neutrino.GetBlockHeaderResponse>	getBlockHeader(Neutrino.GetBlockHeaderRequest request) GetBlockHeader returns a block header with a particular block hash.
com.google.common.util.concurrent.ListenableFuture<Neutrino.GetCFilterResponse>	getCFilter(Neutrino.GetCFilterRequest request) GetCFilter returns a compact filter from a block.
com.google.common.util.concurrent.ListenableFuture<Neutrino.IsBannedResponse>	isBanned(Neutrino.IsBannedRequest request) IsBanned returns true if the peer is banned, otherwise false.
com.google.common.util.concurrent.ListenableFuture<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.AbstractFutureStub

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.NeutrinoKitFutureStub build(io.grpc.Channel channel,
                                                      io.grpc.CallOptions callOptions)

Specified by:

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

status

public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<Neutrino.AddPeerResponse> addPeer(Neutrino.AddPeerRequest request)

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

disconnectPeer

public com.google.common.util.concurrent.ListenableFuture<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 com.google.common.util.concurrent.ListenableFuture<Neutrino.IsBannedResponse> isBanned(Neutrino.IsBannedRequest request)

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

getBlockHeader

public com.google.common.util.concurrent.ListenableFuture<Neutrino.GetBlockHeaderResponse> getBlockHeader(Neutrino.GetBlockHeaderRequest request)

GetBlockHeader returns a block header with a particular block hash.
 

getBlock

public com.google.common.util.concurrent.ListenableFuture<Neutrino.GetBlockResponse> getBlock(Neutrino.GetBlockRequest request)

GetBlock returns a block with a particular block hash.
 

getCFilter

public com.google.common.util.concurrent.ListenableFuture<Neutrino.GetCFilterResponse> getCFilter(Neutrino.GetCFilterRequest request)

GetCFilter returns a compact filter from a block.
 

getBlockHash

@Deprecated
public com.google.common.util.concurrent.ListenableFuture<Neutrino.GetBlockHashResponse> getBlockHash(Neutrino.GetBlockHashRequest request)

Deprecated.

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