difftreelog
Merge pull request #411 from UniqueNetwork/feature/total_pieces
in: master
Add rpc method for total_pieces
11 files changed
client/rpc/src/lib.rsdiffbeforeafterboth191 at: Option<BlockHash>,192 at: Option<BlockHash>,192 ) -> Result<Option<CollectionLimits>>;193 ) -> Result<Option<CollectionLimits>>;194195 #[method(name = "unique_totalPieces")]196 fn total_pieces(197 &self,198 collection_id: CollectionId,199 token_id: TokenId,200 at: Option<BlockHash>,201 ) -> Result<Option<u128>>;193}202}194203195mod rmrk_unique_rpc {204mod rmrk_unique_rpc {463 pass_method!(collection_stats() -> CollectionStats, unique_api);472 pass_method!(collection_stats() -> CollectionStats, unique_api);464 pass_method!(next_sponsored(collection: CollectionId, account: CrossAccountId, token: TokenId) -> Option<u64>, unique_api);473 pass_method!(next_sponsored(collection: CollectionId, account: CrossAccountId, token: TokenId) -> Option<u64>, unique_api);465 pass_method!(effective_collection_limits(collection_id: CollectionId) -> Option<CollectionLimits>, unique_api);474 pass_method!(effective_collection_limits(collection_id: CollectionId) -> Option<CollectionLimits>, unique_api);475 pass_method!(total_pieces(collection_id: CollectionId, token_id: TokenId) -> Option<u128>, unique_api);466}476}467477468#[allow(deprecated)]478#[allow(deprecated)]pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -1384,6 +1384,8 @@
fn account_balance(&self, account: T::CrossAccountId) -> u32;
/// Amount of specific token account have (Applicable to fungible/refungible)
fn balance(&self, account: T::CrossAccountId, token: TokenId) -> u128;
+ /// Amount of token pieces
+ fn total_pieces(&self, token: TokenId) -> Option<u128>;
fn allowance(
&self,
sender: T::CrossAccountId,
pallets/fungible/src/common.rsdiffbeforeafterboth--- a/pallets/fungible/src/common.rs
+++ b/pallets/fungible/src/common.rs
@@ -25,7 +25,8 @@
use up_data_structs::{Property, PropertyKey, PropertyValue, PropertyKeyPermission};
use crate::{
- Allowance, Balance, Config, Error, FungibleHandle, Pallet, SelfWeightOf, weights::WeightInfo,
+ Allowance, TotalSupply, Balance, Config, Error, FungibleHandle, Pallet, SelfWeightOf,
+ weights::WeightInfo,
};
pub struct CommonWeights<T: Config>(PhantomData<T>);
@@ -405,4 +406,11 @@
fn refungible_extensions(&self) -> Option<&dyn RefungibleExtensions<T>> {
None
}
+
+ fn total_pieces(&self, token: TokenId) -> Option<u128> {
+ if token != TokenId::default() {
+ return None;
+ }
+ <TotalSupply<T>>::try_get(self.id).ok()
+ }
}
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -487,4 +487,12 @@
fn refungible_extensions(&self) -> Option<&dyn RefungibleExtensions<T>> {
None
}
+
+ fn total_pieces(&self, token: TokenId) -> Option<u128> {
+ if <TokenData<T>>::contains_key((self.id, token)) {
+ Some(1)
+ } else {
+ None
+ }
+ }
}
pallets/refungible/src/common.rsdiffbeforeafterboth--- a/pallets/refungible/src/common.rs
+++ b/pallets/refungible/src/common.rs
@@ -411,6 +411,10 @@
fn refungible_extensions(&self) -> Option<&dyn RefungibleExtensions<T>> {
Some(self)
}
+
+ fn total_pieces(&self, token: TokenId) -> Option<u128> {
+ <Pallet<T>>::total_pieces(self.id, token)
+ }
}
impl<T: Config> RefungibleExtensions<T> for RefungibleHandle<T> {
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -710,4 +710,8 @@
<TotalSupply<T>>::insert((collection.id, token), amount);
Ok(())
}
+
+ fn total_pieces(collection_id: CollectionId, token_id: TokenId) -> Option<u128> {
+ <TotalSupply<T>>::try_get((collection_id, token_id)).ok()
+ }
}
primitives/data-structs/src/lib.rsdiffbeforeafterboth--- a/primitives/data-structs/src/lib.rs
+++ b/primitives/data-structs/src/lib.rs
@@ -181,6 +181,7 @@
pub struct TokenData<CrossAccountId> {
pub properties: Vec<Property>,
pub owner: Option<CrossAccountId>,
+ pub pieces: u128,
}
pub struct OverflowError;
primitives/rpc/src/lib.rsdiffbeforeafterboth--- a/primitives/rpc/src/lib.rs
+++ b/primitives/rpc/src/lib.rs
@@ -80,5 +80,6 @@
fn collection_stats() -> Result<CollectionStats>;
fn next_sponsored(collection: CollectionId, account: CrossAccountId, token: TokenId) -> Result<Option<u64>>;
fn effective_collection_limits(collection_id: CollectionId) -> Result<Option<CollectionLimits>>;
+ fn total_pieces(collection_id: CollectionId, token_id: TokenId) -> Result<Option<u128>>;
}
}
runtime/common/src/runtime_apis.rsdiffbeforeafterboth--- a/runtime/common/src/runtime_apis.rs
+++ b/runtime/common/src/runtime_apis.rs
@@ -89,7 +89,8 @@
) -> Result<TokenData<CrossAccountId>, DispatchError> {
let token_data = TokenData {
properties: Self::token_properties(collection, token_id, keys)?,
- owner: Self::token_owner(collection, token_id)?
+ owner: Self::token_owner(collection, token_id)?,
+ pieces: Self::total_pieces(collection, token_id)?.unwrap_or(0),
};
Ok(token_data)
@@ -142,6 +143,10 @@
fn effective_collection_limits(collection: CollectionId) -> Result<Option<CollectionLimits>, DispatchError> {
Ok(<pallet_common::Pallet<Runtime>>::effective_collection_limits(collection))
}
+
+ fn total_pieces(collection: CollectionId, token_id: TokenId) -> Result<Option<u128>, DispatchError> {
+ dispatch_unique_runtime!(collection.total_pieces(token_id))
+ }
}
impl sp_api::Core<Block> for Runtime {
tests/src/createItem.test.tsdiffbeforeafterboth--- a/tests/src/createItem.test.ts
+++ b/tests/src/createItem.test.ts
@@ -24,6 +24,8 @@
createCollectionWithPropsExpectSuccess,
createItemWithPropsExpectSuccess,
createItemWithPropsExpectFailure,
+ createCollection,
+ transferExpectSuccess,
} from './util/helpers';
const expect = chai.expect;
@@ -95,6 +97,82 @@
await createItemWithPropsExpectSuccess(alice, newCollectionID, createMode, [{key: 'key1', value: 'val1'}]);
});
+
+ it('Check total pieces of Fungible token', async () => {
+ await usingApi(async api => {
+ const createMode = 'Fungible';
+ const collectionId = await createCollectionExpectSuccess({mode: {type: createMode, decimalPoints: 0}});
+ const amountPieces = 10n;
+ const tokenId = await createItemExpectSuccess(alice, collectionId, createMode, bob.address);
+ {
+ const totalPieces = await api.rpc.unique.totalPieces(collectionId, tokenId);
+ expect(totalPieces.isSome).to.be.true;
+ expect(totalPieces.unwrap().toBigInt()).to.be.eq(amountPieces);
+ }
+
+ await transferExpectSuccess(collectionId, tokenId, bob, alice, 1, createMode);
+ {
+ const totalPieces = await api.rpc.unique.totalPieces(collectionId, tokenId);
+ expect(totalPieces.isSome).to.be.true;
+ expect(totalPieces.unwrap().toBigInt()).to.be.eq(amountPieces);
+ }
+
+ const totalPieces = (await api.rpc.unique.tokenData(collectionId, tokenId, [])).pieces;
+ expect(totalPieces.isSome).to.be.true;
+ expect(totalPieces.unwrap().toBigInt()).to.be.eq(amountPieces);
+ });
+ });
+
+ it('Check total pieces of NFT token', async () => {
+ await usingApi(async api => {
+ const createMode = 'NFT';
+ const collectionId = await createCollectionExpectSuccess({mode: {type: createMode}});
+ const amountPieces = 1n;
+ const tokenId = await createItemExpectSuccess(alice, collectionId, createMode, bob.address);
+ {
+ const totalPieces = await api.rpc.unique.totalPieces(collectionId, tokenId);
+ expect(totalPieces.isSome).to.be.true;
+ expect(totalPieces.unwrap().toBigInt()).to.be.eq(amountPieces);
+ }
+
+ await transferExpectSuccess(collectionId, tokenId, bob, alice, 1, createMode);
+ {
+ const totalPieces = await api.rpc.unique.totalPieces(collectionId, tokenId);
+ expect(totalPieces.isSome).to.be.true;
+ expect(totalPieces.unwrap().toBigInt()).to.be.eq(amountPieces);
+ }
+
+ const totalPieces = (await api.rpc.unique.tokenData(collectionId, tokenId, [])).pieces;
+ expect(totalPieces.isSome).to.be.true;
+ expect(totalPieces.unwrap().toBigInt()).to.be.eq(amountPieces);
+ });
+ });
+
+ it('Check total pieces of ReFungible token', async () => {
+ await usingApi(async api => {
+ const createMode = 'ReFungible';
+ const createCollectionResult = await createCollection(api, alice, {mode: {type: createMode}});
+ const collectionId = createCollectionResult.collectionId;
+ const amountPieces = 100n;
+ const tokenId = await createItemExpectSuccess(alice, collectionId, createMode, bob.address);
+ {
+ const totalPieces = await api.rpc.unique.totalPieces(collectionId, tokenId);
+ expect(totalPieces.isSome).to.be.true;
+ expect(totalPieces.unwrap().toBigInt()).to.be.eq(amountPieces);
+ }
+
+ await transferExpectSuccess(collectionId, tokenId, bob, alice, 60n, createMode);
+ {
+ const totalPieces = await api.rpc.unique.totalPieces(collectionId, tokenId);
+ expect(totalPieces.isSome).to.be.true;
+ expect(totalPieces.unwrap().toBigInt()).to.be.eq(amountPieces);
+ }
+
+ const totalPieces = (await api.rpc.unique.tokenData(collectionId, tokenId, [])).pieces;
+ expect(totalPieces.isSome).to.be.true;
+ expect(totalPieces.unwrap().toBigInt()).to.be.eq(amountPieces);
+ });
+ });
});
describe('Negative integration test: ext. createItem():', () => {
@@ -169,4 +247,37 @@
await createItemWithPropsExpectFailure(alice, newCollectionID, 'NFT', [{key: 'k', value: 'vvvvvv'.repeat(5000)}, {key: 'k2', value: 'vvv'.repeat(5000)}]);
});
});
+
+ it('Check total pieces for invalid Fungible token', async () => {
+ await usingApi(async api => {
+ const createCollectionResult = await createCollection(api, alice, {mode: {type: 'Fungible', decimalPoints: 0}});
+ const collectionId = createCollectionResult.collectionId;
+ const invalidTokenId = 1000_000;
+
+ expect((await api.rpc.unique.totalPieces(collectionId, invalidTokenId)).isNone).to.be.true;
+ expect((await api.rpc.unique.tokenData(collectionId, invalidTokenId, [])).pieces.isNone).to.be.true;
+ });
+ });
+
+ it('Check total pieces for invalid NFT token', async () => {
+ await usingApi(async api => {
+ const createCollectionResult = await createCollection(api, alice, {mode: {type: 'NFT'}});
+ const collectionId = createCollectionResult.collectionId;
+ const invalidTokenId = 1000_000;
+
+ expect((await api.rpc.unique.totalPieces(collectionId, invalidTokenId)).isNone).to.be.true;
+ expect((await api.rpc.unique.tokenData(collectionId, invalidTokenId, [])).pieces.isNone).to.be.true;
+ });
+ });
+
+ it('Check total pieces for invalid Refungible token', async () => {
+ await usingApi(async api => {
+ const createCollectionResult = await createCollection(api, alice, {mode: {type: 'ReFungible'}});
+ const collectionId = createCollectionResult.collectionId;
+ const invalidTokenId = 1000_000;
+
+ expect((await api.rpc.unique.totalPieces(collectionId, invalidTokenId)).isNone).to.be.true;
+ expect((await api.rpc.unique.tokenData(collectionId, invalidTokenId, [])).pieces.isNone).to.be.true;
+ });
+ });
});
tests/src/interfaces/unique/definitions.tsdiffbeforeafterboth--- a/tests/src/interfaces/unique/definitions.ts
+++ b/tests/src/interfaces/unique/definitions.ts
@@ -79,5 +79,6 @@
allowed: fun('Check if user is allowed to use collection', [collectionParam, crossAccountParam()], 'bool'),
nextSponsored: fun('Get number of blocks when sponsored transaction is available', [collectionParam, crossAccountParam(), tokenParam], 'Option<u64>'),
effectiveCollectionLimits: fun('Get effective collection limits', [collectionParam], 'Option<UpDataStructsCollectionLimits>'),
+ totalPieces: fun('Get total pieces of token', [collectionParam, tokenParam], 'Option<u128>'),
},
};