Provider Context: Minimal Profile for Provider and Applications (#2549)

# Details

[Design
Doc](https://github.com/frequency-chain/frequency/blob/main/designdocs/provider_contexts.md)

Provider Context allows provider to now register a minimal profile
`ProviderRegistryEntry` and `ApplicationContext` for provider's default
profile and various applications providers want to register.

Providers which want to register multiple applications under single
provider delegation but distributed across multiple app. Following
issues were resolved as part of this work with following salient points:

1. Migration existing `ProviderToRegistryEntry` to host new
`ProviderRegistryEntry` payload
2. Introduce new state `ProviderToApplicationRegistry` and
`ApprovedLogos` storage maps.
3. CID's are computed in deterministic way =
`base(cid_v1(sha_256(logo_bytes)))` where logo_bytes are .png image
bytes.
4. ApprovedLogos ensure it matches CID and logoBytes but recomputing and
checking on chain.

Issues complete as part of  `Provider Context` work

- [x] #2523 
- [x] #2524 
- [x] #2525 
- [x] #2528 
- [x] #2526
- [x] #2577 
- [x] #2578 

Closes #2578 
Closes #2577 


# Discussion items
- [x] Do we feature flag than base filter out extrinsics @JoeCap08055
comment
[here](#2587 (comment))

# Checklist
- [x] Updated Pallet Readme?
- [x] Updated js/api-augment for Custom RPC APIs?
- [x] Design doc(s) updated?
- [x] Unit Tests added?
- [x] e2e Tests added?
- [x] Benchmarks added?
- [x] Spec version incremented?

---------

Co-authored-by: Joe Caputo <[email protected]>
Co-authored-by: Aramik <[email protected]>
Co-authored-by: Matthew Orris <[email protected]>

Author: 4 people

.github/workflows/release.yml

@@ -457,7 +457,6 @@ jobs:
       - name: Extract and List Downloaded Binaries
         run: |
           download_dir=${{steps.download-binaries.outputs.download-path}}
-          mv "${download_dir}"/artifacts*/* "${download_dir}"
           echo "Download dir: $download_dir"
           echo "Downloaded binaries: $(ls -l $download_dir)"
       - name: Move Binary to Target Dir
@@ -600,7 +599,6 @@ jobs:
       - name: Extract and List Downloaded Binaries
         run: |
           download_dir=${{steps.download-binaries.outputs.download-path}}
-          mv "${download_dir}"/artifacts*/* "${download_dir}"
           echo "Download dir: $download_dir"
           echo "Downloaded binaries: $(ls -l $download_dir)"
       - name: Move Binary to Target Dir
@@ -664,7 +662,6 @@ jobs:
       - name: Rename and Move Binaries
         run: |
           download_dir=${{steps.download-binaries.outputs.download-path}}
-          mv "${download_dir}"/artifacts*/* "${download_dir}"
           echo "Download dir: $download_dir"
           echo "Downloaded binaries: $(ls -l $download_dir)"
           mkdir -p ${{env.BIN_DIR}}

.github/workflows/verify-pr-commit.yml

@@ -463,7 +463,6 @@ jobs:
       - name: Extract and List Downloaded Binaries
         run: |
           download_dir=${{steps.download-binaries.outputs.download-path}}
-          mv "${download_dir}"/artifacts*/* "${download_dir}"
           echo "Download dir: $download_dir"
           echo "Downloaded binaries: $(ls -l $download_dir)"
       - name: Set Binary Permissions
@@ -741,7 +740,6 @@ jobs:
       - name: List Downloaded Binaries
         run: |
           download_dir=${{steps.download-binaries.outputs.download-path}}
-          mv "${download_dir}"/artifacts*/* "${download_dir}"
           echo "Download dir: $download_dir"
           echo "Downloaded binaries: $(ls -l $download_dir)"
       - name: Set Binary Permissions
@@ -859,7 +857,6 @@ jobs:
       - name: List Downloaded Binaries
         run: |
           download_dir=${{steps.download-binaries.outputs.download-path}}
-          mv "${download_dir}"/artifacts*/* "${download_dir}"
           echo "Download dir: $download_dir"
           echo "Downloaded binaries: $(ls -l $download_dir)"
       - name: Download api-augment tarball

Cargo.lock

@@ -20,6 +20,8 @@ apache-avro = { version = "0.19.0", default-features = false }
 rand = "0.9.0"
 parking_lot = "0.12.1"
 lazy_static = { version = "1.5", features = ["spin_no_std"] }
+multibase = { version = "0.9", default-features = false }
+cid = { version = "0.11", default-features = false, features = ["alloc"] }
 
 # substrate wasm
 parity-scale-codec = { version = "3.7.4", default-features = false }

Cargo.toml

@@ -30,6 +30,7 @@ sp-runtime-interface = { workspace = true }
 libsecp256k1 = { workspace = true, features = ["hmac"] }
 log = "0.4.22"
 lazy_static = { workspace = true }
+cid = { workspace = true }
 
 [features]
 default = ['std']

common/primitives/Cargo.toml

@@ -0,0 +1,20 @@
+use cid::Cid;
+use sp_io::hashing::sha2_256;
+use sp_runtime::Vec;
+
+/// Multihash type for wrapping digests (support up to 64-byte digests)
+pub type Multihash = cid::multihash::Multihash<64>;
+
+/// SHA2-256 multihash code
+const SHA2_256: u64 = 0x12;
+
+/// Raw codec for CIDv1 (0x55)
+const RAW: u64 = 0x55;
+
+/// Computes a CIDv1 (RAW + SHA2-256 multihash)
+pub fn compute_cid_v1(bytes: &[u8]) -> Option<Vec<u8>> {
+	let digest = sha2_256(bytes);
+	let mh = Multihash::wrap(SHA2_256, &digest).ok()?;
+	let cid = Cid::new_v1(RAW, mh);
+	Some(cid.to_bytes())
+}

common/primitives/src/cid.rs

@@ -44,3 +44,6 @@ pub mod benchmarks;
 
 /// Signature support for ethereum
 pub mod signatures;
+
+/// IPFS CIDv1 related utilities
+pub mod cid;

common/primitives/src/lib.rs

@@ -1,3 +1,4 @@
+use core::fmt::Debug;
 use frame_support::{dispatch::DispatchResult, traits::Get, BoundedBTreeMap, BoundedVec};
 use parity_scale_codec::{Decode, DecodeWithMemTracking, Encode, EncodeLike, Error, MaxEncodedLen};
 use scale_info::TypeInfo;
@@ -12,6 +13,13 @@ use alloc::vec::Vec;
 
 pub use crate::schema::SchemaId;
 
+/// ApplicationIndex type
+pub type ApplicationIndex = u16;
+
+/// ApplicationContext is type of ProviderRegistryEntry
+pub type ApplicationContext<NameSize, LangSize, CidSize, MaxLocaleCount> =
+	ProviderRegistryEntry<NameSize, LangSize, CidSize, MaxLocaleCount>;
+
 /// Message Source Id or msaId is the unique identifier for Message Source Accounts
 pub type MessageSourceId = u64;
 
@@ -202,14 +210,72 @@ impl From<ProviderId> for MessageSourceId {
 
 /// This is the metadata associated with a provider. As of now it is just a
 /// name, but it will likely be expanded in the future
-#[derive(MaxEncodedLen, TypeInfo, Debug, Clone, Decode, Encode, PartialEq, Eq)]
-#[scale_info(skip_type_params(T))]
-pub struct ProviderRegistryEntry<T>
+/// Generic over size constraints to be used in common types.
+#[derive(
+	MaxEncodedLen, TypeInfo, Clone, Debug, Decode, DecodeWithMemTracking, Encode, PartialEq, Eq,
+)]
+#[scale_info(skip_type_params(NameSize, LangSize, CidSize, MaxLocaleCount))]
+#[codec(mel_bound(
+	NameSize: Get<u32> + Debug + PartialEq + Eq,
+	LangSize: Get<u32> + Debug + PartialEq + Eq,
+	CidSize: Get<u32> + Debug + PartialEq + Eq,
+	MaxLocaleCount: Get<u32> + Debug + PartialEq + Eq,
+))]
+pub struct ProviderRegistryEntry<
+	NameSize: Get<u32> + Debug + PartialEq + Eq,
+	LangSize: Get<u32> + Debug + PartialEq + Eq,
+	CidSize: Get<u32> + Debug + PartialEq + Eq,
+	MaxLocaleCount: Get<u32> + Debug + PartialEq + Eq,
+> {
+	/// Default name (display name) of the provider or application.
+	pub default_name: BoundedVec<u8, NameSize>,
+
+	/// Localized names keyed by BCP 47 language code (e.g., "en-US").
+	pub localized_names:
+		BoundedBTreeMap<BoundedVec<u8, LangSize>, BoundedVec<u8, NameSize>, MaxLocaleCount>,
+
+	/// Default logo (PNG 250x100) content-addressed CID (e.g., IPFS hash).
+	pub default_logo_250_100_png_cid: BoundedVec<u8, CidSize>,
+
+	/// Localized logo CIDs keyed by BCP 47 language code.
+	pub localized_logo_250_100_png_cids:
+		BoundedBTreeMap<BoundedVec<u8, LangSize>, BoundedVec<u8, CidSize>, MaxLocaleCount>,
+}
+
+impl<NameSize, LangSize, CidSize, MaxLocaleCount> Default
+	for ProviderRegistryEntry<NameSize, LangSize, CidSize, MaxLocaleCount>
 where
-	T: Get<u32>,
+	NameSize: Get<u32> + Debug + PartialEq + Eq,
+	LangSize: Get<u32> + Debug + PartialEq + Eq,
+	CidSize: Get<u32> + Debug + PartialEq + Eq,
+	MaxLocaleCount: Get<u32> + Debug + PartialEq + Eq,
 {
-	/// The provider's name
-	pub provider_name: BoundedVec<u8, T>,
+	fn default() -> Self {
+		Self {
+			default_name: BoundedVec::default(),
+			localized_names: BoundedBTreeMap::default(),
+			default_logo_250_100_png_cid: BoundedVec::default(),
+			localized_logo_250_100_png_cids: BoundedBTreeMap::default(),
+		}
+	}
+}
+
+/// RPC Response for getting ProviderApplicationContext
+#[cfg_attr(feature = "std", derive(Serialize, Deserialize))]
+#[derive(TypeInfo, Debug, Clone, Decode, Encode, PartialEq, Default)]
+pub struct ProviderApplicationContext {
+	/// The default name associated with this entry
+	pub default_name: Vec<u8>,
+	/// The provider associated with the `key`
+	pub provider_id: ProviderId,
+	/// The default Application/Provider logo
+	pub default_logo_250_100_png_bytes: Option<Vec<u8>>,
+	/// The optional application id
+	pub application_id: Option<ApplicationIndex>,
+	/// The optional localized name
+	pub localized_name: Option<Vec<u8>>,
+	/// The optional localized logo bytes
+	pub localized_logo_250_100_png_bytes: Option<Vec<u8>>,
 }
 
 /// The pointer value for the Signature Registry

common/primitives/src/msa.rs

@@ -159,6 +159,30 @@ pub fn wrap_binary_data(data: Vec<u8>) -> Vec<u8> {
 	encapsuled
 }
 
+/// This is useful for testing and benchmarks and should not be used for any
+/// cryptographically secure operation
+#[cfg(any(test, feature = "runtime-benchmarks"))]
+pub struct XorRng {
+	state: u64,
+}
+
+#[cfg(any(test, feature = "runtime-benchmarks"))]
+impl XorRng {
+	/// Creates Rnd from the seed
+	pub fn new(seed: u64) -> Self {
+		Self { state: if seed == 0 { 1 } else { seed } }
+	}
+
+	/// Generates the next u8
+	pub fn gen_u8(&mut self) -> u8 {
+		// XorShift64
+		self.state ^= self.state << 13;
+		self.state ^= self.state >> 7;
+		self.state ^= self.state << 17;
+		self.state as u8
+	}
+}
+
 #[cfg(test)]
 mod tests {
 	use super::*;

common/primitives/src/utils.rs

@@ -216,7 +216,7 @@ Proposed are the following changes:
 
 To support the new structure, a storage migration will be required to:
 
-- Migrate existing `ProviderToRegistryEntry` to the new format with default values for localized names and logos.
+- Migrate existing `ProviderToRegistryEntryV2` to the new format with default values for localized names and logos.
 
 ### **Runtime RPC Changes** <a id='rpc'></a>
 
@@ -326,7 +326,7 @@ The Wallet would then:
 1. Verify the SIWF Signed Request.
 2. Lookup the Provider via the `publicKey` in the SIWF Signed Request.
 3. If any, fetch the `ApplicationIndex` from Frequency.
-4. If present, fetch the `ProviderToApplicationRegistryEntry` for that (ProviderId, ApplicationId) pair. Otherwise, fetch the default `ProviderToRegistryEntry` for the ProviderId
+4. If present, fetch the `ProviderToApplicationRegistryEntry` for that (ProviderId, ApplicationId) pair. Otherwise, fetch the default `ProviderToRegistryEntryV2` for the ProviderId
 5. Display the information to the user to help them know who they are authorizing.
 6. Allow the user to continue the login process.