Struct pallet_afloat::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn do_initial_setup( creator: T::AccountId, admin: T::AccountId ) -> DispatchResult

pub fn do_create_user( actor: T::AccountId, user_address: T::AccountId, args: SignUpArgs ) -> DispatchResult

This function creates a new user with the given actor, user address, and sign up arguments.

Inputs

• actor - An account ID of the user who initiated this action.
• user_address - An account ID of the user to be created.
• args - Sign up arguments. It could be either a BuyerOrSeller or a CPA, and contains the first name, last name, email, and state of the user.

Errors

This function may return an error if there is an issue with the pallet_gated_marketplace pallet, which is used to enroll the user in the Afloat marketplace. It may also return an error if the user already exists.

Returns

Returns Ok(()) on success.

pub fn do_edit_user( actor: T::AccountId, user_address: T::AccountId, cid: ShortString, cid_creator: ShortString ) -> DispatchResult

Function for editing user information.

• actor: The AccountId of the actor performing the edit.
• user_address: The AccountId of the user account to edit.
• first_name: An optional ShortString containing the user’s first name.
• last_name: An optional ShortString containing the user’s last name.
• email: An optional LongString containing the user’s email address.
• lang_key: An optional ShortString containing the language code for the user.
• phone: An optional Option<ShortString> containing the user’s phone number, or None if no phone number is provided.
• credits_needed: An optional u32 containing the number of credits needed for the user’s account.
• cpa_id: An optional ShortString containing the user’s CPA ID.
• state: An optional u32 containing the user’s state tax authority ID.

Errors

Returns an Error if the requested user account is not found or if the edit operation fails.

Returns

Returns Ok(()) on success.

pub fn do_admin_edit_user( actor: T::AccountId, user_address: T::AccountId, cid: ShortString, cid_creator: ShortString, group: ShortString ) -> DispatchResult

pub fn do_delete_user( _actor: T::AccountId, user_address: T::AccountId ) -> DispatchResult

Function for deleting a user account.

• _actor: The AccountId of the actor performing the deletion. This parameter is currently unused.
• user_address: The AccountId of the user account to delete.

Errors

Returns an Error if the requested user account is not found.

Returns

Returns Ok(()) on success.

pub fn do_set_afloat_balance( origin: OriginFor<T>, user_address: T::AccountId, amount: T::Balance ) -> DispatchResult

pub fn do_get_afloat_balance(user_address: T::AccountId) -> T::Balance

pub fn do_create_sell_order( authority: T::AccountId, item_id: <T as Config>::ItemId, price: T::Balance, tax_credit_amount: u32, expiration_date: Date ) -> DispatchResult

pub fn do_create_buy_order( authority: T::AccountId, item_id: <T as Config>::ItemId, price: T::Balance, tax_credit_amount: u32, expiration_date: Date ) -> DispatchResult

pub fn do_start_take_sell_order( authority: OriginFor<T>, order_id: [u8; 32], tax_credit_amount: T::Balance ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

Starts the process of taking a sell order.

Arguments

• authority - The origin of the call, from where the function is triggered.
• order_id - The unique identifier of the order.
• tax_credit_amount - The amount of tax credit to to take/buy from the original offer.

Return

• Returns a DispatchResult to indicate the success or failure of the operation.

Errors

This function will return an error if:

• The caller does not have any roles.
• The specified offer does not exist.
• The specified offer is not a sell offer.
• The specified offer has expired.
• The specified offer has been cancelled.
• The specified offer has already been taken.
• The specified offer does not have enough tax credits available for sale.
• The caller does not have enough afloat balance to take the offer.

Side Effects

• If the function is successful, it will mutate the state of the order and create a transaction.

Panics

• This function does not panic.

Safety

• This function does not use any unsafe blocks.

pub fn do_confirm_sell_transaction( authority: OriginFor<T>, transaction_id: [u8; 32] ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

Confirms a sell transaction.

Arguments

• authority - The origin of the call, from where the function is triggered.
• transaction_id - The unique identifier of the transaction.

Return

• Returns a DispatchResult to indicate the success or failure of the operation.

Errors

This function will return an error if:

• The caller does not have any roles.
• The specified transaction does not exist.
• The caller is not the seller in the transaction.
• The specified transaction has been cancelled.
• The specified transaction has already been confirmed by the seller.
• The specified transaction has not been confirmed by the buyer.
• The AfloatMarketPlaceId or AfloatCollectionId does not exist.
• The tax credit amount overflows when converting from T::Balance to u32.

Side Effects

• If the function is successful, it will mutate the state of the transaction, setting the seller confirmation date, confirming the transaction, and linking the transaction to a new child offer.

Panics

• This function does not panic.

Safety

• This function does not use any unsafe blocks.

Note

• Before calling this function, make sure that the transaction_id exists and the caller is the seller.

pub fn do_finish_take_sell_transaction( authority: OriginFor<T>, transaction_id: [u8; 32] ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>,

Finishes the process of taking a sell transaction.

Arguments

• authority - The origin of the call, from where the function is triggered.
• transaction_id - The unique identifier of the transaction.

Return

• Returns a DispatchResult to indicate the success or failure of the operation.

Errors

This function will return an error if:

• The caller does not have any roles.
• The specified transaction does not exist.
• The specified transaction has been cancelled.
• The specified transaction has not been confirmed.
• The child offer id in the transaction does not exist.
• The specified offer does not exist.
• The tax credit amount in the offer is less than the tax credit amount in the transaction (underflow).

Side Effects

• If the function is successful, it will trigger the transfer of tax credits and Balance between buyer and seller, mutate the state of the offer and transaction and emit a SellOrderTaken event.

Panics

• This function does not panic.

Safety

• This function does not use any unsafe blocks.

Note

• Before calling this function, make sure that the transaction id exists, the transaction is confirmed, and the caller is authorized.

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

pub fn do_create_tax_credit( owner: T::AccountId, metadata: CollectionDescription<T>, attributes: Option<Attributes<T>>, parent_info: Option<ParentInfo<T>> ) -> DispatchResultwhere <T as Config>::ItemId: From<u32>, <T as Config>::CollectionId: From<u32>,

pub fn create_afloat_collection( origin: OriginFor<T>, metadata: CollectionDescription<T>, admin: T::AccountId ) -> DispatchResultwhere <T as Config>::CollectionId: From<u32>,

pub fn add_to_afloat_collection( invitee: T::AccountId, role: FruniqueRole ) -> DispatchResult

pub fn remove_from_afloat_collection( invitee: T::AccountId, role: FruniqueRole ) -> DispatchResult

pub fn remove_from_afloat_marketplace(invitee: T::AccountId) -> DispatchResult

pub fn is_admin_or_owner(account: T::AccountId) -> Result<bool, DispatchError>

pub fn is_owner(account: T::AccountId) -> Result<bool, DispatchError>

pub fn is_cpa(account: T::AccountId) -> Result<bool, DispatchError>

pub fn give_role_to_user( authority: T::AccountId, role: AfloatRole ) -> DispatchResult

pub fn do_add_afloat_admin( authority: T::AccountId, user_address: T::AccountId ) -> DispatchResult

pub fn remove_role_from_user( authority: T::AccountId, role: AfloatRole ) -> DispatchResult

pub fn remove_rbac_permissions() -> DispatchResult

pub fn initialize_rbac() -> DispatchResult

pub fn do_delete_all_users() -> DispatchResult

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

pub fn initial_setup( origin: OriginFor<T>, creator: T::AccountId, admin: T::AccountId, asset: CreateAsset<T> ) -> DispatchResult

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

pub fn sign_up(origin: OriginFor<T>, args: SignUpArgs) -> DispatchResult

pub fn update_user_info( origin: OriginFor<T>, address: T::AccountId, args: UpdateUserArgs ) -> DispatchResult

pub fn create_offer( origin: OriginFor<T>, args: CreateOfferArgs<T> ) -> DispatchResult

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

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

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

pub fn create_tax_credit( origin: OriginFor<T>, metadata: CollectionDescription<T>, attributes: Option<Attributes<T>>, parent_info: Option<ParentInfo<T>> ) -> DispatchResult

pub fn set_afloat_balance( origin: OriginFor<T>, beneficiary: T::AccountId, amount: T::Balance ) -> DispatchResult

pub fn add_afloat_admin( origin: OriginFor<T>, admin: T::AccountId ) -> DispatchResult

impl<T: Config> Pallet<T>

pub fn user_info<KArg>(k: KArg) -> Option<User<T>>where KArg: EncodeLike<T::AccountId>,

Keeps track of the number of fruniques in existence for a collection.

impl<T: Config> Pallet<T>

pub fn marketplace_id() -> Option<MarketplaceId>

impl<T: Config> Pallet<T>

pub fn collection_id() -> Option<<T as Config>::CollectionId>

impl<T: Config> Pallet<T>

pub fn asset_id() -> Option<<T as Config>::AssetId>

impl<T: Config> Pallet<T>

pub fn afloat_offers<KArg>(k: KArg) -> Option<Offer<T>>where KArg: EncodeLike<StorageId>,

impl<T: Config> Pallet<T>

pub fn afloat_transactions<KArg>(k: KArg) -> Option<Transaction<T>>where KArg: EncodeLike<StorageId>,

Trait Implementations

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

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>