async fn broadcast_via_ws<T: Serialize + Send + Clone + 'static>(
+broadcast_via_ws in massa_api::api - Rust serve in massa_api - Rust pub(crate) async fn serve<T>(
+serve in massa_api - Rust pub(crate) async fn serve<T>(
api: RpcModule<T>,
url: &SocketAddr,
api_config: &APIConfig,
diff --git a/massa_api/fn.wrong_api.html b/massa_api/fn.wrong_api.html
index 8b2db1bc54..a5da018bc5 100644
--- a/massa_api/fn.wrong_api.html
+++ b/massa_api/fn.wrong_api.html
@@ -1 +1 @@
-wrong_api in massa_api - Rust wrong_api in massa_api - Rust massa_api - Rust Expand description
Copyright (c) 2022 MASSA LABS info@massa.net
+
massa_api - Rust Expand description
Copyright (c) 2022 MASSA LABS info@massa.net
Json RPC API for a massa-node
Modules§
- api 🔒 Copyright (c) 2022 MASSA LABS info@massa.net
Json RPC API for a massa-node
- Copyright (c) 2022 MASSA LABS info@massa.net
diff --git a/massa_api/private/fn.get_file_len.html b/massa_api/private/fn.get_file_len.html
index 6a0716207a..d89b891f3a 100644
--- a/massa_api/private/fn.get_file_len.html
+++ b/massa_api/private/fn.get_file_len.html
@@ -1,4 +1,4 @@
-
get_file_len in massa_api::private - Rust Function massa_api::private::get_file_len
source · fn get_file_len(
+get_file_len in massa_api::private - Rust Function massa_api::private::get_file_len
source · fn get_file_len(
bootstrap_list_file: PathBuf,
list_type: &ListType,
create: bool,
diff --git a/massa_api/private/fn.read_ips_from_jsonfile.html b/massa_api/private/fn.read_ips_from_jsonfile.html
index 276c06e4cc..14b839d317 100644
--- a/massa_api/private/fn.read_ips_from_jsonfile.html
+++ b/massa_api/private/fn.read_ips_from_jsonfile.html
@@ -1,4 +1,4 @@
-read_ips_from_jsonfile in massa_api::private - Rust Function massa_api::private::read_ips_from_jsonfile
source · fn read_ips_from_jsonfile(
+read_ips_from_jsonfile in massa_api::private - Rust Function massa_api::private::read_ips_from_jsonfile
source · fn read_ips_from_jsonfile(
bootstrap_list_file: PathBuf,
list_type: &ListType,
) -> RpcResult<Vec<IpAddr>>
Expand description
Read bootstrap list IP(s) from json file
diff --git a/massa_api/private/fn.run_scrud_operation.html b/massa_api/private/fn.run_scrud_operation.html
index 3c090ce501..a8c9b42e5a 100644
--- a/massa_api/private/fn.run_scrud_operation.html
+++ b/massa_api/private/fn.run_scrud_operation.html
@@ -1,4 +1,4 @@
-run_scrud_operation in massa_api::private - Rust Function massa_api::private::run_scrud_operation
source · fn run_scrud_operation(
+run_scrud_operation in massa_api::private - Rust Function massa_api::private::run_scrud_operation
source · fn run_scrud_operation(
bootstrap_list_file: PathBuf,
ips: Vec<IpAddr>,
list_type: ListType,
diff --git a/massa_api/private/fn.write_ips_to_jsonfile.html b/massa_api/private/fn.write_ips_to_jsonfile.html
index f197c9f498..4a584364f4 100644
--- a/massa_api/private/fn.write_ips_to_jsonfile.html
+++ b/massa_api/private/fn.write_ips_to_jsonfile.html
@@ -1,4 +1,4 @@
-write_ips_to_jsonfile in massa_api::private - Rust Function massa_api::private::write_ips_to_jsonfile
source · fn write_ips_to_jsonfile(
+write_ips_to_jsonfile in massa_api::private - Rust Function massa_api::private::write_ips_to_jsonfile
source · fn write_ips_to_jsonfile(
bootstrap_list_file: PathBuf,
ips: BTreeSet<IpAddr>,
list_type: &ListType,
diff --git a/massa_api/private/index.html b/massa_api/private/index.html
index 22ed528d8d..bfb80a39dd 100644
--- a/massa_api/private/index.html
+++ b/massa_api/private/index.html
@@ -1,2 +1,2 @@
-massa_api::private - Rust Expand description
Copyright (c) 2022 MASSA LABS info@massa.net
+massa_api::private - Rust Expand description
Copyright (c) 2022 MASSA LABS info@massa.net
Functions§
- Get length of the given file if it exists(or create it if requested)
- Read bootstrap list IP(s) from json file
- Run Search, Create, Read, Update, Delete operation on bootstrap list of IP(s)
- Write bootstrap list IP(s) from json file
check_input_operation in massa_api::public - Rust Function massa_api::public::check_input_operation
source · fn check_input_operation(
+check_input_operation in massa_api::public - Rust Function massa_api::public::check_input_operation
source · fn check_input_operation(
op_input: OperationInput,
api_cfg: &APIConfig,
last_slot: Option<Slot>,
diff --git a/massa_api/public/fn.get_address_datastore_keys_to_state_query_item.html b/massa_api/public/fn.get_address_datastore_keys_to_state_query_item.html
new file mode 100644
index 0000000000..3dd3a47893
--- /dev/null
+++ b/massa_api/public/fn.get_address_datastore_keys_to_state_query_item.html
@@ -0,0 +1,6 @@
+get_address_datastore_keys_to_state_query_item in massa_api::public - Rust fn get_address_datastore_keys_to_state_query_item(
+ value: GetAddressDatastoreKeysRequest,
+ max_datastore_query_config: Option<u32>,
+ max_datastore_key_length: u8,
+) -> RpcResult<ExecutionQueryRequestItem>
Expand description
Convert GetAddressDatastoreKeys to ExecutionQueryRequestItem
+massa_api::public - Rust Expand description
Copyright (c) 2022 MASSA LABS info@massa.net
-Functions§
- Checks the validity of an input operation.
massa_api::public - Rust Expand description
Copyright (c) 2022 MASSA LABS info@massa.net
+Functions§
- Checks the validity of an input operation.
- Convert GetAddressDatastoreKeys to ExecutionQueryRequestItem
API in massa_api - Rust pub struct API<T>(pub(crate) T);
Trait Implementations§
source§impl RpcServer for API<Public>
source§fn serve<'life0, 'life1, 'async_trait>(
self,
url: &'life0 SocketAddr,
api_config: &'life1 APIConfig,
diff --git a/massa_api/struct.ApiV2.html b/massa_api/struct.ApiV2.html
index a72463cdc5..5bcd8c4a1a 100644
--- a/massa_api/struct.ApiV2.html
+++ b/massa_api/struct.ApiV2.html
@@ -1,4 +1,4 @@
-ApiV2 in massa_api - Rust pub struct ApiV2 {
+ApiV2 in massa_api - Rust pub struct ApiV2 {
pub consensus_controller: Box<dyn ConsensusController>,
pub consensus_broadcasts: ConsensusBroadcasts,
pub execution_controller: Box<dyn ExecutionController>,
diff --git a/massa_api/struct.Private.html b/massa_api/struct.Private.html
index 7d45292928..db00e64538 100644
--- a/massa_api/struct.Private.html
+++ b/massa_api/struct.Private.html
@@ -1,4 +1,4 @@
-Private in massa_api - Rust pub struct Private {
+Private in massa_api - Rust pub struct Private {
pub protocol_controller: Box<dyn ProtocolController>,
pub execution_controller: Box<dyn ExecutionController>,
pub api_settings: APIConfig,
diff --git a/massa_api/struct.Public.html b/massa_api/struct.Public.html
index 21bc7f02cb..8abb64b084 100644
--- a/massa_api/struct.Public.html
+++ b/massa_api/struct.Public.html
@@ -1,4 +1,4 @@
-Public in massa_api - Rust pub struct Public {
+Public in massa_api - Rust pub struct Public {
pub consensus_controller: Box<dyn ConsensusController>,
pub execution_controller: Box<dyn ExecutionController>,
pub selector_controller: Box<dyn SelectorController>,
diff --git a/massa_api/struct.StopHandle.html b/massa_api/struct.StopHandle.html
index 79fc68fc0f..fa6e2ff724 100644
--- a/massa_api/struct.StopHandle.html
+++ b/massa_api/struct.StopHandle.html
@@ -1,7 +1,7 @@
-StopHandle in massa_api - Rust Struct massa_api::StopHandle
source · pub struct StopHandle {
+StopHandle in massa_api - Rust Struct massa_api::StopHandle
source · pub struct StopHandle {
pub(crate) server_handler: ServerHandle,
}
Expand description
Used to be able to stop the API
-Fields§
§server_handler: ServerHandleImplementations§
source§impl StopHandle
Fields§
§server_handler: ServerHandleImplementations§
source§impl StopHandle
Auto Trait Implementations§
§impl Freeze for StopHandle
§impl !RefUnwindSafe for StopHandle
§impl Send for StopHandle
§impl Sync for StopHandle
§impl Unpin for StopHandle
§impl !UnwindSafe for StopHandle
Blanket Implementations§
§impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
diff --git a/massa_api/trait.ApiServer.html b/massa_api/trait.ApiServer.html
index 58faccb740..48844b50dd 100644
--- a/massa_api/trait.ApiServer.html
+++ b/massa_api/trait.ApiServer.html
@@ -1,4 +1,4 @@
-ApiServer in massa_api - Rust pub trait ApiServer: MassaApiServer {
+ApiServer in massa_api - Rust pub trait ApiServer: MassaApiServer {
// Required method
fn serve<'life0, 'life1, 'async_trait>(
self,
@@ -9,7 +9,7 @@
'life0: 'async_trait,
'life1: 'async_trait;
}
Expand description
Used to manage the API
-Required Methods§
Required Methods§
sourcefn serve<'life0, 'life1, 'async_trait>(
self,
url: &'life0 SocketAddr,
api_config: &'life1 APIConfig,
diff --git a/massa_api/trait.MassaRpcServer.html b/massa_api/trait.MassaRpcServer.html
index 9d64a71cc8..d4a7edcaa7 100644
--- a/massa_api/trait.MassaRpcServer.html
+++ b/massa_api/trait.MassaRpcServer.html
@@ -1,5 +1,5 @@
-MassaRpcServer in massa_api - Rust Trait massa_api::MassaRpcServer
source · pub trait MassaRpcServer: Sized + Send + Sync + 'static {
-Show 40 methods
// Required methods
+MassaRpcServer in massa_api - Rust Trait massa_api::MassaRpcServer
source · pub trait MassaRpcServer: Sized + Send + Sync + 'static {
+Show 41 methods
// Required methods
fn stop_node(&self) -> RpcResult<()>;
fn node_sign_message<'life0, 'async_trait>(
&'life0 self,
@@ -200,7 +200,7 @@
'life0: 'async_trait;
fn get_openrpc_spec<'life0, 'async_trait>(
&'life0 self,
- ) -> Pin<Box<dyn Future<Output = RpcResult<Value>> + Send + 'async_trait>>
+ ) -> Pin<Box<dyn Future<Output = RpcResult<Value>> + Send + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
fn get_deferred_call_quote<'life0, 'async_trait>(
@@ -221,69 +221,75 @@
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<DeferredCallsSlotResponse>>> + Send + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
+ fn get_address_datastore_keys<'life0, 'async_trait>(
+ &'life0 self,
+ arg: Vec<GetAddressDatastoreKeysRequest>,
+ ) -> Pin<Box<dyn Future<Output = RpcResult<Vec<GetAddressDatastoreKeysResponse>>> + Send + 'async_trait>>
+ where Self: 'async_trait,
+ 'life0: 'async_trait;
// Provided method
fn into_rpc(self) -> RpcModule<Self> { ... }
}
Expand description
Server trait implementation for the MassaRpc RPC API.
-Required Methods§
sourcefn node_sign_message<'life0, 'async_trait>(
+
Required Methods§
sourcefn node_sign_message<'life0, 'async_trait>(
&'life0 self,
arg: Vec<u8>,
) -> Pin<Box<dyn Future<Output = RpcResult<PubkeySig>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Sign message with node’s key.
Returns the public key that signed the message and the signature.
-sourcefn add_staking_secret_keys<'life0, 'async_trait>(
+
sourcefn add_staking_secret_keys<'life0, 'async_trait>(
&'life0 self,
arg: Vec<String>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Add a vector of new secret(private) keys for the node to use to stake.
No confirmation to expect.
-sourcefn execute_read_only_bytecode<'life0, 'async_trait>(
+
sourcefn execute_read_only_bytecode<'life0, 'async_trait>(
&'life0 self,
arg: Vec<ReadOnlyBytecodeExecution>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<ExecuteReadOnlyResponse>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Execute bytecode in read-only mode.
-sourcefn execute_read_only_call<'life0, 'async_trait>(
+
sourcefn execute_read_only_call<'life0, 'async_trait>(
&'life0 self,
arg: Vec<ReadOnlyCall>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<ExecuteReadOnlyResponse>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Execute an SC function in read-only mode.
-sourcefn remove_staking_addresses<'life0, 'async_trait>(
+
sourcefn remove_staking_addresses<'life0, 'async_trait>(
&'life0 self,
arg: Vec<Address>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Remove a vector of addresses used to stake.
No confirmation to expect.
-sourcefn get_staking_addresses<'life0, 'async_trait>(
+
sourcefn get_staking_addresses<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = RpcResult<PreHashSet<Address>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Return hash set of staking addresses.
-sourcefn node_ban_by_ip<'life0, 'async_trait>(
+
sourcefn node_ban_by_ip<'life0, 'async_trait>(
&'life0 self,
arg: Vec<IpAddr>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Bans given IP address(es).
No confirmation to expect.
-sourcefn node_ban_by_id<'life0, 'async_trait>(
+
sourcefn node_ban_by_id<'life0, 'async_trait>(
&'life0 self,
arg: Vec<NodeId>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Bans given node id.
No confirmation to expect.
-sourcefn node_peers_whitelist<'life0, 'async_trait>(
+
sourcefn node_peers_whitelist<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<IpAddr>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Returns node peers whitelist IP address(es).
-sourcefn node_add_to_peers_whitelist<'life0, 'async_trait>(
+
sourcefn node_add_to_peers_whitelist<'life0, 'async_trait>(
&'life0 self,
arg: Vec<IpAddr>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
@@ -291,7 +297,7 @@
'life0: 'async_trait,
Add IP address(es) to node peers whitelist.
No confirmation to expect.
Note: If the ip was unknown it adds it to the known peers, otherwise it updates the peer type
-sourcefn node_remove_from_peers_whitelist<'life0, 'async_trait>(
+
sourcefn node_remove_from_peers_whitelist<'life0, 'async_trait>(
&'life0 self,
arg: Vec<IpAddr>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
@@ -299,139 +305,139 @@
'life0: 'async_trait,
Remove from peers whitelist given IP address(es).
keep it as standard
No confirmation to expect.
-sourcefn node_bootstrap_whitelist<'life0, 'async_trait>(
+
sourcefn node_bootstrap_whitelist<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<IpAddr>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Returns node bootstrap whitelist IP address(es).
-sourcefn node_bootstrap_whitelist_allow_all<'life0, 'async_trait>(
+
sourcefn node_bootstrap_whitelist_allow_all<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Allow everyone to bootstrap from the node.
remove bootstrap whitelist configuration file.
-sourcefn node_add_to_bootstrap_whitelist<'life0, 'async_trait>(
+
sourcefn node_add_to_bootstrap_whitelist<'life0, 'async_trait>(
&'life0 self,
arg: Vec<IpAddr>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Add IP address(es) to node bootstrap whitelist.
-sourcefn node_remove_from_bootstrap_whitelist<'life0, 'async_trait>(
+
sourcefn node_remove_from_bootstrap_whitelist<'life0, 'async_trait>(
&'life0 self,
arg: Vec<IpAddr>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Remove IP address(es) to bootstrap whitelist.
-sourcefn node_bootstrap_blacklist<'life0, 'async_trait>(
+
sourcefn node_bootstrap_blacklist<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<IpAddr>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Returns node bootstrap blacklist IP address(es).
-sourcefn node_add_to_bootstrap_blacklist<'life0, 'async_trait>(
+
sourcefn node_add_to_bootstrap_blacklist<'life0, 'async_trait>(
&'life0 self,
arg: Vec<IpAddr>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Add IP address(es) to node bootstrap blacklist.
-sourcefn node_remove_from_bootstrap_blacklist<'life0, 'async_trait>(
+
sourcefn node_remove_from_bootstrap_blacklist<'life0, 'async_trait>(
&'life0 self,
arg: Vec<IpAddr>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Remove IP address(es) to bootstrap blacklist.
-sourcefn node_unban_by_ip<'life0, 'async_trait>(
+
sourcefn node_unban_by_ip<'life0, 'async_trait>(
&'life0 self,
arg: Vec<IpAddr>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Unban given IP address(es).
No confirmation to expect.
-sourcefn node_unban_by_id<'life0, 'async_trait>(
+
sourcefn node_unban_by_id<'life0, 'async_trait>(
&'life0 self,
arg: Vec<NodeId>,
) -> Pin<Box<dyn Future<Output = RpcResult<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Unban given node id.
No confirmation to expect.
-sourcefn get_status<'life0, 'async_trait>(
+
sourcefn get_status<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = RpcResult<NodeStatus>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Summary of the current state: time, last final blocks (hash, thread, slot, timestamp), clique count, connected nodes count.
-sourcefn get_cliques<'life0, 'async_trait>(
+
sourcefn get_cliques<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<Clique>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Get cliques.
-sourcefn get_stakers<'life0, 'async_trait>(
+
sourcefn get_stakers<'life0, 'async_trait>(
&'life0 self,
page_request: Option<PageRequest>,
) -> Pin<Box<dyn Future<Output = RpcResult<PagedVec<(Address, u64)>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Returns the active stakers and their active roll counts for the current cycle.
-sourcefn get_operations<'life0, 'async_trait>(
+
sourcefn get_operations<'life0, 'async_trait>(
&'life0 self,
arg: Vec<OperationId>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<OperationInfo>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Returns operation(s) information associated to a given list of operation(s) ID(s).
-sourcefn get_endorsements<'life0, 'async_trait>(
+
sourcefn get_endorsements<'life0, 'async_trait>(
&'life0 self,
arg: Vec<EndorsementId>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<EndorsementInfo>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Returns endorsement(s) information associated to a given list of endorsement(s) ID(s)
-sourcefn get_blocks<'life0, 'async_trait>(
+
sourcefn get_blocks<'life0, 'async_trait>(
&'life0 self,
arg: Vec<BlockId>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<BlockInfo>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Returns block(s) information associated to a given list of block(s) ID(s)
-sourcefn get_blockclique_block_by_slot<'life0, 'async_trait>(
+
sourcefn get_blockclique_block_by_slot<'life0, 'async_trait>(
&'life0 self,
arg: Slot,
) -> Pin<Box<dyn Future<Output = RpcResult<Option<Block>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Get information on the block at a slot in the blockclique.
If there is no block at this slot a None is returned.
-sourcefn get_graph_interval<'life0, 'async_trait>(
+
sourcefn get_graph_interval<'life0, 'async_trait>(
&'life0 self,
arg: TimeInterval,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<BlockSummary>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Get the block graph within the specified time interval.
Optional parameters: from <time_start> (included) and to <time_end> (excluded) millisecond timestamp
-sourcefn get_datastore_entries<'life0, 'async_trait>(
+
sourcefn get_datastore_entries<'life0, 'async_trait>(
&'life0 self,
arg: Vec<DatastoreEntryInput>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<DatastoreEntryOutput>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Get multiple datastore entries.
-sourcefn get_addresses<'life0, 'async_trait>(
+
sourcefn get_addresses<'life0, 'async_trait>(
&'life0 self,
arg: Vec<Address>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<AddressInfo>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Get addresses.
-sourcefn get_addresses_bytecode<'life0, 'async_trait>(
+
sourcefn get_addresses_bytecode<'life0, 'async_trait>(
&'life0 self,
args: Vec<AddressFilter>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<Vec<u8>>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Get addresses bytecode.
-sourcefn get_slots_transfers<'life0, 'async_trait>(
+
sourcefn get_slots_transfers<'life0, 'async_trait>(
&'life0 self,
arg: Vec<Slot>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<Vec<Transfer>>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Get all the transfers for a slot
-sourcefn send_operations<'life0, 'async_trait>(
+
sourcefn send_operations<'life0, 'async_trait>(
&'life0 self,
arg: Vec<OperationInput>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<OperationId>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Adds operations to pool. Returns operations that were ok and sent to pool.
-sourcefn get_filtered_sc_output_event<'life0, 'async_trait>(
+
sourcefn get_filtered_sc_output_event<'life0, 'async_trait>(
&'life0 self,
arg: EventFilter,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<SCOutputEvent>>> + Send + 'async_trait>>where
@@ -444,28 +450,34 @@
original caller address
operation id
-
sourcefn get_openrpc_spec<'life0, 'async_trait>(
+
sourcefn get_openrpc_spec<'life0, 'async_trait>(
&'life0 self,
-) -> Pin<Box<dyn Future<Output = RpcResult<Value>> + Send + 'async_trait>>
sourcefn get_deferred_call_quote<'life0, 'async_trait>(
&'life0 self,
arg: Vec<DeferredCallsQuoteRequest>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<DeferredCallsQuoteResponse>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
DeferredCall quote
-sourcefn get_deferred_call_info<'life0, 'async_trait>(
+
sourcefn get_deferred_call_info<'life0, 'async_trait>(
&'life0 self,
arg: Vec<String>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<DeferredCallResponse>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
DeferredCall get info
-sourcefn get_deferred_call_ids_by_slot<'life0, 'async_trait>(
+
sourcefn get_deferred_call_ids_by_slot<'life0, 'async_trait>(
&'life0 self,
arg: Vec<Slot>,
) -> Pin<Box<dyn Future<Output = RpcResult<Vec<DeferredCallsSlotResponse>>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
List deferred calls for given slot
-
Provided Methods§
sourcefn into_rpc(self) -> RpcModule<Self>
Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.
+sourcefn get_address_datastore_keys<'life0, 'async_trait>(
+ &'life0 self,
+ arg: Vec<GetAddressDatastoreKeysRequest>,
+) -> Pin<Box<dyn Future<Output = RpcResult<Vec<GetAddressDatastoreKeysResponse>>> + Send + 'async_trait>>where
+ Self: 'async_trait,
+ 'life0: 'async_trait,
Get keys gor given address
+Provided Methods§
Object Safety§
This trait is not object safe.Implementors§
pub trait RpcServer: MassaRpcServer {
+RpcServer in massa_api - Rust pub trait RpcServer: MassaRpcServer {
// Required method
fn serve<'life0, 'life1, 'async_trait>(
self,
@@ -9,7 +9,7 @@
'life0: 'async_trait,
'life1: 'async_trait;
}
Expand description
Used to manage the API
-Required Methods§
Required Methods§
sourcefn serve<'life0, 'life1, 'async_trait>(
self,
url: &'life0 SocketAddr,
api_config: &'life1 APIConfig,
@@ -17,4 +17,4 @@
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Start the API
-Object Safety§
This trait is not object safe.Implementors§
address related structures
-address related structures
+address: AddressAddress
is_final: booltrue means final false means candidate
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morecreated_endorsements: Vec<EndorsementId>created endorsements
cycle_infos: Vec<ExecutionAddressCycleInfo>cycle information
Only essential info about an address
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreactive_rolls: u64active rolls
final_balance: Amountfinal balance
candidate_balance: Amountcandidate balance
-Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morepub struct GetAddressDatastoreKeysRequest {
+ pub address: Address,
+ pub prefix: Vec<u8>,
+ pub is_final: bool,
+ pub start_key: Option<Vec<u8>>,
+ pub inclusive_start_key: Option<bool>,
+ pub end_key: Option<Vec<u8>>,
+ pub inclusive_end_key: Option<bool>,
+ pub count: Option<u32>,
+}Datastore keys entry query input structure
+address: AddressThe address for which to get the datastore keys
+prefix: Vec<u8>The prefix to filter the keys
+is_final: boolfinal true means final
+start_key: Option<Vec<u8>>The start key to filter the keys
+inclusive_start_key: Option<bool>inclusive start key
+end_key: Option<Vec<u8>>The end key to filter the keys
+inclusive_end_key: Option<bool>inclusive end key
+count: Option<u32>The count of keys to return
+source. Read moreclone_to_uninit)self to use its Binary implementation when Debug-formatted.self to use its Display implementation when
+Debug-formatted.self to use its LowerExp implementation when
+Debug-formatted.self to use its LowerHex implementation when
+Debug-formatted.self to use its Octal implementation when Debug-formatted.self to use its Pointer implementation when
+Debug-formatted.self to use its UpperExp implementation when
+Debug-formatted.self to use its UpperHex implementation when
+Debug-formatted.T in a tonic::Requestself and passes that borrow into the pipe function. Read moreself and passes that borrow into the pipe function. Read moreself, then passes self.as_ref() into the pipe function.self, then passes self.as_mut() into the pipe
+function.self, then passes self.deref() into the pipe function.Borrow<B> of a value. Read moreBorrowMut<B> of a value. Read moreAsRef<R> view of a value. Read moreAsMut<R> view of a value. Read moreDeref::Target of a value. Read moreDeref::Target of a value. Read more.tap() only in debug builds, and is erased in release builds..tap_mut() only in debug builds, and is erased in release
+builds..tap_borrow() only in debug builds, and is erased in release
+builds..tap_borrow_mut() only in debug builds, and is erased in release
+builds..tap_ref() only in debug builds, and is erased in release
+builds..tap_ref_mut() only in debug builds, and is erased in release
+builds..tap_deref() only in debug builds, and is erased in release
+builds.Subscriber to this type, returning a
+[WithDispatch] wrapper. Read morepub struct GetAddressDatastoreKeysResponse {
+ pub address: Address,
+ pub is_final: bool,
+ pub keys: Vec<Vec<u8>>,
+}Response object for datastore keys query
+address: AddressThe address for which to get the datastore keys
+is_final: boolfinal true means final
+keys: Vec<Vec<u8>>keys list
+source. Read moreclone_to_uninit)self to use its Binary implementation when Debug-formatted.self to use its Display implementation when
+Debug-formatted.self to use its LowerExp implementation when
+Debug-formatted.self to use its LowerHex implementation when
+Debug-formatted.self to use its Octal implementation when Debug-formatted.self to use its Pointer implementation when
+Debug-formatted.self to use its UpperExp implementation when
+Debug-formatted.self to use its UpperHex implementation when
+Debug-formatted.T in a tonic::Requestself and passes that borrow into the pipe function. Read moreself and passes that borrow into the pipe function. Read moreself, then passes self.as_ref() into the pipe function.self, then passes self.as_mut() into the pipe
+function.self, then passes self.deref() into the pipe function.Borrow<B> of a value. Read moreBorrowMut<B> of a value. Read moreAsRef<R> view of a value. Read moreAsMut<R> view of a value. Read moreDeref::Target of a value. Read moreDeref::Target of a value. Read more.tap() only in debug builds, and is erased in release builds..tap_mut() only in debug builds, and is erased in release
+builds..tap_borrow() only in debug builds, and is erased in release
+builds..tap_borrow_mut() only in debug builds, and is erased in release
+builds..tap_ref() only in debug builds, and is erased in release
+builds..tap_ref_mut() only in debug builds, and is erased in release
+builds..tap_deref() only in debug builds, and is erased in release
+builds.Subscriber to this type, returning a
+[WithDispatch] wrapper. Read morerefactor to delete
id: BlockIdblock id
content: Option<BlockInfoContent>optional block info content
-Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreis_candidate: booltrue if candidate (active any clique but not final)
is_discarded: booltrue if discarded
block: Blockblock
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreslot: Slotthe slot the block is in
creator: Addressthe block creator
parents: Vec<BlockId>the block parents
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morenode configuration
+node configuration
pub struct APIConfig {Show 37 fields
+APIConfig in massa_api_exports::config - Rust Struct massa_api_exports::config::APIConfig
source · pub struct APIConfig {Show 40 fields
pub draw_lookahead_period_count: u64,
pub bind_private: SocketAddr,
pub bind_public: SocketAddr,
@@ -18,6 +18,7 @@
pub enable_http: bool,
pub enable_ws: bool,
pub max_datastore_value_length: u64,
+ pub max_datastore_key_length: u8,
pub max_op_datastore_entry_count: u64,
pub max_op_datastore_key_length: u8,
pub max_op_datastore_value_length: u64,
@@ -36,6 +37,8 @@
pub deferred_credits_delta: MassaTime,
pub minimal_fees: Amount,
pub deferred_calls_config: DeferredCallsConfig,
+ pub max_datastore_keys_queries: Option<u32>,
+ pub max_addresses_datastore_keys_query: Option<u32>,
}
Expand description
API settings.
the API settings
Fields§
§draw_lookahead_period_count: u64when looking for next draw we want to look at max draw_lookahead_period_count
@@ -57,6 +60,7 @@
§enable_http: boolwhether to enable HTTP.
§enable_ws: boolwhether to enable WS.
§max_datastore_value_length: u64max datastore value length
+§max_datastore_key_length: u8max datastore key length
§max_op_datastore_entry_count: u64max op datastore entry
§max_op_datastore_key_length: u8max datastore key length
§max_op_datastore_value_length: u64max datastore value length
@@ -75,8 +79,10 @@
§deferred_credits_delta: MassaTimeDelta to compute upper bounds when fetching deferred credits
§minimal_fees: Amountminimal fees to include an operation in a block
§deferred_calls_config: DeferredCallsConfigdeferred calls config
-Trait Implementations§
source§impl<'de> Deserialize<'de> for APIConfig
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moreAuto Trait Implementations§
§impl Freeze for APIConfig
§impl RefUnwindSafe for APIConfig
§impl Send for APIConfig
§impl Sync for APIConfig
§impl Unpin for APIConfig
§impl UnwindSafe for APIConfig
Blanket Implementations§
source§impl<T> Any for Twhere
+§max_datastore_keys_queries: Option<u32>max datastore keys queries
+§max_addresses_datastore_keys_query: Option<u32>Limit the number of addresses in a single datastore keys request
+Trait Implementations§
source§impl<'de> Deserialize<'de> for APIConfig
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
+ __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moreAuto Trait Implementations§
§impl Freeze for APIConfig
§impl RefUnwindSafe for APIConfig
§impl Send for APIConfig
§impl Sync for APIConfig
§impl Unpin for APIConfig
§impl UnwindSafe for APIConfig
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> CloneToUninit for Twhere
@@ -174,7 +180,7 @@
V: MultiLane<T>,
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moresource§impl<T> DeserializeOwned for Twhere
- T: for<'de> Deserialize<'de>,
§impl<T> ErasedDestructor for Twhere
+[WithDispatch] wrapper. Read more
source§impl<T> DeserializeOwned for Twhere
+ T: for<'de> Deserialize<'de>,
§impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> MaybeSend for Twhere
T: Send,
§impl<T> MaybeSendSync for T
Datastore entry query input structure
address: Addressassociated address of the entry
key: Vec<u8>datastore key
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreDatastore entry query output structure
final_value: Option<Vec<u8>>final datastore entry value
candidate_value: Option<Vec<u8>>candidate datastore entry value
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreis_final: booltrue if the endorsement is final (for example in a final block)
endorsement: SecureShareEndorsementthe endorsement itself
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreBad request: {0}
Internal server error: {0}
Versioning Factory error: {0}
-The result of the read-only execution.
An error occurred during execution.
The result of a successful execution.
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreContext of the transfer
Transfer made in an operation
Transfer made in an asynchronous call
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreresponse for deferred call
call_id: Stringdeferred call id
call: DeferredCalldeferred call
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moretarget_slot: SlotThe slot at which the deferred call is to be executed.
max_gas_request: u64The maximum gas requested.
params_size: u64Size of parameters
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moremax_gas_request: u64The maximum gas requested.
available: boolif the slot is bookable
price: Amountthe cost for booking the call
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreresponse for deferred calls by slot
slot: Slotdeferred calls
call_ids: Vec<String>deferred calls
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreoutput_events: VecDeque<SCOutputEvent>The output events generated by the read-only execution.
gas_cost: u64The gas cost for the execution
state_changes: StateChangesstate changes caused by the execution step
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreaddress: Option<Address>caller’s address, optional
operation_datastore: Option<Vec<u8>>Operation datastore, optional
fee: Option<Amount>fee
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morecaller_address: Option<Address>caller’s address, optional
coins: Option<Amount>coins
fee: Option<Amount>fee
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morefee: AmountFee
block_id: BlockIdBlock ID
context: TransferContextContext
-Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morefinal_ledger_info: LedgerDatafinal data
candidate_ledger_info: LedgerDatalatest data
locked_balance: Amountlocked balance, for example balance due to a roll sell
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morenode related structure
+node related structure
pub struct NodeStatus {Show 17 fields
+NodeStatus in massa_api_exports::node - Rust Struct massa_api_exports::node::NodeStatus
source · pub struct NodeStatus {}
Expand description
node status
Fields§
§node_id: NodeIdour node id
§node_ip: Option<IpAddr>optional node ip
@@ -34,9 +35,10 @@
§config: CompactConfigcompact configuration
§chain_id: u64chain id
§minimal_fees: Amountminimal fees to include an operation in a block
-Trait Implementations§
source§impl Clone for NodeStatus
source§fn clone(&self) -> NodeStatus
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for NodeStatus
source§impl<'de> Deserialize<'de> for NodeStatus
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
- __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for NodeStatus
Auto Trait Implementations§
§impl Freeze for NodeStatus
§impl RefUnwindSafe for NodeStatus
§impl Send for NodeStatus
§impl Sync for NodeStatus
§impl Unpin for NodeStatus
§impl UnwindSafe for NodeStatus
Blanket Implementations§
source§impl<T> Any for Twhere
+§current_mip_version: u32current mip version
+Trait Implementations§
source§impl Clone for NodeStatus
source§fn clone(&self) -> NodeStatus
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read moresource§impl Debug for NodeStatus
source§impl<'de> Deserialize<'de> for NodeStatus
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
+ __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl Display for NodeStatus
Auto Trait Implementations§
§impl Freeze for NodeStatus
§impl RefUnwindSafe for NodeStatus
§impl Send for NodeStatus
§impl Sync for NodeStatus
§impl Unpin for NodeStatus
§impl UnwindSafe for NodeStatus
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read moresource§impl<T> CloneToUninit for Twhere
@@ -135,7 +137,7 @@
V: MultiLane<T>,
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moresource§impl<T> DeserializeOwned for Twhere
- T: for<'de> Deserialize<'de>,
§impl<T> ErasedDestructor for Twhere
+[WithDispatch] wrapper. Read more
source§impl<T> DeserializeOwned for Twhere
+ T: for<'de> Deserialize<'de>,
§impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> MaybeSend for Twhere
T: Send,
§impl<T> MaybeSendSync for T
thread: u8Thread in which the operation can be included
operation: SecureShareOperationthe operation itself
op_exec_status: Option<bool>true if the operation execution succeeded, false if failed, None means unknown
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read morecreator_public_key: PublicKeyThe public key of the creator of the TX
signature: SignatureThe signature of the operation
serialized_content: Vec<u8>The serialized version of the content base58 encoded
Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreRepresents the request inputs for a PagedVec
limit: usizeThe limit of elements in a page
offset: usizeThe page offset
-Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreRepresents a Vec that can be split across Pages Cf. https://docs.rs/paginate/latest/paginate/
-res: Vec<T>§_total_count: usizeres: Vec<T>§_total_count: usizeRepresents the request inputs for a PagedVecV2
-content: Vec<T>§total_count: usizesource. Read morecontent: Vec<T>§total_count: usizesource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreactive_rolls: u64count taken into account for the current cycle
final_rolls: u64at final blocks
candidate_rolls: u64at latest blocks
-Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreslot / amount pair
slot: Slotslot
amount: Amountamount
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreWrap request params into struct for ApiV2 method
page_request: Option<PageRequest>pagination
-Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreJust a wrapper with a optional beginning and end
start: Option<MassaTime>optional start slot
end: Option<MassaTime>optional end slot
-source. Read moresource. Read moreSubscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moremsg_id: ID of the message to push as ready to be executed to the list of changesextends the current AsyncPoolChanges with another one
source. Read moresource. Read moreself and other values to be equal, and is used
by ==.Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreTake an AsyncMessage and return it
Compute the ID of the message for use when choosing which operations to keep in priority (highest score) on pool overflow.
extends the AsyncMessage with a AsyncMessageUpdate
source. Read moresource. Read moreself and other values to be equal, and is used
+self and other values to be equal, and is used
by ==.Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read moreStructure defining a trigger for an asynchronous message
address: AddressFilter on the address
datastore_key: Option<Vec<u8>>Filter on the datastore key
-source. Read moresource. Read moreself and other values to be equal, and is used
by ==.Subscriber to this type, returning a
-[WithDispatch] wrapper. Read moreWithDispatch] wrapper. Read more