Skip to content

test: call runtime nfts example #2752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Daanvdplas wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

test: call runtime nfts example #2752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
245 changes: 235 additions & 10 deletions Cargo.lock
View file
Open in desktop

Large diffs are not rendered by default.

17 changes: 16 additions & 1 deletion crates/runtime/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ frame-support = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cb
pallet-assets = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
pallet-assets-precompiles = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
pallet-balances = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
pallet-nfts = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
pallet-xcm = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
pallet-xcm-precompiles = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
pallet-transaction-payment = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
pallet-revive = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
pallet-timestamp = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
Expand All @@ -25,6 +28,9 @@ sp-core = { workspace = true, default-features = false }
sp-externalities = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
sp-runtime = { version = "43.0.0", default-features = false }
sp-io = { git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
xcm = { package = "staging-xcm", git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
xcm-builder = { package = "staging-xcm-builder", git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }
xcm-executor = { package = "staging-xcm-executor", git = "https://github.com/use-ink/polkadot-sdk.git", rev = "cbab8ed4be1941420dd25dc81102fb79d8e2a7f0", default-features = false }

ink_primitives = { workspace = true }
ink_revive_types = { workspace = true }
Expand Down Expand Up @@ -56,11 +62,20 @@ std = [
"pallet-transaction-payment/std",
"pallet-revive/std",
"pallet-timestamp/std",
"pallet-nfts/std",
"pallet-xcm/std",
"pallet-xcm-precompiles/std",
"scale/std",
"scale-info/std",
"sp-core/std",
"sp-externalities/std",
"sp-io/std",
"ink_e2e_macro/std",
"sp-runtime/std"
"sp-runtime/std",
"xcm/std",
"xcm-builder/std",
"xcm-executor/std",
]

# Enable XCM + pallet-nfts in the test runtime.
xcm = []
2 changes: 2 additions & 0 deletions crates/runtime/src/api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
pub mod assets_api;
pub mod balance_api;
pub mod nfts_api;
pub mod revive_api;
pub mod system_api;
pub mod timestamp_api;
Expand All @@ -8,6 +9,7 @@ pub mod prelude {
pub use super::{
assets_api::AssetsAPI,
balance_api::BalanceAPI,
nfts_api::NftsAPI,
revive_api::ContractAPI,
system_api::SystemAPI,
timestamp_api::TimestampAPI,
Expand Down
297 changes: 297 additions & 0 deletions crates/runtime/src/api/nfts_api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,297 @@
use crate::{
AccountIdFor,
IntoAccountId,
RuntimeEnv,
};
use frame_support::{
pallet_prelude::DispatchError,
traits::tokens::nonfungibles_v2::{
Create,
Inspect,
Mutate,
Transfer,
},
};
use pallet_nfts::{
CollectionConfigFor,
CollectionDetailsFor,
ItemConfig,
ItemSettings,
};

type CollectionIdOf<T, I> = <T as pallet_nfts::Config<I>>::CollectionId;
type ItemIdOf<T, I> = <T as pallet_nfts::Config<I>>::ItemId;

/// NFTs API for the runtime.
///
/// Provides helpers to create collections and manipulate items in `pallet-nfts`
/// when running against the in-memory runtime backend.
pub trait NftsAPI<T, I = ()>
where
T: RuntimeEnv,
T::Runtime: pallet_nfts::Config<I>,
I: 'static,
{
/// Creates a new collection owned by `owner` and administered by `admin`.
///
/// This uses the pallet's `Create` implementation directly, so the caller
/// must provide a config where `CollectionSetting::DepositRequired` is not
/// disabled.
fn create_collection(
&mut self,
owner: impl IntoAccountId<AccountIdFor<T::Runtime>>,
admin: impl IntoAccountId<AccountIdFor<T::Runtime>>,
config: CollectionConfigFor<T::Runtime, I>,
) -> Result<CollectionIdOf<T::Runtime, I>, DispatchError>;

/// Mints an item into `beneficiary`.
///
/// `deposit_to_collection_owner` controls whether the deposit is taken from
/// the collection owner instead of the beneficiary.
fn mint_into(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: ItemIdOf<T::Runtime, I>,
beneficiary: impl IntoAccountId<AccountIdFor<T::Runtime>>,
deposit_to_collection_owner: bool,
) -> Result<(), DispatchError>;

/// Transfers ownership of an item.
fn transfer(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: ItemIdOf<T::Runtime, I>,
destination: impl IntoAccountId<AccountIdFor<T::Runtime>>,
) -> Result<(), DispatchError>;

/// Burns an item, optionally enforcing ownership.
fn burn(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: ItemIdOf<T::Runtime, I>,
maybe_check_owner: Option<impl IntoAccountId<AccountIdFor<T::Runtime>>>,
) -> Result<(), DispatchError>;

/// Returns the owner of an item, if any.
fn owner_of(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: &ItemIdOf<T::Runtime, I>,
) -> Option<AccountIdFor<T::Runtime>>;

/// Returns collection details, if the collection exists.
fn collection_details(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
) -> Option<CollectionDetailsFor<T::Runtime, I>>;

/// Returns the config for a collection, if it exists.
fn collection_config(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
) -> Option<CollectionConfigFor<T::Runtime, I>>;

/// Returns the next collection ID.
fn next_collection_id(&mut self) -> Option<CollectionIdOf<T::Runtime, I>>;

/// Checks if a collection exists.
fn collection_exists(&mut self, collection: &CollectionIdOf<T::Runtime, I>) -> bool;

/// Checks if an item exists inside a collection.
fn item_exists(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: &ItemIdOf<T::Runtime, I>,
) -> bool;
}

impl<T, I> NftsAPI<T, I> for T
where
T: RuntimeEnv,
T::Runtime: pallet_nfts::Config<I>,
I: 'static,
{
fn create_collection(
&mut self,
owner: impl IntoAccountId<AccountIdFor<T::Runtime>>,
admin: impl IntoAccountId<AccountIdFor<T::Runtime>>,
config: CollectionConfigFor<T::Runtime, I>,
) -> Result<CollectionIdOf<T::Runtime, I>, DispatchError> {
let owner = owner.into_account_id();
let admin = admin.into_account_id();
self.execute_with(|| {
<pallet_nfts::Pallet<T::Runtime, I> as Create<
AccountIdFor<T::Runtime>,
CollectionConfigFor<T::Runtime, I>,
>>::create_collection(&owner, &admin, &config)
})
}

fn mint_into(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: ItemIdOf<T::Runtime, I>,
beneficiary: impl IntoAccountId<AccountIdFor<T::Runtime>>,
deposit_to_collection_owner: bool,
) -> Result<(), DispatchError> {
let beneficiary = beneficiary.into_account_id();
let item_config = ItemConfig {
settings: ItemSettings::all_enabled(),
};
self.execute_with(|| {
<pallet_nfts::Pallet<T::Runtime, I> as Mutate<
AccountIdFor<T::Runtime>,
ItemConfig,
>>::mint_into(
collection,
&item,
&beneficiary,
&item_config,
deposit_to_collection_owner,
)
})
}

fn transfer(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: ItemIdOf<T::Runtime, I>,
destination: impl IntoAccountId<AccountIdFor<T::Runtime>>,
) -> Result<(), DispatchError> {
let destination = destination.into_account_id();
self.execute_with(|| {
<pallet_nfts::Pallet<T::Runtime, I> as Transfer<
AccountIdFor<T::Runtime>,
>>::transfer(collection, &item, &destination)
})
}

fn burn(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: ItemIdOf<T::Runtime, I>,
maybe_check_owner: Option<impl IntoAccountId<AccountIdFor<T::Runtime>>>,
) -> Result<(), DispatchError> {
let maybe_owner = maybe_check_owner.map(|owner| owner.into_account_id());
self.execute_with(|| {
<pallet_nfts::Pallet<T::Runtime, I> as Mutate<
AccountIdFor<T::Runtime>,
ItemConfig,
>>::burn(collection, &item, maybe_owner.as_ref())
})
}

fn owner_of(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: &ItemIdOf<T::Runtime, I>,
) -> Option<AccountIdFor<T::Runtime>> {
self.execute_with(|| {
<pallet_nfts::Pallet<T::Runtime, I> as Inspect<AccountIdFor<T::Runtime>>>::owner(
collection, item,
)
})
}

fn collection_details(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
) -> Option<CollectionDetailsFor<T::Runtime, I>> {
self.execute_with(|| pallet_nfts::Collection::<T::Runtime, I>::get(collection))
}

fn collection_config(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
) -> Option<CollectionConfigFor<T::Runtime, I>> {
self.execute_with(|| {
pallet_nfts::CollectionConfigOf::<T::Runtime, I>::get(collection)
})
}

fn next_collection_id(&mut self) -> Option<CollectionIdOf<T::Runtime, I>> {
self.execute_with(|| pallet_nfts::NextCollectionId::<T::Runtime, I>::get())
}

fn collection_exists(&mut self, collection: &CollectionIdOf<T::Runtime, I>) -> bool {
self.execute_with(|| {
pallet_nfts::Collection::<T::Runtime, I>::contains_key(collection)
})
}

fn item_exists(
&mut self,
collection: &CollectionIdOf<T::Runtime, I>,
item: &ItemIdOf<T::Runtime, I>,
) -> bool {
self.execute_with(|| {
pallet_nfts::Item::<T::Runtime, I>::contains_key(collection, item)
})
}
}

#[cfg(test)]
mod tests {
use super::*;
use crate::DefaultRuntime;
use pallet_nfts::{
CollectionConfig,
CollectionSettings,
MintSettings,
};

type Runtime = <DefaultRuntime as RuntimeEnv>::Runtime;

fn simple_config() -> CollectionConfigFor<Runtime> {
CollectionConfig {
settings: CollectionSettings::all_enabled(),
max_supply: None,
mint_settings: MintSettings::default(),
}
}

#[test]
fn create_and_mint_work() {
let mut runtime = DefaultRuntime::default();
let owner = DefaultRuntime::default_actor();
let collection_id = runtime
.create_collection(&owner, &owner, simple_config())
.expect("create failed");

assert_eq!(collection_id, 0);
assert!(runtime.collection_exists(&collection_id));

runtime
.mint_into(&collection_id, 1u32, &owner, false)
.expect("mint failed");

assert_eq!(runtime.owner_of(&collection_id, &1u32), Some(owner));
}

#[test]
fn transfer_and_burn_work() {
let mut runtime = DefaultRuntime::default();
let owner = DefaultRuntime::default_actor();
let recipient = ink_e2e::bob().into_account_id();

let collection = runtime
.create_collection(&owner, &owner, simple_config())
.expect("create failed");
runtime
.mint_into(&collection, 7u32, &owner, false)
.expect("mint failed");

runtime
.transfer(&collection, 7u32, &recipient)
.expect("transfer failed");
assert_eq!(
runtime.owner_of(&collection, &7u32),
Some(recipient.clone())
);

runtime
.burn(&collection, 7u32, None::<&AccountIdFor<Runtime>>)
.expect("burn failed");
assert!(!runtime.item_exists(&collection, &7u32));
}
}
6 changes: 6 additions & 0 deletions crates/runtime/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,12 @@ pub use {
pallet_assets,
pallet_assets_precompiles,
pallet_balances,
pallet_nfts,
pallet_revive,
pallet_timestamp,
pallet_transaction_payment,
pallet_xcm,
pallet_xcm_precompiles,
paste,
scale,
sp_core::crypto::Ss58Codec,
Expand All @@ -64,6 +67,9 @@ pub use {
Extension,
},
sp_io::TestExternalities,
xcm,
xcm_builder,
xcm_executor,
};

pub use client::{
Expand Down
Loading
Loading