feat: allow multiple blueprint source types (#983)

Author: Serial-ATA

Cargo.lock

@@ -79,7 +79,7 @@ fn cggmp21_blueprint<T: Config>() -> ServiceBlueprint<<T as Config>::Constraints
 		.unwrap(),
 		registration_params: Default::default(),
 		request_params: Default::default(),
-		gadget: Default::default(),
+		sources: Default::default(),
 		supported_membership_models: vec![MembershipModelType::Fixed, MembershipModelType::Dynamic]
 			.try_into()
 			.unwrap(),

pallets/services/src/benchmarking.rs

@@ -39,7 +39,7 @@ fn hooks() {
 			},],
 			registration_params: bounded_vec![],
 			request_params: bounded_vec![],
-			gadget: Default::default(),
+			sources: Default::default(),
 			supported_membership_models: bounded_vec![
 				MembershipModelType::Fixed,
 				MembershipModelType::Dynamic,

pallets/services/src/tests/hooks.rs

@@ -108,7 +108,7 @@ pub(crate) fn cggmp21_blueprint() -> ServiceBlueprint<ConstraintsOf<Runtime>> {
 		],
 		registration_params: bounded_vec![],
 		request_params: bounded_vec![],
-		gadget: Default::default(),
+		sources: Default::default(),
 		supported_membership_models: bounded_vec![
 			MembershipModelType::Fixed,
 			MembershipModelType::Dynamic,

pallets/services/src/tests/mod.rs

@@ -92,7 +92,7 @@ fn cggmp21_blueprint() -> ServiceBlueprint<ConstraintsOf<Runtime>> {
 		],
 		registration_params: bounded_vec![],
 		request_params: bounded_vec![],
-		gadget: Default::default(),
+		sources: Default::default(),
 		supported_membership_models: bounded_vec![
 			MembershipModelType::Fixed,
 			MembershipModelType::Dynamic,

precompiles/services/src/tests.rs

@@ -19,15 +19,15 @@
 pub mod constraints;
 pub mod evm;
 pub mod field;
-pub mod gadget;
 pub mod jobs;
 pub mod service;
+pub mod sources;
 pub mod types;
 
 pub use constraints::*;
 pub use evm::*;
 pub use field::*;
-pub use gadget::*;
 pub use jobs::*;
 pub use service::*;
+pub use sources::*;
 pub use types::*;

primitives/src/services/mod.rs

@@ -15,7 +15,7 @@
 // along with Tangle.  If not, see <http://www.gnu.org/licenses/>.
 
 use super::{
-	AssetIdT, AssetSecurityCommitment, AssetSecurityRequirement, BoundedString, Gadget,
+	AssetIdT, AssetSecurityCommitment, AssetSecurityRequirement, BlueprintSource, BoundedString,
 	MembershipModelType, TypeCheckError,
 	constraints::Constraints,
 	jobs::{JobDefinition, type_checker},
@@ -137,8 +137,8 @@ pub struct ServiceBlueprint<C: Constraints> {
 	/// If not sure what to use, use `MasterBlueprintServiceManagerRevision::default()` which will
 	/// use the latest revision available.
 	pub master_manager_revision: MasterBlueprintServiceManagerRevision,
-	/// The gadget that will be executed for the service.
-	pub gadget: Gadget<C>,
+	/// The binary sources for the blueprint.
+	pub sources: BoundedVec<BlueprintSource<C>, C::MaxFields>,
 	/// The membership models supported by this blueprint
 	pub supported_membership_models: BoundedVec<MembershipModelType, ConstU32<2>>,
 }

primitives/src/services/service.rs

@@ -27,36 +27,108 @@ use serde::{Deserialize, Serialize};
 #[codec(encode_bound(skip_type_params(C)))]
 #[codec(decode_bound(skip_type_params(C)))]
 #[codec(mel_bound(skip_type_params(C)))]
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
-pub enum Gadget<C: Constraints> {
-	/// A Gadget that is a WASM binary that will be executed.
-	/// inside the shell using the wasm runtime.
-	Wasm(WasmGadget<C>),
-	/// A Gadget that is a native binary that will be executed.
-	/// inside the shell using the OS.
-	Native(NativeGadget<C>),
-	/// A Gadget that is a container that will be executed.
-	/// inside the shell using the container runtime (e.g. Docker, Podman, etc.)
-	Container(ContainerGadget<C>),
+#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(tag = "type", bound = ""))]
+pub enum BlueprintSource<C: Constraints> {
+	/// A blueprint that is a WASM binary that will be executed with the specified runtime.
+	Wasm {
+		runtime: WasmRuntime,
+		#[cfg_attr(feature = "std", serde(flatten))]
+		fetcher: WasmFetcher<C>,
+	},
+	/// A blueprint that is a native binary that will be executed.
+	Native(NativeFetcher<C>),
+	/// A blueprint contained in a container image.
+	Container(ImageRegistryFetcher<C>),
+	/// A binary source used for testing the blueprint.
+	Testing(TestFetcher<C>),
 }
 
-impl<C: Constraints> Default for Gadget<C> {
+impl<C: Constraints> Default for BlueprintSource<C> {
 	fn default() -> Self {
-		Gadget::Wasm(WasmGadget { runtime: WasmRuntime::Wasmtime, sources: Default::default() })
+		BlueprintSource::Wasm {
+			runtime: WasmRuntime::Wasmtime,
+			fetcher: WasmFetcher::Github(Default::default()),
+		}
 	}
 }
 
-/// A binary that is stored in the Github release.
-/// this will constuct the URL to the release and download the binary.
-/// The URL will be in the following format:
-/// https://github.com/<owner>/<repo>/releases/download/v<tag>/<path>
 #[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
 #[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
 #[scale_info(skip_type_params(C))]
 #[codec(encode_bound(skip_type_params(C)))]
 #[codec(decode_bound(skip_type_params(C)))]
 #[codec(mel_bound(skip_type_params(C)))]
 #[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
+pub enum WasmRuntime {
+	/// The WASM binary will be executed using the WASMtime runtime.
+	#[codec(index = 0)]
+	Wasmtime,
+	/// The WASM binary will be executed using the Wasmer runtime.
+	#[codec(index = 1)]
+	Wasmer,
+}
+
+#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
+#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
+#[scale_info(skip_type_params(C))]
+#[codec(encode_bound(skip_type_params(C)))]
+#[codec(decode_bound(skip_type_params(C)))]
+#[codec(mel_bound(skip_type_params(C)))]
+#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = "", untagged))]
+pub enum WasmFetcher<C: Constraints> {
+	/// A WASM binary that will be fetched from the IPFS.
+	#[codec(index = 0)]
+	IPFS(BoundedVec<u8, C::MaxIpfsHashLength>),
+	/// A WASM binary that will be fetched from a GitHub release.
+	#[codec(index = 1)]
+	Github(GithubFetcher<C>),
+}
+
+#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
+#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
+#[scale_info(skip_type_params(C))]
+#[codec(encode_bound(skip_type_params(C)))]
+#[codec(decode_bound(skip_type_params(C)))]
+#[codec(mel_bound(skip_type_params(C)))]
+#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = "", untagged))]
+pub enum NativeFetcher<C: Constraints> {
+	/// A blueprint that will be fetched from the IPFS.
+	#[codec(index = 0)]
+	IPFS(BoundedVec<u8, C::MaxIpfsHashLength>),
+	/// A blueprint that will be fetched from a GitHub release.
+	#[codec(index = 1)]
+	Github(GithubFetcher<C>),
+}
+
+#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
+#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
+#[scale_info(skip_type_params(C))]
+#[codec(encode_bound(skip_type_params(C)))]
+#[codec(decode_bound(skip_type_params(C)))]
+#[codec(mel_bound(skip_type_params(C)))]
+#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
+pub struct ImageRegistryFetcher<C: Constraints> {
+	/// The URL of the container registry.
+	registry: BoundedString<C::MaxContainerRegistryLength>,
+	/// The name of the image.
+	image: BoundedString<C::MaxContainerImageNameLength>,
+	/// The tag of the image.
+	tag: BoundedString<C::MaxContainerImageTagLength>,
+}
+
+/// A binary that is stored in a GitHub release.
+///
+/// This will construct the URL to the release and download the binary.
+/// The URL will be in the following format:
+///
+/// `https://github.com/<owner>/<repo>/releases/download/v<tag>/<path>`
+#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
+#[educe(Default(bound()), Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
+#[scale_info(skip_type_params(C))]
+#[codec(encode_bound(skip_type_params(C)))]
+#[codec(decode_bound(skip_type_params(C)))]
+#[codec(mel_bound(skip_type_params(C)))]
+#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
 pub struct GithubFetcher<C: Constraints> {
 	/// The owner of the repository.
 	pub owner: BoundedString<C::MaxGitOwnerLength>,
@@ -66,11 +138,11 @@ pub struct GithubFetcher<C: Constraints> {
 	/// NOTE: The tag should be a valid semver tag.
 	pub tag: BoundedString<C::MaxGitTagLength>,
 	/// The names of the binary in the release by the arch and the os.
-	pub binaries: BoundedVec<GadgetBinary<C>, C::MaxBinariesPerGadget>,
+	pub binaries: BoundedVec<BlueprintBinary<C>, C::MaxBinariesPerGadget>,
 }
 
 #[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
-#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
+#[educe(Default(bound()), Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
 #[scale_info(skip_type_params(C))]
 #[codec(encode_bound(skip_type_params(C)))]
 #[codec(decode_bound(skip_type_params(C)))]
@@ -178,7 +250,7 @@ pub enum OperatingSystem {
 #[codec(decode_bound(skip_type_params(C)))]
 #[codec(mel_bound(skip_type_params(C)))]
 #[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
-pub struct GadgetBinary<C: Constraints> {
+pub struct BlueprintBinary<C: Constraints> {
 	/// CPU or System architecture.
 	pub arch: Architecture,
 	/// Operating System that the binary is compiled for.
@@ -189,111 +261,3 @@ pub struct GadgetBinary<C: Constraints> {
 	/// used to verify the downloaded binary.
 	pub sha256: [u8; 32],
 }
-
-#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
-#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
-#[scale_info(skip_type_params(C))]
-#[codec(encode_bound(skip_type_params(C)))]
-#[codec(decode_bound(skip_type_params(C)))]
-#[codec(mel_bound(skip_type_params(C)))]
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
-pub struct GadgetSource<C: Constraints> {
-	/// The fetcher that will fetch the gadget from a remote source.
-	fetcher: GadgetSourceFetcher<C>,
-}
-
-/// A Gadget Source Fetcher is a fetcher that will fetch the gadget
-/// from a remote source.
-#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
-#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
-#[scale_info(skip_type_params(C))]
-#[codec(encode_bound(skip_type_params(C)))]
-#[codec(decode_bound(skip_type_params(C)))]
-#[codec(mel_bound(skip_type_params(C)))]
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
-pub enum GadgetSourceFetcher<C: Constraints> {
-	/// A Gadget that will be fetched from the IPFS.
-	#[codec(index = 0)]
-	IPFS(BoundedVec<u8, C::MaxIpfsHashLength>),
-	/// A Gadget that will be fetched from the Github release.
-	#[codec(index = 1)]
-	Github(GithubFetcher<C>),
-	/// A Gadgets that will be fetched from the container registry.
-	#[codec(index = 2)]
-	ContainerImage(ImageRegistryFetcher<C>),
-	/// For tests only
-	#[codec(index = 3)]
-	Testing(TestFetcher<C>),
-}
-
-#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
-#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
-#[scale_info(skip_type_params(C))]
-#[codec(encode_bound(skip_type_params(C)))]
-#[codec(decode_bound(skip_type_params(C)))]
-#[codec(mel_bound(skip_type_params(C)))]
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
-pub struct ImageRegistryFetcher<C: Constraints> {
-	/// The URL of the container registry.
-	registry: BoundedString<C::MaxContainerRegistryLength>,
-	/// The name of the image.
-	image: BoundedString<C::MaxContainerImageNameLength>,
-	/// The tag of the image.
-	tag: BoundedString<C::MaxContainerImageTagLength>,
-}
-
-/// A WASM binary that contains all the compiled gadget code.
-#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
-#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
-#[scale_info(skip_type_params(C))]
-#[codec(encode_bound(skip_type_params(C)))]
-#[codec(decode_bound(skip_type_params(C)))]
-#[codec(mel_bound(skip_type_params(C)))]
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
-pub struct WasmGadget<C: Constraints> {
-	/// Which runtime to use to execute the WASM binary.
-	pub runtime: WasmRuntime,
-	/// Where the WASM binary is stored.
-	pub sources: BoundedVec<GadgetSource<C>, C::MaxSourcesPerGadget>,
-}
-
-#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
-#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
-#[scale_info(skip_type_params(C))]
-#[codec(encode_bound(skip_type_params(C)))]
-#[codec(decode_bound(skip_type_params(C)))]
-#[codec(mel_bound(skip_type_params(C)))]
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
-pub enum WasmRuntime {
-	/// The WASM binary will be executed using the WASMtime runtime.
-	#[codec(index = 0)]
-	Wasmtime,
-	/// The WASM binary will be executed using the Wasmer runtime.
-	#[codec(index = 1)]
-	Wasmer,
-}
-
-/// A Native binary that contains all the gadget code.
-#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
-#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
-#[scale_info(skip_type_params(C))]
-#[codec(encode_bound(skip_type_params(C)))]
-#[codec(decode_bound(skip_type_params(C)))]
-#[codec(mel_bound(skip_type_params(C)))]
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
-pub struct NativeGadget<C: Constraints> {
-	/// Where the WASM binary is stored.
-	pub sources: BoundedVec<GadgetSource<C>, C::MaxSourcesPerGadget>,
-}
-
-#[derive(Educe, Encode, Decode, TypeInfo, MaxEncodedLen)]
-#[educe(Debug(bound()), Clone(bound()), PartialEq(bound()), Eq)]
-#[scale_info(skip_type_params(C))]
-#[codec(encode_bound(skip_type_params(C)))]
-#[codec(decode_bound(skip_type_params(C)))]
-#[codec(mel_bound(skip_type_params(C)))]
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize), serde(bound = ""))]
-pub struct ContainerGadget<C: Constraints> {
-	/// Where the Image of the gadget binary is stored.
-	pub sources: BoundedVec<GadgetSource<C>, C::MaxSourcesPerGadget>,
-}