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 492 493
//! This module provides a context-aware interface for interacting with contracts.
use std::{
fmt::Debug,
mem,
rc::Rc,
sync::{Arc, Mutex},
};
pub use contract_transcode;
use contract_transcode::ContractMessageTranscoder;
use frame_support::{traits::fungible::Inspect, weights::Weight};
use pallet_contracts::Determinism;
use parity_scale_codec::Decode;
pub use record::Record;
use crate::{
mock::MockRegistry,
runtime::{
pallet_contracts_debugging::{InterceptingExt, TracingExt},
AccountIdFor, HashFor,
},
MockingExtension, Runtime, Sandbox, DEFAULT_GAS_LIMIT,
};
pub mod error;
pub mod mocking_api;
mod record;
mod transcoding;
use error::SessionError;
use self::mocking_api::MockingApi;
use crate::{
bundle::ContractBundle, errors::MessageResult, runtime::MinimalRuntime,
session::transcoding::TranscoderRegistry,
};
type BalanceOf<R> =
<<R as pallet_contracts::Config>::Currency as Inspect<AccountIdFor<R>>>::Balance;
/// Convenient value for an empty sequence of call/instantiation arguments.
///
/// Without it, you would have to specify explicitly a compatible type, like:
/// `session.call::<String>(.., &[], ..)`.
pub const NO_ARGS: &[String] = &[];
/// Convenient value for an empty salt.
pub const NO_SALT: Vec<u8> = vec![];
/// Convenient value for no endowment.
///
/// Compatible with any runtime with `u128` as the balance type.
pub const NO_ENDOWMENT: Option<BalanceOf<<MinimalRuntime as Runtime>::Config>> = None;
/// Wrapper around `Sandbox` that provides a convenient API for interacting with multiple contracts.
///
/// Instead of talking with a low-level `Sandbox`, you can use this struct to keep context,
/// including: origin, gas_limit, transcoder and history of results.
///
/// `Session` has two APIs: chain-ish and for singular actions. The first one can be used like:
/// ```rust, no_run
/// # use std::rc::Rc;
/// # use contract_transcode::ContractMessageTranscoder;
/// # use drink::{
/// # session::Session,
/// # AccountId32,
/// # session::{NO_ARGS, NO_SALT, NO_ENDOWMENT},
/// # runtime::MinimalRuntime
/// # };
/// #
/// # fn get_transcoder() -> Rc<ContractMessageTranscoder> {
/// # Rc::new(ContractMessageTranscoder::load("").unwrap())
/// # }
/// # fn contract_bytes() -> Vec<u8> { vec![] }
/// # fn bob() -> AccountId32 { AccountId32::new([0; 32]) }
///
/// # fn main() -> Result<(), drink::session::error::SessionError> {
///
/// Session::<MinimalRuntime>::new()?
/// .deploy_and(contract_bytes(), "new", NO_ARGS, NO_SALT, NO_ENDOWMENT, &get_transcoder())?
/// .call_and("foo", NO_ARGS, NO_ENDOWMENT)?
/// .with_actor(bob())
/// .call_and("bar", NO_ARGS, NO_ENDOWMENT)?;
/// # Ok(()) }
/// ```
///
/// The second one serves for one-at-a-time actions:
/// ```rust, no_run
/// # use std::rc::Rc;
/// # use contract_transcode::ContractMessageTranscoder;
/// # use drink::{
/// # session::Session,
/// # AccountId32,
/// # runtime::MinimalRuntime,
/// # session::{NO_ARGS, NO_ENDOWMENT, NO_SALT}
/// # };
/// # fn get_transcoder() -> Rc<ContractMessageTranscoder> {
/// # Rc::new(ContractMessageTranscoder::load("").unwrap())
/// # }
/// # fn contract_bytes() -> Vec<u8> { vec![] }
/// # fn bob() -> AccountId32 { AccountId32::new([0; 32]) }
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
///
/// let mut session = Session::<MinimalRuntime>::new()?;
/// let _address = session.deploy(contract_bytes(), "new", NO_ARGS, NO_SALT, NO_ENDOWMENT, &get_transcoder())?;
/// let _result: u32 = session.call("foo", NO_ARGS, NO_ENDOWMENT)??;
/// session.set_actor(bob());
/// session.call::<_, ()>("bar", NO_ARGS, NO_ENDOWMENT)??;
/// # Ok(()) }
/// ```
///
/// You can also work with `.contract` bundles like so:
/// ```rust, no_run
/// # use drink::{
/// # local_contract_file,
/// # session::Session,
/// # session::{NO_ARGS, NO_SALT, NO_ENDOWMENT},
/// # runtime::MinimalRuntime,
/// # ContractBundle,
/// # };
///
/// # fn main() -> Result<(), drink::session::error::SessionError> {
/// // Simplest way, loading a bundle from the project's directory:
/// Session::<MinimalRuntime>::new()?
/// .deploy_bundle_and(local_contract_file!(), "new", NO_ARGS, NO_SALT, NO_ENDOWMENT)?; /* ... */
///
/// // Or choosing the file explicitly:
/// let contract = ContractBundle::load("path/to/your.contract")?;
/// Session::<MinimalRuntime>::new()?
/// .deploy_bundle_and(contract, "new", NO_ARGS, NO_SALT, NO_ENDOWMENT)?; /* ... */
/// # Ok(()) }
/// ```
pub struct Session<R>
where
R: Runtime,
R::Config: pallet_contracts::Config,
{
sandbox: Sandbox<R>,
actor: AccountIdFor<R::Config>,
gas_limit: Weight,
determinism: Determinism,
transcoders: TranscoderRegistry<AccountIdFor<R::Config>>,
record: Record<R::Config>,
mocks: Arc<Mutex<MockRegistry<AccountIdFor<R::Config>>>>,
}
impl<R> Session<R>
where
R: Runtime,
R::Config: pallet_contracts::Config,
{
/// Creates a new `Session`.
pub fn new() -> Result<Self, SessionError> {
let mocks = Arc::new(Mutex::new(MockRegistry::new()));
let mut sandbox = Sandbox::new().map_err(SessionError::Drink)?;
sandbox.register_extension(InterceptingExt(Box::new(MockingExtension {
mock_registry: Arc::clone(&mocks),
})));
Ok(Self {
sandbox,
mocks,
actor: R::default_actor(),
gas_limit: DEFAULT_GAS_LIMIT,
determinism: Determinism::Enforced,
transcoders: TranscoderRegistry::new(),
record: Default::default(),
})
}
/// Sets a new actor and returns updated `self`.
pub fn with_actor(self, actor: AccountIdFor<R::Config>) -> Self {
Self { actor, ..self }
}
/// Returns currently set actor.
pub fn get_actor(&self) -> AccountIdFor<R::Config> {
self.actor.clone()
}
/// Sets a new actor and returns the old one.
pub fn set_actor(&mut self, actor: AccountIdFor<R::Config>) -> AccountIdFor<R::Config> {
mem::replace(&mut self.actor, actor)
}
/// Sets a new gas limit and returns updated `self`.
pub fn with_gas_limit(self, gas_limit: Weight) -> Self {
Self { gas_limit, ..self }
}
/// Sets a new gas limit and returns the old one.
pub fn set_gas_limit(&mut self, gas_limit: Weight) -> Weight {
mem::replace(&mut self.gas_limit, gas_limit)
}
/// Returns currently set gas limit.
pub fn get_gas_limit(&self) -> Weight {
self.gas_limit
}
/// Sets a new determinism policy and returns updated `self`.
pub fn with_determinism(self, determinism: Determinism) -> Self {
Self {
determinism,
..self
}
}
/// Sets a new determinism policy and returns the old one.
pub fn set_determinism(&mut self, determinism: Determinism) -> Determinism {
mem::replace(&mut self.determinism, determinism)
}
/// Register a transcoder for a particular contract and returns updated `self`.
pub fn with_transcoder(
mut self,
contract_address: AccountIdFor<R::Config>,
transcoder: &Rc<ContractMessageTranscoder>,
) -> Self {
self.set_transcoder(contract_address, transcoder);
self
}
/// Registers a transcoder for a particular contract.
pub fn set_transcoder(
&mut self,
contract_address: AccountIdFor<R::Config>,
transcoder: &Rc<ContractMessageTranscoder>,
) {
self.transcoders.register(contract_address, transcoder);
}
/// The underlying `Sandbox` instance.
pub fn sandbox(&mut self) -> &mut Sandbox<R> {
&mut self.sandbox
}
/// Returns a reference to the record of the session.
pub fn record(&self) -> &Record<R::Config> {
&self.record
}
/// Returns a reference for mocking API.
pub fn mocking_api(&mut self) -> &mut impl MockingApi<R> {
self
}
/// Deploys a contract with a given constructor, arguments, salt and endowment. In case of
/// success, returns `self`.
pub fn deploy_and<S: AsRef<str> + Debug>(
mut self,
contract_bytes: Vec<u8>,
constructor: &str,
args: &[S],
salt: Vec<u8>,
endowment: Option<BalanceOf<R::Config>>,
transcoder: &Rc<ContractMessageTranscoder>,
) -> Result<Self, SessionError> {
self.deploy(
contract_bytes,
constructor,
args,
salt,
endowment,
transcoder,
)
.map(|_| self)
}
/// Deploys a contract with a given constructor, arguments, salt and endowment. In case of
/// success, returns the address of the deployed contract.
pub fn deploy<S: AsRef<str> + Debug>(
&mut self,
contract_bytes: Vec<u8>,
constructor: &str,
args: &[S],
salt: Vec<u8>,
endowment: Option<BalanceOf<R::Config>>,
transcoder: &Rc<ContractMessageTranscoder>,
) -> Result<AccountIdFor<R::Config>, SessionError> {
let data = transcoder
.encode(constructor, args)
.map_err(|err| SessionError::Encoding(err.to_string()))?;
self.record.start_recording_events(&mut self.sandbox);
let result = self.sandbox.deploy_contract(
contract_bytes,
endowment.unwrap_or_default(),
data,
salt,
self.actor.clone(),
self.gas_limit,
None,
);
self.record.stop_recording_events(&mut self.sandbox);
let ret = match &result.result {
Ok(exec_result) if exec_result.result.did_revert() => {
Err(SessionError::DeploymentReverted)
}
Ok(exec_result) => {
let address = exec_result.account_id.clone();
self.record.push_deploy_return(address.clone());
self.transcoders.register(address.clone(), transcoder);
Ok(address)
}
Err(err) => Err(SessionError::DeploymentFailed(*err)),
};
self.record.push_deploy_result(result);
ret
}
/// Similar to `deploy` but takes the parsed contract file (`ContractBundle`) as a first argument.
///
/// You can get it with `ContractBundle::load("some/path/your.contract")` or `local_contract_file!()`
pub fn deploy_bundle<S: AsRef<str> + Debug>(
&mut self,
contract_file: ContractBundle,
constructor: &str,
args: &[S],
salt: Vec<u8>,
endowment: Option<BalanceOf<R::Config>>,
) -> Result<AccountIdFor<R::Config>, SessionError> {
self.deploy(
contract_file.wasm,
constructor,
args,
salt,
endowment,
&contract_file.transcoder,
)
}
/// Similar to `deploy_and` but takes the parsed contract file (`ContractBundle`) as a first argument.
///
/// You can get it with `ContractBundle::load("some/path/your.contract")` or `local_contract_file!()`
pub fn deploy_bundle_and<S: AsRef<str> + Debug>(
mut self,
contract_file: ContractBundle,
constructor: &str,
args: &[S],
salt: Vec<u8>,
endowment: Option<BalanceOf<R::Config>>,
) -> Result<Self, SessionError> {
self.deploy_bundle(contract_file, constructor, args, salt, endowment)
.map(|_| self)
}
/// Uploads a raw contract code. In case of success, returns `self`.
pub fn upload_and(mut self, contract_bytes: Vec<u8>) -> Result<Self, SessionError> {
self.upload(contract_bytes).map(|_| self)
}
/// Uploads a raw contract code. In case of success returns the code hash.
pub fn upload(&mut self, contract_bytes: Vec<u8>) -> Result<HashFor<R::Config>, SessionError> {
let result = self.sandbox.upload_contract(
contract_bytes,
self.actor.clone(),
None,
self.determinism,
);
result
.map(|upload_result| upload_result.code_hash)
.map_err(SessionError::UploadFailed)
}
/// Similar to `upload_and` but takes the contract bundle as the first argument.
///
/// You can obtain it using `ContractBundle::load("some/path/your.contract")` or `local_contract_file!()`
pub fn upload_bundle_and(self, contract_file: ContractBundle) -> Result<Self, SessionError> {
self.upload_and(contract_file.wasm)
}
/// Similar to `upload` but takes the contract bundle as the first argument.
///
/// You can obtain it using `ContractBundle::load("some/path/your.contract")` or `local_contract_file!()`
pub fn upload_bundle(
&mut self,
contract_file: ContractBundle,
) -> Result<HashFor<R::Config>, SessionError> {
self.upload(contract_file.wasm)
}
/// Calls a contract with a given address. In case of a successful call, returns `self`.
pub fn call_and<S: AsRef<str> + Debug>(
mut self,
message: &str,
args: &[S],
endowment: Option<BalanceOf<R::Config>>,
) -> Result<Self, SessionError> {
// We ignore result, so we can pass `()` as the message result type, which will never fail
// at decoding.
self.call_internal::<_, ()>(None, message, args, endowment)
.map(|_| self)
}
/// Calls the last deployed contract. In case of a successful call, returns `self`.
pub fn call_with_address_and<S: AsRef<str> + Debug>(
mut self,
address: AccountIdFor<R::Config>,
message: &str,
args: &[S],
endowment: Option<BalanceOf<R::Config>>,
) -> Result<Self, SessionError> {
// We ignore result, so we can pass `()` as the message result type, which will never fail
// at decoding.
self.call_internal::<_, ()>(Some(address), message, args, endowment)
.map(|_| self)
}
/// Calls the last deployed contract. In case of a successful call, returns the encoded result.
pub fn call<S: AsRef<str> + Debug, T: Decode>(
&mut self,
message: &str,
args: &[S],
endowment: Option<BalanceOf<R::Config>>,
) -> Result<MessageResult<T>, SessionError> {
self.call_internal::<_, T>(None, message, args, endowment)
}
/// Calls a contract with a given address. In case of a successful call, returns the encoded
/// result.
pub fn call_with_address<S: AsRef<str> + Debug, T: Decode>(
&mut self,
address: AccountIdFor<R::Config>,
message: &str,
args: &[S],
endowment: Option<BalanceOf<R::Config>>,
) -> Result<MessageResult<T>, SessionError> {
self.call_internal(Some(address), message, args, endowment)
}
fn call_internal<S: AsRef<str> + Debug, T: Decode>(
&mut self,
address: Option<AccountIdFor<R::Config>>,
message: &str,
args: &[S],
endowment: Option<BalanceOf<R::Config>>,
) -> Result<MessageResult<T>, SessionError> {
let address = match address {
Some(address) => address,
None => self
.record
.deploy_returns()
.last()
.ok_or(SessionError::NoContract)?
.clone(),
};
let data = self
.transcoders
.get(&address)
.as_ref()
.ok_or(SessionError::NoTranscoder)?
.encode(message, args)
.map_err(|err| SessionError::Encoding(err.to_string()))?;
self.record.start_recording_events(&mut self.sandbox);
let result = self.sandbox.call_contract(
address,
endowment.unwrap_or_default(),
data,
self.actor.clone(),
self.gas_limit,
None,
self.determinism,
);
self.record.stop_recording_events(&mut self.sandbox);
let ret = match &result.result {
Ok(exec_result) if exec_result.did_revert() => Err(SessionError::CallReverted),
Ok(exec_result) => {
self.record.push_call_return(exec_result.data.clone());
self.record.last_call_return_decoded::<T>()
}
Err(err) => Err(SessionError::CallFailed(*err)),
};
self.record.push_call_result(result);
ret
}
/// Set the tracing extension
pub fn set_tracing_extension(&mut self, d: TracingExt) {
self.sandbox.register_extension(d);
}
}