package neutrinorpc

Get desktop application:
View/edit binary Protocol Buffers messages

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.

• rpc Status (StatusRequest, StatusResponse)

  neutrino.proto:15

  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.

  message StatusRequest

  neutrino.proto:58

  (message has no fields)

  message StatusResponse

  neutrino.proto:61

  • bool active = 1

    Indicates whether the neutrino backend is active or not.

  • bool synced = 2

    Is fully synced.

  • int32 block_height = 3

    Best block height.

  • string block_hash = 4

    Best block hash.

  • repeated string peers = 5

    Connected peers.

• rpc AddPeer (AddPeerRequest, AddPeerResponse)

  neutrino.proto:20

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

  message AddPeerRequest

  neutrino.proto:78

  • string peer_addrs = 1

    Peer to add.

  message AddPeerResponse

  neutrino.proto:83

  (message has no fields)

• rpc DisconnectPeer (DisconnectPeerRequest, DisconnectPeerResponse)

  neutrino.proto:27

  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.

  message DisconnectPeerRequest

  neutrino.proto:86

  • string peer_addrs = 1

    Peer to disconnect.

  message DisconnectPeerResponse

  neutrino.proto:91

  (message has no fields)

• rpc IsBanned (IsBannedRequest, IsBannedResponse)

  neutrino.proto:32

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

  message IsBannedRequest

  neutrino.proto:94

  • string peer_addrs = 1

    Peer to lookup.

  message IsBannedResponse

  neutrino.proto:99

  • bool banned = 1

• rpc GetBlockHeader (GetBlockHeaderRequest, GetBlockHeaderResponse)

  neutrino.proto:37

  GetBlockHeader returns a block header with a particular block hash.

  message GetBlockHeaderRequest

  neutrino.proto:103

  • string hash = 1

    Block hash in hex notation.

  message GetBlockHeaderResponse

  neutrino.proto:108

  • string hash = 1

    The block hash (same as provided).

  • int64 confirmations = 2

    The number of confirmations.

  • int64 stripped_size = 3

    The block size excluding witness data.

  • int64 size = 4

    The block size (bytes).

  • int64 weight = 5

    The block weight as defined in BIP 141.

  • int32 height = 6

    The block height or index.

  • int32 version = 7

    The block version.

  • string version_hex = 8

    The block version.

  • string merkleroot = 9

    The merkle root.

  • int64 time = 10

    The block time in seconds since epoch (Jan 1 1970 GMT).

  • uint32 nonce = 11

    The nonce.

  • string bits = 12

    The bits in hex notation.

  • int32 ntx = 13

    The number of transactions in the block.

  • string previous_block_hash = 14

    The hash of the previous block.

  • bytes raw_hex = 15

    The raw hex of the block.

• rpc GetBlock (GetBlockRequest, GetBlockResponse)

  neutrino.proto:42

  GetBlock returns a block with a particular block hash.

  message GetBlockRequest

  neutrino.proto:155

  • string hash = 1

    Block hash in hex notation.

  message GetBlockResponse

  neutrino.proto:160

  • string hash = 1

    The block hash (same as provided).

  • int64 confirmations = 2

    The number of confirmations.

  • int64 stripped_size = 3

    The block size excluding witness data.

  • int64 size = 4

    The block size (bytes).

  • int64 weight = 5

    The block weight as defined in BIP 141.

  • int32 height = 6

    The block height or index.

  • int32 version = 7

    The block version.

  • string version_hex = 8

    The block version.

  • string merkleroot = 9

    The merkle root.

  • repeated string tx = 10

    List of transaction ids.

  • int64 time = 11

    The block time in seconds since epoch (Jan 1 1970 GMT).

  • uint32 nonce = 12

    The nonce.

  • string bits = 13

    The bits in hex notation.

  • int32 ntx = 14

    The number of transactions in the block.

  • string previous_block_hash = 15

    The hash of the previous block.

  • bytes raw_hex = 16

    The raw hex of the block.

• rpc GetCFilter (GetCFilterRequest, GetCFilterResponse)

  neutrino.proto:47

  GetCFilter returns a compact filter from a block.

  message GetCFilterRequest

  neutrino.proto:210

  • string hash = 1

    Block hash in hex notation.

  message GetCFilterResponse

  neutrino.proto:215

  • bytes filter = 1

    GCS filter.

• rpc GetBlockHash (GetBlockHashRequest, GetBlockHashResponse)

  neutrino.proto:53

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

  message GetBlockHashRequest

  neutrino.proto:220

  • int32 height = 1

    The block height or index.

  message GetBlockHashResponse

  neutrino.proto:225

  • string hash = 1

    The block hash.