refactor: sandbox to runtime

Author: Daanvdplas

CHANGELOG.md

@@ -6,9 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [Unreleased]
 
-## Added
+### Added
 - Implement `From<ink::Address>` for "ink-as-dependency" contract refs - [#2728](https://github.com/use-ink/ink/pull/2728)
 
+### Changed
+- Rename `ink_sandbox` crate to `ink_runtime`, `Sandbox` trait to `RuntimeEnv`, and `SandboxClient` to `RuntimeClient` for improved clarity
+
 ## Version 6.0.0-beta.1
 
 ### Added

Cargo.lock

@@ -15,7 +15,7 @@ members = [
     "crates/revive-types",
     "crates/prelude",
     "crates/primitives",
-    "crates/sandbox",
+    "crates/runtime",
     "crates/storage",
     "crates/storage/traits"
 ]

Cargo.toml

@@ -31,7 +31,7 @@ tracing = { workspace = true }
 [dev-dependencies]
 ink = { path = "../../ink" }
 ink_e2e = { path = "../" }
-ink_sandbox = { path = "../../sandbox" }
+ink_runtime = { path = "../../runtime" }
 temp-env = "0.3.6"
 
 [features]

crates/e2e/macro/Cargo.toml

@@ -65,10 +65,10 @@ impl Node {
 /// The runtime emulator that should be used within `TestExternalities`
 #[derive(Clone, Eq, PartialEq, Debug, darling::FromMeta)]
 pub struct RuntimeOnly {
-    /// The sandbox runtime type (e.g., `ink_sandbox::DefaultSandbox`)
+    /// The sandbox runtime type (e.g., `ink_runtime::DefaultRuntime`)
     pub sandbox: syn::Path,
     /// The client type implementing the backend traits (e.g.,
-    /// `ink_sandbox::SandboxClient`)
+    /// `ink_runtime::RuntimeClient`)
     pub client: syn::Path,
 }
 
@@ -144,7 +144,7 @@ mod tests {
     fn config_works_backend_runtime_only() {
         let input = quote! {
             environment = crate::CustomEnvironment,
-            backend(runtime_only(sandbox = ::ink_sandbox::DefaultSandbox, client = ::ink_sandbox::SandboxClient)),
+            backend(runtime_only(sandbox = ::ink_runtime::DefaultRuntime, client = ::ink_runtime::RuntimeClient)),
         };
         let config =
             E2EConfig::from_list(&NestedMeta::parse_meta_list(input).unwrap()).unwrap();
@@ -157,8 +157,8 @@ mod tests {
         assert_eq!(
             config.backend(),
             Backend::RuntimeOnly(RuntimeOnly {
-                sandbox: syn::parse_quote! { ::ink_sandbox::DefaultSandbox },
-                client: syn::parse_quote! { ::ink_sandbox::SandboxClient },
+                sandbox: syn::parse_quote! { ::ink_runtime::DefaultRuntime },
+                client: syn::parse_quote! { ::ink_runtime::RuntimeClient },
             })
         );
     }
@@ -175,25 +175,25 @@ mod tests {
         assert_eq!(
             config.backend(),
             Backend::RuntimeOnly(RuntimeOnly {
-                sandbox: syn::parse_quote! { ::ink_sandbox::DefaultSandbox },
-                client: syn::parse_quote! { ::ink_sandbox::SandboxClient },
+                sandbox: syn::parse_quote! { ::ink_runtime::DefaultRuntime },
+                client: syn::parse_quote! { ::ink_runtime::RuntimeClient },
             })
         );
     }
 
     #[test]
     fn config_works_runtime_only_with_custom_backend() {
         let input = quote! {
-            backend(runtime_only(sandbox = ::ink_sandbox::DefaultSandbox, client = ::ink_sandbox::SandboxClient)),
+            backend(runtime_only(sandbox = ::ink_runtime::DefaultRuntime, client = ::ink_runtime::RuntimeClient)),
         };
         let config =
             E2EConfig::from_list(&NestedMeta::parse_meta_list(input).unwrap()).unwrap();
 
         assert_eq!(
             config.backend(),
             Backend::RuntimeOnly(RuntimeOnly {
-                sandbox: syn::parse_quote! { ::ink_sandbox::DefaultSandbox },
-                client: syn::parse_quote! { ::ink_sandbox::SandboxClient },
+                sandbox: syn::parse_quote! { ::ink_runtime::DefaultRuntime },
+                client: syn::parse_quote! { ::ink_runtime::RuntimeClient },
             })
         );
     }

crates/e2e/macro/src/config.rs

@@ -60,7 +60,7 @@ use syn::Result;
 /// ```
 /// type E2EResult<T> = std::result::Result<T, Box<dyn std::error::Error>>;
 ///
-/// #[ink_sandbox::test(backend(runtime_only(sandbox = ink_sandbox::DefaultSandbox, client = ink_sandbox::SandboxClient)))]
+/// #[ink_runtime::test(backend(runtime_only(sandbox = ink_runtime::DefaultRuntime, client = ink_runtime::RuntimeClient)))]
 /// async fn runtime_call_works() -> E2EResult<()> {
 ///     // ...
 /// }

crates/e2e/macro/src/lib.rs

@@ -401,7 +401,7 @@ pub enum DefaultEnvironment {}
 impl Environment for DefaultEnvironment {
     // This number was chosen as it's also what `pallet-revive`
     // chooses by default. It's also the number present in the
-    // `ink_sandbox` and the `ink-node`.
+    // `ink_runtime` and the `ink-node`.
     const NATIVE_TO_ETH_RATIO: u32 = 100_000_000;
 
     // These const's correspond to the settings of Asset Hub and

crates/primitives/src/types.rs

@@ -1,12 +1,12 @@
 [package]
-name = "ink_sandbox"
+name = "ink_runtime"
 version = "6.0.0-beta.1"
 authors = ["Use Ink <[email protected]>", "Cardinal Cryptography"]
 edition.workspace = true
 license.workspace = true
-description = "Sandbox runtime environment for ink! e2e tests"
+description = "Runtime environment for ink! e2e tests"
 repository.workspace = true
-documentation = "https://docs.rs/ink_sandbox"
+documentation = "https://docs.rs/ink_runtime"
 homepage.workspace = true
 
 [dependencies]

crates/sandbox/Cargo.toml renamed to crates/runtime/Cargo.toml

@@ -1,7 +1,7 @@
 use crate::{
     AccountIdFor,
     IntoAccountId,
-    Sandbox,
+    RuntimeEnv,
 };
 use frame_support::{
     pallet_prelude::DispatchError,
@@ -28,7 +28,7 @@ type AssetBalanceOf<T, I> = <T as pallet_assets::Config<I>>::Balance;
 /// Provides methods to create, mint, and manage assets in `pallet-assets`.
 pub trait AssetsAPI<T, I = pallet_assets::Instance1>
 where
-    T: Sandbox,
+    T: RuntimeEnv,
     T::Runtime: pallet_assets::Config<I>,
     I: 'static,
 {
@@ -168,7 +168,7 @@ where
 
 impl<T, I> AssetsAPI<T, I> for T
 where
-    T: Sandbox,
+    T: RuntimeEnv,
     T::Runtime: pallet_assets::Config<I>,
     I: 'static,
 {
@@ -323,12 +323,12 @@ where
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::DefaultSandbox;
+    use crate::DefaultRuntime;
 
     #[test]
     fn create_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let asset_id = 1u32;
         let min_balance = 1u128;
 
@@ -340,8 +340,8 @@ mod tests {
 
     #[test]
     fn set_metadata_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let asset_id = 1u32;
 
         sandbox.create(&asset_id, &admin, 1u128).unwrap();
@@ -357,8 +357,8 @@ mod tests {
 
     #[test]
     fn metadata_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let asset_id = 1u32;
 
         sandbox.create(&asset_id, &admin, 1u128).unwrap();
@@ -381,8 +381,8 @@ mod tests {
 
     #[test]
     fn approve_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let spender = ink_e2e::bob().into_account_id();
         let asset_id = 1u32;
 
@@ -402,8 +402,8 @@ mod tests {
 
     #[test]
     fn mint_into_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let asset_id = 1u32;
 
         sandbox.create(&asset_id, &admin, 1u128).unwrap();
@@ -419,8 +419,8 @@ mod tests {
 
     #[test]
     fn transfer_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let recipient = ink_e2e::bob().into_account_id();
         let asset_id = 1u32;
 
@@ -446,8 +446,8 @@ mod tests {
 
     #[test]
     fn balance_of_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let asset_id = 1u32;
 
         sandbox.create(&asset_id, &admin, 1u128).unwrap();
@@ -463,8 +463,8 @@ mod tests {
 
     #[test]
     fn total_supply_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let asset_id = 1u32;
 
         sandbox.create(&asset_id, &admin, 1u128).unwrap();
@@ -480,8 +480,8 @@ mod tests {
 
     #[test]
     fn allowance_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let spender = ink_e2e::bob().into_account_id();
         let asset_id = 1u32;
 
@@ -500,8 +500,8 @@ mod tests {
 
     #[test]
     fn asset_exists_works() {
-        let mut sandbox = DefaultSandbox::default();
-        let admin = DefaultSandbox::default_actor();
+        let mut sandbox = DefaultRuntime::default();
+        let admin = DefaultRuntime::default_actor();
         let asset_id = 1u32;
 
         assert!(!sandbox.asset_exists(&asset_id));