fix: foreign-assets related docs

UniqueNetwork · Oct 25, 2023 · 4e0f363 · 4e0f363
1 parent aa504bc
commit 4e0f363
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 7 deletions.
diff --git a/pallets/foreign-assets/src/lib.rs b/pallets/foreign-assets/src/lib.rs
@@ -259,7 +259,7 @@ impl<T: Config> Pallet<T> {
 		}
 	}
 
-	/// Converts a multiasset to a Unique Network's collection (either local or the foreign one).
+	/// Converts a multiasset to a Unique Network's collection (either local or a foreign one).
 	///
 	/// The function will try to convert the multiasset's reserve location
 	/// to the Unique Network's local collection.
@@ -385,8 +385,6 @@ impl<T: Config> Pallet<T> {
 	/// Withdraws an asset instance from the `from` account.
 	///
 	/// Transfers the asset instance to the pallet's account.
-	///
-	/// Won't withdraw the instance if it has children.
 	fn withdraw_asset_instance(
 		xcm_ext: &dyn XcmExtensions<T>,
 		collection_id: CollectionId,

diff --git a/pallets/unique/src/eth/stubs/CollectionHelpers.sol b/pallets/unique/src/eth/stubs/CollectionHelpers.sol
@@ -199,7 +199,7 @@ struct CreateCollectionData {
 type CollectionFlags is uint8;
 
 library CollectionFlagsLib {
-	/// Tokens in foreign collections can be transferred, but not burnt
+	/// A collection of foreign assets
 	CollectionFlags constant foreignField = CollectionFlags.wrap(128);
 	/// Supports ERC721Metadata
 	CollectionFlags constant erc721metadataField = CollectionFlags.wrap(64);

diff --git a/primitives/data-structs/src/lib.rs b/primitives/data-structs/src/lib.rs
@@ -378,7 +378,7 @@ pub type CollectionTokenPrefix = BoundedVec<u8, ConstU32<MAX_TOKEN_PREFIX_LENGTH
 #[derive(AbiCoderFlags, Bitfields, Clone, Copy, PartialEq, Eq, Debug, Default)]
 #[bondrewd(enforce_bytes = 1)]
 pub struct CollectionFlags {
-	/// Reserved flag
+	/// A collection of foreign assets
 	#[bondrewd(bits = "0..1")]
 	pub foreign: bool,
 	/// Supports ERC721Metadata

diff --git a/tests/src/eth/api/CollectionHelpers.sol b/tests/src/eth/api/CollectionHelpers.sol
@@ -132,7 +132,7 @@ struct CreateCollectionData {
 type CollectionFlags is uint8;
 
 library CollectionFlagsLib {
-	/// Tokens in foreign collections can be transferred, but not burnt
+	/// A collection of foreign assets
 	CollectionFlags constant foreignField = CollectionFlags.wrap(128);
 	/// Supports ERC721Metadata
 	CollectionFlags constant erc721metadataField = CollectionFlags.wrap(64);

diff --git a/tests/src/util/playgrounds/types.ts b/tests/src/util/playgrounds/types.ts
@@ -160,7 +160,7 @@ export enum CollectionFlag {
   External = 1,
   /// Supports ERC721Metadata
   Erc721metadata = 64,
-  /// Tokens in foreign collections can be transferred, but not burnt
+  /// A collection of foreign assets
   Foreign = 128,
 }