Skip to main content

Module rest

Module rest 

Source
Expand description

Axum REST handlers derived from the google.api.http annotations, transcoding HTTP/JSON onto the tonic service traits.

Constantsยง

PUBLIC_REST_PATHS
REST paths that are marked as public (no authentication required).

Functionsยง

all_rest_routes
Build a combined Axum router with REST routes for all proto services.
availability_service_rest_router
Build Axum REST routes for AvailabilityService.
catchup_service_rest_router
Build Axum REST routes for CatchupService.
config_service_rest_router
Build Axum REST routes for ConfigService.
database_service_rest_router
Build Axum REST routes for DatabaseService.
explorer_service_rest_router
Build Axum REST routes for ExplorerService.
light_client_service_rest_router
Build Axum REST routes for LightClientService.
merklized_state_service_rest_router
Build Axum REST routes for MerklizedStateService.
node_service_rest_router
Build Axum REST routes for NodeService.
rest_availability_service_get_block ๐Ÿ”’
GetBlock - JSON endpoint.
rest_availability_service_get_block_range ๐Ÿ”’
GetBlockRange - JSON endpoint.
rest_availability_service_get_block_ranges ๐Ÿ”’
GetBlockRanges - JSON endpoint.
rest_availability_service_get_block_summary ๐Ÿ”’
GetBlockSummary - JSON endpoint.
rest_availability_service_get_block_summary_range ๐Ÿ”’
GetBlockSummaryRange - JSON endpoint.
rest_availability_service_get_cert2 ๐Ÿ”’
GetCert2 - JSON endpoint.
rest_availability_service_get_header ๐Ÿ”’
GetHeader - JSON endpoint.
rest_availability_service_get_header_range ๐Ÿ”’
GetHeaderRange - JSON endpoint.
rest_availability_service_get_incorrect_encoding_proof ๐Ÿ”’
GetIncorrectEncodingProof - JSON endpoint.
rest_availability_service_get_leaf ๐Ÿ”’
GetLeaf - JSON endpoint.
rest_availability_service_get_leaf_range ๐Ÿ”’
GetLeafRange - JSON endpoint.
rest_availability_service_get_leaf_ranges ๐Ÿ”’
GetLeafRanges - JSON endpoint.
rest_availability_service_get_limits ๐Ÿ”’
GetLimits - JSON endpoint.
rest_availability_service_get_namespace_proof ๐Ÿ”’
GetNamespaceProof - JSON endpoint.
rest_availability_service_get_namespace_proof_range ๐Ÿ”’
GetNamespaceProofRange - JSON endpoint.
rest_availability_service_get_payload ๐Ÿ”’
GetPayload - JSON endpoint.
rest_availability_service_get_payload_range ๐Ÿ”’
GetPayloadRange - JSON endpoint.
rest_availability_service_get_state_cert ๐Ÿ”’
GetStateCert - JSON endpoint.
rest_availability_service_get_state_cert_v2 ๐Ÿ”’
GetStateCertV2 - JSON endpoint.
rest_availability_service_get_transaction ๐Ÿ”’
GetTransaction - JSON endpoint.
rest_availability_service_get_transaction_proof ๐Ÿ”’
GetTransactionProof - JSON endpoint.
rest_availability_service_get_vid_common ๐Ÿ”’
GetVidCommon - JSON endpoint.
rest_availability_service_get_vid_common_range ๐Ÿ”’
GetVidCommonRange - JSON endpoint.
rest_availability_service_get_vid_common_ranges ๐Ÿ”’
GetVidCommonRanges - JSON endpoint.
rest_availability_service_stream_blocks ๐Ÿ”’
StreamBlocks - SSE streaming endpoint.
rest_availability_service_stream_headers ๐Ÿ”’
StreamHeaders - SSE streaming endpoint.
rest_availability_service_stream_leaves ๐Ÿ”’
StreamLeaves - SSE streaming endpoint.
rest_availability_service_stream_namespace_proofs ๐Ÿ”’
StreamNamespaceProofs - SSE streaming endpoint.
rest_availability_service_stream_payloads ๐Ÿ”’
StreamPayloads - SSE streaming endpoint.
rest_availability_service_stream_transactions ๐Ÿ”’
StreamTransactions - SSE streaming endpoint.
rest_availability_service_stream_vid_common ๐Ÿ”’
StreamVidCommon - SSE streaming endpoint.
rest_catchup_service_get_catchup_blocks_frontier ๐Ÿ”’
GetCatchupBlocksFrontier - JSON endpoint.
rest_catchup_service_get_catchup_cert2 ๐Ÿ”’
GetCatchupCert2 - JSON endpoint.
rest_catchup_service_get_catchup_chain_config ๐Ÿ”’
GetCatchupChainConfig - JSON endpoint.
rest_catchup_service_get_catchup_fee_account ๐Ÿ”’
GetCatchupFeeAccount - JSON endpoint.
rest_catchup_service_get_catchup_fee_accounts ๐Ÿ”’
GetCatchupFeeAccounts - JSON endpoint.
rest_catchup_service_get_catchup_leaf_chain ๐Ÿ”’
GetCatchupLeafChain - JSON endpoint.
rest_catchup_service_get_catchup_reward_account ๐Ÿ”’
GetCatchupRewardAccount - JSON endpoint.
rest_catchup_service_get_catchup_reward_account_v2 ๐Ÿ”’
GetCatchupRewardAccountV2 - JSON endpoint.
rest_catchup_service_get_catchup_reward_accounts ๐Ÿ”’
GetCatchupRewardAccounts - JSON endpoint.
rest_catchup_service_get_catchup_reward_merkle_tree_v2 ๐Ÿ”’
GetCatchupRewardMerkleTreeV2 - JSON endpoint.
rest_catchup_service_get_catchup_state_cert ๐Ÿ”’
GetCatchupStateCert - JSON endpoint.
rest_config_service_get_env ๐Ÿ”’
GetEnv - JSON endpoint.
rest_config_service_get_hotshot_config ๐Ÿ”’
GetHotshotConfig - JSON endpoint.
rest_config_service_get_runtime_config ๐Ÿ”’
GetRuntimeConfig - JSON endpoint.
rest_database_service_get_migration_status ๐Ÿ”’
GetMigrationStatus - JSON endpoint.
rest_database_service_get_table_sizes ๐Ÿ”’
GetTableSizes - JSON endpoint.
rest_explorer_service_get_explorer_block_detail ๐Ÿ”’
GetExplorerBlockDetail - JSON endpoint.
rest_explorer_service_get_explorer_block_summaries ๐Ÿ”’
GetExplorerBlockSummaries - JSON endpoint.
rest_explorer_service_get_explorer_search ๐Ÿ”’
GetExplorerSearch - JSON endpoint.
rest_explorer_service_get_explorer_summary ๐Ÿ”’
GetExplorerSummary - JSON endpoint.
rest_explorer_service_get_explorer_transaction_detail ๐Ÿ”’
GetExplorerTransactionDetail - JSON endpoint.
rest_explorer_service_get_explorer_transaction_summaries ๐Ÿ”’
GetExplorerTransactionSummaries - JSON endpoint.
rest_light_client_service_get_light_client_header_proof ๐Ÿ”’
GetLightClientHeaderProof - JSON endpoint.
rest_light_client_service_get_light_client_leaf_proof ๐Ÿ”’
GetLightClientLeafProof - JSON endpoint.
rest_light_client_service_get_light_client_namespace_proof ๐Ÿ”’
GetLightClientNamespaceProof - JSON endpoint.
rest_light_client_service_get_light_client_namespace_proof_range ๐Ÿ”’
GetLightClientNamespaceProofRange - JSON endpoint.
rest_light_client_service_get_light_client_namespaces_proof_range ๐Ÿ”’
GetLightClientNamespacesProofRange - JSON endpoint.
rest_light_client_service_get_light_client_payload_proof ๐Ÿ”’
GetLightClientPayloadProof - JSON endpoint.
rest_light_client_service_get_light_client_payload_proof_range ๐Ÿ”’
GetLightClientPayloadProofRange - JSON endpoint.
rest_light_client_service_get_light_client_payload_proof_ranges ๐Ÿ”’
GetLightClientPayloadProofRanges - JSON endpoint.
rest_light_client_service_get_light_client_stake_table ๐Ÿ”’
GetLightClientStakeTable - JSON endpoint.
rest_merklized_state_service_get_block_state_path ๐Ÿ”’
GetBlockStatePath - JSON endpoint.
rest_merklized_state_service_get_fee_state_path ๐Ÿ”’
GetFeeStatePath - JSON endpoint.
rest_merklized_state_service_get_latest_fee_balance ๐Ÿ”’
GetLatestFeeBalance - JSON endpoint.
rest_merklized_state_service_get_state_height ๐Ÿ”’
GetStateHeight - JSON endpoint.
rest_node_service_get_all_validators ๐Ÿ”’
GetAllValidators - JSON endpoint.
rest_node_service_get_block_reward ๐Ÿ”’
GetBlockReward - JSON endpoint.
rest_node_service_get_header_window ๐Ÿ”’
GetHeaderWindow - JSON endpoint.
rest_node_service_get_node_block_height ๐Ÿ”’
GetNodeBlockHeight - JSON endpoint.
rest_node_service_get_node_limits ๐Ÿ”’
GetNodeLimits - JSON endpoint.
rest_node_service_get_payload_size ๐Ÿ”’
GetPayloadSize - JSON endpoint.
rest_node_service_get_proposal_participation ๐Ÿ”’
GetProposalParticipation - JSON endpoint.
rest_node_service_get_stake_table ๐Ÿ”’
GetStakeTable - JSON endpoint.
rest_node_service_get_sync_status ๐Ÿ”’
GetSyncStatus - JSON endpoint.
rest_node_service_get_transaction_count ๐Ÿ”’
GetTransactionCount - JSON endpoint.
rest_node_service_get_validators ๐Ÿ”’
GetValidators - JSON endpoint.
rest_node_service_get_vid_share ๐Ÿ”’
GetVidShare - JSON endpoint.
rest_node_service_get_vote_participation ๐Ÿ”’
GetVoteParticipation - JSON endpoint.
rest_reward_state_service_get_reward_account_proof ๐Ÿ”’
GetRewardAccountProof - JSON endpoint.
rest_reward_state_service_get_reward_amounts ๐Ÿ”’
GetRewardAmounts - JSON endpoint.
rest_reward_state_service_get_reward_balance ๐Ÿ”’
GetRewardBalance - JSON endpoint.
rest_reward_state_service_get_reward_claim_input ๐Ÿ”’
GetRewardClaimInput - JSON endpoint.
rest_reward_state_service_get_reward_merkle_tree_v2 ๐Ÿ”’
GetRewardMerkleTreeV2 - JSON endpoint.
rest_state_signature_service_get_state_signature ๐Ÿ”’
GetStateSignature - JSON endpoint.
rest_status_service_get_block_height ๐Ÿ”’
GetBlockHeight - JSON endpoint.
rest_status_service_get_node_keys ๐Ÿ”’
GetNodeKeys - JSON endpoint.
rest_status_service_get_success_rate ๐Ÿ”’
GetSuccessRate - JSON endpoint.
rest_status_service_get_time_since_last_decide ๐Ÿ”’
GetTimeSinceLastDecide - JSON endpoint.
rest_submit_service_submit_transaction ๐Ÿ”’
SubmitTransaction - JSON endpoint.
rest_token_service_get_circulating_supply ๐Ÿ”’
GetCirculatingSupply - JSON endpoint.
rest_token_service_get_circulating_supply_ethereum ๐Ÿ”’
GetCirculatingSupplyEthereum - JSON endpoint.
rest_token_service_get_total_issued_supply ๐Ÿ”’
GetTotalIssuedSupply - JSON endpoint.
rest_token_service_get_total_minted_supply ๐Ÿ”’
GetTotalMintedSupply - JSON endpoint.
rest_token_service_get_total_reward_distributed ๐Ÿ”’
GetTotalRewardDistributed - JSON endpoint.
reward_state_service_rest_router
Build Axum REST routes for RewardStateService.
state_signature_service_rest_router
Build Axum REST routes for StateSignatureService.
status_service_rest_router
Build Axum REST routes for StatusService.
submit_service_rest_router
Build Axum REST routes for SubmitService.
token_service_rest_router
Build Axum REST routes for TokenService.