Struct pallet_uniques::pallet::Pallet
source · pub struct Pallet<T, I = ()>(_);
Expand description
The Pallet
struct, the main type that implements traits and standalone
functions within the pallet.
Implementations§
source§impl<T: Config<I>, I: 'static> Pallet<T, I>
impl<T: Config<I>, I: 'static> Pallet<T, I>
sourcepub fn do_transfer(
collection: T::CollectionId,
item: T::ItemId,
dest: T::AccountId,
with_details: impl FnOnce(&CollectionDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>, &mut ItemDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>) -> DispatchResult
) -> DispatchResult
pub fn do_transfer( collection: T::CollectionId, item: T::ItemId, dest: T::AccountId, with_details: impl FnOnce(&CollectionDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>, &mut ItemDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>) -> DispatchResult ) -> DispatchResult
Perform a transfer of an item from one account to another within a collection.
Errors
This function returns a dispatch error in the following cases:
- The collection or item does not exist
(
UnknownCollection
). - The collection is frozen, and no transfers are allowed (
Frozen
). - The item is locked, and transfers are not permitted (
Locked
). - The
with_details
closure returns an error.
sourcepub fn do_create_collection(
collection: T::CollectionId,
owner: T::AccountId,
admin: T::AccountId,
deposit: <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance,
free_holding: bool,
event: Event<T, I>
) -> DispatchResult
pub fn do_create_collection( collection: T::CollectionId, owner: T::AccountId, admin: T::AccountId, deposit: <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance, free_holding: bool, event: Event<T, I> ) -> DispatchResult
sourcepub fn do_destroy_collection(
collection: T::CollectionId,
witness: DestroyWitness,
maybe_check_owner: Option<T::AccountId>
) -> Result<DestroyWitness, DispatchError>
pub fn do_destroy_collection( collection: T::CollectionId, witness: DestroyWitness, maybe_check_owner: Option<T::AccountId> ) -> Result<DestroyWitness, DispatchError>
Destroy a collection along with its associated items and metadata.
Errors
This function returns a dispatch error in the following cases:
- The collection does not exist (
UnknownCollection
). - The provided witness does not match the actual counts
(
BadWitness
). - The caller is not the owner of the collection
(
NoPermission
).
sourcepub fn do_mint(
collection: T::CollectionId,
item: T::ItemId,
owner: T::AccountId,
with_details: impl FnOnce(&CollectionDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>) -> DispatchResult
) -> DispatchResult
pub fn do_mint( collection: T::CollectionId, item: T::ItemId, owner: T::AccountId, with_details: impl FnOnce(&CollectionDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>) -> DispatchResult ) -> DispatchResult
Mint (create) a new item within a collection and assign ownership to an account.
Errors
This function returns a dispatch error in the following cases:
- The item already exists in the collection
(
AlreadyExists
). - The collection does not exist (
UnknownCollection
). - The provided closure
with_details
returns an error. - The collection has reached its maximum supply
(
MaxSupplyReached
). - An arithmetic overflow occurs when incrementing the number of items in the collection.
- The currency reserve operation for the item deposit fails for any reason.
sourcepub fn do_burn(
collection: T::CollectionId,
item: T::ItemId,
with_details: impl FnOnce(&CollectionDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>, &ItemDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>) -> DispatchResult
) -> DispatchResult
pub fn do_burn( collection: T::CollectionId, item: T::ItemId, with_details: impl FnOnce(&CollectionDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>, &ItemDetails<<T as SystemConfig>::AccountId, <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>) -> DispatchResult ) -> DispatchResult
Burn (destroy) an item from a collection.
Errors
This function returns a Dispatch
error in the following cases:
- The item is locked and burns are not permitted (
Locked
). - The collection or item does not exist
(
UnknownCollection
). - The
with_details
closure returns an error.
sourcepub fn do_set_price(
collection: T::CollectionId,
item: T::ItemId,
sender: T::AccountId,
price: Option<<<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>,
whitelisted_buyer: Option<T::AccountId>
) -> DispatchResult
pub fn do_set_price( collection: T::CollectionId, item: T::ItemId, sender: T::AccountId, price: Option<<<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>, whitelisted_buyer: Option<T::AccountId> ) -> DispatchResult
Set or remove the price for an item in a collection.
Errors
This function returns a dispatch error in the following cases:
- The item or collection does not exist (
UnknownItem
orUnknownCollection
). - The sender is not the owner of the item (
NoPermission
).
sourcepub fn do_buy_item(
collection: T::CollectionId,
item: T::ItemId,
buyer: T::AccountId,
bid_price: <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance
) -> DispatchResult
pub fn do_buy_item( collection: T::CollectionId, item: T::ItemId, buyer: T::AccountId, bid_price: <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance ) -> DispatchResult
Buy an item from a collection.
Errors
This function returns a dispatch error in the following cases:
- The item or collection does not exist (
UnknownItem
orUnknownCollection
). - The buyer is the current owner of the item (
NoPermission
). - The item is not for sale (
NotForSale
). - The bid price is lower than the item’s sale price
(
BidTooLow
). - The item is set to be sold only to a specific buyer, and the provided buyer is not the
whitelisted buyer (
NoPermission
). - The currency transfer between the buyer and the owner fails for any reason.
source§impl<T: Config<I>, I: 'static> Pallet<T, I>
impl<T: Config<I>, I: 'static> Pallet<T, I>
sourcepub fn owner(
collection: T::CollectionId,
item: T::ItemId
) -> Option<T::AccountId>
pub fn owner( collection: T::CollectionId, item: T::ItemId ) -> Option<T::AccountId>
Get the owner of the item, if the item exists.
sourcepub fn collection_owner(collection: T::CollectionId) -> Option<T::AccountId>
pub fn collection_owner(collection: T::CollectionId) -> Option<T::AccountId>
Get the owner of the item, if the item exists.
source§impl<T: Config<I>, I: 'static> Pallet<T, I>
impl<T: Config<I>, I: 'static> Pallet<T, I>
sourcepub fn create(
origin: OriginFor<T>,
collection: T::CollectionId,
admin: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult
pub fn create( origin: OriginFor<T>, collection: T::CollectionId, admin: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult
Issue a new collection of non-fungible items from a public origin.
This new collection has no items initially and its owner is the origin.
The origin must conform to the configured CreateOrigin
and have sufficient funds free.
ItemDeposit
funds of sender are reserved.
Parameters:
collection
: The identifier of the new collection. This must not be currently in use.admin
: The admin of this collection. The admin is the initial address of each member of the collection’s admin team.
Emits Created
event when successful.
Weight: O(1)
sourcepub fn force_create(
origin: OriginFor<T>,
collection: T::CollectionId,
owner: <<T as Config>::Lookup as StaticLookup>::Source,
free_holding: bool
) -> DispatchResult
pub fn force_create( origin: OriginFor<T>, collection: T::CollectionId, owner: <<T as Config>::Lookup as StaticLookup>::Source, free_holding: bool ) -> DispatchResult
Issue a new collection of non-fungible items from a privileged origin.
This new collection has no items initially.
The origin must conform to ForceOrigin
.
Unlike create
, no funds are reserved.
collection
: The identifier of the new item. This must not be currently in use.owner
: The owner of this collection of items. The owner has full superuser permissions over this item, but may later change and configure the permissions usingtransfer_ownership
andset_team
.
Emits ForceCreated
event when successful.
Weight: O(1)
sourcepub fn destroy(
origin: OriginFor<T>,
collection: T::CollectionId,
witness: DestroyWitness
) -> DispatchResultWithPostInfo
pub fn destroy( origin: OriginFor<T>, collection: T::CollectionId, witness: DestroyWitness ) -> DispatchResultWithPostInfo
Destroy a collection of fungible items.
The origin must conform to ForceOrigin
or must be Signed
and the sender must be the
owner of the collection
.
collection
: The identifier of the collection to be destroyed.witness
: Information on the items minted in the collection. This must be correct.
Emits Destroyed
event when successful.
Weight: O(n + m)
where:
n = witness.items
m = witness.item_metadatas
a = witness.attributes
sourcepub fn mint(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
owner: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult
pub fn mint( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, owner: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult
Mint an item of a particular collection.
The origin must be Signed and the sender must be the Issuer of the collection
.
collection
: The collection of the item to be minted.item
: The item value of the item to be minted.beneficiary
: The initial owner of the minted item.
Emits Issued
event when successful.
Weight: O(1)
sourcepub fn burn(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
check_owner: Option<<<T as Config>::Lookup as StaticLookup>::Source>
) -> DispatchResult
pub fn burn( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, check_owner: Option<<<T as Config>::Lookup as StaticLookup>::Source> ) -> DispatchResult
Destroy a single item.
Origin must be Signed and the signing account must be either:
-
the Admin of the
collection
; -
the Owner of the
item
; -
collection
: The collection of the item to be burned. -
item
: The item of the item to be burned. -
check_owner
: IfSome
then the operation will fail withWrongOwner
unless the item is owned by this value.
Emits Burned
with the actual amount burned.
Weight: O(1)
Modes: check_owner.is_some()
.
sourcepub fn transfer(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
dest: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult
pub fn transfer( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, dest: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult
Move an item from the sender account to another.
This resets the approved account of the item.
Origin must be Signed and the signing account must be either:
- the Admin of the
collection
; - the Owner of the
item
; - the approved delegate for the
item
(in this case, the approval is reset).
Arguments:
collection
: The collection of the item to be transferred.item
: The item of the item to be transferred.dest
: The account to receive ownership of the item.
Emits Transferred
.
Weight: O(1)
sourcepub fn redeposit(
origin: OriginFor<T>,
collection: T::CollectionId,
items: Vec<T::ItemId>
) -> DispatchResult
pub fn redeposit( origin: OriginFor<T>, collection: T::CollectionId, items: Vec<T::ItemId> ) -> DispatchResult
Reevaluate the deposits on some items.
Origin must be Signed and the sender should be the Owner of the collection
.
collection
: The collection to be frozen.items
: The items of the collection whose deposits will be reevaluated.
NOTE: This exists as a best-effort function. Any items which are unknown or in the case that the owner account does not have reservable funds to pay for a deposit increase are ignored. Generally the owner isn’t going to call this on items whose existing deposit is less than the refreshed deposit as it would only cost them, so it’s of little consequence.
It will still return an error in the case that the collection is unknown of the signer is not permitted to call it.
Weight: O(items.len())
sourcepub fn freeze(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId
) -> DispatchResult
pub fn freeze( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId ) -> DispatchResult
Disallow further unprivileged transfer of an item.
Origin must be Signed and the sender should be the Freezer of the collection
.
collection
: The collection of the item to be frozen.item
: The item of the item to be frozen.
Emits Frozen
.
Weight: O(1)
sourcepub fn thaw(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId
) -> DispatchResult
pub fn thaw( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId ) -> DispatchResult
Re-allow unprivileged transfer of an item.
Origin must be Signed and the sender should be the Freezer of the collection
.
collection
: The collection of the item to be thawed.item
: The item of the item to be thawed.
Emits Thawed
.
Weight: O(1)
sourcepub fn freeze_collection(
origin: OriginFor<T>,
collection: T::CollectionId
) -> DispatchResult
pub fn freeze_collection( origin: OriginFor<T>, collection: T::CollectionId ) -> DispatchResult
Disallow further unprivileged transfers for a whole collection.
Origin must be Signed and the sender should be the Freezer of the collection
.
collection
: The collection to be frozen.
Emits CollectionFrozen
.
Weight: O(1)
sourcepub fn thaw_collection(
origin: OriginFor<T>,
collection: T::CollectionId
) -> DispatchResult
pub fn thaw_collection( origin: OriginFor<T>, collection: T::CollectionId ) -> DispatchResult
Re-allow unprivileged transfers for a whole collection.
Origin must be Signed and the sender should be the Admin of the collection
.
collection
: The collection to be thawed.
Emits CollectionThawed
.
Weight: O(1)
sourcepub fn transfer_ownership(
origin: OriginFor<T>,
collection: T::CollectionId,
owner: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult
pub fn transfer_ownership( origin: OriginFor<T>, collection: T::CollectionId, owner: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult
Change the Owner of a collection.
Origin must be Signed and the sender should be the Owner of the collection
.
collection
: The collection whose owner should be changed.owner
: The new Owner of this collection. They must have calledset_accept_ownership
withcollection
in order for this operation to succeed.
Emits OwnerChanged
.
Weight: O(1)
sourcepub fn set_team(
origin: OriginFor<T>,
collection: T::CollectionId,
issuer: <<T as Config>::Lookup as StaticLookup>::Source,
admin: <<T as Config>::Lookup as StaticLookup>::Source,
freezer: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult
pub fn set_team( origin: OriginFor<T>, collection: T::CollectionId, issuer: <<T as Config>::Lookup as StaticLookup>::Source, admin: <<T as Config>::Lookup as StaticLookup>::Source, freezer: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult
Change the Issuer, Admin and Freezer of a collection.
Origin must be Signed and the sender should be the Owner of the collection
.
collection
: The collection whose team should be changed.issuer
: The new Issuer of this collection.admin
: The new Admin of this collection.freezer
: The new Freezer of this collection.
Emits TeamChanged
.
Weight: O(1)
sourcepub fn approve_transfer(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
delegate: <<T as Config>::Lookup as StaticLookup>::Source
) -> DispatchResult
pub fn approve_transfer( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, delegate: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult
Approve an item to be transferred by a delegated third-party account.
The origin must conform to ForceOrigin
or must be Signed
and the sender must be
either the owner of the item
or the admin of the collection.
collection
: The collection of the item to be approved for delegated transfer.item
: The item of the item to be approved for delegated transfer.delegate
: The account to delegate permission to transfer the item.
Important NOTE: The approved
account gets reset after each transfer.
Emits ApprovedTransfer
on success.
Weight: O(1)
sourcepub fn cancel_approval(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
maybe_check_delegate: Option<<<T as Config>::Lookup as StaticLookup>::Source>
) -> DispatchResult
pub fn cancel_approval( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, maybe_check_delegate: Option<<<T as Config>::Lookup as StaticLookup>::Source> ) -> DispatchResult
Cancel the prior approval for the transfer of an item by a delegate.
Origin must be either:
- the
Force
origin; Signed
with the signer being the Admin of thecollection
;Signed
with the signer being the Owner of theitem
;
Arguments:
collection
: The collection of the item of whose approval will be cancelled.item
: The item of the item of whose approval will be cancelled.maybe_check_delegate
: IfSome
will ensure that the given account is the one to which permission of transfer is delegated.
Emits ApprovalCancelled
on success.
Weight: O(1)
sourcepub fn force_item_status(
origin: OriginFor<T>,
collection: T::CollectionId,
owner: <<T as Config>::Lookup as StaticLookup>::Source,
issuer: <<T as Config>::Lookup as StaticLookup>::Source,
admin: <<T as Config>::Lookup as StaticLookup>::Source,
freezer: <<T as Config>::Lookup as StaticLookup>::Source,
free_holding: bool,
is_frozen: bool
) -> DispatchResult
pub fn force_item_status( origin: OriginFor<T>, collection: T::CollectionId, owner: <<T as Config>::Lookup as StaticLookup>::Source, issuer: <<T as Config>::Lookup as StaticLookup>::Source, admin: <<T as Config>::Lookup as StaticLookup>::Source, freezer: <<T as Config>::Lookup as StaticLookup>::Source, free_holding: bool, is_frozen: bool ) -> DispatchResult
Alter the attributes of a given item.
Origin must be ForceOrigin
.
collection
: The identifier of the item.owner
: The new Owner of this item.issuer
: The new Issuer of this item.admin
: The new Admin of this item.freezer
: The new Freezer of this item.free_holding
: Whether a deposit is taken for holding an item of this collection.is_frozen
: Whether this collection is frozen except for permissioned/admin instructions.
Emits ItemStatusChanged
with the identity of the item.
Weight: O(1)
sourcepub fn set_attribute(
origin: OriginFor<T>,
collection: T::CollectionId,
maybe_item: Option<T::ItemId>,
key: BoundedVec<u8, T::KeyLimit>,
value: BoundedVec<u8, T::ValueLimit>
) -> DispatchResult
pub fn set_attribute( origin: OriginFor<T>, collection: T::CollectionId, maybe_item: Option<T::ItemId>, key: BoundedVec<u8, T::KeyLimit>, value: BoundedVec<u8, T::ValueLimit> ) -> DispatchResult
Set an attribute for a collection or item.
Origin must be either ForceOrigin
or Signed and the sender should be the Owner of the
collection
.
If the origin is Signed, then funds of signer are reserved according to the formula:
MetadataDepositBase + DepositPerByte * (key.len + value.len)
taking into
account any already reserved funds.
collection
: The identifier of the collection whose item’s metadata to set.maybe_item
: The identifier of the item whose metadata to set.key
: The key of the attribute.value
: The value to which to set the attribute.
Emits AttributeSet
.
Weight: O(1)
sourcepub fn clear_attribute(
origin: OriginFor<T>,
collection: T::CollectionId,
maybe_item: Option<T::ItemId>,
key: BoundedVec<u8, T::KeyLimit>
) -> DispatchResult
pub fn clear_attribute( origin: OriginFor<T>, collection: T::CollectionId, maybe_item: Option<T::ItemId>, key: BoundedVec<u8, T::KeyLimit> ) -> DispatchResult
Clear an attribute for a collection or item.
Origin must be either ForceOrigin
or Signed and the sender should be the Owner of the
collection
.
Any deposit is freed for the collection’s owner.
collection
: The identifier of the collection whose item’s metadata to clear.maybe_item
: The identifier of the item whose metadata to clear.key
: The key of the attribute.
Emits AttributeCleared
.
Weight: O(1)
sourcepub fn set_metadata(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
data: BoundedVec<u8, T::StringLimit>,
is_frozen: bool
) -> DispatchResult
pub fn set_metadata( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, data: BoundedVec<u8, T::StringLimit>, is_frozen: bool ) -> DispatchResult
Set the metadata for an item.
Origin must be either ForceOrigin
or Signed and the sender should be the Owner of the
collection
.
If the origin is Signed, then funds of signer are reserved according to the formula:
MetadataDepositBase + DepositPerByte * data.len
taking into
account any already reserved funds.
collection
: The identifier of the collection whose item’s metadata to set.item
: The identifier of the item whose metadata to set.data
: The general information of this item. Limited in length byStringLimit
.is_frozen
: Whether the metadata should be frozen against further changes.
Emits MetadataSet
.
Weight: O(1)
sourcepub fn clear_metadata(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId
) -> DispatchResult
pub fn clear_metadata( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId ) -> DispatchResult
Clear the metadata for an item.
Origin must be either ForceOrigin
or Signed and the sender should be the Owner of the
item
.
Any deposit is freed for the collection’s owner.
collection
: The identifier of the collection whose item’s metadata to clear.item
: The identifier of the item whose metadata to clear.
Emits MetadataCleared
.
Weight: O(1)
sourcepub fn set_collection_metadata(
origin: OriginFor<T>,
collection: T::CollectionId,
data: BoundedVec<u8, T::StringLimit>,
is_frozen: bool
) -> DispatchResult
pub fn set_collection_metadata( origin: OriginFor<T>, collection: T::CollectionId, data: BoundedVec<u8, T::StringLimit>, is_frozen: bool ) -> DispatchResult
Set the metadata for a collection.
Origin must be either ForceOrigin
or Signed
and the sender should be the Owner of
the collection
.
If the origin is Signed
, then funds of signer are reserved according to the formula:
MetadataDepositBase + DepositPerByte * data.len
taking into
account any already reserved funds.
collection
: The identifier of the item whose metadata to update.data
: The general information of this item. Limited in length byStringLimit
.is_frozen
: Whether the metadata should be frozen against further changes.
Emits CollectionMetadataSet
.
Weight: O(1)
sourcepub fn clear_collection_metadata(
origin: OriginFor<T>,
collection: T::CollectionId
) -> DispatchResult
pub fn clear_collection_metadata( origin: OriginFor<T>, collection: T::CollectionId ) -> DispatchResult
Clear the metadata for a collection.
Origin must be either ForceOrigin
or Signed
and the sender should be the Owner of
the collection
.
Any deposit is freed for the collection’s owner.
collection
: The identifier of the collection whose metadata to clear.
Emits CollectionMetadataCleared
.
Weight: O(1)
sourcepub fn set_accept_ownership(
origin: OriginFor<T>,
maybe_collection: Option<T::CollectionId>
) -> DispatchResult
pub fn set_accept_ownership( origin: OriginFor<T>, maybe_collection: Option<T::CollectionId> ) -> DispatchResult
Set (or reset) the acceptance of ownership for a particular account.
Origin must be Signed
and if maybe_collection
is Some
, then the signer must have a
provider reference.
maybe_collection
: The identifier of the collection whose ownership the signer is willing to accept, or ifNone
, an indication that the signer is willing to accept no ownership transferal.
Emits OwnershipAcceptanceChanged
.
sourcepub fn set_collection_max_supply(
origin: OriginFor<T>,
collection: T::CollectionId,
max_supply: u32
) -> DispatchResult
pub fn set_collection_max_supply( origin: OriginFor<T>, collection: T::CollectionId, max_supply: u32 ) -> DispatchResult
Set the maximum amount of items a collection could have.
Origin must be either ForceOrigin
or Signed
and the sender should be the Owner of
the collection
.
Note: This function can only succeed once per collection.
collection
: The identifier of the collection to change.max_supply
: The maximum amount of items a collection could have.
Emits CollectionMaxSupplySet
event when successful.
sourcepub fn set_price(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
price: Option<<<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>,
whitelisted_buyer: Option<<<T as Config>::Lookup as StaticLookup>::Source>
) -> DispatchResult
pub fn set_price( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, price: Option<<<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance>, whitelisted_buyer: Option<<<T as Config>::Lookup as StaticLookup>::Source> ) -> DispatchResult
Set (or reset) the price for an item.
Origin must be Signed and must be the owner of the asset item
.
collection
: The collection of the item.item
: The item to set the price for.price
: The price for the item. PassNone
, to reset the price.buyer
: Restricts the buy operation to a specific account.
Emits ItemPriceSet
on success if the price is not None
.
Emits ItemPriceRemoved
on success if the price is None
.
sourcepub fn buy_item(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
bid_price: <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance
) -> DispatchResult
pub fn buy_item( origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId, bid_price: <<T as Config<I>>::Currency as Currency<<T as SystemConfig>::AccountId>>::Balance ) -> DispatchResult
Allows to buy an item if it’s up for sale.
Origin must be Signed and must not be the owner of the item
.
collection
: The collection of the item.item
: The item the sender wants to buy.bid_price
: The price the sender is willing to pay.
Emits ItemBought
on success.
Trait Implementations§
source§impl<T, I: 'static> Benchmarking for Pallet<T, I>where
T: Config + Config<I>,
impl<T, I: 'static> Benchmarking for Pallet<T, I>where T: Config + Config<I>,
source§fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>
fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>
source§fn run_benchmark(
extrinsic: &[u8],
c: &[(BenchmarkParameter, u32)],
whitelist: &[TrackedStorageKey],
verify: bool,
internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>
fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32 ) -> Result<Vec<BenchmarkResult>, BenchmarkError>
source§impl<T: Config<I>, I: 'static> Create<<T as Config>::AccountId> for Pallet<T, I>
impl<T: Config<I>, I: 'static> Create<<T as Config>::AccountId> for Pallet<T, I>
source§fn create_collection(
collection: &Self::CollectionId,
who: &T::AccountId,
admin: &T::AccountId
) -> DispatchResult
fn create_collection( collection: &Self::CollectionId, who: &T::AccountId, admin: &T::AccountId ) -> DispatchResult
Create a collection
of nonfungible items to be owned by who
and managed by admin
.
source§impl<T: Config<I>, I: 'static> Destroy<<T as Config>::AccountId> for Pallet<T, I>
impl<T: Config<I>, I: 'static> Destroy<<T as Config>::AccountId> for Pallet<T, I>
§type DestroyWitness = DestroyWitness
type DestroyWitness = DestroyWitness
source§fn get_destroy_witness(
collection: &Self::CollectionId
) -> Option<DestroyWitness>
fn get_destroy_witness( collection: &Self::CollectionId ) -> Option<DestroyWitness>
source§fn destroy(
collection: Self::CollectionId,
witness: Self::DestroyWitness,
maybe_check_owner: Option<T::AccountId>
) -> Result<Self::DestroyWitness, DispatchError>
fn destroy( collection: Self::CollectionId, witness: Self::DestroyWitness, maybe_check_owner: Option<T::AccountId> ) -> Result<Self::DestroyWitness, DispatchError>
source§impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>
impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>
source§fn current_storage_version() -> Self::CurrentStorageVersion
fn current_storage_version() -> Self::CurrentStorageVersion
source§fn on_chain_storage_version() -> StorageVersion
fn on_chain_storage_version() -> StorageVersion
source§impl<T: Config<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
impl<T: Config<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
source§fn on_initialize(_n: BlockNumber) -> Weight
fn on_initialize(_n: BlockNumber) -> Weight
source§fn on_finalize(_n: BlockNumber)
fn on_finalize(_n: BlockNumber)
source§fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight
fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight
Hooks::on_finalize
). Read moresource§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
source§fn try_state(_n: BlockNumber) -> Result<(), DispatchError>
fn try_state(_n: BlockNumber) -> Result<(), DispatchError>
source§fn pre_upgrade() -> Result<Vec<u8, Global>, DispatchError>
fn pre_upgrade() -> Result<Vec<u8, Global>, DispatchError>
source§fn post_upgrade(_state: Vec<u8, Global>) -> Result<(), DispatchError>
fn post_upgrade(_state: Vec<u8, Global>) -> Result<(), DispatchError>
source§fn offchain_worker(_n: BlockNumber)
fn offchain_worker(_n: BlockNumber)
source§fn integrity_test()
fn integrity_test()
source§impl<T: Config<I>, I: 'static> Inspect<<T as Config>::AccountId> for Pallet<T, I>
impl<T: Config<I>, I: 'static> Inspect<<T as Config>::AccountId> for Pallet<T, I>
source§fn attribute(
collection: &Self::CollectionId,
item: &Self::ItemId,
key: &[u8]
) -> Option<Vec<u8>>
fn attribute( collection: &Self::CollectionId, item: &Self::ItemId, key: &[u8] ) -> Option<Vec<u8>>
Returns the attribute value of item
of collection
corresponding to key
.
When key
is empty, we return the item metadata value.
By default this is None
; no attributes are defined.
source§fn collection_attribute(
collection: &Self::CollectionId,
key: &[u8]
) -> Option<Vec<u8>>
fn collection_attribute( collection: &Self::CollectionId, key: &[u8] ) -> Option<Vec<u8>>
Returns the attribute value of item
of collection
corresponding to key
.
When key
is empty, we return the item metadata value.
By default this is None
; no attributes are defined.
source§fn can_transfer(collection: &Self::CollectionId, item: &Self::ItemId) -> bool
fn can_transfer(collection: &Self::CollectionId, item: &Self::ItemId) -> bool
Returns true
if the item
of collection
may be transferred.
Default implementation is that all items are transferable.
§type CollectionId = <T as Config<I>>::CollectionId
type CollectionId = <T as Config<I>>::CollectionId
source§fn owner(
collection: &Self::CollectionId,
item: &Self::ItemId
) -> Option<<T as SystemConfig>::AccountId>
fn owner( collection: &Self::CollectionId, item: &Self::ItemId ) -> Option<<T as SystemConfig>::AccountId>
item
of collection
, or None
if the item doesn’t exist
(or somehow has no owner).source§fn collection_owner(
collection: &Self::CollectionId
) -> Option<<T as SystemConfig>::AccountId>
fn collection_owner( collection: &Self::CollectionId ) -> Option<<T as SystemConfig>::AccountId>
collection
, if there is one. For many NFTs this may not
make any sense, so users of this API should not be surprised to find a collection
results in None
here.source§fn typed_attribute<K, V>(
collection: &Self::CollectionId,
item: &Self::ItemId,
key: &K
) -> Option<V>where
K: Encode,
V: Decode,
fn typed_attribute<K, V>( collection: &Self::CollectionId, item: &Self::ItemId, key: &K ) -> Option<V>where K: Encode, V: Decode,
source§fn typed_collection_attribute<K, V>(
collection: &Self::CollectionId,
key: &K
) -> Option<V>where
K: Encode,
V: Decode,
fn typed_collection_attribute<K, V>( collection: &Self::CollectionId, key: &K ) -> Option<V>where K: Encode, V: Decode,
source§impl<T: Config<I>, I: 'static> InspectEnumerable<<T as Config>::AccountId> for Pallet<T, I>
impl<T: Config<I>, I: 'static> InspectEnumerable<<T as Config>::AccountId> for Pallet<T, I>
source§fn collections() -> Self::CollectionsIterator
fn collections() -> Self::CollectionsIterator
Returns an iterator of the collections in existence.
NOTE: iterating this list invokes a storage read per item.
source§fn items(collection: &Self::CollectionId) -> Self::ItemsIterator
fn items(collection: &Self::CollectionId) -> Self::ItemsIterator
Returns an iterator of the items of a collection
in existence.
NOTE: iterating this list invokes a storage read per item.
source§fn owned(who: &T::AccountId) -> Self::OwnedIterator
fn owned(who: &T::AccountId) -> Self::OwnedIterator
Returns an iterator of the items of all collections owned by who
.
NOTE: iterating this list invokes a storage read per item.
source§fn owned_in_collection(
collection: &Self::CollectionId,
who: &T::AccountId
) -> Self::OwnedInCollectionIterator
fn owned_in_collection( collection: &Self::CollectionId, who: &T::AccountId ) -> Self::OwnedInCollectionIterator
Returns an iterator of the items of collection
owned by who
.
NOTE: iterating this list invokes a storage read per item.
§type CollectionsIterator = KeyPrefixIterator<<T as Config<I>>::CollectionId>
type CollectionsIterator = KeyPrefixIterator<<T as Config<I>>::CollectionId>
Self::collections
.§type ItemsIterator = KeyPrefixIterator<<T as Config<I>>::ItemId>
type ItemsIterator = KeyPrefixIterator<<T as Config<I>>::ItemId>
Self::items
.§type OwnedIterator = KeyPrefixIterator<(<T as Config<I>>::CollectionId, <T as Config<I>>::ItemId)>
type OwnedIterator = KeyPrefixIterator<(<T as Config<I>>::CollectionId, <T as Config<I>>::ItemId)>
Self::owned
.§type OwnedInCollectionIterator = KeyPrefixIterator<<T as Config<I>>::ItemId>
type OwnedInCollectionIterator = KeyPrefixIterator<<T as Config<I>>::ItemId>
Self::owned_in_collection
.source§impl<T: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>
impl<T: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>
source§impl<T: Config<I>, I: 'static> Mutate<<T as Config>::AccountId> for Pallet<T, I>
impl<T: Config<I>, I: 'static> Mutate<<T as Config>::AccountId> for Pallet<T, I>
source§fn mint_into(
collection: &Self::CollectionId,
item: &Self::ItemId,
who: &T::AccountId
) -> DispatchResult
fn mint_into( collection: &Self::CollectionId, item: &Self::ItemId, who: &T::AccountId ) -> DispatchResult
source§fn burn(
collection: &Self::CollectionId,
item: &Self::ItemId,
maybe_check_owner: Option<&T::AccountId>
) -> DispatchResult
fn burn( collection: &Self::CollectionId, item: &Self::ItemId, maybe_check_owner: Option<&T::AccountId> ) -> DispatchResult
source§fn set_attribute(
_collection: &Self::CollectionId,
_item: &Self::ItemId,
_key: &[u8],
_value: &[u8]
) -> Result<(), DispatchError>
fn set_attribute( _collection: &Self::CollectionId, _item: &Self::ItemId, _key: &[u8], _value: &[u8] ) -> Result<(), DispatchError>
source§fn set_typed_attribute<K, V>(
collection: &Self::CollectionId,
item: &Self::ItemId,
key: &K,
value: &V
) -> Result<(), DispatchError>where
K: Encode,
V: Encode,
fn set_typed_attribute<K, V>( collection: &Self::CollectionId, item: &Self::ItemId, key: &K, value: &V ) -> Result<(), DispatchError>where K: Encode, V: Encode,
source§fn set_collection_attribute(
_collection: &Self::CollectionId,
_key: &[u8],
_value: &[u8]
) -> Result<(), DispatchError>
fn set_collection_attribute( _collection: &Self::CollectionId, _key: &[u8], _value: &[u8] ) -> Result<(), DispatchError>
source§fn set_typed_collection_attribute<K, V>(
collection: &Self::CollectionId,
key: &K,
value: &V
) -> Result<(), DispatchError>where
K: Encode,
V: Encode,
fn set_typed_collection_attribute<K, V>( collection: &Self::CollectionId, key: &K, value: &V ) -> Result<(), DispatchError>where K: Encode, V: Encode,
source§impl<T: Config<I>, I: 'static> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
impl<T: Config<I>, I: 'static> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
source§fn offchain_worker(n: BlockNumberFor<T>)
fn offchain_worker(n: BlockNumberFor<T>)
source§impl<T: Config<I>, I: 'static> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
impl<T: Config<I>, I: 'static> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
source§fn on_finalize(n: BlockNumberFor<T>)
fn on_finalize(n: BlockNumberFor<T>)
Hooks::on_finalize
.source§impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>
impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>
source§fn on_genesis()
fn on_genesis()
source§impl<T: Config<I>, I: 'static> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
impl<T: Config<I>, I: 'static> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
source§fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight
fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight
Hooks::on_idle
.source§impl<T: Config<I>, I: 'static> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
impl<T: Config<I>, I: 'static> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
source§fn on_initialize(n: BlockNumberFor<T>) -> Weight
fn on_initialize(n: BlockNumberFor<T>) -> Weight
Hooks::on_initialize
.source§impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>
impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>
source§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
source§fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>
fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>
Hooks::pre_upgrade
.source§fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>
fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>
Hooks::post_upgrade
.source§fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>
fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>
pre_upgrade
->
on_runtime_upgrade
-> post_upgrade
hooks for a migration. Read moresource§impl<T: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>
impl<T: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>
source§fn module_name() -> &'static str
fn module_name() -> &'static str
source§fn crate_version() -> CrateVersion
fn crate_version() -> CrateVersion
source§impl<T: Config<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>
impl<T: Config<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>
source§impl<T, I> PartialEq<Pallet<T, I>> for Pallet<T, I>
impl<T, I> PartialEq<Pallet<T, I>> for Pallet<T, I>
source§impl<T: Config<I>, I: 'static> StorageInfoTrait for Pallet<T, I>
impl<T: Config<I>, I: 'static> StorageInfoTrait for Pallet<T, I>
fn storage_info() -> Vec<StorageInfo>
source§impl<T: Config<I>, I: 'static> Transfer<<T as Config>::AccountId> for Pallet<T, I>
impl<T: Config<I>, I: 'static> Transfer<<T as Config>::AccountId> for Pallet<T, I>
source§fn transfer(
collection: &Self::CollectionId,
item: &Self::ItemId,
destination: &T::AccountId
) -> DispatchResult
fn transfer( collection: &Self::CollectionId, item: &Self::ItemId, destination: &T::AccountId ) -> DispatchResult
item
of collection
into destination
account.source§impl<T: Config<I>, I: 'static> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
impl<T: Config<I>, I: 'static> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>
source§fn try_state(
n: BlockNumberFor<T>,
_s: TryStateSelect
) -> Result<(), TryRuntimeError>
fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect ) -> Result<(), TryRuntimeError>
source§impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>
impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>
source§fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
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, I> Eq for Pallet<T, I>
Auto Trait Implementations§
impl<T, I> RefUnwindSafe for Pallet<T, I>where I: RefUnwindSafe, T: RefUnwindSafe,
impl<T, I> Send for Pallet<T, I>where I: Send, T: Send,
impl<T, I> Sync for Pallet<T, I>where I: Sync, T: Sync,
impl<T, I> Unpin for Pallet<T, I>where I: Unpin, T: Unpin,
impl<T, I> UnwindSafe for Pallet<T, I>where I: UnwindSafe, T: UnwindSafe,
Blanket Implementations§
source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T, Outer> IsWrappedBy<Outer> for Twhere
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
source§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,
source§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,
T
. Read more§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,
source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.source§impl<T, S> UniqueSaturatedInto<T> for Swhere
T: Bounded,
S: TryInto<T>,
impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,
source§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T
.