Struct 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 set_max_schema_model_bytes( origin: OriginFor<T>, max_size: u32, ) -> DispatchResult

REMOVED create_schema() at call index 0 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 create_intent( origin: OriginFor<T>, intent_name: SchemaNamePayload, payload_location: PayloadLocation, settings: BoundedVec<IntentSetting, T::MaxSchemaSettingsPerSchema>, ) -> DispatchResult

Creates a new Intent with a name (testnet)

Events

• Event::IntentCreated

Errors

• Error::IntentCountOverflow - The Intent count has exceeded its bounds
• Error::InvalidSetting - Invalid setting is provided
• Error::NameAlreadyExists - The name already exists
• Error::InvalidSchemaNameEncoding - The name has an invalid encoding
• Error::InvalidSchemaNameCharacters - The name contains invalid characters
• Error::InvalidSchemaNameStructure - The name has an invalid structure (i.e., not protocol.descriptor)
• Error::InvalidSchemaNameLength - The name exceeds the allowed overall name length
• Error::InvalidSchemaNamespaceLength - The protocol portion of the name exceeds the max allowed length
• Error::InvalidSchemaDescriptorLength - The descriptor portion of the name exceeds the max allowed length

pub fn create_intent_via_governance( origin: OriginFor<T>, creator_key: T::AccountId, payload_location: PayloadLocation, settings: BoundedVec<IntentSetting, T::MaxSchemaSettingsPerSchema>, intent_name: SchemaNamePayload, ) -> DispatchResult

Create an Intent by means of council approval

Events

• Event::IntentCreated

Errors

• Error::IntentCountOverflow - The Intent count has exceeded its bounds
• Error::InvalidSetting - Invalid setting is provided
• Error::NameAlreadyExists - The name already exists
• Error::InvalidSchemaNameEncoding - The name has an invalid encoding
• Error::InvalidSchemaNameCharacters - The name contains invalid characters
• Error::InvalidSchemaNameStructure - The name has an invalid structure (i.e., not protocol.descriptor)
• Error::InvalidSchemaNameLength - The name exceeds the allowed overall name length
• Error::InvalidSchemaNamespaceLength - The protocol portion of the name exceeds the max allowed length
• Error::InvalidSchemaDescriptorLength - The descriptor portion of the name exceeds the max allowed length

pub fn propose_to_create_intent( origin: OriginFor<T>, payload_location: PayloadLocation, settings: BoundedVec<IntentSetting, T::MaxSchemaSettingsPerSchema>, intent_name: SchemaNamePayload, ) -> DispatchResult

Propose to create an Intent. Creates a proposal for council approval to create an Intent

pub fn create_intent_group( origin: OriginFor<T>, intent_group_name: SchemaNamePayload, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> DispatchResult

Create an intent group (testnet)

Events

• Event::IntentGroupCreated

Errors

• Error::IntentGroupCountOverflow - The Intent Group count has exceeded its bounds.
• Error::NameAlreadyExists - The name already exists.
• Error::InvalidSchemaNameEncoding - The name has an invalid encoding.
• Error::InvalidSchemaNameCharacters - The name contains invalid characters.
• Error::InvalidSchemaNameStructure - The name has an invalid structure (i.e., not protocol.descriptor).
• Error::InvalidSchemaNameLength - The name exceeds the allowed overall name length.
• Error::InvalidSchemaNamespaceLength - The protocol portion of the name exceeds the max allowed length.
• Error::InvalidSchemaDescriptorLength - The descriptor portion of the name exceeds the max allowed length.
• Error::InvalidIntentId - At least one of the specified [IntentId]s does not exist.

pub fn create_intent_group_via_governance( origin: OriginFor<T>, creator_key: T::AccountId, intent_group_name: SchemaNamePayload, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> DispatchResult

Create an IntentGroup by means of council approval

Events

• Event::IntentGroupCreated

Errors

• Error::IntentGroupCountOverflow - The Intent Group count has exceeded its bounds
• Error::NameAlreadyExists - The name already exists.
• Error::InvalidSchemaNameEncoding - The name has an invalid encoding.
• Error::InvalidSchemaNameCharacters - The name contains invalid characters.
• Error::InvalidSchemaNameStructure - The name has an invalid structure (i.e., not protocol.descriptor).
• Error::InvalidSchemaNameLength - The name exceeds the allowed overall name length.
• Error::InvalidSchemaNamespaceLength - The protocol portion of the name exceeds the max allowed length.
• Error::InvalidSchemaDescriptorLength - The descriptor portion of the name exceeds the max allowed length.
• Error::InvalidIntentId - At least one of the specified [IntentId]s does not exist

pub fn propose_to_create_intent_group( origin: OriginFor<T>, intent_group_name: SchemaNamePayload, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> DispatchResult

Propose to create an Intent Group. Creates a proposal for council approval to create an Intent Group.

pub fn update_intent_group( origin: OriginFor<T>, intent_group_id: IntentGroupId, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> DispatchResult

Update an IntentGroup (testnet) Replaces an IntentGroup’s list of Intents with a new list.

Events

• Event::IntentGroupUpdated

Errors

• Error::InvalidIntentGroupId - The specified [IntentGroupId] does not exist.
• Error::InvalidIntentId - At least one of the specified [IntentId]s does not exist.
• Error::TooManyIntentsInGroup - The update would result in too many Intents in the group.

pub fn update_intent_group_via_governance( origin: OriginFor<T>, updater_key: T::AccountId, intent_group_id: IntentGroupId, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> DispatchResult

Update an IntentGroup by means of council approval. Replaces an IntentGroup’s list of Intents with a new list.

Events

• Event::IntentGroupUpdated

Errors

• Error::InvalidIntentGroupId - The specified [IntentGroupId] does not exist.
• Error::InvalidIntentId - At least one of the specified [IntentId]s does not exist.
• Error::TooManyIntentsInGroup - The update would result in too many Intents in the group.

pub fn propose_to_update_intent_group( origin: OriginFor<T>, intent_group_id: IntentGroupId, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> DispatchResult

Propose to update an Intent Group. Creates a proposal for council approval to update an existing Intent Group.

pub fn propose_to_create_schema_v3( origin: OriginFor<T>, intent_id: IntentId, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, ) -> DispatchResult

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

pub fn create_schema_via_governance_v3( origin: OriginFor<T>, creator_key: T::AccountId, intent_id: IntentId, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, ) -> DispatchResult

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_v4( origin: OriginFor<T>, intent_id: IntentId, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, ) -> DispatchResult

Adds a given schema to storage. (testnet)

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

impl<T: Config> Pallet<T>

pub fn set_schema_count(n: SchemaId)

Set the maximum schema id to the supplied value.

pub fn set_intent_count(n: IntentId)

Set the maximum intent id to the supplied value.

pub fn store_schema_info_and_payload( schema_id: SchemaId, schema_info: SchemaInfo, schema_payload: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, ) -> Result<(), DispatchError>

Lowest-level insertion function for a SchemaInfo and SchemaPayload into storage, using an already-allocated [SchemaId]

pub fn add_schema( intent_id: IntentId, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, payload_location: PayloadLocation, settings: IntentSettings, status: SchemaStatus, ) -> Result<SchemaId, DispatchError>

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

pub fn store_intent_info( intent_id: IntentId, intent_info: IntentInfo, intent_name: &SchemaName, ) -> Result<(), DispatchError>

Lowest-level insertion function for a IntentInfo into storage, using an already-allocated [IntentId]

pub fn add_intent( payload_location: PayloadLocation, settings: BoundedVec<IntentSetting, T::MaxSchemaSettingsPerSchema>, intent_name: &SchemaName, ) -> Result<IntentId, DispatchError>

Inserts the IntentInfo into storage Updates the [CurrentIntentIdentifierMaximum] storage Does little validation, as this is an internal method intended to be called by higher-level extrinsics that perform various validations.

Errors

• Error::IntentCountOverflow

pub fn store_intent_group( intent_group_id: IntentGroupId, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, intent_group_name: &SchemaName, ) -> Result<(), DispatchError>

Lowest-level insertion function for a IntentGroup into storage, using an already-allocated [IntentGroupId]

pub fn add_intent_group( intent_group_name: &SchemaName, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> Result<IntentGroupId, DispatchError>

Inserts a list of [IntentId]s with a new [IntentGroupId] in storage, and adds. a new name mapping to the [IntentGroupId]. Updates the [CurrentIntentGroupIdentifierMaximum] storage. Does little validation, as this is an internal method intended to be called by. higher-level extrinsics that perform the validations.

Errors

• Error::IntentGroupCountOverflow

pub fn update_intent_group_storage( intent_group_id: IntentGroupId, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> DispatchResult

Updates the list of [IntentId]s associated with a given [IntentGroupId] Does little validation, as this is an internal method intended to be called by higher-level extrinsics that perform the validations.

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

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 get_intent_by_id(intent_id: IntentId) -> Option<IntentResponse>

Retrieve an Intent by its ID

pub fn get_intent_by_id_with_schemas( intent_id: IntentId, ) -> Option<IntentResponse>

Retrieve an Intent by its ID NOTE: This must not be called on-chain due to inability to determine weight

pub fn get_intent_group_by_id( intent_group_id: IntentGroupId, ) -> Option<IntentGroupResponse>

Retrieve an IntentGroup by its 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( intent_id: IntentId, model: BoundedVec<u8, T::SchemaModelMaxBytesBoundedVecLimit>, model_type: ModelType, ) -> Result<SchemaId, 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 create_intent_for( intent_name_payload: SchemaNamePayload, payload_location: PayloadLocation, settings: BoundedVec<IntentSetting, T::MaxSchemaSettingsPerSchema>, ) -> Result<(IntentId, SchemaName), DispatchError>

Adds a given Intent to storage. If the pallet’s maximum Intent limit has been fulfilled by the time this extrinsic is called, an IntentCountOverflow error will be thrown.

Errors

• Error::IntentCountOverflow - The Intent count has exceeded its bounds
• Error::InvalidSetting - Invalid setting is provided
• Error::NameAlreadyExists - The name already exists
• Error::InvalidSchemaNameEncoding - The name has an invalid encoding
• Error::InvalidSchemaNameCharacters - The name contains invalid characters
• Error::InvalidSchemaNameStructure - The name has an invalid structure (i.e., not protocol.descriptor)
• Error::InvalidSchemaNameLength - The name exceed the allowed overall name length
• Error::InvalidSchemaNamespaceLength - The protocol portion of the name exceeds the max allowed length
• Error::InvalidSchemaDescriptorLength - The descriptor portion of the name exceeds the max allowed length

pub fn create_intent_group_for( intent_group_name: SchemaNamePayload, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> Result<(IntentGroupId, SchemaName), DispatchError>

Adds a given Intent to storage. If the pallet’s maximum Intent limit has been fulfilled by the time this extrinsic is called, an IntentCountOverflow error will be thrown.

Errors

• Error::IntentGroupCountOverflow - The schema count has exceeded its bounds
• Error::NameAlreadyExists - The name already exists
• Error::InvalidSchemaNameEncoding - The name has an invalid encoding
• Error::InvalidSchemaNameCharacters - The name contains invalid characters
• Error::InvalidSchemaNameStructure - The name has an invalid structure (i.e., not protocol.descriptor)
• Error::InvalidSchemaNameLength - The name exceed the allowed overall name length
• Error::InvalidSchemaNamespaceLength - The protocol portion of the name exceeds the max allowed length
• Error::InvalidSchemaDescriptorLength - The descriptor portion of the name exceeds the max allowed length
• Error::InvalidIntentId - One of the [IntentId]s specified does not exist

pub fn update_intent_group_for( intent_group_id: IntentGroupId, intent_ids: BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> Result<(), DispatchError>

Update the list of [IntentId]s associated with a given [IntentGroupId]

Errors

• Error::InvalidIntentGroupId - The specified [IntentGroupId] doesn’t exist
• Error::InvalidIntentId - One of the [IntentId]s specified doesn’t exist

pub fn validate_intent_ids( intent_ids: &BoundedVec<IntentId, T::MaxIntentsPerIntentGroup>, ) -> Result<(), DispatchError>

Validate that all items in a list of [IntentId]s exist

Errors

• Error::InvalidIntentId - At least one of the specified [IntentId]s does not exist

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

pub fn get_intent_or_group_ids_by_name( entity_name: Vec<u8>, ) -> Option<Vec<NameLookupResponse>>

method to return the entity ID (Intent or IntentGroup) associated with a name 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> DispatchViewFunction for Pallet<T>

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

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

Tests for self and other values to be equal, and is used by ==.

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

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<SchemaResponseV2>

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

fn get_intent_by_id(intent_id: IntentId) -> Option<IntentResponse>

Gets the Intent associated with this IntentId, if any

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

fn are_all_intent_ids_valid(intent_ids: &[IntentId]) -> bool

Checks that all IntentIds in a collection are valid.

fn set_schema_count(n: SchemaId)

Set the schema counter for testing purposes.

fn set_intent_count(n: IntentId)

Set the Intent counter for testing purposes.

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

fn storage_info() -> Vec<StorageInfo>

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

fn prefix() -> [u8; 16]

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>