Categorygithub.com/astrix-network/astrixdinfrastructurenetworknetadapterservergrpcserverprotowire

package

0.12.18

Repository: https://github.com/astrix-network/astrixd.git

Documentation: pkg.go.dev

# README

protowire

Download and place in your PATH: https://github.com/protocolbuffers/protobuf/releases/download/v3.12.3/protoc-3.12.3-linux-x86_64.zip
go install github.com/golang/protobuf/protoc-gen-go
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc
In the protowire directory: go generate .

Documentation

To generate rpc.md:

go install -u github.com/astrix-network/protoc-gen-doc/cmd/protoc-gen-doc
In the protowire directory: protoc --doc_out=. --doc_opt=markdown,rpc.md rpc.proto

# Functions

FromAppMessage

FromAppMessage creates a AstrixdMessage from a appmessage.Message.

NewP2PClient

No description provided by the author

NewRPCClient

No description provided by the author

RegisterP2PServer

No description provided by the author

RegisterRPCServer

No description provided by the author

# Constants

SubmitBlockResponseMessage_BLOCK_INVALID

No description provided by the author

SubmitBlockResponseMessage_IS_IN_IBD

No description provided by the author

SubmitBlockResponseMessage_NONE

No description provided by the author

# Variables

File_messages_proto

No description provided by the author

File_p2p_proto

No description provided by the author

File_rpc_proto

No description provided by the author

P2P_ServiceDesc

P2P_ServiceDesc is the grpc.ServiceDesc for P2P service.

RPC_ServiceDesc

RPC_ServiceDesc is the grpc.ServiceDesc for RPC service.

SubmitBlockResponseMessage_RejectReason_name

Enum value maps for SubmitBlockResponseMessage_RejectReason.

SubmitBlockResponseMessage_RejectReason_value

Enum value maps for SubmitBlockResponseMessage_RejectReason.

# Structs

AcceptedTransactionIds

No description provided by the author

AddPeerRequestMessage

AddPeerRequestMessage adds a peer to astrixd's outgoing connection list.

AddPeerResponseMessage

No description provided by the author

AddressesMessage

No description provided by the author

AstrixdMessage

No description provided by the author

AstrixdMessage_AddPeerRequest

No description provided by the author

AstrixdMessage_AddPeerResponse

No description provided by the author

AstrixdMessage_Addresses

No description provided by the author

AstrixdMessage_BanRequest

No description provided by the author

AstrixdMessage_BanResponse

No description provided by the author

AstrixdMessage_Block

No description provided by the author

AstrixdMessage_BlockAddedNotification

No description provided by the author

AstrixdMessage_BlockHeaders

No description provided by the author

AstrixdMessage_BlockLocator

No description provided by the author

AstrixdMessage_BlockWithTrustedData

No description provided by the author

AstrixdMessage_BlockWithTrustedDataV4

No description provided by the author

AstrixdMessage_DoneBlocksWithTrustedData

No description provided by the author

AstrixdMessage_DoneHeaders

No description provided by the author

AstrixdMessage_DonePruningPointUtxoSetChunks

No description provided by the author

AstrixdMessage_EstimateNetworkHashesPerSecondRequest

No description provided by the author

AstrixdMessage_EstimateNetworkHashesPerSecondResponse

No description provided by the author

AstrixdMessage_FinalityConflictNotification

No description provided by the author

AstrixdMessage_FinalityConflictResolvedNotification

No description provided by the author

AstrixdMessage_GetBalanceByAddressRequest

No description provided by the author

AstrixdMessage_GetBalanceByAddressResponse

No description provided by the author

AstrixdMessage_GetBalancesByAddressesRequest

No description provided by the author

AstrixdMessage_GetBalancesByAddressesResponse

No description provided by the author

AstrixdMessage_GetBlockCountRequest

No description provided by the author

AstrixdMessage_GetBlockCountResponse

No description provided by the author

AstrixdMessage_GetBlockDagInfoRequest

No description provided by the author

AstrixdMessage_GetBlockDagInfoResponse

No description provided by the author

AstrixdMessage_GetBlockRequest

No description provided by the author

AstrixdMessage_GetBlockResponse

No description provided by the author

AstrixdMessage_GetBlocksRequest

No description provided by the author

AstrixdMessage_GetBlocksResponse

No description provided by the author

AstrixdMessage_GetBlockTemplateRequest

No description provided by the author

AstrixdMessage_GetBlockTemplateResponse

No description provided by the author

AstrixdMessage_GetCoinSupplyRequest

No description provided by the author

AstrixdMessage_GetCoinSupplyResponse

No description provided by the author

AstrixdMessage_GetConnectedPeerInfoRequest

No description provided by the author

AstrixdMessage_GetConnectedPeerInfoResponse

No description provided by the author

AstrixdMessage_GetCurrentNetworkRequest

No description provided by the author

AstrixdMessage_GetCurrentNetworkResponse

No description provided by the author

AstrixdMessage_GetHeadersRequest

No description provided by the author

AstrixdMessage_GetHeadersResponse

No description provided by the author

AstrixdMessage_GetInfoRequest

No description provided by the author

AstrixdMessage_GetInfoResponse

No description provided by the author

AstrixdMessage_GetMempoolEntriesByAddressesRequest

No description provided by the author

AstrixdMessage_GetMempoolEntriesByAddressesResponse

No description provided by the author

AstrixdMessage_GetMempoolEntriesRequest

No description provided by the author

AstrixdMessage_GetMempoolEntriesResponse

No description provided by the author

AstrixdMessage_GetMempoolEntryRequest

No description provided by the author

AstrixdMessage_GetMempoolEntryResponse

No description provided by the author

AstrixdMessage_GetPeerAddressesRequest

No description provided by the author

AstrixdMessage_GetPeerAddressesResponse

No description provided by the author

AstrixdMessage_GetSelectedTipHashRequest

No description provided by the author

AstrixdMessage_GetSelectedTipHashResponse

No description provided by the author

AstrixdMessage_GetSubnetworkRequest

No description provided by the author

AstrixdMessage_GetSubnetworkResponse

No description provided by the author

AstrixdMessage_GetUtxosByAddressesRequest

No description provided by the author

AstrixdMessage_GetUtxosByAddressesResponse

No description provided by the author

AstrixdMessage_GetVirtualSelectedParentBlueScoreRequest

No description provided by the author

AstrixdMessage_GetVirtualSelectedParentBlueScoreResponse

No description provided by the author

AstrixdMessage_GetVirtualSelectedParentChainFromBlockRequest

No description provided by the author

AstrixdMessage_GetVirtualSelectedParentChainFromBlockResponse

No description provided by the author

AstrixdMessage_IbdBlock

No description provided by the author

AstrixdMessage_IbdBlockLocator

No description provided by the author

AstrixdMessage_IbdBlockLocatorHighestHash

No description provided by the author

AstrixdMessage_IbdBlockLocatorHighestHashNotFound

No description provided by the author

AstrixdMessage_IbdChainBlockLocator

No description provided by the author

AstrixdMessage_InvRelayBlock

No description provided by the author

AstrixdMessage_InvTransactions

No description provided by the author

AstrixdMessage_NewBlockTemplateNotification

No description provided by the author

AstrixdMessage_NotifyBlockAddedRequest

No description provided by the author

AstrixdMessage_NotifyBlockAddedResponse

No description provided by the author

AstrixdMessage_NotifyFinalityConflictsRequest

No description provided by the author

AstrixdMessage_NotifyFinalityConflictsResponse

No description provided by the author

AstrixdMessage_NotifyNewBlockTemplateRequest

No description provided by the author

AstrixdMessage_NotifyNewBlockTemplateResponse

No description provided by the author

AstrixdMessage_NotifyPruningPointUTXOSetOverrideRequest

No description provided by the author

AstrixdMessage_NotifyPruningPointUTXOSetOverrideResponse

No description provided by the author

AstrixdMessage_NotifyUtxosChangedRequest

No description provided by the author

AstrixdMessage_NotifyUtxosChangedResponse

No description provided by the author

AstrixdMessage_NotifyVirtualDaaScoreChangedRequest

No description provided by the author

AstrixdMessage_NotifyVirtualDaaScoreChangedResponse

No description provided by the author

AstrixdMessage_NotifyVirtualSelectedParentBlueScoreChangedRequest

No description provided by the author

AstrixdMessage_NotifyVirtualSelectedParentBlueScoreChangedResponse

No description provided by the author

AstrixdMessage_NotifyVirtualSelectedParentChainChangedRequest

No description provided by the author

AstrixdMessage_NotifyVirtualSelectedParentChainChangedResponse

No description provided by the author

AstrixdMessage_Ping

No description provided by the author

AstrixdMessage_Pong

No description provided by the author

AstrixdMessage_PruningPointProof

No description provided by the author

AstrixdMessage_PruningPoints

No description provided by the author

AstrixdMessage_PruningPointUtxoSetChunk

No description provided by the author

AstrixdMessage_PruningPointUTXOSetOverrideNotification

No description provided by the author

AstrixdMessage_Ready

No description provided by the author

AstrixdMessage_Reject

No description provided by the author

AstrixdMessage_RequestAddresses

No description provided by the author

AstrixdMessage_RequestAnticone

No description provided by the author

AstrixdMessage_RequestBlockLocator

No description provided by the author

AstrixdMessage_RequestHeaders

No description provided by the author

AstrixdMessage_RequestIBDBlocks

No description provided by the author

AstrixdMessage_RequestIBDChainBlockLocator

No description provided by the author

AstrixdMessage_RequestNextHeaders

No description provided by the author

AstrixdMessage_RequestNextPruningPointAndItsAnticoneBlocks

No description provided by the author

AstrixdMessage_RequestNextPruningPointUtxoSetChunk

No description provided by the author

AstrixdMessage_RequestPruningPointAndItsAnticone

No description provided by the author

AstrixdMessage_RequestPruningPointProof

No description provided by the author

AstrixdMessage_RequestPruningPointUTXOSet

No description provided by the author

AstrixdMessage_RequestRelayBlocks

No description provided by the author

AstrixdMessage_RequestTransactions

No description provided by the author

AstrixdMessage_ResolveFinalityConflictRequest

No description provided by the author

AstrixdMessage_ResolveFinalityConflictResponse

No description provided by the author

AstrixdMessage_ShutDownRequest

No description provided by the author

AstrixdMessage_ShutDownResponse

No description provided by the author

AstrixdMessage_StopNotifyingPruningPointUTXOSetOverrideRequest

No description provided by the author

AstrixdMessage_StopNotifyingPruningPointUTXOSetOverrideResponse

No description provided by the author

AstrixdMessage_StopNotifyingUtxosChangedRequest

No description provided by the author

AstrixdMessage_StopNotifyingUtxosChangedResponse

No description provided by the author

AstrixdMessage_SubmitBlockRequest

No description provided by the author

AstrixdMessage_SubmitBlockResponse

No description provided by the author

AstrixdMessage_SubmitTransactionRequest

No description provided by the author

AstrixdMessage_SubmitTransactionResponse

No description provided by the author

AstrixdMessage_Transaction

No description provided by the author

AstrixdMessage_TransactionNotFound

No description provided by the author

AstrixdMessage_TrustedData

No description provided by the author

AstrixdMessage_UnbanRequest

No description provided by the author

AstrixdMessage_UnbanResponse

No description provided by the author

AstrixdMessage_UnexpectedPruningPoint

No description provided by the author

AstrixdMessage_UtxosChangedNotification

No description provided by the author

AstrixdMessage_Verack

No description provided by the author

AstrixdMessage_Version

No description provided by the author

AstrixdMessage_VirtualDaaScoreChangedNotification

No description provided by the author

AstrixdMessage_VirtualSelectedParentBlueScoreChangedNotification

No description provided by the author

AstrixdMessage_VirtualSelectedParentChainChangedNotification

No description provided by the author

BalancesByAddressEntry

No description provided by the author

BanRequestMessage

BanRequestMessage bans the given ip.

BanResponseMessage

No description provided by the author

BlockAddedNotificationMessage

BlockAddedNotificationMessage is sent whenever a blocks has been added (NOT accepted) into the DAG.

BlockGhostdagDataHashPair

No description provided by the author

BlockHeader

No description provided by the author

BlockHeadersMessage

No description provided by the author

BlockLevelParents

No description provided by the author

BlockLocatorMessage

No description provided by the author

BlockMessage

No description provided by the author

BlockWithTrustedDataMessage

No description provided by the author

BlockWithTrustedDataV4Message

No description provided by the author

BluesAnticoneSizes

No description provided by the author

DaaBlock

No description provided by the author

DaaBlockV4

No description provided by the author

DoneBlocksWithTrustedDataMessage

No description provided by the author

DoneHeadersMessage

No description provided by the author

DonePruningPointUtxoSetChunksMessage

No description provided by the author

EstimateNetworkHashesPerSecondRequestMessage

No description provided by the author

EstimateNetworkHashesPerSecondResponseMessage

No description provided by the author

FinalityConflictNotificationMessage

No description provided by the author

FinalityConflictResolvedNotificationMessage

No description provided by the author

GetBalanceByAddressRequestMessage

GetBalanceByAddressRequest returns the total balance in unspent transactions towards a given address This call is only available when this astrixd was started with `--utxoindex`.

GetBalanceByAddressResponseMessage

No description provided by the author

GetBalancesByAddressesRequestMessage

No description provided by the author

GetBalancesByAddressesResponseMessage

No description provided by the author

GetBlockCountRequestMessage

GetBlockCountRequestMessage requests the current number of blocks in this astrixd.

GetBlockCountResponseMessage

No description provided by the author

GetBlockDagInfoRequestMessage

GetBlockDagInfoRequestMessage requests general information about the current state of this astrixd's DAG.

GetBlockDagInfoResponseMessage

No description provided by the author

GetBlockRequestMessage

GetBlockRequestMessage requests information about a specific block.

GetBlockResponseMessage

No description provided by the author

GetBlocksRequestMessage

GetBlocksRequestMessage requests blocks between a certain block lowHash up to this astrixd's current virtual.

GetBlocksResponseMessage

No description provided by the author

GetBlockTemplateRequestMessage

GetBlockTemplateRequestMessage requests a current block template.

GetBlockTemplateResponseMessage

No description provided by the author

GetCoinSupplyRequestMessage

No description provided by the author

GetCoinSupplyResponseMessage

No description provided by the author

GetConnectedPeerInfoMessage

No description provided by the author

GetConnectedPeerInfoRequestMessage

GetConnectedPeerInfoRequestMessage requests information about all the p2p peers currently connected to this astrixd.

GetConnectedPeerInfoResponseMessage

No description provided by the author

GetCurrentNetworkRequestMessage

GetCurrentNetworkRequestMessage requests the network astrixd is currently running against.

GetCurrentNetworkResponseMessage

No description provided by the author

GetHeadersRequestMessage

GetHeadersRequestMessage requests headers between the given startHash and the current virtual, up to the given limit.

GetHeadersResponseMessage

No description provided by the author

GetInfoRequestMessage

GetInfoRequestMessage returns info about the node.

GetInfoResponseMessage

No description provided by the author

GetMempoolEntriesByAddressesRequestMessage

No description provided by the author

GetMempoolEntriesByAddressesResponseMessage

No description provided by the author

GetMempoolEntriesRequestMessage

GetMempoolEntriesRequestMessage requests information about all the transactions currently in the mempool.

GetMempoolEntriesResponseMessage

No description provided by the author

GetMempoolEntryRequestMessage

GetMempoolEntryRequestMessage requests information about a specific transaction in the mempool.

GetMempoolEntryResponseMessage

No description provided by the author

GetPeerAddressesKnownAddressMessage

No description provided by the author

GetPeerAddressesRequestMessage

GetPeerAddressesRequestMessage requests the list of known astrixd addresses in the current network.

GetPeerAddressesResponseMessage

No description provided by the author

GetSelectedTipHashRequestMessage

GetSelectedTipHashRequestMessage requests the hash of the current virtual's selected parent.

GetSelectedTipHashResponseMessage

No description provided by the author

GetSubnetworkRequestMessage

GetSubnetworkRequestMessage requests information about a specific subnetwork Currently unimplemented.

GetSubnetworkResponseMessage

No description provided by the author

GetUtxosByAddressesRequestMessage

GetUtxosByAddressesRequestMessage requests all current UTXOs for the given astrixd addresses This call is only available when this astrixd was started with `--utxoindex`.

GetUtxosByAddressesResponseMessage

No description provided by the author

GetVirtualSelectedParentBlueScoreRequestMessage

GetVirtualSelectedParentBlueScoreRequestMessage requests the blue score of the current selected parent of the virtual block.

GetVirtualSelectedParentBlueScoreResponseMessage

No description provided by the author

GetVirtualSelectedParentChainFromBlockRequestMessage

GetVirtualSelectedParentChainFromBlockRequestMessage requests the virtual selected parent chain from some startHash to this astrixd's current virtual.

GetVirtualSelectedParentChainFromBlockResponseMessage

No description provided by the author

GhostdagData

No description provided by the author

Hash

No description provided by the author

IbdBlockLocatorHighestHashMessage

No description provided by the author

IbdBlockLocatorHighestHashNotFoundMessage

No description provided by the author

IbdBlockLocatorMessage

No description provided by the author

IbdChainBlockLocatorMessage

No description provided by the author

InvRelayBlockMessage

No description provided by the author

InvTransactionsMessage

No description provided by the author

MempoolEntry

No description provided by the author

MempoolEntryByAddress

No description provided by the author

NetAddress

No description provided by the author

NewBlockTemplateNotificationMessage

NewBlockTemplateNotificationMessage is sent whenever a new updated block template is available for miners.

NotifyBlockAddedRequestMessage

NotifyBlockAddedRequestMessage registers this connection for blockAdded notifications.

NotifyBlockAddedResponseMessage

No description provided by the author

NotifyFinalityConflictsRequestMessage

No description provided by the author

NotifyFinalityConflictsResponseMessage

No description provided by the author

NotifyNewBlockTemplateRequestMessage

NotifyNewBlockTemplateRequestMessage registers this connection for NewBlockTemplate notifications.

NotifyNewBlockTemplateResponseMessage

No description provided by the author

NotifyPruningPointUTXOSetOverrideRequestMessage

NotifyPruningPointUTXOSetOverrideRequestMessage registers this connection for pruning point UTXO set override notifications.

NotifyPruningPointUTXOSetOverrideResponseMessage

No description provided by the author

NotifyUtxosChangedRequestMessage

NotifyUtxosChangedRequestMessage registers this connection for utxoChanged notifications for the given addresses.

NotifyUtxosChangedResponseMessage

No description provided by the author

NotifyVirtualDaaScoreChangedRequestMessage

NotifyVirtualDaaScoreChangedRequestMessage registers this connection for virtualDaaScoreChanged notifications.

NotifyVirtualDaaScoreChangedResponseMessage

No description provided by the author

NotifyVirtualSelectedParentBlueScoreChangedRequestMessage

NotifyVirtualSelectedParentBlueScoreChangedRequestMessage registers this connection for virtualSelectedParentBlueScoreChanged notifications.

NotifyVirtualSelectedParentBlueScoreChangedResponseMessage

No description provided by the author

NotifyVirtualSelectedParentChainChangedRequestMessage

NotifyVirtualSelectedParentChainChangedRequestMessage registers this connection for virtualSelectedParentChainChanged notifications.

NotifyVirtualSelectedParentChainChangedResponseMessage

No description provided by the author

Outpoint

No description provided by the author

OutpointAndUtxoEntryPair

No description provided by the author

PingMessage

No description provided by the author

PongMessage

No description provided by the author

PruningPointProofHeaderArray

No description provided by the author

PruningPointProofMessage

No description provided by the author

PruningPointsMessage

No description provided by the author

PruningPointUtxoSetChunkMessage

No description provided by the author

PruningPointUTXOSetOverrideNotificationMessage

PruningPointUTXOSetOverrideNotificationMessage is sent whenever the UTXO index resets due to pruning point change via IBD.

ReadyMessage

No description provided by the author

RejectMessage

No description provided by the author

RequestAddressesMessage

No description provided by the author

RequestAnticoneMessage

No description provided by the author

RequestBlockLocatorMessage

No description provided by the author

RequestHeadersMessage

No description provided by the author

RequestIBDBlocksMessage

No description provided by the author

RequestIBDChainBlockLocatorMessage

No description provided by the author

RequestNextHeadersMessage

No description provided by the author

RequestNextPruningPointAndItsAnticoneBlocksMessage

No description provided by the author

RequestNextPruningPointUtxoSetChunkMessage

No description provided by the author

RequestPruningPointAndItsAnticoneMessage

No description provided by the author

RequestPruningPointProofMessage

No description provided by the author

RequestPruningPointUTXOSetMessage

No description provided by the author

RequestRelayBlocksMessage

No description provided by the author

RequestTransactionsMessage

No description provided by the author

ResolveFinalityConflictRequestMessage

No description provided by the author

ResolveFinalityConflictResponseMessage

No description provided by the author

RpcBlock

No description provided by the author

RpcBlockHeader

No description provided by the author

RpcBlockLevelParents

No description provided by the author

RpcBlockVerboseData

No description provided by the author

RPCError

RPCError represents a generic non-internal error.

RpcOutpoint

No description provided by the author

RpcScriptPublicKey

No description provided by the author

RpcTransaction

No description provided by the author

RpcTransactionInput

No description provided by the author

RpcTransactionInputVerboseData

No description provided by the author

RpcTransactionOutput

No description provided by the author

RpcTransactionOutputVerboseData

No description provided by the author

RpcTransactionVerboseData

No description provided by the author

RpcUtxoEntry

No description provided by the author

ScriptPublicKey

No description provided by the author

ShutDownRequestMessage

ShutDownRequestMessage shuts down this astrixd.

ShutDownResponseMessage

No description provided by the author

StopNotifyingPruningPointUTXOSetOverrideRequestMessage

StopNotifyingPruningPointUTXOSetOverrideRequestMessage unregisters this connection for pruning point UTXO set override notifications.

StopNotifyingPruningPointUTXOSetOverrideResponseMessage

No description provided by the author

StopNotifyingUtxosChangedRequestMessage

StopNotifyingUtxosChangedRequestMessage unregisters this connection for utxoChanged notifications for the given addresses.

StopNotifyingUtxosChangedResponseMessage

No description provided by the author

SubmitBlockRequestMessage

SubmitBlockRequestMessage requests to submit a block into the DAG.

SubmitBlockResponseMessage

No description provided by the author

SubmitTransactionRequestMessage

SubmitTransactionRequestMessage submits a transaction to the mempool.

SubmitTransactionResponseMessage

No description provided by the author

SubnetworkId

No description provided by the author

TransactionId

No description provided by the author

TransactionInput

No description provided by the author

TransactionMessage

No description provided by the author

TransactionNotFoundMessage

No description provided by the author

TransactionOutput

No description provided by the author

TrustedDataMessage

No description provided by the author

UnbanRequestMessage

UnbanRequestMessage unbans the given ip.

UnbanResponseMessage

No description provided by the author

UnexpectedPruningPointMessage

No description provided by the author

UnimplementedP2PServer

UnimplementedP2PServer must be embedded to have forward compatible implementations.

UnimplementedRPCServer

UnimplementedRPCServer must be embedded to have forward compatible implementations.

UtxoEntry

No description provided by the author

UtxosByAddressesEntry

No description provided by the author

UtxosChangedNotificationMessage

UtxosChangedNotificationMessage is sent whenever the UTXO index had been updated.

VerackMessage

No description provided by the author

VersionMessage

No description provided by the author

VirtualDaaScoreChangedNotificationMessage

VirtualDaaScoreChangedNotificationMessage is sent whenever the DAA score of the virtual changes.

VirtualSelectedParentBlueScoreChangedNotificationMessage

VirtualSelectedParentBlueScoreChangedNotificationMessage is sent whenever the blue score of the virtual's selected parent changes.

VirtualSelectedParentChainChangedNotificationMessage

VirtualSelectedParentChainChangedNotificationMessage is sent whenever the DAG's selected parent chain had changed.

# Interfaces

P2P_MessageStreamClient

No description provided by the author

P2P_MessageStreamServer

No description provided by the author

P2PClient

P2PClient is the client API for P2P service.

P2PServer

P2PServer is the server API for P2P service.

RPC_MessageStreamClient

No description provided by the author

RPC_MessageStreamServer

No description provided by the author

RPCClient

RPCClient is the client API for RPC service.

RPCServer

RPCServer is the server API for RPC service.

UnsafeP2PServer

UnsafeP2PServer may be embedded to opt out of forward compatibility for this service.

UnsafeRPCServer

UnsafeRPCServer may be embedded to opt out of forward compatibility for this service.

# Type aliases

SubmitBlockResponseMessage_RejectReason

No description provided by the author