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 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
// This file is part of Tetcore. // Copyright (C) 2018-2021 Parity Technologies (UK) Ltd. // SPDX-License-Identifier: Apache-2.0 // 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. //! # Contract Module //! //! The Contract module provides functionality for the runtime to deploy and execute WebAssembly smart-contracts. //! //! - [`contract::Config`](./trait.Config.html) //! - [`Call`](./enum.Call.html) //! //! ## Overview //! //! This module extends accounts based on the `Currency` trait to have smart-contract functionality. It can //! be used with other modules that implement accounts based on `Currency`. These "smart-contract accounts" //! have the ability to instantiate smart-contracts and make calls to other contract and non-contract accounts. //! //! The smart-contract code is stored once in a `code_cache`, and later retrievable via its `code_hash`. //! This means that multiple smart-contracts can be instantiated from the same `code_cache`, without replicating //! the code each time. //! //! When a smart-contract is called, its associated code is retrieved via the code hash and gets executed. //! This call can alter the storage entries of the smart-contract account, instantiate new smart-contracts, //! or call other smart-contracts. //! //! Finally, when an account is reaped, its associated code and storage of the smart-contract account //! will also be deleted. //! //! ### Gas //! //! Senders must specify a gas limit with every call, as all instructions invoked by the smart-contract require gas. //! Unused gas is refunded after the call, regardless of the execution outcome. //! //! If the gas limit is reached, then all calls and state changes (including balance transfers) are only //! reverted at the current call's contract level. For example, if contract A calls B and B runs out of gas mid-call, //! then all of B's calls are reverted. Assuming correct error handling by contract A, A's other calls and state //! changes still persist. //! //! ### Notable Scenarios //! //! Contract call failures are not always cascading. When failures occur in a sub-call, they do not "bubble up", //! and the call will only revert at the specific contract level. For example, if contract A calls contract B, and B //! fails, A can decide how to handle that failure, either proceeding or reverting A's changes. //! //! ## Interface //! //! ### Dispatchable functions //! //! * `put_code` - Stores the given binary Wasm code into the chain's storage and returns its `code_hash`. //! * `instantiate` - Deploys a new contract from the given `code_hash`, optionally transferring some balance. //! This instantiates a new smart contract account and calls its contract deploy handler to //! initialize the contract. //! * `call` - Makes a call to an account, optionally transferring some balance. //! //! ## Usage //! //! The Contract module is a work in progress. The following examples show how this Contract module //! can be used to instantiate and call contracts. //! //! * [`pro`](https://github.com/tetcoin/pro) is //! an [`eDSL`](https://wiki.haskell.org/Embedded_domain_specific_language) that enables writing //! WebAssembly based smart contracts in the Rust programming language. This is a work in progress. //! //! ## Related Modules //! //! * [Balances](../noble_balances/index.html) #![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(feature = "runtime-benchmarks", recursion_limit="256")] #[macro_use] mod gas; mod storage; mod exec; mod wasm; mod rent; mod benchmarking; mod schedule; pub mod chain_extension; pub mod weights; #[cfg(test)] mod tests; pub use crate::{ gas::{Gas, GasMeter}, wasm::ReturnCode as RuntimeReturnCode, weights::WeightInfo, schedule::{Schedule, HostFnWeights, InstructionWeights, Limits}, }; use crate::{ exec::ExecutionContext, wasm::{WasmLoader, WasmVm}, rent::Rent, storage::Storage, }; use tet_core::crypto::UncheckedFrom; use tetcore_std::{prelude::*, marker::PhantomData, fmt::Debug}; use codec::{Codec, Encode, Decode}; use tp_runtime::{ traits::{ Hash, StaticLookup, Zero, MaybeSerializeDeserialize, Member, Convert, Saturating, }, RuntimeDebug, Perbill, }; use fabric_support::{ decl_module, decl_event, decl_storage, decl_error, ensure, storage::child::ChildInfo, dispatch::{DispatchResult, DispatchResultWithPostInfo}, traits::{OnUnbalanced, Currency, Get, Time, Randomness}, weights::Pays, }; use fabric_system::{ensure_signed, ensure_root, Module as System}; use noble_contracts_primitives::{ RentProjectionResult, GetStorageResult, ContractAccessError, ContractExecResult, ExecResult, }; use fabric_support::weights::Weight; pub type CodeHash<T> = <T as fabric_system::Config>::Hash; pub type TrieId = Vec<u8>; /// Information for managing an account and its sub trie abstraction. /// This is the required info to cache for an account #[derive(Encode, Decode, RuntimeDebug)] pub enum ContractInfo<T: Config> { Alive(AliveContractInfo<T>), Tombstone(TombstoneContractInfo<T>), } impl<T: Config> ContractInfo<T> { /// If contract is alive then return some alive info pub fn get_alive(self) -> Option<AliveContractInfo<T>> { if let ContractInfo::Alive(alive) = self { Some(alive) } else { None } } /// If contract is alive then return some reference to alive info pub fn as_alive(&self) -> Option<&AliveContractInfo<T>> { if let ContractInfo::Alive(ref alive) = self { Some(alive) } else { None } } /// If contract is alive then return some mutable reference to alive info pub fn as_alive_mut(&mut self) -> Option<&mut AliveContractInfo<T>> { if let ContractInfo::Alive(ref mut alive) = self { Some(alive) } else { None } } /// If contract is tombstone then return some tombstone info pub fn get_tombstone(self) -> Option<TombstoneContractInfo<T>> { if let ContractInfo::Tombstone(tombstone) = self { Some(tombstone) } else { None } } /// If contract is tombstone then return some reference to tombstone info pub fn as_tombstone(&self) -> Option<&TombstoneContractInfo<T>> { if let ContractInfo::Tombstone(ref tombstone) = self { Some(tombstone) } else { None } } /// If contract is tombstone then return some mutable reference to tombstone info pub fn as_tombstone_mut(&mut self) -> Option<&mut TombstoneContractInfo<T>> { if let ContractInfo::Tombstone(ref mut tombstone) = self { Some(tombstone) } else { None } } } pub type AliveContractInfo<T> = RawAliveContractInfo<CodeHash<T>, BalanceOf<T>, <T as fabric_system::Config>::BlockNumber>; /// Information for managing an account and its sub trie abstraction. /// This is the required info to cache for an account. #[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug)] pub struct RawAliveContractInfo<CodeHash, Balance, BlockNumber> { /// Unique ID for the subtree encoded as a bytes vector. pub trie_id: TrieId, /// The total number of bytes used by this contract. /// /// It is a sum of each key-value pair stored by this contract. pub storage_size: u32, /// The total number of key-value pairs in storage of this contract. pub pair_count: u32, /// The code associated with a given account. pub code_hash: CodeHash, /// Pay rent at most up to this value. pub rent_allowance: Balance, /// The amount of rent that was payed by the contract over its whole lifetime. /// /// A restored contract starts with a value of zero just like a new contract. pub rent_payed: Balance, /// Last block rent has been payed. pub deduct_block: BlockNumber, /// Last block child storage has been written. pub last_write: Option<BlockNumber>, } impl<CodeHash, Balance, BlockNumber> RawAliveContractInfo<CodeHash, Balance, BlockNumber> { /// Associated child trie unique id is built from the hash part of the trie id. pub fn child_trie_info(&self) -> ChildInfo { child_trie_info(&self.trie_id[..]) } } /// Associated child trie unique id is built from the hash part of the trie id. pub(crate) fn child_trie_info(trie_id: &[u8]) -> ChildInfo { ChildInfo::new_default(trie_id) } pub type TombstoneContractInfo<T> = RawTombstoneContractInfo<<T as fabric_system::Config>::Hash, <T as fabric_system::Config>::Hashing>; #[derive(Encode, Decode, PartialEq, Eq, RuntimeDebug)] pub struct RawTombstoneContractInfo<H, Hasher>(H, PhantomData<Hasher>); impl<H, Hasher> RawTombstoneContractInfo<H, Hasher> where H: Member + MaybeSerializeDeserialize+ Debug + AsRef<[u8]> + AsMut<[u8]> + Copy + Default + tetcore_std::hash::Hash + Codec, Hasher: Hash<Output=H>, { fn new(storage_root: &[u8], code_hash: H) -> Self { let mut buf = Vec::new(); storage_root.using_encoded(|encoded| buf.extend_from_slice(encoded)); buf.extend_from_slice(code_hash.as_ref()); RawTombstoneContractInfo(<Hasher as Hash>::hash(&buf[..]), PhantomData) } } impl<T: Config> From<AliveContractInfo<T>> for ContractInfo<T> { fn from(alive_info: AliveContractInfo<T>) -> Self { Self::Alive(alive_info) } } pub type BalanceOf<T> = <<T as Config>::Currency as Currency<<T as fabric_system::Config>::AccountId>>::Balance; pub type NegativeImbalanceOf<T> = <<T as Config>::Currency as Currency<<T as fabric_system::Config>::AccountId>>::NegativeImbalance; pub trait Config: fabric_system::Config { type Time: Time; type Randomness: Randomness<Self::Hash>; /// The currency in which fees are paid and contract balances are held. type Currency: Currency<Self::AccountId>; /// The overarching event type. type Event: From<Event<Self>> + Into<<Self as fabric_system::Config>::Event>; /// Handler for rent payments. type RentPayment: OnUnbalanced<NegativeImbalanceOf<Self>>; /// Number of block delay an extrinsic claim surcharge has. /// /// When claim surcharge is called by an extrinsic the rent is checked /// for current_block - delay type SignedClaimHandicap: Get<Self::BlockNumber>; /// The minimum amount required to generate a tombstone. type TombstoneDeposit: Get<BalanceOf<Self>>; /// The balance every contract needs to deposit to stay alive indefinitely. /// /// This is different from the [`Self::TombstoneDeposit`] because this only needs to be /// deposited while the contract is alive. Costs for additional storage are added to /// this base cost. /// /// This is a simple way to ensure that contracts with empty storage eventually get deleted by /// making them pay rent. This creates an incentive to remove them early in order to save rent. type DepositPerContract: Get<BalanceOf<Self>>; /// The balance a contract needs to deposit per storage byte to stay alive indefinitely. /// /// Let's suppose the deposit is 1,000 BU (balance units)/byte and the rent is 1 BU/byte/day, /// then a contract with 1,000,000 BU that uses 1,000 bytes of storage would pay no rent. /// But if the balance reduced to 500,000 BU and the storage stayed the same at 1,000, /// then it would pay 500 BU/day. type DepositPerStorageByte: Get<BalanceOf<Self>>; /// The balance a contract needs to deposit per storage item to stay alive indefinitely. /// /// It works the same as [`Self::DepositPerStorageByte`] but for storage items. type DepositPerStorageItem: Get<BalanceOf<Self>>; /// The fraction of the deposit that should be used as rent per block. /// /// When a contract hasn't enough balance deposited to stay alive indefinitely it needs /// to pay per block for the storage it consumes that is not covered by the deposit. /// This determines how high this rent payment is per block as a fraction of the deposit. type RentFraction: Get<Perbill>; /// Reward that is received by the party whose touch has led /// to removal of a contract. type SurchargeReward: Get<BalanceOf<Self>>; /// The maximum nesting level of a call/instantiate stack. type MaxDepth: Get<u32>; /// The maximum size of a storage value and event payload in bytes. type MaxValueSize: Get<u32>; /// Used to answer contracts's queries regarding the current weight price. This is **not** /// used to calculate the actual fee and is only for informational purposes. type WeightPrice: Convert<Weight, BalanceOf<Self>>; /// Describes the weights of the dispatchables of this module and is also used to /// construct a default cost schedule. type WeightInfo: WeightInfo; /// Type that allows the runtime authors to add new host functions for a contract to call. type ChainExtension: chain_extension::ChainExtension; /// The maximum number of tries that can be queued for deletion. type DeletionQueueDepth: Get<u32>; /// The maximum amount of weight that can be consumed per block for lazy trie removal. type DeletionWeightLimit: Get<Weight>; } decl_error! { /// Error for the contracts module. pub enum Error for Module<T: Config> where T::AccountId: UncheckedFrom<T::Hash>, T::AccountId: AsRef<[u8]>, { /// A new schedule must have a greater version than the current one. InvalidScheduleVersion, /// An origin must be signed or inherent and auxiliary sender only provided on inherent. InvalidSurchargeClaim, /// Cannot restore from nonexisting or tombstone contract. InvalidSourceContract, /// Cannot restore to nonexisting or alive contract. InvalidDestinationContract, /// Tombstones don't match. InvalidTombstone, /// An origin TrieId written in the current block. InvalidContractOrigin, /// The executed contract exhausted its gas limit. OutOfGas, /// The output buffer supplied to a contract API call was too small. OutputBufferTooSmall, /// Performing the requested transfer would have brought the contract below /// the subsistence threshold. No transfer is allowed to do this in order to allow /// for a tombstone to be created. Use `seal_terminate` to remove a contract without /// leaving a tombstone behind. BelowSubsistenceThreshold, /// The newly created contract is below the subsistence threshold after executing /// its contructor. No contracts are allowed to exist below that threshold. NewContractNotFunded, /// Performing the requested transfer failed for a reason originating in the /// chosen currency implementation of the runtime. Most probably the balance is /// too low or locks are placed on it. TransferFailed, /// Performing a call was denied because the calling depth reached the limit /// of what is specified in the schedule. MaxCallDepthReached, /// The contract that was called is either no contract at all (a plain account) /// or is a tombstone. NotCallable, /// The code supplied to `put_code` exceeds the limit specified in the current schedule. CodeTooLarge, /// No code could be found at the supplied code hash. CodeNotFound, /// A buffer outside of sandbox memory was passed to a contract API function. OutOfBounds, /// Input passed to a contract API function failed to decode as expected type. DecodingFailed, /// Contract trapped during execution. ContractTrapped, /// The size defined in `T::MaxValueSize` was exceeded. ValueTooLarge, /// The action performed is not allowed while the contract performing it is already /// on the call stack. Those actions are contract self destruction and restoration /// of a tombstone. ReentranceDenied, /// `seal_input` was called twice from the same contract execution context. InputAlreadyRead, /// The subject passed to `seal_random` exceeds the limit. RandomSubjectTooLong, /// The amount of topics passed to `seal_deposit_events` exceeds the limit. TooManyTopics, /// The topics passed to `seal_deposit_events` contains at least one duplicate. DuplicateTopics, /// The chain does not provide a chain extension. Calling the chain extension results /// in this error. Note that this usually shouldn't happen as deploying such contracts /// is rejected. NoChainExtension, /// Removal of a contract failed because the deletion queue is full. /// /// This can happen when either calling [`Module::claim_surcharge`] or `seal_terminate`. /// The queue is filled by deleting contracts and emptied by a fixed amount each block. /// Trying again during another block is the only way to resolve this issue. DeletionQueueFull, /// A contract could not be evicted because it has enough balance to pay rent. /// /// This can be returned from [`Module::claim_surcharge`] because the target /// contract has enough balance to pay for its rent. ContractNotEvictable, /// A storage modification exhausted the 32bit type that holds the storage size. /// /// This can either happen when the accumulated storage in bytes is too large or /// when number of storage items is too large. StorageExhausted, } } decl_module! { /// Contracts module. pub struct Module<T: Config> for enum Call where origin: T::Origin, T::AccountId: UncheckedFrom<T::Hash>, T::AccountId: AsRef<[u8]>, { type Error = Error<T>; /// Number of block delay an extrinsic claim surcharge has. /// /// When claim surcharge is called by an extrinsic the rent is checked /// for current_block - delay const SignedClaimHandicap: T::BlockNumber = T::SignedClaimHandicap::get(); /// The minimum amount required to generate a tombstone. const TombstoneDeposit: BalanceOf<T> = T::TombstoneDeposit::get(); /// The balance every contract needs to deposit to stay alive indefinitely. /// /// This is different from the [`Self::TombstoneDeposit`] because this only needs to be /// deposited while the contract is alive. Costs for additional storage are added to /// this base cost. /// /// This is a simple way to ensure that contracts with empty storage eventually get deleted by /// making them pay rent. This creates an incentive to remove them early in order to save rent. const DepositPerContract: BalanceOf<T> = T::DepositPerContract::get(); /// The balance a contract needs to deposit per storage byte to stay alive indefinitely. /// /// Let's suppose the deposit is 1,000 BU (balance units)/byte and the rent is 1 BU/byte/day, /// then a contract with 1,000,000 BU that uses 1,000 bytes of storage would pay no rent. /// But if the balance reduced to 500,000 BU and the storage stayed the same at 1,000, /// then it would pay 500 BU/day. const DepositPerStorageByte: BalanceOf<T> = T::DepositPerStorageByte::get(); /// The balance a contract needs to deposit per storage item to stay alive indefinitely. /// /// It works the same as [`Self::DepositPerStorageByte`] but for storage items. const DepositPerStorageItem: BalanceOf<T> = T::DepositPerStorageItem::get(); /// The fraction of the deposit that should be used as rent per block. /// /// When a contract hasn't enough balance deposited to stay alive indefinitely it needs /// to pay per block for the storage it consumes that is not covered by the deposit. /// This determines how high this rent payment is per block as a fraction of the deposit. const RentFraction: Perbill = T::RentFraction::get(); /// Reward that is received by the party whose touch has led /// to removal of a contract. const SurchargeReward: BalanceOf<T> = T::SurchargeReward::get(); /// The maximum nesting level of a call/instantiate stack. A reasonable default /// value is 100. const MaxDepth: u32 = T::MaxDepth::get(); /// The maximum size of a storage value in bytes. A reasonable default is 16 KiB. const MaxValueSize: u32 = T::MaxValueSize::get(); /// The maximum number of tries that can be queued for deletion. const DeletionQueueDepth: u32 = T::DeletionQueueDepth::get(); /// The maximum amount of weight that can be consumed per block for lazy trie removal. const DeletionWeightLimit: Weight = T::DeletionWeightLimit::get(); fn deposit_event() = default; fn on_initialize() -> Weight { // We do not want to go above the block limit and rather avoid lazy deletion // in that case. This should only happen on runtime upgrades. let weight_limit = T::BlockWeights::get().max_block .saturating_sub(System::<T>::block_weight().total()) .min(T::DeletionWeightLimit::get()); Storage::<T>::process_deletion_queue_batch(weight_limit) .saturating_add(T::WeightInfo::on_initialize()) } /// Updates the schedule for metering contracts. /// /// The schedule must have a greater version than the stored schedule. #[weight = T::WeightInfo::update_schedule()] pub fn update_schedule(origin, schedule: Schedule<T>) -> DispatchResult { ensure_root(origin)?; if <Module<T>>::current_schedule().version >= schedule.version { Err(Error::<T>::InvalidScheduleVersion)? } Self::deposit_event(RawEvent::ScheduleUpdated(schedule.version)); CurrentSchedule::put(schedule); Ok(()) } /// Stores the given binary Wasm code into the chain's storage and returns its `codehash`. /// You can instantiate contracts only with stored code. #[weight = T::WeightInfo::put_code(code.len() as u32 / 1024)] pub fn put_code( origin, code: Vec<u8> ) -> DispatchResult { ensure_signed(origin)?; let schedule = <Module<T>>::current_schedule(); ensure!(code.len() as u32 <= schedule.limits.code_size, Error::<T>::CodeTooLarge); let result = wasm::save_code::<T>(code, &schedule); if let Ok(code_hash) = result { Self::deposit_event(RawEvent::CodeStored(code_hash)); } result.map(|_| ()).map_err(Into::into) } /// Makes a call to an account, optionally transferring some balance. /// /// * If the account is a smart-contract account, the associated code will be /// executed and any value will be transferred. /// * If the account is a regular account, any value will be transferred. /// * If no account exists and the call value is not less than `existential_deposit`, /// a regular account will be created and any value will be transferred. #[weight = T::WeightInfo::call().saturating_add(*gas_limit)] pub fn call( origin, dest: <T::Lookup as StaticLookup>::Source, #[compact] value: BalanceOf<T>, #[compact] gas_limit: Gas, data: Vec<u8> ) -> DispatchResultWithPostInfo { let origin = ensure_signed(origin)?; let dest = T::Lookup::lookup(dest)?; let mut gas_meter = GasMeter::new(gas_limit); let result = Self::execute_wasm(origin, &mut gas_meter, |ctx, gas_meter| { ctx.call(dest, value, gas_meter, data) }); gas_meter.into_dispatch_result(result) } /// Instantiates a new contract from the `code_hash` generated by `put_code`, /// optionally transferring some balance. /// /// The supplied `salt` is used for contract address deriviation. See `fn contract_address`. /// /// Instantiation is executed as follows: /// /// - The destination address is computed based on the sender, code_hash and the salt. /// - The smart-contract account is created at the computed address. /// - The `ctor_code` is executed in the context of the newly-created account. Buffer returned /// after the execution is saved as the `code` of the account. That code will be invoked /// upon any call received by this account. /// - The contract is initialized. #[weight = T::WeightInfo::instantiate( data.len() as u32 / 1024, salt.len() as u32 / 1024, ).saturating_add(*gas_limit) ] pub fn instantiate( origin, #[compact] endowment: BalanceOf<T>, #[compact] gas_limit: Gas, code_hash: CodeHash<T>, data: Vec<u8>, salt: Vec<u8>, ) -> DispatchResultWithPostInfo { let origin = ensure_signed(origin)?; let mut gas_meter = GasMeter::new(gas_limit); let result = Self::execute_wasm(origin, &mut gas_meter, |ctx, gas_meter| { ctx.instantiate(endowment, gas_meter, &code_hash, data, &salt) .map(|(_address, output)| output) }); gas_meter.into_dispatch_result(result) } /// Allows block producers to claim a small reward for evicting a contract. If a block /// producer fails to do so, a regular users will be allowed to claim the reward. /// /// In case of a successful eviction no fees are charged from the sender. However, the /// reward is capped by the total amount of rent that was payed by the contract while /// it was alive. /// /// If contract is not evicted as a result of this call, [`Error::ContractNotEvictable`] /// is returned and the sender is not eligible for the reward. #[weight = T::WeightInfo::claim_surcharge()] pub fn claim_surcharge( origin, dest: T::AccountId, aux_sender: Option<T::AccountId> ) -> DispatchResultWithPostInfo { let origin = origin.into(); let (signed, rewarded) = match (origin, aux_sender) { (Ok(fabric_system::RawOrigin::Signed(account)), None) => { (true, account) }, (Ok(fabric_system::RawOrigin::None), Some(aux_sender)) => { (false, aux_sender) }, _ => Err(Error::<T>::InvalidSurchargeClaim)?, }; // Add some advantage for block producers (who send unsigned extrinsics) by // adding a handicap: for signed extrinsics we use a slightly older block number // for the eviction check. This can be viewed as if we pushed regular users back in past. let handicap = if signed { T::SignedClaimHandicap::get() } else { Zero::zero() }; // If poking the contract has lead to eviction of the contract, give out the rewards. if let Some(rent_payed) = Rent::<T>::try_eviction(&dest, handicap)? { T::Currency::deposit_into_existing( &rewarded, T::SurchargeReward::get().min(rent_payed), ) .map(|_| Pays::No.into()) .map_err(Into::into) } else { Err(Error::<T>::ContractNotEvictable.into()) } } } } /// Public APIs provided by the contracts module. impl<T: Config> Module<T> where T::AccountId: UncheckedFrom<T::Hash> + AsRef<[u8]>, { /// Perform a call to a specified contract. /// /// This function is similar to `Self::call`, but doesn't perform any address lookups and better /// suitable for calling directly from Rust. /// /// It returns the exection result and the amount of used weight. pub fn bare_call( origin: T::AccountId, dest: T::AccountId, value: BalanceOf<T>, gas_limit: Gas, input_data: Vec<u8>, ) -> ContractExecResult { let mut gas_meter = GasMeter::new(gas_limit); let exec_result = Self::execute_wasm(origin, &mut gas_meter, |ctx, gas_meter| { ctx.call(dest, value, gas_meter, input_data) }); let gas_consumed = gas_meter.gas_spent(); ContractExecResult { exec_result, gas_consumed, } } /// Query storage of a specified contract under a specified key. pub fn get_storage(address: T::AccountId, key: [u8; 32]) -> GetStorageResult { let contract_info = ContractInfoOf::<T>::get(&address) .ok_or(ContractAccessError::DoesntExist)? .get_alive() .ok_or(ContractAccessError::IsTombstone)?; let maybe_value = Storage::<T>::read(&contract_info.trie_id, &key); Ok(maybe_value) } pub fn rent_projection(address: T::AccountId) -> RentProjectionResult<T::BlockNumber> { Rent::<T>::compute_projection(&address) } /// Put code for benchmarks which does not check or instrument the code. #[cfg(feature = "runtime-benchmarks")] pub fn put_code_raw(code: Vec<u8>) -> DispatchResult { let schedule = <Module<T>>::current_schedule(); let result = wasm::save_code_raw::<T>(code, &schedule); result.map(|_| ()).map_err(Into::into) } /// Determine the address of a contract, /// /// This is the address generation function used by contract instantation. Its result /// is only dependend on its inputs. It can therefore be used to reliably predict the /// address of a contract. This is akin to the formular of eth's CRATE2 opcode. There /// is no CREATE equivalent because CREATE2 is strictly more powerful. /// /// Formula: `hash(deploying_address ++ code_hash ++ salt)` pub fn contract_address( deploying_address: &T::AccountId, code_hash: &CodeHash<T>, salt: &[u8], ) -> T::AccountId { let buf: Vec<_> = deploying_address.as_ref().iter() .chain(code_hash.as_ref()) .chain(salt) .cloned() .collect(); UncheckedFrom::unchecked_from(T::Hashing::hash(&buf)) } } impl<T: Config> Module<T> where T::AccountId: UncheckedFrom<T::Hash> + AsRef<[u8]>, { fn execute_wasm( origin: T::AccountId, gas_meter: &mut GasMeter<T>, func: impl FnOnce(&mut ExecutionContext<T, WasmVm<T>, WasmLoader<T>>, &mut GasMeter<T>) -> ExecResult, ) -> ExecResult { let cfg = ConfigCache::preload(); let vm = WasmVm::new(&cfg.schedule); let loader = WasmLoader::new(&cfg.schedule); let mut ctx = ExecutionContext::top_level(origin, &cfg, &vm, &loader); func(&mut ctx, gas_meter) } } decl_event! { pub enum Event<T> where Balance = BalanceOf<T>, <T as fabric_system::Config>::AccountId, <T as fabric_system::Config>::Hash { /// Contract deployed by address at the specified address. \[owner, contract\] Instantiated(AccountId, AccountId), /// Contract has been evicted and is now in tombstone state. /// \[contract, tombstone\] /// /// # Params /// /// - `contract`: `AccountId`: The account ID of the evicted contract. /// - `tombstone`: `bool`: True if the evicted contract left behind a tombstone. Evicted(AccountId, bool), /// Restoration for a contract has been successful. /// \[donor, dest, code_hash, rent_allowance\] /// /// # Params /// /// - `donor`: `AccountId`: Account ID of the restoring contract /// - `dest`: `AccountId`: Account ID of the restored contract /// - `code_hash`: `Hash`: Code hash of the restored contract /// - `rent_allowance: `Balance`: Rent allowance of the restored contract Restored(AccountId, AccountId, Hash, Balance), /// Code with the specified hash has been stored. /// \[code_hash\] CodeStored(Hash), /// Triggered when the current \[schedule\] is updated. ScheduleUpdated(u32), /// An event deposited upon execution of a contract from the account. /// \[account, data\] ContractExecution(AccountId, Vec<u8>), } } decl_storage! { trait Store for Module<T: Config> as Contracts where T::AccountId: UncheckedFrom<T::Hash> + AsRef<[u8]> { /// Current cost schedule for contracts. CurrentSchedule get(fn current_schedule) config(): Schedule<T> = Default::default(); /// A mapping from an original code hash to the original code, untouched by instrumentation. pub PristineCode: map hasher(identity) CodeHash<T> => Option<Vec<u8>>; /// A mapping between an original code hash and instrumented wasm code, ready for execution. pub CodeStorage: map hasher(identity) CodeHash<T> => Option<wasm::PrefabWasmModule>; /// The subtrie counter. pub AccountCounter: u64 = 0; /// The code associated with a given account. /// /// TWOX-NOTE: SAFE since `AccountId` is a secure hash. pub ContractInfoOf: map hasher(twox_64_concat) T::AccountId => Option<ContractInfo<T>>; /// Evicted contracts that await child trie deletion. /// /// Child trie deletion is a heavy operation depending on the amount of storage items /// stored in said trie. Therefore this operation is performed lazily in `on_initialize`. pub DeletionQueue: Vec<storage::DeletedContract>; } } /// In-memory cache of configuration values. /// /// We assume that these values can't be changed in the /// course of transaction execution. pub struct ConfigCache<T: Config> { pub schedule: Schedule<T>, pub existential_deposit: BalanceOf<T>, pub tombstone_deposit: BalanceOf<T>, pub max_depth: u32, pub max_value_size: u32, } impl<T: Config> ConfigCache<T> where T::AccountId: UncheckedFrom<T::Hash> + AsRef<[u8]> { fn preload() -> ConfigCache<T> { ConfigCache { schedule: <Module<T>>::current_schedule(), existential_deposit: T::Currency::minimum_balance(), tombstone_deposit: T::TombstoneDeposit::get(), max_depth: T::MaxDepth::get(), max_value_size: T::MaxValueSize::get(), } } /// Subsistence threshold is the extension of the minimum balance (aka existential deposit) by the /// tombstone deposit, required for leaving a tombstone. /// /// Rent or any contract initiated balance transfer mechanism cannot make the balance lower /// than the subsistence threshold in order to guarantee that a tombstone is created. /// /// The only way to completely kill a contract without a tombstone is calling `seal_terminate`. pub fn subsistence_threshold(&self) -> BalanceOf<T> { self.existential_deposit.saturating_add(self.tombstone_deposit) } /// The same as `subsistence_threshold` but without the need for a preloaded instance. /// /// This is for cases where this value is needed in rent calculation rather than /// during contract execution. pub fn subsistence_threshold_uncached() -> BalanceOf<T> { T::Currency::minimum_balance().saturating_add(T::TombstoneDeposit::get()) } }