Struct pallet_gated_marketplace::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn do_initial_setup() -> DispatchResult

pub fn do_create_marketplace( origin: OriginFor<T>, admin: T::AccountId, marketplace: Marketplace<T> ) -> DispatchResult

pub fn do_apply( applicant: T::AccountId, custodian: Option<T::AccountId>, marketplace_id: [u8; 32], application: Application<T> ) -> DispatchResult

pub fn do_invite( authority: T::AccountId, marketplace_id: [u8; 32], new_user: T::AccountId, fields: Fields<T>, custodian_fields: Option<CustodianFields<T>> ) -> DispatchResult

pub fn do_enroll( authority: T::AccountId, marketplace_id: [u8; 32], account_or_application: AccountOrApplication<T>, approved: bool, feedback: BoundedVec<u8, T::MaxFeedbackLen> ) -> DispatchResult

pub fn do_authority( authority: T::AccountId, account: T::AccountId, authority_type: MarketplaceRole, marketplace_id: [u8; 32] ) -> DispatchResult

pub fn self_enroll( account: T::AccountId, marketplace_id: [u8; 32] ) -> DispatchResult

pub fn do_remove_authority( authority: T::AccountId, account: T::AccountId, authority_type: MarketplaceRole, marketplace_id: [u8; 32] ) -> DispatchResult

pub fn do_update_label_marketplace( authority: T::AccountId, marketplace_id: [u8; 32], new_label: BoundedVec<u8, T::LabelMaxLen> ) -> DispatchResult

pub fn do_remove_marketplace( authority: T::AccountId, marketplace_id: [u8; 32] ) -> DispatchResult

pub fn do_enlist_sell_offer( authority: T::AccountId, marketplace_id: [u8; 32], collection_id: T::CollectionId, item_id: T::ItemId, price: T::Balance, percentage: u32 ) -> Result<[u8; 32], DispatchError>

pub fn do_enlist_buy_offer( authority: T::AccountId, marketplace_id: [u8; 32], collection_id: T::CollectionId, item_id: T::ItemId, price: T::Balance, percentage: u32 ) -> Result<[u8; 32], DispatchError>

pub fn do_take_sell_offer( origin: OriginFor<T>, offer_id: [u8; 32] ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

pub fn do_take_buy_offer( authority: T::AccountId, offer_id: [u8; 32] ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

pub fn do_remove_offer( authority: T::AccountId, offer_id: [u8; 32] ) -> DispatchResult

pub fn set_up_application( fields: Fields<T>, custodian_fields: Option<CustodianFields<T>> ) -> (Option<T::AccountId>, BoundedVec<ApplicationField, T::MaxFiles>)

pub fn remove_from_market_lists( account: T::AccountId, author_type: MarketplaceRole, marketplace_id: [u8; 32] ) -> DispatchResult

pub fn do_block_user( authority: T::AccountId, marketplace_id: [u8; 32], user: T::AccountId ) -> DispatchResult

pub fn do_unblock_user( authority: T::AccountId, marketplace_id: [u8; 32], user: T::AccountId ) -> DispatchResult

pub fn is_application_in_rejected_status( account: T::AccountId, marketplace_id: [u8; 32] ) -> DispatchResult

Let us check the curent status of the selected application. If the status is rejected, we can safely remove its data from the storage sources so the user can apply again. It doesn’t affect any other storage source/workflow.

pub fn do_ask_for_redeem( who: T::AccountId, marketplace: MarketplaceId, collection_id: T::CollectionId, item_id: T::ItemId ) -> DispatchResult

pub fn do_accept_redeem( who: T::AccountId, marketplace: MarketplaceId, redemption_id: RedemptionId ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

pub fn pallet_id() -> IdOrVec

impl<T> Pallet<T>where T: Config<CollectionId = u32, ItemId = u32> + Config,

pub fn initial_setup(origin: OriginFor<T>) -> DispatchResult

pub fn create_marketplace( origin: OriginFor<T>, admin: T::AccountId, label: BoundedVec<u8, T::LabelMaxLen>, buy_fee: u32, sell_fee: u32, asset_id: T::AssetId ) -> DispatchResult

Create a new marketplace.

Creates a new marketplace with the given label .

Parameters:

• origin: The owner of the marketplace.
• admin: The admin of the marketplace.
• label: The name of the marketplace.

pub fn block_user( origin: OriginFor<T>, marketplace_id: MarketplaceId, block_args: BlockUserArgs<T> ) -> DispatchResult

Block or Unblock a user from apllying to a marketplace.

Blocks or Unblocks a user from applying to a marketplace.

Parameters:

• origin: The admin of the marketplace.
• marketplace_id: The id of the marketplace to block/unblock the user.
• user: The id of the user to block/unblock.`

Considerations:

• Once a user is blocked, the user won’t be able to join the marketplace until unblocked.

pub fn apply( origin: OriginFor<T>, marketplace_id: [u8; 32], fields: Fields<T>, custodian_fields: Option<CustodianFields<T>> ) -> DispatchResult

Apply to a marketplace.

Applies to the selected marketplace.

Parameters:

• origin: The applicant.
• marketplace_id: The id of the marketplace where we want to apply.
• fields: Confidential user documents, any files necessary for the application
• custodian_fields: The custodian account and their documents.

Considerations:

• You can add many documents, up to the maximum allowed (10).
• The custodian account is optional. You can apply to a marketplace without a custodian account.
• All custodian fields are optional.

pub fn reapply( origin: OriginFor<T>, marketplace_id: [u8; 32], fields: Fields<T>, custodian_fields: Option<CustodianFields<T>> ) -> DispatchResult

Accept or reject a reapplyment.

Allows the applicant for a second chance to apply to the selected marketplace.

Parameters:

• origin: The reapplicant.
• marketplace_id: The id of the marketplace where we want to reapply.
• fields: Confidential user documents, any files necessary for the reapplication
• custodian_fields: The custodian account and their documents.

Considerations:

• Since this is a second chance, you can replace your previous documents, up to the maximum allowed (10).
• The custodian account is optional. You can replace the previous custodian.
• Since we know the application exists, we can check the current status of the application.

pub fn enroll( origin: OriginFor<T>, marketplace_id: [u8; 32], account_or_application: AccountOrApplication<T>, approved: bool, feedback: BoundedVec<u8, T::MaxFeedbackLen> ) -> DispatchResult

Accept or reject an application.

If the application is accepted, the user will be added to the list of applicants. If the application is rejected, the user will be moved to the list of rejected applicants.

Parameters:

• origin: The owner/admin of the marketplace.
• marketplace_id: The id of the marketplace where we want to enroll users.
• account_or_application: The account or application id to accept or reject.
• approved: Whether to accept or reject the account/application.

Considerations:

• You can only accept or reject applications where you are the owner/admin of the marketplace.
• Ensure that your extrinsic has selected the right option account/application because some fields changes.
• If you select Account you need to enter the account to be accepted.
• If you select Application you need to enter the application_id to be accepted.

pub fn invite( origin: OriginFor<T>, marketplace_id: [u8; 32], account: T::AccountId, fields: Fields<T>, custodian_fields: Option<CustodianFields<T>> ) -> DispatchResult

Invite a user to a marketplace.

The admin of the marketplace can invite a user to the marketplace.

Parameters:

• origin: The admin of the marketplace.
• marketplace_id: The id of the marketplace where we want to invite a user.
• account: The account to be invited.

Considerations:

• You can only invite users to a marketplace where you are the admin.

pub fn add_authority( origin: OriginFor<T>, account: T::AccountId, authority_type: MarketplaceRole, marketplace_id: [u8; 32] ) -> DispatchResult

Add an Authority type

This extrinsic adds an authority type for the selected account from the selected marketplace.

Parameters:

• origin: The user who performs the action.
• account: The account to be removed.
• authority_type: The type of authority to be added.
• marketplace_id: The id of the marketplace where we want to add the account.

Considerations:

If the user has already applied to the marketplace for that particular authority type, it will throw an error.

pub fn remove_authority( origin: OriginFor<T>, account: T::AccountId, authority_type: MarketplaceRole, marketplace_id: [u8; 32] ) -> DispatchResult

Remove an Authority type

This extrinsic removes an authority type for the selected account from the selected marketplace.

Parameters:

• origin: The user who performs the action.
• account: The account to be removed.
• authority_type: The type of authority to be removed.
• marketplace_id: The id of the marketplace where we want to remove the account.

Considerations:

• This extrinsic doesn’t remove the account from the marketplace, it only removes the selected authority type for that account. If the user doesn’t have the selected authority type, it will throw an error.

pub fn update_label_marketplace( origin: OriginFor<T>, marketplace_id: [u8; 32], new_label: BoundedVec<u8, T::LabelMaxLen> ) -> DispatchResult

Update marketplace’s label.

This extrinsic updates the label of the selected marketplace.

Parameters:

• origin: The user who performs the action.
• marketplace_id: The id of the marketplace where we want to update the label.
• label: The new label for the selected marketplace.

Considerations:

• You can only update the label of the marketplace where you are the owner/admin of the marketplace.
• The label must be less than or equal to `T::LabelMaxLen
• If the selected marketplace doesn’t exist, it will throw an error.

pub fn remove_marketplace( origin: OriginFor<T>, marketplace_id: [u8; 32] ) -> DispatchResult

Remove a particular marketplace.

This extrinsic removes the selected marketplace. It removes all the applications related with the marketplace. It removes all the authorities from the lists of the marketplace.

Parameters:

• origin: The user who performs the action.
• marketplace_id: The id of the marketplace to be removed.

Considerations:

• You can only remove the marketplace where you are the owner/admin of the marketplace.
• If the selected marketplace doesn’t exist, it will throw an error.

pub fn enlist_sell_offer( origin: OriginFor<T>, marketplace_id: [u8; 32], collection_id: T::CollectionId, item_id: T::ItemId, price: T::Balance, percentage: u32 ) -> DispatchResult

Enlist a sell order.

This extrinsic creates a sell order in the selected marketplace.

Parameters:

• origin: The user who performs the action.
• marketplace_id: The id of the marketplace where we want to create the sell order.
• collection_id: The id of the collection.
• item_id: The id of the item inside the collection.
• price: The price of the item.

Considerations:

• You can only create a sell order in the marketplace if you are the owner of the item.
• You can create only one sell order for each item per marketplace.
• If the selected marketplace doesn’t exist, it will throw an error.
• If the selected collection doesn’t exist, it will throw an error.

pub fn take_sell_offer( origin: OriginFor<T>, offer_id: [u8; 32] ) -> DispatchResult

Accepts a sell order.

This extrinsic is called by the user who wants to buy the item. Accepts a sell order in the selected marketplace.

Parameters:

• origin: The user who performs the action.
• ’offer_id`: The id of the sell order to be accepted.
• marketplace_id: The id of the marketplace where we want to accept the sell order.

Considerations:

• You don’t need to be the owner of the item to accept the sell order.
• Once the sell order is accepted, the ownership of the item is transferred to the buyer.
• If you don’t have the enough balance to accept the sell order, it will throw an error.

pub fn remove_offer(origin: OriginFor<T>, offer_id: [u8; 32]) -> DispatchResult

Delete an offer.

This extrinsic deletes an offer in the selected marketplace.

Parameters:

• origin: The user who performs the action.
• offer_id: The id of the offer to be deleted.

Considerations:

• You can delete sell orders or buy orders.
• You can only delete an offer if you are the creator of the offer.
• Only open offers can be deleted.
• If you need to delete multiple offers for the same item, you need to delete them one by one.

pub fn enlist_buy_offer( origin: OriginFor<T>, marketplace_id: [u8; 32], collection_id: T::CollectionId, item_id: T::ItemId, price: T::Balance, percentage: u32 ) -> DispatchResult

Enlist a buy order.

This extrinsic creates a buy order in the selected marketplace.

Parameters:

• origin: The user who performs the action.
• marketplace_id: The id of the marketplace where we want to create the buy order.
• collection_id: The id of the collection.
• item_id: The id of the item inside the collection.
• price: The price of the item.

Considerations:

• Any user can create a buy order in the marketplace.
• An item can receive multiple buy orders at a time.
• You need to have the enough balance to create the buy order.

pub fn take_buy_offer( origin: OriginFor<T>, offer_id: [u8; 32] ) -> DispatchResult

Accepts a buy order.

This extrinsic is called by the owner of the item who accepts the buy offer created by a market participant. Accepts a buy order in the selected marketplace.

Parameters:

• origin: The user who performs the action.
• offer_id: The id of the buy order to be accepted.
• marketplace_id: The id of the marketplace where we accept the buy order.

Considerations:

• You need to be the owner of the item to accept a buy order.
• Owner of the item can accept only one buy order at a time.
• When an offer is accepted, all the other offers for this item are closed.
• The buyer needs to have the enough balance to accept the buy order.
• Once the buy order is accepted, the ownership of the item is transferred to the buyer.

pub fn redeem( origin: OriginFor<T>, marketplace: MarketplaceId, redeem: RedeemArgs<T> ) -> DispatchResult

Redeem an item. This extrinsic is called by the owner of the item who wants to redeem the item. The owner of the item can ask for redemption or accept redemption.

Parameters:

• origin: The user who performs the action.
• marketplace_id: The id of the marketplace where we want to redeem the item.
• redeem: The type of redemption.

pub fn kill_storage(origin: OriginFor<T>) -> DispatchResult

Kill all the stored data.

This function is used to kill ALL the stored data. Use with caution!

Parameters:

• origin: The user who performs the action.

Considerations:

• This function is only available to the admin with sudo access.

impl<T: Config> Pallet<T>

pub fn marketplaces<KArg>(k: KArg) -> Option<Marketplace<T>>where KArg: EncodeLike<MarketplaceId>,

impl<T: Config> Pallet<T>

pub fn applications<KArg>(k: KArg) -> Option<Application<T>>where KArg: EncodeLike<ApplicationId>,

impl<T: Config> Pallet<T>

pub fn applications_by_account<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<ApplicationId>where KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<MarketplaceId>,

impl<T: Config> Pallet<T>

pub fn applicants_by_marketplace<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> BoundedVec<T::AccountId, T::MaxApplicants>where KArg1: EncodeLike<MarketplaceId>, KArg2: EncodeLike<ApplicationStatus>,

impl<T: Config> Pallet<T>

pub fn custodians<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> BoundedVec<T::AccountId, T::MaxApplicationsPerCustodian>where KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<MarketplaceId>,

impl<T: Config> Pallet<T>

pub fn offers_by_item<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> BoundedVec<OfferId, T::MaxOffersPerMarket>where KArg1: EncodeLike<T::CollectionId>, KArg2: EncodeLike<T::ItemId>,

impl<T: Config> Pallet<T>

pub fn offers_by_account<KArg>( k: KArg ) -> BoundedVec<OfferId, T::MaxOffersPerMarket>where KArg: EncodeLike<T::AccountId>,

impl<T: Config> Pallet<T>

pub fn offers_by_marketplace<KArg>( k: KArg ) -> BoundedVec<OfferId, T::MaxOffersPerMarket>where KArg: EncodeLike<MarketplaceId>,

impl<T: Config> Pallet<T>

pub fn offers_info<KArg>(k: KArg) -> Option<OfferData<T>>where KArg: EncodeLike<OfferId>,

impl<T: Config> Pallet<T>

pub fn asking_for_redemption<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<RedemptionData<T>>where KArg1: EncodeLike<MarketplaceId>, KArg2: EncodeLike<RedemptionId>,

impl<T: Config> Pallet<T>

pub fn get_blocked_accounts<KArg>( k: KArg ) -> BoundedVec<T::AccountId, T::MaxBlockedUsersPerMarket>where KArg: EncodeLike<MarketplaceId>,

Trait Implementations

impl<T> Callable<T> for Pallet<T>where T: Config<CollectionId = u32, ItemId = u32> + Config,

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>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

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

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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

fn on_runtime_upgrade() -> Weight

Perform a module 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 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<Pallet<T>> 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> 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>