multiversx_sdk/
gateway.rs

1mod gateway_account;
2mod gateway_account_esdt_roles;
3mod gateway_account_esdt_tokens;
4mod gateway_account_storage;
5mod gateway_block;
6mod gateway_chain_simulator_add_keys;
7mod gateway_chain_simulator_blocks;
8mod gateway_chain_simulator_send_funds;
9mod gateway_chain_simulator_set_state;
10mod gateway_chain_simulator_set_state_overwrite;
11mod gateway_network_config;
12mod gateway_network_economics;
13mod gateway_network_status;
14mod gateway_tx_cost;
15mod gateway_tx_info;
16mod gateway_tx_process_status;
17mod gateway_tx_send;
18mod gateway_tx_send_multi;
19mod gateway_tx_simulate;
20mod gateway_tx_status;
21mod gateway_tx_vmquery;
22
23use std::fmt::Display;
24
25pub use gateway_account::GetAccountRequest;
26pub use gateway_account_esdt_roles::GetAccountEsdtRolesRequest;
27pub use gateway_account_esdt_tokens::GetAccountEsdtTokensRequest;
28pub use gateway_account_storage::GetAccountStorageRequest;
29pub use gateway_block::GetHyperBlockRequest;
30pub use gateway_chain_simulator_add_keys::ChainSimulatorAddKeysRequest;
31pub use gateway_chain_simulator_blocks::ChainSimulatorGenerateBlocksRequest;
32pub use gateway_chain_simulator_send_funds::ChainSimulatorSendFundsRequest;
33pub use gateway_chain_simulator_set_state::{ChainSimulatorSetStateRequest, SetStateAccount};
34pub use gateway_chain_simulator_set_state_overwrite::ChainSimulatorSetStateOverwriteRequest;
35pub use gateway_network_config::NetworkConfigRequest;
36pub use gateway_network_economics::NetworkEconimicsRequest;
37pub use gateway_network_status::NetworkStatusRequest;
38pub use gateway_tx_cost::GetTxCost;
39pub use gateway_tx_info::GetTxInfo;
40pub use gateway_tx_process_status::GetTxProcessStatus;
41pub use gateway_tx_send::SendTxRequest;
42pub use gateway_tx_send_multi::SendMultiTxRequest;
43pub use gateway_tx_simulate::SimulateTxRequest;
44pub use gateway_tx_status::GetTxStatus;
45pub use gateway_tx_vmquery::VMQueryRequest;
46
47pub const MAINNET_GATEWAY: &str = "https://gateway.multiversx.com";
48pub const TESTNET_GATEWAY: &str = "https://testnet-gateway.multiversx.com";
49pub const DEVNET_GATEWAY: &str = "https://devnet-gateway.multiversx.com";
50
51// MetachainShardId will be used to identify a shard ID as metachain
52pub const METACHAIN_SHARD_ID: u32 = 0xFFFFFFFF;
53
54const ACCOUNT_ENDPOINT: &str = "address";
55const KEYS_ENDPOINT: &str = "keys";
56const NETWORK_CONFIG_ENDPOINT: &str = "network/config";
57const NETWORK_ECONOMICS_ENDPOINT: &str = "network/economics";
58const GET_NETWORK_STATUS_ENDPOINT: &str = "network/status";
59const GET_HYPER_BLOCK_BY_NONCE_ENDPOINT: &str = "hyperblock/by-nonce";
60const GET_HYPER_BLOCK_BY_HASH_ENDPOINT: &str = "hyperblock/by-hash";
61const COST_TRANSACTION_ENDPOINT: &str = "transaction/cost";
62const SEND_TRANSACTION_ENDPOINT: &str = "transaction/send";
63const TRANSACTION_COST_ENDPOINT: &str = "transaction/cost";
64const SEND_MULTIPLE_TRANSACTIONS_ENDPOINT: &str = "transaction/send-multiple";
65const GET_TRANSACTION_INFO_ENDPOINT: &str = "transaction";
66const WITH_RESULTS_QUERY_PARAM: &str = "?withResults=true";
67const VM_VALUES_ENDPOINT: &str = "vm-values/query";
68
69const SEND_USER_FUNDS_ENDPOINT: &str = "transaction/send-user-funds";
70const GENERATE_BLOCKS_ENDPOINT: &str = "simulator/generate-blocks";
71const GENERATE_BLOCKS_UNTIL_TX_PROCESSED_ENDPOINT: &str =
72    "simulator/generate-blocks-until-transaction-processed";
73const GENERATE_BLOCKS_UNTIL_EPOCH_REACHED_ENDPOINT: &str =
74    "simulator/generate-blocks-until-epoch-reached";
75const SET_STATE_ENDPOINT: &str = "simulator/set-state";
76const SET_STATE_OVERWRITE_ENDPOINT: &str = "simulator/set-state-overwrite";
77const ADD_KEYS: &str = "simulator/add-keys";
78
79#[derive(Clone, Copy, PartialEq, Eq, Debug)]
80pub enum GatewayRequestType {
81    Get,
82    Post,
83}
84
85impl Display for GatewayRequestType {
86    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
87        // padding makes the logs prettier
88        let padded_str = match self {
89            GatewayRequestType::Get => "GET ",
90            GatewayRequestType::Post => "POST",
91        };
92        padded_str.fmt(f)
93    }
94}
95
96/// Models requests to the gateway.
97pub trait GatewayRequest {
98    type Payload: serde::ser::Serialize + ?Sized;
99
100    type DecodedJson: serde::de::DeserializeOwned;
101
102    type Result;
103
104    fn request_type(&self) -> GatewayRequestType;
105
106    fn get_endpoint(&self) -> String;
107
108    fn get_payload(&self) -> Option<&Self::Payload> {
109        None
110    }
111
112    fn process_json(&self, decoded: Self::DecodedJson) -> anyhow::Result<Self::Result>;
113}
114
115pub trait GatewayAsyncService {
116    /// Keeps track of elapsed time.
117    type Instant;
118
119    fn from_uri(uri: &str) -> Self;
120
121    fn request<G>(
122        &self,
123        request: G,
124    ) -> impl std::future::Future<Output = anyhow::Result<G::Result>>
125    where
126        G: GatewayRequest;
127
128    fn sleep(&self, millis: u64) -> impl std::future::Future<Output = ()>;
129
130    fn now(&self) -> Self::Instant;
131
132    fn elapsed_seconds(&self, instant: &Self::Instant) -> f32;
133}
multiversx_sdk/gateway.rs

multiversx_sdk/
gateway.rs
