1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
// This file is part of Gear.
// Copyright (C) 2022-2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
#![allow(clippy::too_many_arguments)]
use crate::{api::Result, GearApi};
use gear_core::{
ids::{CodeId, MessageId, ProgramId},
message::ReplyInfo,
};
use gsdk::{ext::sp_core::H256, GasInfo};
use parity_scale_codec::{Decode, Encode};
use std::path::Path;
use crate::utils;
impl GearApi {
/// Execute an RPC to calculate the gas required to create a program from a
/// code and process an initialization message.
///
/// Actually sends the `gear_calculateInitCreateGas` RPC to the node. The
/// function's parameters are:
///
/// - `origin` (optional) is the caller's public address;
/// - `code_id` is the uploaded code identifier that can be obtained by
/// calling the [`upload_code`](Self::upload_code) function;
/// - `payload` vector contains data to be processed by the program;
/// - `value` to be transferred to the program's account;
/// - `allow_other_panics` flag indicates ignoring a trap during the
/// program's execution;
/// - `at` (optional) allows executing the RPC at the specified block
/// identified by its hash.
pub async fn calculate_create_gas(
&self,
origin: Option<H256>,
code_id: CodeId,
payload: Vec<u8>,
value: u128,
allow_other_panics: bool,
) -> Result<GasInfo> {
self.calculate_create_gas_at(origin, code_id, payload, value, allow_other_panics, None)
.await
}
/// Same as [`calculate_create_gas`](Self::calculate_create_gas), but
/// calculates the gas at the block identified by its hash.
pub async fn calculate_create_gas_at(
&self,
origin: Option<H256>,
code_id: CodeId,
payload: Vec<u8>,
value: u128,
allow_other_panics: bool,
at: Option<H256>,
) -> Result<GasInfo> {
self.0
.rpc
.calculate_create_gas(origin, code_id, payload, value, allow_other_panics, at)
.await
.map_err(Into::into)
}
/// Execute an RPC to calculate the gas required to upload a program and
/// process an initialization message.
///
/// Actually sends the `gear_calculateInitUploadGas` RPC to the node. The
/// function's parameters are:
///
/// - `origin` (optional) is the caller's public address;
/// - `code` is the buffer containing the Wasm binary code of the Gear
/// program;
/// - `payload` vector contains data to be processed by the program;
/// - `value` to be transferred to the program's account;
/// - `allow_other_panics` flag indicates ignoring a trap during the
/// program's execution;
/// - `at` (optional) allows executing the RPC at the specified block
/// identified by its hash.
pub async fn calculate_upload_gas(
&self,
origin: Option<H256>,
code: Vec<u8>,
payload: Vec<u8>,
value: u128,
allow_other_panics: bool,
) -> Result<GasInfo> {
self.calculate_upload_gas_at(origin, code, payload, value, allow_other_panics, None)
.await
}
/// Same as [`calculate_upload_gas`](Self::calculate_upload_gas), but
/// calculates the gas at the block identified by its hash.
pub async fn calculate_upload_gas_at(
&self,
origin: Option<H256>,
code: Vec<u8>,
payload: Vec<u8>,
value: u128,
allow_other_panics: bool,
at: Option<H256>,
) -> Result<GasInfo> {
self.0
.rpc
.calculate_upload_gas(origin, code, payload, value, allow_other_panics, at)
.await
.map_err(Into::into)
}
/// Execute an RPC to calculate the gas required to handle a message.
///
/// Actually sends the `gear_calculateHandleGas` RPC to the node. The
/// function's parameters are:
///
/// - `origin` (optional) is the caller's public address;
/// - `destination` is the program address;
/// - `payload` vector contains data to be processed by the program;
/// - `value` to be transferred to the program's account;
/// - `allow_other_panics` flag indicates ignoring a trap during the
/// program's execution;
/// - `at` (optional) allows executing the RPC at the specified block
/// identified by its hash.
pub async fn calculate_handle_gas(
&self,
origin: Option<H256>,
destination: ProgramId,
payload: Vec<u8>,
value: u128,
allow_other_panics: bool,
) -> Result<GasInfo> {
self.calculate_handle_gas_at(
origin,
destination,
payload,
value,
allow_other_panics,
None,
)
.await
}
/// Same as [`calculate_handle_gas`](Self::calculate_handle_gas), but
/// calculates the gas at the block identified by its hash.
pub async fn calculate_handle_gas_at(
&self,
origin: Option<H256>,
destination: ProgramId,
payload: Vec<u8>,
value: u128,
allow_other_panics: bool,
at: Option<H256>,
) -> Result<GasInfo> {
self.0
.rpc
.calculate_handle_gas(origin, destination, payload, value, allow_other_panics, at)
.await
.map_err(Into::into)
}
/// Execute an RPC to calculate the gas required to reply to the received
/// message from the mailbox.
///
/// Actually sends the `gear_calculateReplyGas` RPC to the node. The
/// function's parameters are:
///
/// - `origin` (optional) is the caller's public address;
/// - `message_id` is a message identifier required to find it in the
/// mailbox;
/// - `exit_code` is the status code of the reply;
/// - `payload` vector contains data to be processed by the program;
/// - `value` to be transferred to the program's account;
/// - `allow_other_panics` flag indicates ignoring a trap during the
/// program's execution;
/// - `at` (optional) allows executing the RPC at the specified block
/// identified by its hash.
pub async fn calculate_reply_gas(
&self,
origin: Option<H256>,
message_id: MessageId,
payload: Vec<u8>,
value: u128,
allow_other_panics: bool,
) -> Result<GasInfo> {
self.calculate_reply_gas_at(origin, message_id, payload, value, allow_other_panics, None)
.await
}
/// Same as [`calculate_reply_gas`](Self::calculate_reply_gas), but
/// calculates the gas at the block identified by its hash.
pub async fn calculate_reply_gas_at(
&self,
origin: Option<H256>,
message_id: MessageId,
payload: Vec<u8>,
value: u128,
allow_other_panics: bool,
at: Option<H256>,
) -> Result<GasInfo> {
self.0
.rpc
.calculate_reply_gas(origin, message_id, payload, value, allow_other_panics, at)
.await
.map_err(Into::into)
}
/// Read the program's state as a byte vector.
pub async fn read_state_bytes(
&self,
program_id: ProgramId,
payload: Vec<u8>,
) -> Result<Vec<u8>> {
self.read_state_bytes_at(program_id, payload, None).await
}
/// Same as [`read_state_bytes`](Self::read_state_bytes), but reads the
/// program's state at the block identified by its hash.
pub async fn read_state_bytes_at(
&self,
program_id: ProgramId,
payload: Vec<u8>,
at: Option<H256>,
) -> Result<Vec<u8>> {
let response: String = self
.0
.api()
.read_state(H256(program_id.into()), payload, at)
.await?;
crate::utils::hex_to_vec(response).map_err(Into::into)
}
/// Read the program's state as decoded data.
pub async fn read_state<D: Decode>(
&self,
program_id: ProgramId,
payload: Vec<u8>,
) -> Result<D> {
self.read_state_at(program_id, payload, None).await
}
/// Same as [`read_state`](Self::read_state), but reads the program's state
/// at the block identified by its hash.
pub async fn read_state_at<D: Decode>(
&self,
program_id: ProgramId,
payload: Vec<u8>,
at: Option<H256>,
) -> Result<D> {
let bytes = self.read_state_bytes_at(program_id, payload, at).await?;
D::decode(&mut bytes.as_ref()).map_err(Into::into)
}
/// Read the program's state as a byte vector using a meta Wasm.
pub async fn read_state_bytes_using_wasm(
&self,
program_id: ProgramId,
payload: Vec<u8>,
fn_name: &str,
wasm: Vec<u8>,
argument: Option<Vec<u8>>,
) -> Result<Vec<u8>> {
self.read_state_bytes_using_wasm_at(program_id, payload, fn_name, wasm, argument, None)
.await
}
/// Same as [`read_state_bytes_using_wasm`](Self::read_state_bytes_using_wasm), but reads the program's state at the block identified by its hash.
pub async fn read_state_bytes_using_wasm_at(
&self,
program_id: ProgramId,
payload: Vec<u8>,
fn_name: &str,
wasm: Vec<u8>,
argument: Option<Vec<u8>>,
at: Option<H256>,
) -> Result<Vec<u8>> {
let response: String = self
.0
.api()
.read_state_using_wasm(
H256(program_id.into()),
payload,
fn_name,
wasm,
argument,
at,
)
.await?;
crate::utils::hex_to_vec(response).map_err(Into::into)
}
/// Read the program's state as decoded data using a meta Wasm.
pub async fn read_state_using_wasm<E: Encode, D: Decode>(
&self,
program_id: ProgramId,
payload: Vec<u8>,
fn_name: &str,
wasm: Vec<u8>,
argument: Option<E>,
) -> Result<D> {
self.read_state_using_wasm_at(program_id, payload, fn_name, wasm, argument, None)
.await
}
/// Same as [`read_state_using_wasm`](Self::read_state_using_wasm), but
/// reads the program's state at the block identified by its hash.
pub async fn read_state_using_wasm_at<E: Encode, D: Decode>(
&self,
program_id: ProgramId,
payload: Vec<u8>,
fn_name: &str,
wasm: Vec<u8>,
argument: Option<E>,
at: Option<H256>,
) -> Result<D> {
let bytes = self
.read_state_bytes_using_wasm_at(
program_id,
payload,
fn_name,
wasm,
argument.map(|v| v.encode()),
at,
)
.await?;
D::decode(&mut bytes.as_ref()).map_err(Into::into)
}
/// Read the program's state using a meta Wasm file referenced by its
/// `path`.
pub async fn read_state_bytes_using_wasm_by_path(
&self,
program_id: ProgramId,
payload: Vec<u8>,
fn_name: &str,
path: impl AsRef<Path>,
argument: Option<Vec<u8>>,
) -> Result<Vec<u8>> {
self.read_state_bytes_using_wasm_by_path_at(
program_id, payload, fn_name, path, argument, None,
)
.await
}
/// Same as [`read_state_using_wasm_by_path`](Self::read_state_using_wasm_by_path), but reads the program's state at the block identified by its hash.
pub async fn read_state_bytes_using_wasm_by_path_at(
&self,
program_id: ProgramId,
payload: Vec<u8>,
fn_name: &str,
path: impl AsRef<Path>,
argument: Option<Vec<u8>>,
at: Option<H256>,
) -> Result<Vec<u8>> {
self.read_state_bytes_using_wasm_at(
program_id,
payload,
fn_name,
utils::code_from_os(path.as_ref())?,
argument,
at,
)
.await
}
/// Read the program's state using a meta Wasm file referenced by its
/// `path`.
pub async fn read_state_using_wasm_by_path<E: Encode, D: Decode>(
&self,
program_id: ProgramId,
payload: Vec<u8>,
fn_name: &str,
path: impl AsRef<Path>,
argument: Option<E>,
) -> Result<D> {
self.read_state_using_wasm_by_path_at(program_id, payload, fn_name, path, argument, None)
.await
}
/// Same as [`read_state_using_wasm_by_path`](Self::read_state_using_wasm_by_path), but reads the program's state at the block identified by its hash.
pub async fn read_state_using_wasm_by_path_at<E: Encode, D: Decode>(
&self,
program_id: ProgramId,
payload: Vec<u8>,
fn_name: &str,
path: impl AsRef<Path>,
argument: Option<E>,
at: Option<H256>,
) -> Result<D> {
let bytes = self
.read_state_bytes_using_wasm_by_path_at(
program_id,
payload,
fn_name,
path,
argument.map(|v| v.encode()),
at,
)
.await?;
D::decode(&mut bytes.as_ref()).map_err(Into::into)
}
/// Read the program's metahash.
pub async fn read_metahash(&self, program_id: ProgramId) -> Result<H256> {
self.read_metahash_at(program_id, None).await
}
/// Same as [`read_metahash`](Self::read_metahash), but read the program's
/// metahash at the block identified by its hash.
pub async fn read_metahash_at(&self, program_id: ProgramId, at: Option<H256>) -> Result<H256> {
self.0
.api()
.read_meta_hash(H256(program_id.into()), at)
.await
.map_err(Into::into)
}
// Reserved for development usages.
//
// NOTE: Please gather the low-level rpc requests in `[gsdk::rpc]` module.
#[cfg(test)]
#[allow(unused)]
async fn rpc_request<T: gsdk::ext::sp_runtime::DeserializeOwned>(
&self,
method: &str,
params: subxt::backend::rpc::RpcParams,
) -> Result<T> {
self.0
.api()
.rpc()
.request(method, params)
.await
.map_err(Into::into)
}
/// Execute an RPC call is used to figure out the reply on calling
/// `Gear::send_message(..)`.
///
/// Actually sends the `gear_calculateReplyForHandle` RPC to the node. The
/// function's parameters are:
///
/// - `origin` (optional) is the caller's public address;
/// - `destination` is the program address;
/// - `payload` vector contains data to be processed by the program;
/// - `gas_limit`: maximum amount of gas the program can spend before it is
/// halted.
/// - `value` to be transferred to the program's account;
/// - `at` (optional) allows executing the RPC at the specified block
/// identified by its hash.
pub async fn calculate_reply_for_handle(
&self,
origin: Option<H256>,
destination: ProgramId,
payload: Vec<u8>,
gas_limit: u64,
value: u128,
) -> Result<ReplyInfo> {
self.calculate_reply_for_handle_at(origin, destination, payload, gas_limit, value, None)
.await
}
/// Same as [`calculate_reply_for_handle`](Self::calculate_reply_for_handle), but
/// calculates the gas at the block identified by its hash.
pub async fn calculate_reply_for_handle_at(
&self,
origin: Option<H256>,
destination: ProgramId,
payload: Vec<u8>,
gas_limit: u64,
value: u128,
at: Option<H256>,
) -> Result<ReplyInfo> {
self.0
.rpc
.calculate_reply_for_handle(origin, destination, payload, gas_limit, value, at)
.await
.map_err(Into::into)
}
}