Mirroristas/kaspad
2
0
Fork 0
mirror of https://github.com/kaspanet/kaspad.git synced 2025-06-26 07:52:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
kaspad/infrastructure/network/netadapter/server/grpcserver/protowire
History
stasatdaglabs 541205904e
Add RPC documentation (#1379) 
* Split messages.proto to p2p and rpc.

* Split messages.proto to p2p and rpc.

* Write a short intro to the RPC docs.

* Start documenting RPC calls.

* Use a custom protoc-gen-doc.

* Continue writing RPC documentation.

* Finish writing RPC documentation.

* Fix a formatting error.

* Fix merge errors.

* Fix formatting into protowire/README.md.

* Rerun go generate ..

Co-authored-by: Ori Newman <orinewman1@gmail.com>
2021-01-07 16:55:47 +02:00
..
common.go
Make DomainHash and TransactionID read-only structs (#1282)
2020-12-24 16:15:23 +02:00
generate.go
Add RPC documentation (#1379)
2021-01-07 16:55:47 +02:00
messages_grpc.pb.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
messages.pb.go
Add RPC documentation (#1379)
2021-01-07 16:55:47 +02:00
messages.proto
Add RPC documentation (#1379)
2021-01-07 16:55:47 +02:00
p2p_addresses.go
[NOD-1538] Fix MinimalNetAdapter and don't insert BlockRelations before making sure the block's parents exist (#1074)
2020-11-17 16:00:16 +02:00
p2p_block_headers.go
Improve the performance of downloading headers (#1340)
2021-01-03 17:57:14 +02:00
p2p_block_locator.go
[NOD-1500] Glue between domain and application (#1007)
2020-11-08 11:55:54 +02:00
p2p_block.go
[NOD-1525] Implement headers first ibd (#1017)
2020-11-10 16:14:51 +02:00
p2p_done_ibd_blocks.go
[NOD-1525] Implement headers first ibd (#1017)
2020-11-10 16:14:51 +02:00
p2p_header.go
Add script pubkey version to signature hash (#1360)
2021-01-06 11:51:12 +02:00
p2p_ibd_block_locator_highest_hash.go
Move the heavy lifting in BlockLocator from the syncer to the syncee (#1324)
2020-12-30 15:44:14 +02:00
p2p_ibd_block_locator.go
Move the heavy lifting in BlockLocator from the syncer to the syncee (#1324)
2020-12-30 15:44:14 +02:00
p2p_ibd_block.go
[NOD-1525] Implement headers first ibd (#1017)
2020-11-10 16:14:51 +02:00
p2p_ibd_root_hash.go
Move the heavy lifting in BlockLocator from the syncer to the syncee (#1324)
2020-12-30 15:44:14 +02:00
p2p_ibd_root_not_found.go
[NOD-1525] Implement headers first ibd (#1017)
2020-11-10 16:14:51 +02:00
p2p_ibd_root_utxo_set_and_block.go
[NOD-1518] Fix genesis block insertion and integration tests (#1013)
2020-11-12 15:19:39 +02:00
p2p_inv_relay_block.go
[NOD-1500] Glue between domain and application (#1007)
2020-11-08 11:55:54 +02:00
p2p_inv_transactions.go
[NOD-1500] Glue between domain and application (#1007)
2020-11-08 11:55:54 +02:00
p2p_ping.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
p2p_pong.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
p2p_reject.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
p2p_request_addresses.go
[NOD-1538] Fix mempool not wrapping consensus errors and bad invalid message handling (#1082)
2020-11-17 16:00:16 +02:00
p2p_request_block_locator.go
[NOD-1579] Improve the IBD mechanism (#1174)
2020-12-06 16:23:56 +02:00
p2p_request_headers.go
[NOD-1525] Implement headers first ibd (#1017)
2020-11-10 16:14:51 +02:00
p2p_request_ibd_blocks.go
[NOD-1579] Improve the IBD mechanism (#1174)
2020-12-06 16:23:56 +02:00
p2p_request_ibd_root_hash.go
Move the heavy lifting in BlockLocator from the syncer to the syncee (#1324)
2020-12-30 15:44:14 +02:00
p2p_request_ibd_root_utxo_set_and_block.go
[NOD-1518] Fix genesis block insertion and integration tests (#1013)
2020-11-12 15:19:39 +02:00
p2p_request_next_headers.go
[NOD-1525] Implement headers first ibd (#1017)
2020-11-10 16:14:51 +02:00
p2p_request_relay_blocks.go
[NOD-1525] Implement headers first ibd (#1017)
2020-11-10 16:14:51 +02:00
p2p_request_transactions.go
[NOD-1500] Glue between domain and application (#1007)
2020-11-08 11:55:54 +02:00
p2p_transaction_not_found.go
[NOD-1500] Glue between domain and application (#1007)
2020-11-08 11:55:54 +02:00
p2p_transaction.go
Add script pubkey version to signature hash (#1360)
2021-01-06 11:51:12 +02:00
p2p_verack.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
p2p_version.go
[NOD-1579] Improve the IBD mechanism (#1174)
2020-12-06 16:23:56 +02:00
p2p.pb.go
Add RPC documentation (#1379)
2021-01-07 16:55:47 +02:00
p2p.proto
Add RPC documentation (#1379)
2021-01-07 16:55:47 +02:00
README.md
Add RPC documentation (#1379)
2021-01-07 16:55:47 +02:00
rpc_add_peer.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
rpc_get_block_count.go
[NOD-1594] Add HeaderCount to GetBlockCount rpc call (#1197)
2020-12-08 19:11:35 +02:00
rpc_get_block_dag_info.go
[NOD-1595] Implement all fields of GetBlockDAGInfo (#1200)
2020-12-09 12:14:15 +02:00
rpc_get_block_template.go
Implement a simple mechanism to stop a miner from mining while kaspad is not synced (#1284)
2020-12-24 17:15:44 +02:00
rpc_get_block.go
Add script pubkey version to signature hash (#1360)
2021-01-06 11:51:12 +02:00
rpc_get_blocks.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
rpc_get_connected_peer_info.go
Add IsIBDPeer to GetConnectedPeerInfoResponse. (#1367)
2021-01-06 17:33:51 +02:00
rpc_get_current_network.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
rpc_get_headers.go
[NOD-1444] Implement getHeaders RPC command (#944)
2020-10-06 11:18:31 +03:00
rpc_get_mempool_entries.go
[NOD-1405] Add getMempoolEntries RPC command (#937)
2020-09-23 15:51:02 +03:00
rpc_get_mempool_entry.go
[NOD-1405] Add getMempoolEntries RPC command (#937)
2020-09-23 15:51:02 +03:00
rpc_get_peer_addresses.go
[NOD-1313] Refactor AddressManager (#918) (#1049)
2020-11-12 14:40:41 +02:00
rpc_get_selected_tip_hash.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
rpc_get_subnetwork.go
[NOD-1319] Reimplement kaspad's RPC in gRPC (#914)
2020-09-07 14:35:40 +03:00
rpc_get_utxos_by_addresses.go
Upgradability mechanisms script version (#1313)
2021-01-05 17:50:09 +02:00
rpc_get_virtual_selected_parent_blue_score.go
[NOD-1597] Implement a UTXO index (#1221)
2020-12-20 17:24:56 +02:00
rpc_get_virtual_selected_parent_chain_from_block.go
Implement virtual selected parent chain RPC methods (#1249)
2020-12-21 14:43:32 +02:00
rpc_notify_block_added.go
[NOD-1525] Implement headers first ibd (#1017)
2020-11-10 16:14:51 +02:00
rpc_notify_finality_conflicts.go
[NOD-1032] Consensus updates pre-pruning (#917)
2020-09-13 17:49:59 +03:00
rpc_notify_utxos_changed.go
Upgradability mechanisms script version (#1313)
2021-01-05 17:50:09 +02:00
rpc_notify_virtual_selected_parent_blue_score_changed.go
[NOD-1597] Implement a UTXO index (#1221)
2020-12-20 17:24:56 +02:00
rpc_notify_virtual_selected_parent_chain_changed.go
Implement virtual selected parent chain RPC methods (#1249)
2020-12-21 14:43:32 +02:00
rpc_resolve_finality_conflict.go
[NOD-1032] Consensus updates pre-pruning (#917)
2020-09-13 17:49:59 +03:00
rpc_shut_down.go
[NOD-1439] Added Stop command (#940)
2020-09-29 15:59:47 +03:00
rpc_submit_block.go
[NOD-1518] Fix genesis block insertion and integration tests (#1013)
2020-11-12 15:19:39 +02:00
rpc_submit_transaction.go
Add script pubkey version to signature hash (#1360)
2021-01-06 11:51:12 +02:00
rpc.md
Add RPC documentation (#1379)
2021-01-07 16:55:47 +02:00
rpc.pb.go
Add RPC documentation (#1379)
2021-01-07 16:55:47 +02:00
rpc.proto
Add RPC documentation (#1379)
2021-01-07 16:55:47 +02:00
wire.go
Improve the performance of downloading headers (#1340)
2021-01-03 17:57:14 +02:00

README.md

protowire

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

Documentation

To generate rpc.md:

  1. go get -u github.com/kaspanet/protoc-gen-doc/cmd/protoc-gen-doc
  2. In the protowire directory: protoc --doc_out=. --doc_opt=markdown,rpc.md rpc.proto