difftreelog
CORE-180. burnItem
in: master
9 files changed
pallets/nft/src/lib.rsdiffbeforeafterboth--- a/pallets/nft/src/lib.rs
+++ b/pallets/nft/src/lib.rs
@@ -987,12 +987,12 @@
/// * item_id: ID of NFT to burn.
#[weight = <SelfWeightOf<T>>::burn_item()]
#[transactional]
- pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, value: u128) -> DispatchResult {
+ pub fn burn_item(origin, collection_id: CollectionId, item_id: TokenId, item_owner: T::CrossAccountId, value: u128) -> DispatchResult {
let sender = T::CrossAccountId::from_sub(ensure_signed(origin)?);
let target_collection = Self::get_collection(collection_id)?;
- Self::burn_item_internal(&sender, &target_collection, item_id, value)?;
+ Self::burn_item_internal(&sender, &target_collection, item_id, &item_owner, value)?;
target_collection.submit_logs()
}
@@ -1596,6 +1596,7 @@
sender: &T::CrossAccountId,
collection: &CollectionHandle<T>,
item_id: TokenId,
+ item_owner: &T::CrossAccountId,
value: u128,
) -> DispatchResult {
ensure!(
@@ -1611,8 +1612,11 @@
match collection.mode {
CollectionMode::NFT => Self::burn_nft_item(collection, item_id)?,
- CollectionMode::Fungible(_) => Self::burn_fungible_item(sender, collection, value)?,
- CollectionMode::ReFungible => Self::burn_refungible_item(collection, item_id, sender)?,
+ CollectionMode::Fungible(_) => Self::burn_fungible_item(collection, item_owner, value)?,
+ CollectionMode::ReFungible => {
+ Self::burn_refungible_item(collection, item_id, item_owner)?
+ }
+ _ => (),
};
Ok(())
@@ -1947,8 +1951,8 @@
}
fn burn_fungible_item(
- owner: &T::CrossAccountId,
collection: &CollectionHandle<T>,
+ owner: &T::CrossAccountId,
value: u128,
) -> DispatchResult {
let collection_id = collection.id;
pallets/nft/src/tests.rsdiffbeforeafterboth--- a/pallets/nft/src/tests.rs
+++ b/pallets/nft/src/tests.rs
@@ -707,9 +707,15 @@
assert_eq!(TemplateModule::balance_count(1, 1), 1);
// burn item
- assert_ok!(TemplateModule::burn_item(origin1.clone(), 1, 1, 5));
+ assert_ok!(TemplateModule::burn_item(
+ origin1.clone(),
+ 1,
+ 1,
+ account(1),
+ 5
+ ));
assert_noop!(
- TemplateModule::burn_item(origin1, 1, 1, 5),
+ TemplateModule::burn_item(origin1, 1, 1, account(1), 5),
Error::<Test>::TokenNotFound
);
@@ -736,9 +742,15 @@
assert_eq!(TemplateModule::balance_count(1, 1), 5);
// burn item
- assert_ok!(TemplateModule::burn_item(origin1.clone(), 1, 1, 5));
+ assert_ok!(TemplateModule::burn_item(
+ origin1.clone(),
+ 1,
+ 1,
+ account(1),
+ 5
+ ));
assert_noop!(
- TemplateModule::burn_item(origin1, 1, 1, 5),
+ TemplateModule::burn_item(origin1, 1, 1, account(1), 5),
Error::<Test>::TokenValueNotEnough
);
@@ -781,9 +793,15 @@
assert_eq!(TemplateModule::balance_count(1, 1), 1023);
// burn item
- assert_ok!(TemplateModule::burn_item(origin1.clone(), 1, 1, 1023));
+ assert_ok!(TemplateModule::burn_item(
+ origin1.clone(),
+ 1,
+ 1,
+ account(1),
+ 1023
+ ));
assert_noop!(
- TemplateModule::burn_item(origin1, 1, 1, 1023),
+ TemplateModule::burn_item(origin1, 1, 1, account(1), 1023),
Error::<Test>::TokenNotFound
);
@@ -1378,7 +1396,7 @@
AccessMode::WhiteList
));
assert_noop!(
- TemplateModule::burn_item(origin1, 1, 1, 5),
+ TemplateModule::burn_item(origin1.clone(), 1, 1, account(1), 5),
Error::<Test>::AddresNotInWhiteList
);
});
tests/src/burnItem.test.tsdiffbeforeafterboth1//2// This file is subject to the terms and conditions defined in3// file 'LICENSE', which is part of this source code package.4//56import { default as usingApi, submitTransactionAsync, submitTransactionExpectFailAsync } from './substrate/substrate-api';7import { Keyring } from '@polkadot/api';8import { IKeyringPair } from '@polkadot/types/types';9import { 10 createCollectionExpectSuccess, 11 createItemExpectSuccess,12 getGenericResult,13 destroyCollectionExpectSuccess,14 normalizeAccountId,15 addCollectionAdminExpectSuccess,16} from './util/helpers';1718import chai from 'chai';19import chaiAsPromised from 'chai-as-promised';20chai.use(chaiAsPromised);21const expect = chai.expect;2223let alice: IKeyringPair;24let bob: IKeyringPair;2526describe('integration test: ext. burnItem():', () => {27 before(async () => {28 await usingApi(async () => {29 const keyring = new Keyring({ type: 'sr25519' });30 alice = keyring.addFromUri('//Alice');31 bob = keyring.addFromUri('//Bob');32 });33 });3435 it('Burn item in NFT collection', async () => {36 const createMode = 'NFT';37 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});38 const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);3940 await usingApi(async (api) => {41 const tx = api.tx.nft.burnItem(collectionId, tokenId, 0);42 const events = await submitTransactionAsync(alice, tx);43 const result = getGenericResult(events);44 // Get the item45 const item: any = (await api.query.nft.nftItemList(collectionId, tokenId)).toJSON();46 // What to expect47 // tslint:disable-next-line:no-unused-expression48 expect(result.success).to.be.true;49 // tslint:disable-next-line:no-unused-expression50 expect(item).to.be.null;51 });52 });5354 it('Burn item in Fungible collection', async () => {55 const createMode = 'Fungible';56 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode, decimalPoints: 0 }});57 await createItemExpectSuccess(alice, collectionId, createMode); // Helper creates 10 fungible tokens58 const tokenId = 0; // ignored5960 await usingApi(async (api) => {61 // Destroy 1 of 1062 const tx = api.tx.nft.burnItem(collectionId, tokenId, 1);63 const events = await submitTransactionAsync(alice, tx);64 const result = getGenericResult(events);65 66 // Get alice balance 67 const balance: any = (await api.query.nft.fungibleItemList(collectionId, alice.address)).toJSON();68 69 // What to expect70 expect(result.success).to.be.true;71 expect(balance).to.be.not.null;72 expect(balance.Value).to.be.equal(9);73 });74 });7576 it('Burn item in ReFungible collection', async () => {77 const createMode = 'ReFungible';78 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode }});79 const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);8081 await usingApi(async (api) => {82 const tx = api.tx.nft.burnItem(collectionId, tokenId, 1);83 const events = await submitTransactionAsync(alice, tx);84 const result = getGenericResult(events);85 86 // Get alice balance 87 const balance: any = (await api.query.nft.reFungibleItemList(collectionId, tokenId)).toJSON();88 89 // What to expect90 expect(result.success).to.be.true;91 expect(balance).to.be.null;92 });93 });9495 it('Burn owned portion of item in ReFungible collection', async () => {96 const createMode = 'ReFungible';97 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});98 const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);99100 await usingApi(async (api) => {101 // Transfer 1/100 of the token to Bob102 const transfertx = api.tx.nft.transfer(normalizeAccountId(bob.address), collectionId, tokenId, 1);103 const events1 = await submitTransactionAsync(alice, transfertx);104 const result1 = getGenericResult(events1);105106 // Get balances107 const balanceBefore: any = (await api.query.nft.reFungibleItemList(collectionId, tokenId)).toJSON();108109 // Bob burns his portion110 const tx = api.tx.nft.burnItem(collectionId, tokenId, 0);111 const events2 = await submitTransactionAsync(bob, tx);112 const result2 = getGenericResult(events2);113114 // Get balances 115 const balance: any = (await api.query.nft.reFungibleItemList(collectionId, tokenId)).toJSON();116 // console.log(balance);117 118 // What to expect before burning119 expect(result1.success).to.be.true;120 expect(balanceBefore).to.be.not.null;121 expect(balanceBefore.Owner.length).to.be.equal(2);122 expect(balanceBefore.Owner[0].Owner).to.be.deep.equal(normalizeAccountId(alice.address));123 expect(balanceBefore.Owner[0].Fraction).to.be.equal(99);124 expect(balanceBefore.Owner[1].Owner).to.be.deep.equal(normalizeAccountId(bob.address));125 expect(balanceBefore.Owner[1].Fraction).to.be.equal(1);126127 // What to expect after burning128 expect(result2.success).to.be.true;129 expect(balance).to.be.not.null;130 expect(balance.Owner.length).to.be.equal(1);131 expect(balance.Owner[0].Fraction).to.be.equal(99);132 expect(balance.Owner[0].Owner).to.be.deep.equal(normalizeAccountId(alice.address));133 });134135 });136137});138139describe('integration test: ext. burnItem() with admin permissions:', () => {140 before(async () => {141 await usingApi(async () => {142 const keyring = new Keyring({ type: 'sr25519' });143 alice = keyring.addFromUri('//Alice');144 bob = keyring.addFromUri('//Bob');145 });146 });147148 it('Burn item in NFT collection', async () => {149 const createMode = 'NFT';150 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});151 const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);152 await addCollectionAdminExpectSuccess(alice, collectionId, bob);153154 await usingApi(async (api) => {155 const tx = api.tx.nft.burnItem(collectionId, tokenId, 0);156 const events = await submitTransactionAsync(bob, tx);157 const result = getGenericResult(events);158 // Get the item159 const item: any = (await api.query.nft.nftItemList(collectionId, tokenId)).toJSON();160 // What to expect161 // tslint:disable-next-line:no-unused-expression162 expect(result.success).to.be.true;163 // tslint:disable-next-line:no-unused-expression164 expect(item).to.be.null;165 });166 });167});168169describe('Negative integration test: ext. burnItem():', () => {170 before(async () => {171 await usingApi(async () => {172 const keyring = new Keyring({ type: 'sr25519' });173 alice = keyring.addFromUri('//Alice');174 bob = keyring.addFromUri('//Bob');175 });176 });177178 it('Burn a token in a destroyed collection', async () => {179 const createMode = 'NFT';180 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode }});181 const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);182 await destroyCollectionExpectSuccess(collectionId);183184 await usingApi(async (api) => {185 const tx = api.tx.nft.burnItem(collectionId, tokenId, 0);186 const badTransaction = async function () { 187 await submitTransactionExpectFailAsync(alice, tx);188 };189 await expect(badTransaction()).to.be.rejected;190 });191192 });193194 it('Burn a token that was never created', async () => {195 const createMode = 'NFT';196 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode }});197 const tokenId = 10;198199 await usingApi(async (api) => {200 const tx = api.tx.nft.burnItem(collectionId, tokenId, 0);201 const badTransaction = async function () { 202 await submitTransactionExpectFailAsync(alice, tx);203 };204 await expect(badTransaction()).to.be.rejected;205 });206207 });208209 it('Burn a token using the address that does not own it', async () => {210 const createMode = 'NFT';211 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode }});212 const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);213214 await usingApi(async (api) => {215 const tx = api.tx.nft.burnItem(collectionId, tokenId, 0);216 const badTransaction = async function () { 217 await submitTransactionExpectFailAsync(bob, tx);218 };219 await expect(badTransaction()).to.be.rejected;220 });221222 });223224 it('Transfer a burned a token', async () => {225 const createMode = 'NFT';226 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode }});227 const tokenId = await createItemExpectSuccess(alice, collectionId, createMode);228229 await usingApi(async (api) => {230231 const burntx = api.tx.nft.burnItem(collectionId, tokenId, 0);232 const events1 = await submitTransactionAsync(alice, burntx);233 const result1 = getGenericResult(events1);234 expect(result1.success).to.be.true;235 236 const tx = api.tx.nft.transfer(normalizeAccountId(bob.address), collectionId, tokenId, 0);237 const badTransaction = async function () { 238 await submitTransactionExpectFailAsync(alice, tx);239 };240 await expect(badTransaction()).to.be.rejected;241 });242243 });244245 it('Burn more than owned in Fungible collection', async () => {246 const createMode = 'Fungible';247 const collectionId = await createCollectionExpectSuccess({mode: {type: createMode, decimalPoints: 0 }});248 // Helper creates 10 fungible tokens249 await createItemExpectSuccess(alice, collectionId, createMode);250 const tokenId = 0; // ignored251252 await usingApi(async (api) => {253 // Destroy 11 of 10254 const tx = api.tx.nft.burnItem(collectionId, tokenId, 11);255 const badTransaction = async function () { 256 await submitTransactionExpectFailAsync(alice, tx);257 };258 await expect(badTransaction()).to.be.rejected;259 260 // Get alice balance 261 const balance: any = (await api.query.nft.fungibleItemList(collectionId, alice.address)).toJSON();262 263 // What to expect264 expect(balance).to.be.not.null;265 expect(balance.Value).to.be.equal(10);266 });267268 });269270});tests/src/check-event/burnItemEvent.test.tsdiffbeforeafterboth--- a/tests/src/check-event/burnItemEvent.test.ts
+++ b/tests/src/check-event/burnItemEvent.test.ts
@@ -10,7 +10,7 @@
import chaiAsPromised from 'chai-as-promised';
import privateKey from '../substrate/privateKey';
import usingApi, {submitTransactionAsync} from '../substrate/substrate-api';
-import { createCollectionExpectSuccess, createItemExpectSuccess, nftEventMessage } from '../util/helpers';
+import { createCollectionExpectSuccess, createItemExpectSuccess, nftEventMessage, normalizeAccountId } from '../util/helpers';
chai.use(chaiAsPromised);
const expect = chai.expect;
@@ -29,7 +29,7 @@
await usingApi(async (api: ApiPromise) => {
const collectionID = await createCollectionExpectSuccess();
const itemID = await createItemExpectSuccess(Alice, collectionID, 'NFT');
- const burnItem = api.tx.nft.burnItem(collectionID, itemID, 1);
+ const burnItem = api.tx.nft.burnItem(collectionID, itemID, normalizeAccountId(Alice.address), 1);
const events = await submitTransactionAsync(Alice, burnItem);
const msg = JSON.stringify(nftEventMessage(events));
expect(msg).to.be.contain(checkSection);
tests/src/collision-tests/admVsOwnerTake.test.tsdiffbeforeafterboth--- a/tests/src/collision-tests/admVsOwnerTake.test.ts
+++ b/tests/src/collision-tests/admVsOwnerTake.test.ts
@@ -34,7 +34,7 @@
const itemId = await createItemExpectSuccess(Bob, collectionId, 'NFT');
//
const sendItem = api.tx.nft.transfer(normalizeAccountId(Ferdie.address), collectionId, itemId, 1);
- const burnItem = api.tx.nft.burnItem(collectionId, itemId, 1);
+ const burnItem = api.tx.nft.burnItem(collectionId, itemId, normalizeAccountId(Alice.address), 1);
await Promise.all([
sendItem.signAndSend(Bob),
burnItem.signAndSend(Alice),
tests/src/setVariableMetaData.test.tsdiffbeforeafterboth--- a/tests/src/setVariableMetaData.test.ts
+++ b/tests/src/setVariableMetaData.test.ts
@@ -116,7 +116,7 @@
it('fails on removed token', async () => {
const removedTokenCollectionId = await createCollectionExpectSuccess({ mode: { type: 'NFT' } });
const removedTokenId = await createItemExpectSuccess(alice, removedTokenCollectionId, 'NFT');
- await burnItemExpectSuccess(alice, removedTokenCollectionId, removedTokenId);
+ await burnItemExpectSuccess(alice, removedTokenCollectionId, removedTokenId, alice);
await setVariableMetaDataExpectFailure(alice, removedTokenCollectionId, removedTokenId, data);
});
tests/src/transfer.test.tsdiffbeforeafterboth--- a/tests/src/transfer.test.ts
+++ b/tests/src/transfer.test.ts
@@ -188,18 +188,18 @@
// nft
const nftCollectionId = await createCollectionExpectSuccess();
const newNftTokenId = await createItemExpectSuccess(Alice, nftCollectionId, 'NFT');
- await burnItemExpectSuccess(Alice, nftCollectionId, newNftTokenId, 1);
+ await burnItemExpectSuccess(Alice, nftCollectionId, newNftTokenId, Alice, 1);
await transferExpectFailure(nftCollectionId, newNftTokenId, Alice, Bob, 1);
// fungible
const fungibleCollectionId = await createCollectionExpectSuccess({mode: {type: 'Fungible', decimalPoints: 0}});
const newFungibleTokenId = await createItemExpectSuccess(Alice, fungibleCollectionId, 'Fungible');
- await burnItemExpectSuccess(Alice, fungibleCollectionId, newFungibleTokenId, 10);
+ await burnItemExpectSuccess(Alice, fungibleCollectionId, newFungibleTokenId, Alice, 10);
await transferExpectFailure(fungibleCollectionId, newFungibleTokenId, Alice, Bob, 1);
// reFungible
const reFungibleCollectionId = await
createCollectionExpectSuccess({mode: {type: 'ReFungible'}});
const newReFungibleTokenId = await createItemExpectSuccess(Alice, reFungibleCollectionId, 'ReFungible');
- await burnItemExpectSuccess(Alice, reFungibleCollectionId, newReFungibleTokenId, 1);
+ await burnItemExpectSuccess(Alice, reFungibleCollectionId, newReFungibleTokenId, Alice, 1);
await transferExpectFailure(
reFungibleCollectionId,
newReFungibleTokenId,
tests/src/transferFrom.test.tsdiffbeforeafterboth--- a/tests/src/transferFrom.test.ts
+++ b/tests/src/transferFrom.test.ts
@@ -246,7 +246,7 @@
// nft
const nftCollectionId = await createCollectionExpectSuccess();
const newNftTokenId = await createItemExpectSuccess(Alice, nftCollectionId, 'NFT');
- await burnItemExpectSuccess(Alice, nftCollectionId, newNftTokenId, 1);
+ await burnItemExpectSuccess(Alice, nftCollectionId, newNftTokenId, Alice, 1);
await approveExpectFail(nftCollectionId, newNftTokenId, Alice, Bob);
await transferFromExpectFail(nftCollectionId, newNftTokenId, Bob, Alice, Charlie, 1);
});
@@ -255,7 +255,7 @@
await usingApi(async () => {
const fungibleCollectionId = await createCollectionExpectSuccess({mode: {type: 'Fungible', decimalPoints: 0}});
const newFungibleTokenId = await createItemExpectSuccess(Alice, fungibleCollectionId, 'Fungible');
- await burnItemExpectSuccess(Alice, fungibleCollectionId, 1, 10);
+ await burnItemExpectSuccess(Alice, fungibleCollectionId, 1, Alice, 10);
await approveExpectSuccess(fungibleCollectionId, newFungibleTokenId, Alice, Bob);
await transferFromExpectFail(fungibleCollectionId, newFungibleTokenId, Bob, Alice, Charlie, 1);
@@ -265,7 +265,7 @@
await usingApi(async () => {
const reFungibleCollectionId = await createCollectionExpectSuccess({mode: {type: 'ReFungible'}});
const newReFungibleTokenId = await createItemExpectSuccess(Alice, reFungibleCollectionId, 'ReFungible');
- await burnItemExpectSuccess(Alice, reFungibleCollectionId, newReFungibleTokenId, 1);
+ await burnItemExpectSuccess(Alice, reFungibleCollectionId, newReFungibleTokenId, Alice, 1);
await approveExpectFail(reFungibleCollectionId, newReFungibleTokenId, Alice, Bob);
await transferFromExpectFail(reFungibleCollectionId, newReFungibleTokenId, Bob, Alice, Charlie, 1);
@@ -278,7 +278,7 @@
const nftCollectionId = await createCollectionExpectSuccess();
const newNftTokenId = await createItemExpectSuccess(Alice, nftCollectionId, 'NFT');
await approveExpectSuccess(nftCollectionId, newNftTokenId, Alice, Bob);
- await burnItemExpectSuccess(Alice, nftCollectionId, newNftTokenId, 1);
+ await burnItemExpectSuccess(Alice, nftCollectionId, newNftTokenId, Alice, 1);
await transferFromExpectFail(nftCollectionId, newNftTokenId, Bob, Alice, Charlie, 1);
});
});
@@ -287,7 +287,7 @@
const fungibleCollectionId = await createCollectionExpectSuccess({mode: {type: 'Fungible', decimalPoints: 0}});
const newFungibleTokenId = await createItemExpectSuccess(Alice, fungibleCollectionId, 'Fungible');
await approveExpectSuccess(fungibleCollectionId, newFungibleTokenId, Alice, Bob);
- await burnItemExpectSuccess(Alice, fungibleCollectionId, 1, 10);
+ await burnItemExpectSuccess(Alice, fungibleCollectionId, 1, Alice, 10);
await transferFromExpectFail(fungibleCollectionId, newFungibleTokenId, Bob, Alice, Charlie, 1);
});
@@ -297,7 +297,7 @@
const reFungibleCollectionId = await createCollectionExpectSuccess({mode: {type: 'ReFungible'}});
const newReFungibleTokenId = await createItemExpectSuccess(Alice, reFungibleCollectionId, 'ReFungible');
await approveExpectSuccess(reFungibleCollectionId, newReFungibleTokenId, Alice, Bob);
- await burnItemExpectSuccess(Alice, reFungibleCollectionId, newReFungibleTokenId, 1);
+ await burnItemExpectSuccess(Alice, reFungibleCollectionId, newReFungibleTokenId, Alice, 1);
await transferFromExpectFail(reFungibleCollectionId, newReFungibleTokenId, Bob, Alice, Charlie, 1);
});
tests/src/util/helpers.tsdiffbeforeafterboth--- a/tests/src/util/helpers.ts
+++ b/tests/src/util/helpers.ts
@@ -700,10 +700,10 @@
ReFungible: CreateReFungibleData;
};
-export async function burnItemExpectSuccess(owner: IKeyringPair, collectionId: number, tokenId: number, value = 0) {
+export async function burnItemExpectSuccess(sender: IKeyringPair, collectionId: number, tokenId: number, owner: IKeyringPair, value = 0) {
await usingApi(async (api) => {
- const tx = api.tx.nft.burnItem(collectionId, tokenId, value);
- const events = await submitTransactionAsync(owner, tx);
+ const tx = api.tx.nft.burnItem(collectionId, tokenId, normalizeAccountId(owner.address), value);
+ const events = await submitTransactionAsync(sender, tx);
const result = getGenericResult(events);
// Get the item
const item: any = (await api.query.nft.nftItemList(collectionId, tokenId)).toJSON();