Hyperledger Burrow RPC接口
程序员文章站
2024-01-27 14:23:04
...
默认配置
[RPC]
[RPC.Info]
Enabled = true
ListenHost = "0.0.0.0"
ListenPort = "26658"
[RPC.Profiler]
Enabled = false
ListenHost = "0.0.0.0"
ListenPort = "6060"
[RPC.GRPC]
Enabled = true
ListenHost = "0.0.0.0"
ListenPort = "10997"
[RPC.Metrics]
Enabled = false
ListenHost = "0.0.0.0"
ListenPort = "9102"
MetricsPath = "/metrics"
BlockSampleSize = 100
[RPC.Web3]
Enabled = true
ListenHost = "0.0.0.0"
ListenPort = "26660"
RPC.info
提供一个简易的web ui ，浏览器打开http://localhost:26658/, 可以展示查询相关的rpc接口信息，并暴露相应的restful接口。
Available endpoints:
http://localhost:26658/account_stats
http://localhost:26658/accounts
http://localhost:26658/chain_id
http://localhost:26658/consensus
http://localhost:26658/genesis
http://localhost:26658/network
http://localhost:26658/network/registry
http://localhost:26658/validators
Endpoints that require arguments:
http://localhost:26658/account?address=_
http://localhost:26658/account_human?address=_
http://localhost:26658/block?height=_
http://localhost:26658/blocks?minHeight=_&maxHeight=_
http://localhost:26658/dump_storage?address=_
http://localhost:26658/name?name=_
http://localhost:26658/names?regex=_
http://localhost:26658/status?block_time_within=_&block_seen_time_within=_
http://localhost:26658/storage?address=_&key=_
http://localhost:26658/unconfirmed_txs?maxTxs=_
RPC.Profiler
用于性能分析，启用Profiler后，浏览器打开http://localhost:6060/debug/pprof/
pprof 是用于可视化和分析性能分析数据的工具
RPC.Web3
web3兼容的RPC服务器，可以与以太坊工具（Truffle，Metamask，Remix IDE）集成，支持的方法如下：
// Returns the version of the current client
Web3ClientVersion() (*Web3ClientVersionResult, error)
// Hashes data using the Keccak-256 algorithm
Web3Sha3(*Web3Sha3Params) (*Web3Sha3Result, error)
// Determines if this client is listening for new network connections.
NetListening() (*NetListeningResult, error)
// Returns the number of peers currently connected to this client.
NetPeerCount() (*NetPeerCountResult, error)
// Returns the chain ID associated with the current network.
NetVersion() (*NetVersionResult, error)
// Returns the number of most recent block.
EthBlockNumber() (*EthBlockNumberResult, error)
// Executes a new message call (locally) immediately without creating a transaction on the block chain.
EthCall(*EthCallParams) (*EthCallResult, error)
// Returns the currently configured chain id, a value used in replay-protected transaction signing as introduced by [EIP-155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md).
EthChainId() (*EthChainIdResult, error)
// Returns the client coinbase address.
EthCoinbase() (*EthCoinbaseResult, error)
// Generates and returns an estimate of how much gas is necessary to allow the transaction to complete. The transaction will not be added to the blockchain. Note that the estimate may be significantly more than the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance.
EthEstimateGas(*EthEstimateGasParams) (*EthEstimateGasResult, error)
// Returns the current price per gas in wei
EthGasPrice() (*EthGasPriceResult, error)
// Returns Ether balance of a given or account or contract
EthGetBalance(*EthGetBalanceParams) (*EthGetBalanceResult, error)
// Gets a block for a given hash
EthGetBlockByHash(*EthGetBlockByHashParams) (*EthGetBlockByHashResult, error)
// Gets a block for a given number salad
EthGetBlockByNumber(*EthGetBlockByNumberParams) (*EthGetBlockByNumberResult, error)
// Returns the number of transactions in a block from a block matching the given block hash.
EthGetBlockTransactionCountByHash(*EthGetBlockTransactionCountByHashParams) (*EthGetBlockTransactionCountByHashResult, error)
// Returns the number of transactions in a block from a block matching the given block number.
EthGetBlockTransactionCountByNumber(*EthGetBlockTransactionCountByNumberParams) (*EthGetBlockTransactionCountByNumberResult, error)
// Returns code at a given contract address
EthGetCode(*EthGetCodeParams) (*EthGetCodeResult, error)
// Polling method for a filter, which returns an array of logs which occurred since last poll.
EthGetFilterChanges(*EthGetFilterChangesParams) (*EthGetFilterChangesResult, error)
// Returns an array of all logs matching filter with given id.
EthGetFilterLogs(*EthGetFilterLogsParams) (*EthGetFilterLogsResult, error)
// Returns raw transaction data of a transaction with the given hash.
EthGetRawTransactionByHash(*EthGetRawTransactionByHashParams) (*EthGetRawTransactionByHashResult, error)
// Returns raw transaction data of a transaction with the given hash.
EthGetRawTransactionByBlockHashAndIndex(*EthGetRawTransactionByBlockHashAndIndexParams) (*EthGetRawTransactionByBlockHashAndIndexResult, error)
// Returns raw transaction data of a transaction with the given hash.
EthGetRawTransactionByBlockNumberAndIndex(*EthGetRawTransactionByBlockNumberAndIndexParams) (*EthGetRawTransactionByBlockNumberAndIndexResult, error)
// Returns an array of all logs matching a given filter object.
EthGetLogs(*EthGetLogsParams) (*EthGetLogsResult, error)
// Gets a storage value from a contract address, a position, and an optional blockNumber
EthGetStorageAt(*EthGetStorageAtParams) (*EthGetStorageAtResult, error)
// Returns the information about a transaction requested by the block hash and index of which it was mined.
EthGetTransactionByBlockHashAndIndex(*EthGetTransactionByBlockHashAndIndexParams) (*EthGetTransactionByBlockHashAndIndexResult, error)
// Returns the information about a transaction requested by the block hash and index of which it was mined.
EthGetTransactionByBlockNumberAndIndex(*EthGetTransactionByBlockNumberAndIndexParams) (*EthGetTransactionByBlockNumberAndIndexResult, error)
// Returns the information about a transaction requested by transaction hash.
EthGetTransactionByHash(*EthGetTransactionByHashParams) (*EthGetTransactionByHashResult, error)
// Returns the number of transactions sent from an address
EthGetTransactionCount(*EthGetTransactionCountParams) (*EthGetTransactionCountResult, error)
// Returns the receipt information of a transaction by its hash.
EthGetTransactionReceipt(*EthGetTransactionReceiptParams) (*EthGetTransactionReceiptResult, error)
// Returns information about a uncle of a block by hash and uncle index position.
EthGetUncleByBlockHashAndIndex(*EthGetUncleByBlockHashAndIndexParams) (*EthGetUncleByBlockHashAndIndexResult, error)
// Returns information about a uncle of a block by hash and uncle index position.
EthGetUncleByBlockNumberAndIndex(*EthGetUncleByBlockNumberAndIndexParams) (*EthGetUncleByBlockNumberAndIndexResult, error)
// Returns the number of uncles in a block from a block matching the given block hash.
EthGetUncleCountByBlockHash(*EthGetUncleCountByBlockHashParams) (*EthGetUncleCountByBlockHashResult, error)
// Returns the number of uncles in a block from a block matching the given block number.
EthGetUncleCountByBlockNumber(*EthGetUncleCountByBlockNumberParams) (*EthGetUncleCountByBlockNumberResult, error)
// Returns the account- and storage-values of the specified account including the Merkle-proof.
EthGetProof(*EthGetProofParams) (*EthGetProofResult, error)
// Returns the hash of the current block, the seedHash, and the boundary condition to be met ('target').
EthGetWork() (*EthGetWorkResult, error)
// Returns the number of hashes per second that the node is mining with.
EthHashrate() (*EthHashrateResult, error)
// Returns true if client is actively mining new blocks.
EthMining() (*EthMiningResult, error)
// Creates a filter in the node, to notify when a new block arrives. To check if the state has changed, call eth_getFilterChanges.
EthNewBlockFilter() (*EthNewBlockFilterResult, error)
// Creates a filter object, based on filter options, to notify when the state changes (logs). To check if the state has changed, call eth_getFilterChanges.
EthNewFilter(*EthNewFilterParams) (*EthNewFilterResult, error)
// Creates a filter in the node, to notify when new pending transactions arrive. To check if the state has changed, call eth_getFilterChanges.
EthNewPendingTransactionFilter() (*EthNewPendingTransactionFilterResult, error)
// Returns the pending transactions list
EthPendingTransactions() (*EthPendingTransactionsResult, error)
// Returns the current ethereum protocol version.
EthProtocolVersion() (*EthProtocolVersionResult, error)
// The sign method calculates an Ethereum specific signature.
EthSign(*EthSignParams) (*EthSignResult, error)
// Returns a list of addresses owned by client.
EthAccounts() (*EthAccountsResult, error)
// Creates new message call transaction or a contract creation, if the data field contains code.
EthSendTransaction(*EthSendTransactionParams) (*EthSendTransactionResult, error)
// Creates new message call transaction or a contract creation for signed transactions.
EthSendRawTransaction(*EthSendRawTransactionParams) (*EthSendRawTransactionResult, error)
// Returns an array of all logs matching a given filter object.
EthSubmitHashrate(*EthSubmitHashrateParams) (*EthSubmitHashrateResult, error)
// Used for submitting a proof-of-work solution.
EthSubmitWork(*EthSubmitWorkParams) (*EthSubmitWorkResult, error)
// Returns an object with data about the sync status or false.
EthSyncing() (*EthSyncingResult, error)
// Uninstalls a filter with given id. Should always be called when watch is no longer needed. Additionally Filters timeout when they aren't requested with eth_getFilterChanges for a period of time.
EthUninstallFilter(*EthUninstallFilterParams) (*EthUninstallFilterResult, error)
RPC.GRPC
分client和server端
Dump service
GetDump(*GetDumpParam, Dump_GetDumpServer) error
ExecutionEvents service
// Get StreamEvents (including transactions) for a range of block heights
Stream(*BlocksRequest, ExecutionEvents_StreamServer) error
// Get a particular TxExecution by hash
Tx(context.Context, *TxRequest) (*exec.TxExecution, error)
// GetEvents provides events streaming one block at a time - that is all events emitted in a particular block
// are guaranteed to be delivered in each GetEventsResponse
Events(*BlocksRequest, ExecutionEvents_EventsServer) error
Query service
Status(context.Context, *StatusParam) (*rpc.ResultStatus, error)
GetAccount(context.Context, *GetAccountParam) (*acm.Account, error)
GetMetadata(context.Context, *GetMetadataParam) (*MetadataResult, error)
GetStorage(context.Context, *GetStorageParam) (*StorageValue, error)
ListAccounts(*ListAccountsParam, Query_ListAccountsServer) error
GetName(context.Context, *GetNameParam) (*names.Entry, error)
ListNames(*ListNamesParam, Query_ListNamesServer) error
// GetNetworkRegistry returns for each validator address, the list of their identified node at the current state
GetNetworkRegistry(context.Context, *GetNetworkRegistryParam) (*NetworkRegistry, error)
GetValidatorSet(context.Context, *GetValidatorSetParam) (*ValidatorSet, error)
GetValidatorSetHistory(context.Context, *GetValidatorSetHistoryParam) (*ValidatorSetHistory, error)
GetProposal(context.Context, *GetProposalParam) (*payload.Ballot, error)
ListProposals(*ListProposalsParam, Query_ListProposalsServer) error
GetStats(context.Context, *GetStatsParam) (*Stats, error)
GetBlockHeader(context.Context, *GetBlockParam) (*types.Header, error)
Transact service
// Broadcast a transaction to the mempool - if the transaction is not signed signing will be attempted server-side
// and wait for it to be included in block
BroadcastTxSync(context.Context, *TxEnvelopeParam) (*exec.TxExecution, error)
// Broadcast a transaction to the mempool - if the transaction is not signed signing will be attempted server-side
BroadcastTxAsync(context.Context, *TxEnvelopeParam) (*txs.Receipt, error)
// Sign transaction server-side
SignTx(context.Context, *TxEnvelopeParam) (*TxEnvelope, error)
// Formulate a transaction from a Payload and retrun the envelop with the Tx bytes ready to sign
FormulateTx(context.Context, *payload.Any) (*TxEnvelope, error)
// Formulate and sign a CallTx transaction signed server-side and wait for it to be included in a block, retrieving response
CallTxSync(context.Context, *payload.CallTx) (*exec.TxExecution, error)
// Formulate and sign a CallTx transaction signed server-side
CallTxAsync(context.Context, *payload.CallTx) (*txs.Receipt, error)
// Perform a 'simulated' call of a contract against the current committed EVM state without any changes been saved
// and wait for the transaction to be included in a block
CallTxSim(context.Context, *payload.CallTx) (*exec.TxExecution, error)
// Perform a 'simulated' execution of provided code against the current committed EVM state without any changes been saved
CallCodeSim(context.Context, *CallCodeParam) (*exec.TxExecution, error)
// Formulate a SendTx transaction signed server-side and wait for it to be included in a block, retrieving response
SendTxSync(context.Context, *payload.SendTx) (*exec.TxExecution, error)
// Formulate and SendTx transaction signed server-side
SendTxAsync(context.Context, *payload.SendTx) (*txs.Receipt, error)
// Formulate a NameTx signed server-side and wait for it to be included in a block returning the registered name
NameTxSync(context.Context, *payload.NameTx) (*exec.TxExecution, error)
// Formulate a NameTx signed server-side
NameTxAsync(context.Context, *payload.NameTx) (*txs.Receipt, error)
RPC.Metrics
可将数据吐到prometheus，利用grafana展示。
浏览器打开http://localhost:9102/metrics，可查询当前Metrics值
# HELP burrow_accounts_contracts Current contracts on the chain
# TYPE burrow_accounts_contracts gauge
burrow_accounts_contracts{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 0
# HELP burrow_accounts_users Current users on the chain
# TYPE burrow_accounts_users gauge
burrow_accounts_users{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 3
# HELP burrow_chain_block_height Current block height
# TYPE burrow_chain_block_height counter
burrow_chain_block_height{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 8
# HELP burrow_chain_block_time Histogram metric of block duration
# TYPE burrow_chain_block_time histogram
burrow_chain_block_time_bucket{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11",le="300"} 5
burrow_chain_block_time_bucket{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11",le="568"} 6
burrow_chain_block_time_bucket{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11",le="+Inf"} 7
burrow_chain_block_time_sum{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 2070.207764
burrow_chain_block_time_count{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 7
# HELP burrow_peers_inbound Current inbound peers
# TYPE burrow_peers_inbound gauge
burrow_peers_inbound{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 0
# HELP burrow_peers_outbound Current outbound peers
# TYPE burrow_peers_outbound gauge
burrow_peers_outbound{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 0
# HELP burrow_peers_total Current total peers
# TYPE burrow_peers_total gauge
burrow_peers_total{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 0
# HELP burrow_transactions_in_mempool Current depth of the mempool
# TYPE burrow_transactions_in_mempool gauge
burrow_transactions_in_mempool{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 0
# HELP burrow_transactions_per_block Histogram metric of transactions per block
# TYPE burrow_transactions_per_block histogram
burrow_transactions_per_block_bucket{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11",le="0"} 8
burrow_transactions_per_block_bucket{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11",le="+Inf"} 8
burrow_transactions_per_block_sum{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 0
burrow_transactions_per_block_count{chain_id="BurrowChain_FAB3C1-D6962A",moniker="BurrowChain_FAB3C1-D6962A_Node_3191169FCA4C3F678ADAF4B83870044530916D11"} 8
# HELP go_gc_duration_seconds A summary of the GC invocation durations.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 3.2484e-05
go_gc_duration_seconds{quantile="0.25"} 4.0078e-05
go_gc_duration_seconds{quantile="0.5"} 7.4365e-05
go_gc_duration_seconds{quantile="0.75"} 0.000103171
go_gc_duration_seconds{quantile="1"} 0.000164968
go_gc_duration_seconds_sum 0.000575938
go_gc_duration_seconds_count 8
# HELP go_goroutines Number of goroutines that currently exist.
# TYPE go_goroutines gauge
go_goroutines 54
# HELP go_info Information about the Go environment.
# TYPE go_info gauge
go_info{version="go1.14"} 1
# HELP go_memstats_alloc_bytes Number of bytes allocated and still in use.
# TYPE go_memstats_alloc_bytes gauge
go_memstats_alloc_bytes 2.9882768e+07
# HELP go_memstats_alloc_bytes_total Total number of bytes allocated, even if freed.
# TYPE go_memstats_alloc_bytes_total counter
go_memstats_alloc_bytes_total 5.294816e+07
# HELP go_memstats_buck_hash_sys_bytes Number of bytes used by the profiling bucket hash table.
# TYPE go_memstats_buck_hash_sys_bytes gauge
go_memstats_buck_hash_sys_bytes 1.454088e+06
# HELP go_memstats_frees_total Total number of frees.
# TYPE go_memstats_frees_total counter
go_memstats_frees_total 44424
# HELP go_memstats_gc_cpu_fraction The fraction of this program's available CPU time used by the GC since the program started.
# TYPE go_memstats_gc_cpu_fraction gauge
go_memstats_gc_cpu_fraction 7.174487250610696e-06
# HELP go_memstats_gc_sys_bytes Number of bytes used for garbage collection system metadata.
# TYPE go_memstats_gc_sys_bytes gauge
go_memstats_gc_sys_bytes 3.574024e+06
# HELP go_memstats_heap_alloc_bytes Number of heap bytes allocated and still in use.
# TYPE go_memstats_heap_alloc_bytes gauge
go_memstats_heap_alloc_bytes 2.9882768e+07
# HELP go_memstats_heap_idle_bytes Number of heap bytes waiting to be used.
# TYPE go_memstats_heap_idle_bytes gauge
go_memstats_heap_idle_bytes 3.4168832e+07
# HELP go_memstats_heap_inuse_bytes Number of heap bytes that are in use.
# TYPE go_memstats_heap_inuse_bytes gauge
go_memstats_heap_inuse_bytes 3.1858688e+07
# HELP go_memstats_heap_objects Number of allocated objects.
# TYPE go_memstats_heap_objects gauge
go_memstats_heap_objects 12903
# HELP go_memstats_heap_released_bytes Number of heap bytes released to OS.
# TYPE go_memstats_heap_released_bytes gauge
go_memstats_heap_released_bytes 3.1760384e+07
# HELP go_memstats_heap_sys_bytes Number of heap bytes obtained from system.
# TYPE go_memstats_heap_sys_bytes gauge
go_memstats_heap_sys_bytes 6.602752e+07
# HELP go_memstats_last_gc_time_seconds Number of seconds since 1970 of last garbage collection.
# TYPE go_memstats_last_gc_time_seconds gauge
go_memstats_last_gc_time_seconds 1.585795532653038e+09
# HELP go_memstats_lookups_total Total number of pointer lookups.
# TYPE go_memstats_lookups_total counter
go_memstats_lookups_total 0
# HELP go_memstats_mallocs_total Total number of mallocs.
# TYPE go_memstats_mallocs_total counter
go_memstats_mallocs_total 57327
# HELP go_memstats_mcache_inuse_bytes Number of bytes in use by mcache structures.
# TYPE go_memstats_mcache_inuse_bytes gauge
go_memstats_mcache_inuse_bytes 20832
# HELP go_memstats_mcache_sys_bytes Number of bytes used for mcache structures obtained from system.
# TYPE go_memstats_mcache_sys_bytes gauge
go_memstats_mcache_sys_bytes 32768
# HELP go_memstats_mspan_inuse_bytes Number of bytes in use by mspan structures.
# TYPE go_memstats_mspan_inuse_bytes gauge
go_memstats_mspan_inuse_bytes 142664
# HELP go_memstats_mspan_sys_bytes Number of bytes used for mspan structures obtained from system.
# TYPE go_memstats_mspan_sys_bytes gauge
go_memstats_mspan_sys_bytes 147456
# HELP go_memstats_next_gc_bytes Number of heap bytes when next garbage collection will take place.
# TYPE go_memstats_next_gc_bytes gauge
go_memstats_next_gc_bytes 5.9476576e+07
# HELP go_memstats_other_sys_bytes Number of bytes used for other system allocations.
# TYPE go_memstats_other_sys_bytes gauge
go_memstats_other_sys_bytes 2.476016e+06
# HELP go_memstats_stack_inuse_bytes Number of bytes in use by the stack allocator.
# TYPE go_memstats_stack_inuse_bytes gauge
go_memstats_stack_inuse_bytes 1.081344e+06
# HELP go_memstats_stack_sys_bytes Number of bytes obtained from system for stack allocator.
# TYPE go_memstats_stack_sys_bytes gauge
go_memstats_stack_sys_bytes 1.081344e+06
# HELP go_memstats_sys_bytes Number of bytes obtained from system.
# TYPE go_memstats_sys_bytes gauge
go_memstats_sys_bytes 7.4793216e+07
# HELP go_threads Number of OS threads created.
# TYPE go_threads gauge
go_threads 18
# HELP promhttp_metric_handler_requests_in_flight Current number of scrapes being served.
# TYPE promhttp_metric_handler_requests_in_flight gauge
promhttp_metric_handler_requests_in_flight 1
# HELP promhttp_metric_handler_requests_total Total number of scrapes by HTTP status code.
# TYPE promhttp_metric_handler_requests_total counter
promhttp_metric_handler_requests_total{code="200"} 1
promhttp_metric_handler_requests_total{code="500"} 0
promhttp_metric_handler_requests_total{code="503"} 0