pallet_nodle_uniques/lib.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
/*
* This file is part of the Nodle Chain distributed at https://github.com/NodleCode/chain
* Copyright (C) 2020-2022 Nodle International
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#![cfg_attr(not(feature = "std"), no_std)]
//! Handle the ability to notify other pallets that they should stop all
use frame_support::traits::{Currency, StorageVersion};
use sp_runtime::traits::{StaticLookup, Zero};
use support::LimitedBalance;
pub use pallet::*;
pub use weights::WeightInfo;
pub mod weights;
mod benchmarking;
#[cfg(test)]
mod tests;
type AccountIdLookupOf<T> = <<T as frame_system::Config>::Lookup as StaticLookup>::Source;
pub type BalanceOf<T, I = ()> =
<<T as pallet_uniques::Config<I>>::Currency as Currency<<T as frame_system::Config>::AccountId>>::Balance;
#[frame_support::pallet]
pub mod pallet {
use super::*;
use frame_support::{
pallet_prelude::*,
traits::{BalanceStatus::Reserved, ExistenceRequirement, ReservableCurrency},
transactional,
};
use frame_system::pallet_prelude::*;
use pallet_uniques::{DestroyWitness, WeightInfo as UniquesWeightInfo};
use sp_runtime::DispatchResult;
use sp_std::vec::Vec;
const STORAGE_VERSION: StorageVersion = StorageVersion::new(0);
#[pallet::config]
pub trait Config<I: 'static = ()>: frame_system::Config + pallet_uniques::Config<I> {
/// The overarching event type.
type RuntimeEvent: From<Event<Self, I>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;
/// Weight information for extrinsics specific to this pallet.
type WeightInfo: WeightInfo;
}
#[pallet::pallet]
#[pallet::storage_version(STORAGE_VERSION)]
pub struct Pallet<T, I = ()>(PhantomData<(T, I)>);
#[pallet::hooks]
impl<T: Config<I>, I: 'static> Hooks<BlockNumberFor<T>> for Pallet<T, I> {}
#[pallet::storage]
/// The extra deposits in existence.
pub(crate) type ItemExtraDeposits<T: Config<I>, I: 'static = ()> = StorageDoubleMap<
_,
Blake2_128Concat,
T::CollectionId,
Blake2_128Concat,
T::ItemId,
BalanceOf<T, I>,
OptionQuery,
>;
#[pallet::storage]
pub(crate) type CollectionExtraDepositDetails<T: Config<I>, I: 'static = ()> =
StorageMap<_, Blake2_128Concat, T::CollectionId, LimitedBalance<BalanceOf<T, I>>, OptionQuery>;
#[pallet::event]
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config<I>, I: 'static = ()> {
/// A `collection` was created.
ExtraDepositLimitUpdated {
collection: T::CollectionId,
limit: BalanceOf<T, I>,
},
}
#[pallet::error]
pub enum Error<T, I = ()> {
/// Cannot mint the token most likely due to extra deposit exceeding the collection owner's limit.
FailedToIncreaseTotalExtraDeposit,
/// The owner of collection is not retrievable most likely due to collection not existing.
FailedToRetrieveCollectionOwner,
/// The owner of item is not found due to item not existing.
FailedToRetrieveItemOwner,
/// Permission denied.
PermissionDenied,
/// Cannot update the extra deposit limit most likely due to it going lower than commitment
FailedToUpdateExtraDepositLimit,
}
#[pallet::call]
impl<T: Config<I>, I: 'static> Pallet<T, I> {
/// 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)`
#[pallet::call_index(0)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::create())]
pub fn create(
origin: OriginFor<T>,
collection: T::CollectionId,
admin: AccountIdLookupOf<T>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::create(origin, collection, admin)
}
/// 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 using
/// `transfer_ownership` and `set_team`.
///
/// Emits `ForceCreated` event when successful.
///
/// Weight: `O(1)`
#[pallet::call_index(1)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::force_create())]
pub fn force_create(
origin: OriginFor<T>,
collection: T::CollectionId,
owner: AccountIdLookupOf<T>,
free_holding: bool,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::force_create(origin, collection, owner, free_holding)
}
/// 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`
#[pallet::call_index(2)]
#[pallet::weight(<T as Config<I>>::WeightInfo::destroy(
witness.items,
witness.item_metadatas,
witness.attributes,
))]
pub fn destroy(
origin: OriginFor<T>,
collection: T::CollectionId,
witness: DestroyWitness,
) -> DispatchResultWithPostInfo {
let collection_owner = pallet_uniques::Pallet::<T, I>::collection_owner(collection.clone())
.ok_or(Error::<T, I>::FailedToRetrieveCollectionOwner)?;
for (item, extra_deposit) in ItemExtraDeposits::<T, I>::drain_prefix(collection.clone()) {
let item_owner = pallet_uniques::Pallet::<T, I>::owner(collection.clone(), item)
.ok_or(Error::<T, I>::FailedToRetrieveItemOwner)?;
<T as pallet_uniques::Config<I>>::Currency::unreserve(&collection_owner, extra_deposit);
<T as pallet_uniques::Config<I>>::Currency::transfer(
&collection_owner,
&item_owner,
extra_deposit,
ExistenceRequirement::AllowDeath,
)?;
}
CollectionExtraDepositDetails::<T, I>::remove(collection.clone());
pallet_uniques::Pallet::<T, I>::destroy(origin, collection, witness)
}
/// 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)`
#[pallet::call_index(3)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::mint())]
pub fn mint(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
owner: AccountIdLookupOf<T>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::mint(origin, collection, item, owner)
}
/// 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`: If `Some` then the operation will fail with `WrongOwner` unless the
/// item is owned by this value.
///
/// Emits `Burned` with the actual amount burned.
///
/// Weight: `O(1)`
/// Modes: `check_owner.is_some()`.
#[pallet::call_index(4)]
#[pallet::weight(<T as Config<I>>::WeightInfo::burn())]
pub fn burn(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
check_owner: Option<AccountIdLookupOf<T>>,
) -> DispatchResult {
let collection_owner = pallet_uniques::Pallet::<T, I>::collection_owner(collection.clone())
.ok_or(Error::<T, I>::FailedToRetrieveCollectionOwner)?;
let item_owner = pallet_uniques::Pallet::<T, I>::owner(collection.clone(), item)
.ok_or(Error::<T, I>::FailedToRetrieveItemOwner)?;
pallet_uniques::Pallet::<T, I>::burn(origin, collection.clone(), item, check_owner)?;
let extra_deposit = ItemExtraDeposits::<T, I>::take(collection, item).unwrap_or_else(Zero::zero);
if !extra_deposit.is_zero() {
<T as pallet_uniques::Config<I>>::Currency::unreserve(&collection_owner, extra_deposit);
<T as pallet_uniques::Config<I>>::Currency::transfer(
&collection_owner,
&item_owner,
extra_deposit,
ExistenceRequirement::AllowDeath,
)
} else {
Ok(())
}
}
/// 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)`
#[pallet::call_index(5)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::transfer())]
pub fn transfer(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
dest: AccountIdLookupOf<T>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::transfer(origin, collection, item, dest)
}
/// 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())`
#[pallet::call_index(6)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::redeposit(items.len() as u32))]
pub fn redeposit(origin: OriginFor<T>, collection: T::CollectionId, items: Vec<T::ItemId>) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::redeposit(origin, collection, items)
}
/// 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)`
#[pallet::call_index(7)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::freeze())]
pub fn freeze(origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::freeze(origin, collection, item)
}
/// 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)`
#[pallet::call_index(8)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::thaw())]
pub fn thaw(origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::thaw(origin, collection, item)
}
/// 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)`
#[pallet::call_index(9)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::freeze_collection())]
pub fn freeze_collection(origin: OriginFor<T>, collection: T::CollectionId) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::freeze_collection(origin, collection)
}
/// 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)`
#[pallet::call_index(10)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::thaw_collection())]
pub fn thaw_collection(origin: OriginFor<T>, collection: T::CollectionId) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::thaw_collection(origin, collection)
}
/// 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 called
/// `set_accept_ownership` with `collection` in order for this operation to succeed.
///
/// Emits `OwnerChanged`.
///
/// Weight: `O(1)`
#[pallet::call_index(11)]
#[pallet::weight(<T as Config<I>>::WeightInfo::transfer_ownership())]
pub fn transfer_ownership(
origin: OriginFor<T>,
collection: T::CollectionId,
owner: AccountIdLookupOf<T>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::transfer_ownership(origin.clone(), collection.clone(), owner.clone())?;
let old_owner = ensure_signed(origin)?;
let new_owner = T::Lookup::lookup(owner)?;
if old_owner != new_owner {
let total_extra_deposit = CollectionExtraDepositDetails::<T, I>::get(collection)
.unwrap_or_default()
.balance();
T::Currency::repatriate_reserved(&old_owner, &new_owner, total_extra_deposit, Reserved)?;
}
Ok(())
}
/// 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)`
#[pallet::call_index(12)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::set_team())]
pub fn set_team(
origin: OriginFor<T>,
collection: T::CollectionId,
issuer: AccountIdLookupOf<T>,
admin: AccountIdLookupOf<T>,
freezer: AccountIdLookupOf<T>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::set_team(origin, collection, issuer, admin, freezer)
}
/// 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)`
#[pallet::call_index(13)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::approve_transfer())]
pub fn approve_transfer(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
delegate: AccountIdLookupOf<T>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::approve_transfer(origin, collection, item, delegate)
}
/// 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 the `collection`;
/// - `Signed` with the signer being the Owner of the `item`;
///
/// 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`: If `Some` will ensure that the given account is the one to
/// which permission of transfer is delegated.
///
/// Emits `ApprovalCancelled` on success.
///
/// Weight: `O(1)`
#[pallet::call_index(14)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::cancel_approval())]
pub fn cancel_approval(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
maybe_check_delegate: Option<AccountIdLookupOf<T>>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::cancel_approval(origin, collection, item, maybe_check_delegate)
}
/// 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)`
#[pallet::call_index(15)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::force_item_status())]
#[allow(clippy::too_many_arguments)]
pub fn force_item_status(
origin: OriginFor<T>,
collection: T::CollectionId,
owner: AccountIdLookupOf<T>,
issuer: AccountIdLookupOf<T>,
admin: AccountIdLookupOf<T>,
freezer: AccountIdLookupOf<T>,
free_holding: bool,
is_frozen: bool,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::force_item_status(
origin,
collection,
owner,
issuer,
admin,
freezer,
free_holding,
is_frozen,
)
}
/// 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)`
#[pallet::call_index(16)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::set_attribute())]
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 {
pallet_uniques::Pallet::<T, I>::set_attribute(origin, collection, maybe_item, key, value)
}
/// 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)`
#[pallet::call_index(17)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::clear_attribute())]
pub fn clear_attribute(
origin: OriginFor<T>,
collection: T::CollectionId,
maybe_item: Option<T::ItemId>,
key: BoundedVec<u8, T::KeyLimit>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::clear_attribute(origin, collection, maybe_item, key)
}
/// 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 by `StringLimit`.
/// - `is_frozen`: Whether the metadata should be frozen against further changes.
///
/// Emits `MetadataSet`.
///
/// Weight: `O(1)`
#[pallet::call_index(18)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::set_metadata())]
pub fn set_metadata(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
data: BoundedVec<u8, T::StringLimit>,
is_frozen: bool,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::set_metadata(origin, collection, item, data, is_frozen)
}
/// 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)`
#[pallet::call_index(19)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::clear_metadata())]
pub fn clear_metadata(origin: OriginFor<T>, collection: T::CollectionId, item: T::ItemId) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::clear_metadata(origin, collection, item)
}
/// 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 by `StringLimit`.
/// - `is_frozen`: Whether the metadata should be frozen against further changes.
///
/// Emits `CollectionMetadataSet`.
///
/// Weight: `O(1)`
#[pallet::call_index(20)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::set_collection_metadata())]
pub fn set_collection_metadata(
origin: OriginFor<T>,
collection: T::CollectionId,
data: BoundedVec<u8, T::StringLimit>,
is_frozen: bool,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::set_collection_metadata(origin, collection, data, is_frozen)
}
/// 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)`
#[pallet::call_index(21)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::clear_collection_metadata())]
pub fn clear_collection_metadata(origin: OriginFor<T>, collection: T::CollectionId) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::clear_collection_metadata(origin, collection)
}
/// 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 if `None`, an indication that the signer is willing to accept no
/// ownership transferal.
///
/// Emits `OwnershipAcceptanceChanged`.
#[pallet::call_index(22)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::set_accept_ownership())]
pub fn set_accept_ownership(origin: OriginFor<T>, maybe_collection: Option<T::CollectionId>) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::set_accept_ownership(origin, maybe_collection)
}
/// 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.
#[pallet::call_index(23)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::set_collection_max_supply())]
pub fn set_collection_max_supply(
origin: OriginFor<T>,
collection: T::CollectionId,
max_supply: u32,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::set_collection_max_supply(origin, collection, max_supply)
}
/// 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. Pass `None`, 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`.
#[pallet::call_index(24)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::set_price())]
pub fn set_price(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
price: Option<BalanceOf<T, I>>,
whitelisted_buyer: Option<AccountIdLookupOf<T>>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::set_price(origin, collection, item, price, whitelisted_buyer)
}
/// 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.
#[pallet::call_index(25)]
#[pallet::weight(<T as pallet_uniques::Config<I>>::WeightInfo::buy_item())]
#[transactional]
pub fn buy_item(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
bid_price: BalanceOf<T, I>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::buy_item(origin, collection, item, bid_price)
}
/// 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.
/// - `extra_deposit_limit`: The cap on the total amount of funds that an admin/issuer can
/// reserve from the collection owner (origin of this call) while minting NFTs with extra
/// deposit.
///
/// Emits `Created` event when successful.
///
/// Weight: `O(1)`
#[pallet::call_index(26)]
#[pallet::weight(<T as Config<I>>::WeightInfo::create_with_extra_deposit_limit())]
#[transactional]
pub fn create_with_extra_deposit_limit(
origin: OriginFor<T>,
collection: T::CollectionId,
admin: AccountIdLookupOf<T>,
limit: BalanceOf<T, I>,
) -> DispatchResult {
// Since the extrinsic is transactional the following call only succeeds if the
// collection is also created successfully.
CollectionExtraDepositDetails::<T, I>::insert(
collection.clone(),
LimitedBalance::<BalanceOf<T, I>>::with_limit(limit),
);
pallet_uniques::Pallet::<T, I>::create(origin, collection, admin)
}
/// Mint an item of a particular collection with extra deposit.
///
/// 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)`
#[pallet::call_index(27)]
#[pallet::weight(<T as Config<I>>::WeightInfo::mint_with_extra_deposit())]
#[transactional]
pub fn mint_with_extra_deposit(
origin: OriginFor<T>,
collection: T::CollectionId,
item: T::ItemId,
owner: AccountIdLookupOf<T>,
deposit: BalanceOf<T, I>,
) -> DispatchResult {
pallet_uniques::Pallet::<T, I>::mint(origin, collection.clone(), item, owner)?;
let collection_owner = pallet_uniques::Pallet::<T, I>::collection_owner(collection.clone())
.ok_or(Error::<T, I>::FailedToRetrieveCollectionOwner)?;
let mut extra_deposit_details =
CollectionExtraDepositDetails::<T, I>::get(collection.clone()).unwrap_or_default();
extra_deposit_details
.add(deposit)
.map_err(|_| Error::<T, I>::FailedToIncreaseTotalExtraDeposit)?;
<T as pallet_uniques::Config<I>>::Currency::reserve(&collection_owner, deposit)?;
ItemExtraDeposits::<T, I>::insert(collection.clone(), item, deposit);
CollectionExtraDepositDetails::<T, I>::insert(collection, extra_deposit_details);
Ok(())
}
/// Update extra deposit limit for a collection when it's not against what is already
/// reserved.
///
/// Only the collection owner can update this limit to a value higher than the total extra
/// deposit for the collection currently.
///
/// Parameters:
/// - `collection`: The identifier of the collection owned by the origin.
/// - `limit`: The new cap on the total amount of funds that an admin/issuer can
/// reserve from the collection owner (origin of this call) while minting NFTs with extra
/// deposit.
///
/// Emits `ExtraDepositLimitUpdated` event when successful.
///
/// Weight: `O(1)`
#[pallet::call_index(28)]
#[pallet::weight(<T as Config<I>>::WeightInfo::update_extra_deposit_limit())]
#[transactional]
pub fn update_extra_deposit_limit(
origin: OriginFor<T>,
collection: T::CollectionId,
limit: BalanceOf<T, I>,
) -> DispatchResult {
let origin = ensure_signed(origin)?;
let owner = pallet_uniques::Pallet::<T, I>::collection_owner(collection.clone())
.ok_or(Error::<T, I>::FailedToRetrieveCollectionOwner)?;
ensure!(origin == owner, Error::<T, I>::PermissionDenied);
let mut extra_deposit_details =
CollectionExtraDepositDetails::<T, I>::get(collection.clone()).unwrap_or_default();
extra_deposit_details
.update_limit(limit)
.map_err(|_| Error::<T, I>::FailedToUpdateExtraDepositLimit)?;
CollectionExtraDepositDetails::<T, I>::insert(collection.clone(), extra_deposit_details);
Self::deposit_event(Event::<T, I>::ExtraDepositLimitUpdated { collection, limit });
Ok(())
}
}
}