Struct pallet_schemas::pallet::Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

pub fn create_schema( origin: OriginFor<T>, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation ) -> DispatchResult

👎Deprecated: please use create_schema_v3 since create_schema has been deprecated.

Adds a given schema to storage. The schema in question must be of length between the min and max model size allowed for schemas (see pallet constants above). If the pallet’s maximum schema limit has been fulfilled by the time this extrinsic is called, a SchemaCountOverflow error will be thrown.

Events

• Event::SchemaCreated

Errors

• Error::LessThanMinSchemaModelBytes - The schema’s length is less than the minimum schema length
• Error::ExceedsMaxSchemaModelBytes - The schema’s length is greater than the maximum schema length
• Error::InvalidSchema - Schema is malformed in some way
• Error::SchemaCountOverflow - The schema count has exceeded its bounds

pub fn set_max_schema_model_bytes( origin: OriginFor<T>, max_size: u32 ) -> DispatchResult

Root and Governance can set a new max value for Schema bytes. Must be <= the limit of the Schema BoundedVec used for registration.

Requires

• Root Origin

Events

• Event::SchemaMaxSizeChanged

Errors

• Error::ExceedsMaxSchemaModelBytes - Cannot set to above the hard coded maximum Config::SchemaModelMaxBytesBoundedVecLimit

pub fn propose_to_create_schema( origin: OriginFor<T>, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation, settings: BoundedVec<SchemaSetting, T::MaxSchemaSettingsPerSchema> ) -> DispatchResult

👎Deprecated: please use propose_to_create_schema_v2 since propose_to_create_schema has been deprecated.

Propose to create a schema. Creates a proposal for council approval to create a schema

pub fn create_schema_via_governance( origin: OriginFor<T>, creator_key: T::AccountId, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation, settings: BoundedVec<SchemaSetting, T::MaxSchemaSettingsPerSchema> ) -> DispatchResult

👎Deprecated: please use create_schema_via_governance_v2 since create_schema_via_governance has been deprecated.

Create a schema by means of council approval

Events

• Event::SchemaCreated

Errors

• Error::LessThanMinSchemaModelBytes - The schema’s length is less than the minimum schema length
• Error::ExceedsMaxSchemaModelBytes - The schema’s length is greater than the maximum schema length
• Error::InvalidSchema - Schema is malformed in some way
• Error::SchemaCountOverflow - The schema count has exceeded its bounds

pub fn create_schema_v2( origin: OriginFor<T>, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation, settings: BoundedVec<SchemaSetting, T::MaxSchemaSettingsPerSchema> ) -> DispatchResult

👎Deprecated: please use create_schema_v3 since create_schema_v2 has been deprecated.

Adds a given schema to storage. The schema in question must be of length between the min and max model size allowed for schemas (see pallet constants above). If the pallet’s maximum schema limit has been fulfilled by the time this extrinsic is called, a SchemaCountOverflow error will be thrown.

Events

• Event::SchemaCreated

Errors

• Error::LessThanMinSchemaModelBytes - The schema’s length is less than the minimum schema length
• Error::ExceedsMaxSchemaModelBytes - The schema’s length is greater than the maximum schema length
• Error::InvalidSchema - Schema is malformed in some way
• Error::SchemaCountOverflow - The schema count has exceeded its bounds
• Error::InvalidSetting - Invalid setting is provided

pub fn propose_to_create_schema_v2( origin: OriginFor<T>, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation, settings: BoundedVec<SchemaSetting, T::MaxSchemaSettingsPerSchema>, schema_name: Option<SchemaNamePayload> ) -> DispatchResult

Propose to create a schema. Creates a proposal for council approval to create a schema

pub fn create_schema_via_governance_v2( origin: OriginFor<T>, creator_key: T::AccountId, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation, settings: BoundedVec<SchemaSetting, T::MaxSchemaSettingsPerSchema>, schema_name: Option<SchemaNamePayload> ) -> DispatchResult

Create a schema by means of council approval

Events

• Event::SchemaCreated
• Event::SchemaNameCreated

Errors

• Error::LessThanMinSchemaModelBytes - The schema’s length is less than the minimum schema length
• Error::ExceedsMaxSchemaModelBytes - The schema’s length is greater than the maximum schema length
• Error::InvalidSchema - Schema is malformed in some way
• Error::SchemaCountOverflow - The schema count has exceeded its bounds
• Error::InvalidSchemaNameEncoding - The schema name has invalid encoding
• Error::InvalidSchemaNameCharacters - The schema name has invalid characters
• Error::InvalidSchemaNameStructure - The schema name has invalid structure
• Error::InvalidSchemaNameLength - The schema name has invalid length
• Error::InvalidSchemaNamespaceLength - The schema namespace has invalid length
• Error::InvalidSchemaDescriptorLength - The schema descriptor has invalid length
• Error::ExceedsMaxNumberOfVersions - The schema name reached max number of versions

pub fn create_schema_v3( origin: OriginFor<T>, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation, settings: BoundedVec<SchemaSetting, T::MaxSchemaSettingsPerSchema>, schema_name: Option<SchemaNamePayload> ) -> DispatchResult

Adds a given schema to storage. The schema in question must be of length between the min and max model size allowed for schemas (see pallet constants above). If the pallet’s maximum schema limit has been fulfilled by the time this extrinsic is called, a SchemaCountOverflow error will be thrown.

Events

• Event::SchemaCreated
• Event::SchemaNameCreated

Errors

• Error::LessThanMinSchemaModelBytes - The schema’s length is less than the minimum schema length
• Error::ExceedsMaxSchemaModelBytes - The schema’s length is greater than the maximum schema length
• Error::InvalidSchema - Schema is malformed in some way
• Error::SchemaCountOverflow - The schema count has exceeded its bounds
• Error::InvalidSetting - Invalid setting is provided
• Error::InvalidSchemaNameEncoding - The schema name has invalid encoding
• Error::InvalidSchemaNameCharacters - The schema name has invalid characters
• Error::InvalidSchemaNameStructure - The schema name has invalid structure
• Error::InvalidSchemaNameLength - The schema name has invalid length
• Error::InvalidSchemaNamespaceLength - The schema namespace has invalid length
• Error::InvalidSchemaDescriptorLength - The schema descriptor has invalid length
• Error::ExceedsMaxNumberOfVersions - The schema name reached max number of versions

pub fn propose_to_create_schema_name( origin: OriginFor<T>, schema_id: SchemaId, schema_name: SchemaNamePayload ) -> DispatchResult

Propose to create a schema name. Creates a proposal for council approval to create a schema name

• Error::LessThanMinSchemaModelBytes - The schema’s length is less than the minimum schema length
• Error::ExceedsMaxSchemaModelBytes - The schema’s length is greater than the maximum schema length
• Error::InvalidSchema - Schema is malformed in some way
• Error::InvalidSchemaNameEncoding - The schema name has invalid encoding
• Error::InvalidSchemaNameCharacters - The schema name has invalid characters
• Error::InvalidSchemaNameStructure - The schema name has invalid structure
• Error::InvalidSchemaNameLength - The schema name has invalid length
• Error::InvalidSchemaNamespaceLength - The schema namespace has invalid length
• Error::InvalidSchemaDescriptorLength - The schema descriptor has invalid length
• Error::ExceedsMaxNumberOfVersions - The schema name reached max number of versions
• Error::SchemaIdDoesNotExist - The schema id does not exist
• Error::SchemaIdAlreadyHasName - The schema id already has a name

pub fn create_schema_name_via_governance( origin: OriginFor<T>, schema_id: SchemaId, schema_name: SchemaNamePayload ) -> DispatchResult

Assigns a name to a schema without any name

Events

• Event::SchemaNameCreated

Errors

• Error::LessThanMinSchemaModelBytes - The schema’s length is less than the minimum schema length
• Error::ExceedsMaxSchemaModelBytes - The schema’s length is greater than the maximum schema length
• Error::InvalidSchema - Schema is malformed in some way
• Error::SchemaCountOverflow - The schema count has exceeded its bounds
• Error::InvalidSchemaNameEncoding - The schema name has invalid encoding
• Error::InvalidSchemaNameCharacters - The schema name has invalid characters
• Error::InvalidSchemaNameStructure - The schema name has invalid structure
• Error::InvalidSchemaNameLength - The schema name has invalid length
• Error::InvalidSchemaNamespaceLength - The schema namespace has invalid length
• Error::InvalidSchemaDescriptorLength - The schema descriptor has invalid length
• Error::ExceedsMaxNumberOfVersions - The schema name reached max number of versions
• Error::SchemaIdDoesNotExist - The schema id does not exist
• Error::SchemaIdAlreadyHasName - The schema id already has a name

impl<T: Config> Pallet<T>

pub fn set_schema_count(n: SchemaId)

Set the schema count to something in particular.

pub fn add_schema( model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation, settings: BoundedVec<SchemaSetting, T::MaxSchemaSettingsPerSchema>, schema_name_option: Option<SchemaName> ) -> Result<SchemaId, DispatchError>

Inserts both the SchemaInfo and Schema Payload into storage Updates the CurrentSchemaIdentifierMaximum storage

pub fn get_schema_by_id(schema_id: SchemaId) -> Option<SchemaResponse>

Retrieve a schema by id

pub fn get_schema_info_by_id(schema_id: SchemaId) -> Option<SchemaInfoResponse>

Retrieve a schema info by id

pub fn ensure_valid_model( model_type: &ModelType, model: &BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit> ) -> DispatchResult

Ensures that a given u8 Vector conforms to a recognized Parquet shape

Errors

• Error::InvalidSchema
• Error::SchemaCountOverflow

pub fn create_schema_for( model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation, settings: BoundedVec<SchemaSetting, T::MaxSchemaSettingsPerSchema>, optional_schema_name: Option<SchemaNamePayload> ) -> Result<(SchemaId, Option<SchemaName>), DispatchError>

Adds a given schema to storage. The schema in question must be of length between the min and max model size allowed for schemas (see pallet constants above). If the pallet’s maximum schema limit has been fulfilled by the time this extrinsic is called, a SchemaCountOverflow error will be thrown.

Errors

• Error::LessThanMinSchemaModelBytes - The schema’s length is less than the minimum schema length
• Error::ExceedsMaxSchemaModelBytes - The schema’s length is greater than the maximum schema length
• Error::InvalidSchema - Schema is malformed in some way
• Error::SchemaCountOverflow - The schema count has exceeded its bounds
• Error::InvalidSetting - Invalid setting is provided

pub fn get_schema_versions( schema_name: Vec<u8> ) -> Option<Vec<SchemaVersionResponse>>

a method to return all versions of a schema name with their schemaIds Warning: Must only get called from RPC, since the number of DB accesses is not deterministic

Trait Implementations

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> SchemaProvider<u16> for Pallet<T>

fn get_schema_by_id(schema_id: SchemaId) -> Option<SchemaResponse>

Gets the Schema details associated with this SchemaId if any

fn get_schema_info_by_id(schema_id: SchemaId) -> Option<SchemaInfoResponse>

Gets the Schema Info associated with this SchemaId if any

impl<T: Config> SchemaValidator<u16> for Pallet<T>

fn are_all_schema_ids_valid(schema_ids: &Vec<SchemaId>) -> bool

Checks that a collection of SchemaIds are all valid

fn set_schema_count(n: SchemaId)

Set the schema counter for testing purposes.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>