ink_sandbox/
lib.rs

1use core::any::Any;
2
3pub mod api;
4pub mod macros;
5
6pub use frame_metadata::RuntimeMetadataPrefixed;
7pub use frame_support::weights::Weight;
8use frame_support::{
9    sp_runtime::traits::Dispatchable,
10    traits::fungible::Inspect,
11};
12use frame_system::{
13    pallet_prelude::{
14        BlockNumberFor,
15        OriginFor,
16    },
17    EventRecord,
18};
19pub use macros::{
20    BlockBuilder,
21    DefaultSandbox,
22};
23use pallet_revive::{
24    ContractResult,
25    ExecReturnValue,
26    InstantiateReturnValue,
27};
28/// Export pallets that are used in [`crate::create_sandbox`]
29pub use {
30    frame_support::sp_runtime::testing::H256,
31    frame_support::{
32        self,
33        sp_runtime::{
34            AccountId32,
35            DispatchError,
36        },
37    },
38    frame_system,
39    pallet_balances,
40    pallet_revive,
41    pallet_timestamp,
42    paste,
43    sp_core::crypto::Ss58Codec,
44    sp_externalities::{
45        self,
46        Extension,
47    },
48    sp_io::TestExternalities,
49};
50
51/// A snapshot of the storage.
52#[derive(Clone, Debug)]
53pub struct Snapshot {
54    /// The storage raw key-value pairs.
55    pub storage: RawStorage,
56    /// The storage root hash.
57    pub storage_root: StorageRoot,
58}
59
60pub type RawStorage = Vec<(Vec<u8>, (Vec<u8>, i32))>;
61pub type StorageRoot = H256;
62
63/// Alias for the balance type.
64type BalanceOf<R> =
65    <<R as pallet_revive::Config>::Currency as Inspect<AccountIdFor<R>>>::Balance;
66
67/// Alias for the account ID type.
68pub type AccountIdFor<R> = <R as frame_system::Config>::AccountId;
69
70/// Alias for the runtime call type.
71pub type RuntimeCall<R> = <R as frame_system::Config>::RuntimeCall;
72
73/// Alias for the event record type.
74pub type EventRecordOf<Runtime> = EventRecord<
75    <Runtime as frame_system::Config>::RuntimeEvent,
76    <Runtime as frame_system::Config>::Hash,
77>;
78
79/// Alias for the contract instantiate result.
80pub type ContractInstantiateResultFor<Runtime> =
81    ContractResult<OriginFor<Runtime>, BalanceOf<Runtime>>;
82
83pub type ContractResultFor<Runtime> = ContractResult<Runtime, BalanceOf<Runtime>>;
84
85pub type ContractResultInstantiate<Runtime> =
86    ContractResult<InstantiateReturnValue, BalanceOf<Runtime>>;
87
88/// Alias for the contract exec result.
89pub type ContractExecResultFor<Runtime> =
90    ContractResult<ExecReturnValue, BalanceOf<Runtime>>;
91
92/// Alias for the `map_acocunt` result.
93pub type MapAccountResultFor = Result<(), DispatchError>;
94
95/// Alias for the runtime of a sandbox.
96pub type RuntimeOf<S> = <S as Sandbox>::Runtime;
97
98/// Alias for the runtime event of a sandbox.
99pub type RuntimeEventOf<S> = <RuntimeOf<S> as frame_system::Config>::RuntimeEvent;
100
101/// Sandbox defines the API of a sandboxed runtime.
102pub trait Sandbox {
103    /// The runtime associated with the sandbox.
104    type Runtime: frame_system::Config;
105
106    /// Execute the given externalities.
107    fn execute_with<T>(&mut self, execute: impl FnOnce() -> T) -> T;
108
109    /// Dry run an action without modifying the storage.
110    fn dry_run<T>(&mut self, action: impl FnOnce(&mut Self) -> T) -> T;
111
112    /// Register an extension.
113    fn register_extension<E: Any + Extension>(&mut self, ext: E);
114
115    /// Initialize a new block at particular height.
116    fn initialize_block(
117        _height: BlockNumberFor<Self::Runtime>,
118        _parent_hash: <Self::Runtime as frame_system::Config>::Hash,
119    ) {
120    }
121
122    /// Finalize a block at particular height.
123    fn finalize_block(
124        _height: BlockNumberFor<Self::Runtime>,
125    ) -> <Self::Runtime as frame_system::Config>::Hash {
126        Default::default()
127    }
128
129    /// Default actor for the sandbox.
130    fn default_actor() -> AccountIdFor<Self::Runtime>;
131
132    fn default_gas_limit() -> Weight {
133        Weight::from_parts(100_000_000_000_000, 6 * 1024 * 1024)
134    }
135
136    /// Metadata of the runtime.
137    fn get_metadata() -> RuntimeMetadataPrefixed;
138
139    /// Convert an account to a call origin.
140    fn convert_account_to_origin(
141        account: AccountIdFor<Self::Runtime>,
142    ) -> <<Self::Runtime as frame_system::Config>::RuntimeCall as Dispatchable>::RuntimeOrigin;
143
144    /// Take a snapshot of the storage.
145    fn take_snapshot(&mut self) -> Snapshot;
146
147    /// Restore the storage from the given snapshot.
148    fn restore_snapshot(&mut self, snapshot: Snapshot);
149}
ink_sandbox/lib.rs

ink_sandbox/
lib.rs
