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
// Copyright (C) Parity Technologies (UK) Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use ink_env::Environment;
use scale::{
Decode,
Encode,
};
use sp_weights::Weight;
use crate::{
backend::BuilderClient,
builders::CreateBuilderPartial,
CallBuilderFinal,
CallDryRunResult,
CallResult,
ContractsBackend,
InstantiateDryRunResult,
InstantiationResult,
UploadResult,
};
use super::Keypair;
/// Allows to build an end-to-end call using a builder pattern.
pub struct CallBuilder<'a, E, Args, RetType, B>
where
E: Environment,
Args: Encode + Clone,
RetType: Send + Decode,
B: BuilderClient<E>,
{
client: &'a mut B,
caller: &'a Keypair,
message: &'a CallBuilderFinal<E, Args, RetType>,
value: E::Balance,
extra_gas_portion: Option<u64>,
gas_limit: Option<Weight>,
storage_deposit_limit: Option<E::Balance>,
}
impl<'a, E, Args, RetType, B> CallBuilder<'a, E, Args, RetType, B>
where
E: Environment,
Args: Sync + Encode + Clone,
RetType: Send + Decode,
B: BuilderClient<E>,
{
/// Initialize a call builder with defaults values.
pub fn new(
client: &'a mut B,
caller: &'a Keypair,
message: &'a CallBuilderFinal<E, Args, RetType>,
) -> CallBuilder<'a, E, Args, RetType, B>
where
E::Balance: From<u32>,
{
Self {
client,
caller,
message,
value: 0u32.into(),
extra_gas_portion: None,
gas_limit: None,
storage_deposit_limit: None,
}
}
/// Provide value with a call
pub fn value(&mut self, value: E::Balance) -> &mut Self {
self.value = value;
self
}
/// Increases the gas limit marginally by a specified percent.
/// Useful when the message's gas usage depends on the runtime state
/// and the dry run does not produce an accurate gas estimate.
///
/// # Example
///
/// With dry run gas estimate of `100` units and `5`% extra gas portion specified,
/// the set gas limit becomes `105` units
pub fn extra_gas_portion(&mut self, per_cent: u64) -> &mut Self {
if per_cent == 0 {
self.extra_gas_portion = None
} else {
self.extra_gas_portion = Some(per_cent)
}
self
}
/// Specifies the raw gas limit as part of the call.
///
/// # Notes
///
/// Overwrites any values specified for `extra_gas_portion`.
/// The gas estimate fro dry-run will be ignored.
pub fn gas_limit(&mut self, limit: Weight) -> &mut Self {
if limit == Weight::from_parts(0, 0) {
self.gas_limit = None
} else {
self.gas_limit = Some(limit)
}
self
}
/// Specify the max amount of funds that can be charged for storage.
pub fn storage_deposit_limit(
&mut self,
storage_deposit_limit: E::Balance,
) -> &mut Self {
if storage_deposit_limit == 0u32.into() {
self.storage_deposit_limit = None
} else {
self.storage_deposit_limit = Some(storage_deposit_limit)
}
self
}
/// Submit the call for the on-chain execution.
///
/// This will automatically run a dry-run call, and use `extra_gas_portion`
/// to add a margin to the gas limit.
pub async fn submit(
&mut self,
) -> Result<CallResult<E, RetType, B::EventLog>, B::Error>
where
CallBuilderFinal<E, Args, RetType>: Clone,
{
let dry_run = B::bare_call_dry_run(
self.client,
self.caller,
self.message,
self.value,
self.storage_deposit_limit,
)
.await?;
let gas_limit = if let Some(limit) = self.gas_limit {
limit
} else {
let gas_required = dry_run.exec_result.gas_required;
let proof_size = gas_required.proof_size();
let ref_time = gas_required.ref_time();
calculate_weight(proof_size, ref_time, self.extra_gas_portion)
};
let call_result = B::bare_call(
self.client,
self.caller,
self.message,
self.value,
gas_limit,
self.storage_deposit_limit,
)
.await?;
Ok(CallResult {
dry_run,
events: call_result,
})
}
/// Dry run the call.
pub async fn dry_run(&mut self) -> Result<CallDryRunResult<E, RetType>, B::Error>
where
CallBuilderFinal<E, Args, RetType>: Clone,
{
B::bare_call_dry_run(
self.client,
self.caller,
self.message,
self.value,
self.storage_deposit_limit,
)
.await
}
}
/// Allows to build an end-to-end instantiation call using a builder pattern.
pub struct InstantiateBuilder<'a, E, Contract, Args, R, B>
where
E: Environment,
Args: Encode + Clone,
Contract: Clone,
B: ContractsBackend<E>,
{
client: &'a mut B,
caller: &'a Keypair,
contract_name: &'a str,
constructor: &'a mut CreateBuilderPartial<E, Contract, Args, R>,
value: E::Balance,
extra_gas_portion: Option<u64>,
gas_limit: Option<Weight>,
storage_deposit_limit: Option<E::Balance>,
}
impl<'a, E, Contract, Args, R, B> InstantiateBuilder<'a, E, Contract, Args, R, B>
where
E: Environment,
Args: Encode + Clone + Send + Sync,
Contract: Clone,
B: BuilderClient<E>,
{
/// Initialize a call builder with essential values.
pub fn new(
client: &'a mut B,
caller: &'a Keypair,
contract_name: &'a str,
constructor: &'a mut CreateBuilderPartial<E, Contract, Args, R>,
) -> InstantiateBuilder<'a, E, Contract, Args, R, B>
where
E::Balance: From<u32>,
{
Self {
client,
caller,
contract_name,
constructor,
value: 0u32.into(),
extra_gas_portion: None,
gas_limit: None,
storage_deposit_limit: None,
}
}
/// Provide value with a call
pub fn value(&mut self, value: E::Balance) -> &mut Self {
self.value = value;
self
}
/// Increases the gas limit marginally by a specified percent.
/// Useful when the message's gas usage depends on the runtime state
/// and the dry run does not produce an accurate gas estimate.
///
/// # Example
///
/// With dry run gas estimate of `100` units and `5`% extra gas portion specified,
/// the set gas limit becomes `105` units
pub fn extra_gas_portion(&mut self, per_cent: u64) -> &mut Self {
if per_cent == 0 {
self.extra_gas_portion = None
} else {
self.extra_gas_portion = Some(per_cent)
}
self
}
/// Specifies the raw gas limit as part of the call.
///
/// # Notes
///
/// Overwrites any values specified for `extra_gas_portion`.
/// The gas estimate fro dry-run will be ignored.
pub fn gas_limit(&mut self, limit: Weight) -> &mut Self {
if limit == Weight::from_parts(0, 0) {
self.gas_limit = None
} else {
self.gas_limit = Some(limit)
}
self
}
/// Specify the max amount of funds that can be charged for storage.
pub fn storage_deposit_limit(
&mut self,
storage_deposit_limit: E::Balance,
) -> &mut Self {
if storage_deposit_limit == 0u32.into() {
self.storage_deposit_limit = None
} else {
self.storage_deposit_limit = Some(storage_deposit_limit)
}
self
}
/// Submit the instantiate call for the on-chain execution.
///
/// This will automatically run a dry-run call, and use `extra_gas_portion`
/// to add a margin to the gas limit.
pub async fn submit(
&mut self,
) -> Result<InstantiationResult<E, B::EventLog>, B::Error> {
let dry_run = B::bare_instantiate_dry_run(
self.client,
self.contract_name,
self.caller,
self.constructor,
self.value,
self.storage_deposit_limit,
)
.await?;
let gas_limit = if let Some(limit) = self.gas_limit {
limit
} else {
let gas_required = dry_run.contract_result.gas_required;
let proof_size = gas_required.proof_size();
let ref_time = gas_required.ref_time();
calculate_weight(proof_size, ref_time, self.extra_gas_portion)
};
let instantiate_result = B::bare_instantiate(
self.client,
self.contract_name,
self.caller,
self.constructor,
self.value,
gas_limit,
self.storage_deposit_limit,
)
.await?;
Ok(InstantiationResult {
account_id: instantiate_result.account_id,
dry_run,
events: instantiate_result.events,
})
}
/// Dry run the instantiate call.
pub async fn dry_run(&mut self) -> Result<InstantiateDryRunResult<E>, B::Error> {
B::bare_instantiate_dry_run(
self.client,
self.contract_name,
self.caller,
self.constructor,
self.value,
self.storage_deposit_limit,
)
.await
}
}
/// Allows to build an end-to-end upload call using a builder pattern.
pub struct UploadBuilder<'a, E, B>
where
E: Environment,
B: BuilderClient<E>,
{
client: &'a mut B,
contract_name: &'a str,
caller: &'a Keypair,
storage_deposit_limit: Option<E::Balance>,
}
impl<'a, E, B> UploadBuilder<'a, E, B>
where
E: Environment,
B: BuilderClient<E>,
{
/// Initialize an upload builder with essential values.
pub fn new(client: &'a mut B, contract_name: &'a str, caller: &'a Keypair) -> Self {
Self {
client,
contract_name,
caller,
storage_deposit_limit: None,
}
}
/// Specify the max amount of funds that can be charged for storage.
pub fn storage_deposit_limit(
&mut self,
storage_deposit_limit: E::Balance,
) -> &mut Self {
if storage_deposit_limit == 0u32.into() {
self.storage_deposit_limit = None
} else {
self.storage_deposit_limit = Some(storage_deposit_limit)
}
self
}
/// Execute the upload.
pub async fn submit(&mut self) -> Result<UploadResult<E, B::EventLog>, B::Error> {
B::bare_upload(
self.client,
self.contract_name,
self.caller,
self.storage_deposit_limit,
)
.await
}
}
/// Allows to build an end-to-end remove code call using a builder pattern.
pub struct RemoveCodeBuilder<'a, E, B>
where
E: Environment,
B: BuilderClient<E>,
{
client: &'a mut B,
caller: &'a Keypair,
code_hash: E::Hash,
}
impl<'a, E, B> RemoveCodeBuilder<'a, E, B>
where
E: Environment,
B: BuilderClient<E>,
{
/// Initialize a remove code builder with essential values.
pub fn new(client: &'a mut B, caller: &'a Keypair, code_hash: E::Hash) -> Self {
Self {
client,
caller,
code_hash,
}
}
/// Submit the remove code extrinsic.
pub async fn submit(&mut self) -> Result<B::EventLog, B::Error> {
B::bare_remove_code(self.client, self.caller, self.code_hash).await
}
}
fn calculate_weight(
mut proof_size: u64,
mut ref_time: u64,
portion: Option<u64>,
) -> Weight {
if let Some(m) = portion {
ref_time += ref_time / 100 * m;
proof_size += proof_size / 100 * m;
}
Weight::from_parts(ref_time, proof_size)
}