git.delta.rocks / unique-network / refs/commits / 5847eccaa1a7

difftreelog

source

client/rpc/src/lib.rs15.1 KiBsourcehistory
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617// Original License18use std::sync::Arc;1920use codec::{Decode, Encode};21use jsonrpsee::{22	core::{RpcResult as Result},23	proc_macros::rpc,24};25use anyhow::anyhow;26use up_data_structs::{27	RpcCollection, CollectionId, CollectionStats, CollectionLimits, TokenId, Property,28	PropertyKeyPermission, TokenData, TokenChild,29};30use sp_api::{BlockId, BlockT, ProvideRuntimeApi, ApiExt};31use sp_blockchain::HeaderBackend;32use up_rpc::UniqueApi as UniqueRuntimeApi;3334// RMRK35use rmrk_rpc::RmrkApi as RmrkRuntimeApi;36use up_data_structs::{37	RmrkCollectionId, RmrkNftId, RmrkBaseId, RmrkNftChild, RmrkThemeName, RmrkResourceId,38};3940pub use rmrk_unique_rpc::RmrkApiServer;4142#[rpc(server)]43#[async_trait]44pub trait UniqueApi<BlockHash, CrossAccountId, AccountId> {45	#[method(name = "unique_accountTokens")]46	fn account_tokens(47		&self,48		collection: CollectionId,49		account: CrossAccountId,50		at: Option<BlockHash>,51	) -> Result<Vec<TokenId>>;52	#[method(name = "unique_collectionTokens")]53	fn collection_tokens(54		&self,55		collection: CollectionId,56		at: Option<BlockHash>,57	) -> Result<Vec<TokenId>>;58	#[method(name = "unique_tokenExists")]59	fn token_exists(60		&self,61		collection: CollectionId,62		token: TokenId,63		at: Option<BlockHash>,64	) -> Result<bool>;6566	#[method(name = "unique_tokenOwner")]67	fn token_owner(68		&self,69		collection: CollectionId,70		token: TokenId,71		at: Option<BlockHash>,72	) -> Result<Option<CrossAccountId>>;73	#[method(name = "unique_topmostTokenOwner")]74	fn topmost_token_owner(75		&self,76		collection: CollectionId,77		token: TokenId,78		at: Option<BlockHash>,79	) -> Result<Option<CrossAccountId>>;80	#[method(name = "unique_tokenChildren")]81	fn token_children(82		&self,83		collection: CollectionId,84		token: TokenId,85		at: Option<BlockHash>,86	) -> Result<Vec<TokenChild>>;8788	#[method(name = "unique_collectionProperties")]89	fn collection_properties(90		&self,91		collection: CollectionId,92		keys: Option<Vec<String>>,93		at: Option<BlockHash>,94	) -> Result<Vec<Property>>;9596	#[method(name = "unique_tokenProperties")]97	fn token_properties(98		&self,99		collection: CollectionId,100		token_id: TokenId,101		keys: Option<Vec<String>>,102		at: Option<BlockHash>,103	) -> Result<Vec<Property>>;104105	#[method(name = "unique_propertyPermissions")]106	fn property_permissions(107		&self,108		collection: CollectionId,109		keys: Option<Vec<String>>,110		at: Option<BlockHash>,111	) -> Result<Vec<PropertyKeyPermission>>;112113	#[method(name = "unique_tokenData")]114	fn token_data(115		&self,116		collection: CollectionId,117		token_id: TokenId,118		keys: Option<Vec<String>>,119		at: Option<BlockHash>,120	) -> Result<TokenData<CrossAccountId>>;121122	#[method(name = "unique_totalSupply")]123	fn total_supply(&self, collection: CollectionId, at: Option<BlockHash>) -> Result<u32>;124	#[method(name = "unique_accountBalance")]125	fn account_balance(126		&self,127		collection: CollectionId,128		account: CrossAccountId,129		at: Option<BlockHash>,130	) -> Result<u32>;131	#[method(name = "unique_balance")]132	fn balance(133		&self,134		collection: CollectionId,135		account: CrossAccountId,136		token: TokenId,137		at: Option<BlockHash>,138	) -> Result<String>;139	#[method(name = "unique_allowance")]140	fn allowance(141		&self,142		collection: CollectionId,143		sender: CrossAccountId,144		spender: CrossAccountId,145		token: TokenId,146		at: Option<BlockHash>,147	) -> Result<String>;148149	#[method(name = "unique_adminlist")]150	fn adminlist(151		&self,152		collection: CollectionId,153		at: Option<BlockHash>,154	) -> Result<Vec<CrossAccountId>>;155	#[method(name = "unique_allowlist")]156	fn allowlist(157		&self,158		collection: CollectionId,159		at: Option<BlockHash>,160	) -> Result<Vec<CrossAccountId>>;161	#[method(name = "unique_allowed")]162	fn allowed(163		&self,164		collection: CollectionId,165		user: CrossAccountId,166		at: Option<BlockHash>,167	) -> Result<bool>;168	#[method(name = "unique_lastTokenId")]169	fn last_token_id(&self, collection: CollectionId, at: Option<BlockHash>) -> Result<TokenId>;170	#[method(name = "unique_collectionById")]171	fn collection_by_id(172		&self,173		collection: CollectionId,174		at: Option<BlockHash>,175	) -> Result<Option<RpcCollection<AccountId>>>;176	#[method(name = "unique_collectionStats")]177	fn collection_stats(&self, at: Option<BlockHash>) -> Result<CollectionStats>;178179	#[method(name = "unique_nextSponsored")]180	fn next_sponsored(181		&self,182		collection: CollectionId,183		account: CrossAccountId,184		token: TokenId,185		at: Option<BlockHash>,186	) -> Result<Option<u64>>;187	#[method(name = "unique_effectiveCollectionLimits")]188	fn effective_collection_limits(189		&self,190		collection_id: CollectionId,191		at: Option<BlockHash>,192	) -> Result<Option<CollectionLimits>>;193}194195mod rmrk_unique_rpc {196	use super::*;197198	#[rpc(server)]199	#[async_trait]200	pub trait RmrkApi<201		BlockHash,202		AccountId,203		CollectionInfo,204		NftInfo,205		ResourceInfo,206		PropertyInfo,207		BaseInfo,208		PartType,209		Theme,210	>211	{212		#[method(name = "rmrk_lastCollectionIdx")]213		/// Get the latest created collection id214		fn last_collection_idx(&self, at: Option<BlockHash>) -> Result<RmrkCollectionId>;215216		#[method(name = "rmrk_collectionById")]217		/// Get collection by id218		fn collection_by_id(219			&self,220			id: RmrkCollectionId,221			at: Option<BlockHash>,222		) -> Result<Option<CollectionInfo>>;223224		#[method(name = "rmrk_nftById")]225		/// Get NFT by collection id and NFT id226		fn nft_by_id(227			&self,228			collection_id: RmrkCollectionId,229			nft_id: RmrkNftId,230			at: Option<BlockHash>,231		) -> Result<Option<NftInfo>>;232233		#[method(name = "rmrk_accountTokens")]234		/// Get tokens owned by an account in a collection235		fn account_tokens(236			&self,237			account_id: AccountId,238			collection_id: RmrkCollectionId,239			at: Option<BlockHash>,240		) -> Result<Vec<RmrkNftId>>;241242		#[method(name = "rmrk_nftChildren")]243		/// Get NFT children244		fn nft_children(245			&self,246			collection_id: RmrkCollectionId,247			nft_id: RmrkNftId,248			at: Option<BlockHash>,249		) -> Result<Vec<RmrkNftChild>>;250251		#[method(name = "rmrk_collectionProperties")]252		/// Get collection properties253		fn collection_properties(254			&self,255			collection_id: RmrkCollectionId,256			filter_keys: Option<Vec<String>>,257			at: Option<BlockHash>,258		) -> Result<Vec<PropertyInfo>>;259260		#[method(name = "rmrk_nftProperties")]261		/// Get NFT properties262		fn nft_properties(263			&self,264			collection_id: RmrkCollectionId,265			nft_id: RmrkNftId,266			filter_keys: Option<Vec<String>>,267			at: Option<BlockHash>,268		) -> Result<Vec<PropertyInfo>>;269270		#[method(name = "rmrk_nftResources")]271		/// Get NFT resources272		fn nft_resources(273			&self,274			collection_id: RmrkCollectionId,275			nft_id: RmrkNftId,276			at: Option<BlockHash>,277		) -> Result<Vec<ResourceInfo>>;278279		#[method(name = "rmrk_nftResourcePriority")]280		/// Get NFT resource priority281		fn nft_resource_priority(282			&self,283			collection_id: RmrkCollectionId,284			nft_id: RmrkNftId,285			resource_id: RmrkResourceId,286			at: Option<BlockHash>,287		) -> Result<Option<u32>>;288289		#[method(name = "rmrk_base")]290		/// Get base info291		fn base(&self, base_id: RmrkBaseId, at: Option<BlockHash>) -> Result<Option<BaseInfo>>;292293		#[method(name = "rmrk_baseParts")]294		/// Get all Base's parts295		fn base_parts(&self, base_id: RmrkBaseId, at: Option<BlockHash>) -> Result<Vec<PartType>>;296297		#[method(name = "rmrk_themeNames")]298		fn theme_names(299			&self,300			base_id: RmrkBaseId,301			at: Option<BlockHash>,302		) -> Result<Vec<RmrkThemeName>>;303304		#[method(name = "rmrk_themes")]305		fn theme(306			&self,307			base_id: RmrkBaseId,308			theme_name: String,309			filter_keys: Option<Vec<String>>,310			at: Option<BlockHash>,311		) -> Result<Option<Theme>>;312	}313}314315pub struct Unique<C, P> {316	client: Arc<C>,317	_marker: std::marker::PhantomData<P>,318}319320impl<C, P> Unique<C, P> {321	pub fn new(client: Arc<C>) -> Self {322		Self {323			client,324			_marker: Default::default(),325		}326	}327}328329macro_rules! pass_method {330	(331		$method_name:ident(332			$($(#[map(|$map_arg:ident| $map:expr)])? $name:ident: $ty:ty),* $(,)?333		) -> $result:ty $(=> $mapper:expr)?,334		//$runtime_name:ident $(<$($lt: tt),+>)*335		$runtime_api_macro:ident336		$(; changed_in $ver:expr, $changed_method_name:ident ($($changed_name:expr), * $(,)?) => $fixer:expr)*337	) => {338		fn $method_name(339			&self,340			$(341				$name: $ty,342			)*343			at: Option<<Block as BlockT>::Hash>,344		) -> Result<$result> {345			let api = self.client.runtime_api();346			let at = BlockId::hash(at.unwrap_or_else(|| self.client.info().best_hash));347			let _api_version = if let Ok(Some(api_version)) =348				api.api_version::<$runtime_api_macro!()>(&at)349			{350				api_version351			} else {352				// unreachable for our runtime353				return Err(anyhow!("api is not available").into())354			};355356			let result = $(if _api_version < $ver {357				api.$changed_method_name(&at, $($changed_name),*).map(|r| r.map($fixer))358			} else)*359			{ api.$method_name(&at, $($((|$map_arg: $ty| $map))? ($name)),*) };360361			Ok(result362				.map_err(|e| anyhow!("unable to query: {e}"))?363				.map_err(|e| anyhow!("runtime error: {e:?}"))$(.map($mapper))??)364		}365	};366}367368macro_rules! unique_api {369	() => {370		dyn UniqueRuntimeApi<Block, CrossAccountId, AccountId>371	};372}373374macro_rules! rmrk_api {375	() => {376		dyn RmrkRuntimeApi<Block, AccountId, CollectionInfo, NftInfo, ResourceInfo, PropertyInfo, BaseInfo, PartType, Theme>377	};378}379380#[allow(deprecated)]381impl<C, Block, CrossAccountId, AccountId>382	UniqueApiServer<<Block as BlockT>::Hash, CrossAccountId, AccountId> for Unique<C, Block>383where384	Block: BlockT,385	AccountId: Decode,386	C: 'static + ProvideRuntimeApi<Block> + HeaderBackend<Block>,387	C::Api: UniqueRuntimeApi<Block, CrossAccountId, AccountId>,388	CrossAccountId: pallet_evm::account::CrossAccountId<AccountId>,389{390	pass_method!(391		account_tokens(collection: CollectionId, account: CrossAccountId) -> Vec<TokenId>, unique_api392	);393	pass_method!(394		collection_tokens(collection: CollectionId) -> Vec<TokenId>, unique_api395	);396	pass_method!(397		token_exists(collection: CollectionId, token: TokenId) -> bool, unique_api398	);399	pass_method!(400		token_owner(collection: CollectionId, token: TokenId) -> Option<CrossAccountId>, unique_api401	);402	pass_method!(403		topmost_token_owner(collection: CollectionId, token: TokenId) -> Option<CrossAccountId>, unique_api404	);405	pass_method!(token_children(collection: CollectionId, token: TokenId) -> Vec<TokenChild>, unique_api);406	pass_method!(total_supply(collection: CollectionId) -> u32, unique_api);407	pass_method!(account_balance(collection: CollectionId, account: CrossAccountId) -> u32, unique_api);408	pass_method!(balance(collection: CollectionId, account: CrossAccountId, token: TokenId) -> String => |v| v.to_string(), unique_api);409	pass_method!(410		allowance(collection: CollectionId, sender: CrossAccountId, spender: CrossAccountId, token: TokenId) -> String => |v| v.to_string(),411		unique_api412	);413414	pass_method!(collection_properties(415		collection: CollectionId,416417		#[map(|keys| string_keys_to_bytes_keys(keys))]418		keys: Option<Vec<String>>419	) -> Vec<Property>, unique_api);420421	pass_method!(token_properties(422		collection: CollectionId,423		token_id: TokenId,424425		#[map(|keys| string_keys_to_bytes_keys(keys))]426		keys: Option<Vec<String>>427	) -> Vec<Property>, unique_api);428429	pass_method!(property_permissions(430		collection: CollectionId,431432		#[map(|keys| string_keys_to_bytes_keys(keys))]433		keys: Option<Vec<String>>434	) -> Vec<PropertyKeyPermission>, unique_api);435436	pass_method!(token_data(437		collection: CollectionId,438		token_id: TokenId,439440		#[map(|keys| string_keys_to_bytes_keys(keys))]441		keys: Option<Vec<String>>,442	) -> TokenData<CrossAccountId>, unique_api);443444	pass_method!(adminlist(collection: CollectionId) -> Vec<CrossAccountId>, unique_api);445	pass_method!(allowlist(collection: CollectionId) -> Vec<CrossAccountId>, unique_api);446	pass_method!(allowed(collection: CollectionId, user: CrossAccountId) -> bool, unique_api);447	pass_method!(last_token_id(collection: CollectionId) -> TokenId, unique_api);448	pass_method!(collection_by_id(collection: CollectionId) -> Option<RpcCollection<AccountId>>, unique_api);449	pass_method!(collection_stats() -> CollectionStats, unique_api);450	pass_method!(next_sponsored(collection: CollectionId, account: CrossAccountId, token: TokenId) -> Option<u64>, unique_api);451	pass_method!(effective_collection_limits(collection_id: CollectionId) -> Option<CollectionLimits>, unique_api);452}453454#[allow(deprecated)]455impl<456		C,457		Block,458		AccountId,459		CollectionInfo,460		NftInfo,461		ResourceInfo,462		PropertyInfo,463		BaseInfo,464		PartType,465		Theme,466	>467	rmrk_unique_rpc::RmrkApiServer<468		<Block as BlockT>::Hash,469		AccountId,470		CollectionInfo,471		NftInfo,472		ResourceInfo,473		PropertyInfo,474		BaseInfo,475		PartType,476		Theme,477	> for Unique<C, Block>478where479	C: Send + Sync + 'static + ProvideRuntimeApi<Block> + HeaderBackend<Block>,480	C::Api: RmrkRuntimeApi<481		Block,482		AccountId,483		CollectionInfo,484		NftInfo,485		ResourceInfo,486		PropertyInfo,487		BaseInfo,488		PartType,489		Theme,490	>,491	AccountId: Decode + Encode,492	CollectionInfo: Decode,493	NftInfo: Decode,494	ResourceInfo: Decode,495	PropertyInfo: Decode,496	BaseInfo: Decode,497	PartType: Decode,498	Theme: Decode,499	Block: BlockT,500{501	pass_method!(last_collection_idx() -> RmrkCollectionId, rmrk_api);502	pass_method!(collection_by_id(id: RmrkCollectionId) -> Option<CollectionInfo>, rmrk_api);503	pass_method!(nft_by_id(collection_id: RmrkCollectionId, nft_id: RmrkNftId) -> Option<NftInfo>, rmrk_api);504	pass_method!(account_tokens(account_id: AccountId, collection_id: RmrkCollectionId) -> Vec<RmrkNftId>, rmrk_api);505	pass_method!(nft_children(collection_id: RmrkCollectionId, nft_id: RmrkNftId) -> Vec<RmrkNftChild>, rmrk_api);506	pass_method!(507		collection_properties(508			collection_id: RmrkCollectionId,509510			#[map(|keys| string_keys_to_bytes_keys(keys))]511			filter_keys: Option<Vec<String>>512		) -> Vec<PropertyInfo>,513		rmrk_api514	);515	pass_method!(516		nft_properties(517			collection_id: RmrkCollectionId,518			nft_id: RmrkNftId,519520			#[map(|keys| string_keys_to_bytes_keys(keys))]521			filter_keys: Option<Vec<String>>522		) -> Vec<PropertyInfo>,523		rmrk_api524	);525	pass_method!(nft_resources(collection_id: RmrkCollectionId, nft_id: RmrkNftId) -> Vec<ResourceInfo>, rmrk_api);526	pass_method!(nft_resource_priority(collection_id: RmrkCollectionId, nft_id: RmrkNftId, resource_id: RmrkResourceId) -> Option<u32>, rmrk_api);527	pass_method!(base(base_id: RmrkBaseId) -> Option<BaseInfo>, rmrk_api);528	pass_method!(base_parts(base_id: RmrkBaseId) -> Vec<PartType>, rmrk_api);529	pass_method!(theme_names(base_id: RmrkBaseId) -> Vec<RmrkThemeName>, rmrk_api);530	pass_method!(531		theme(532			base_id: RmrkBaseId,533534			#[map(|n| n.into_bytes())]535			theme_name: String,536537			#[map(|keys| string_keys_to_bytes_keys(keys))]538			filter_keys: Option<Vec<String>>539		) -> Option<Theme>, rmrk_api);540}541542fn string_keys_to_bytes_keys(keys: Option<Vec<String>>) -> Option<Vec<Vec<u8>>> {543	keys.map(|keys| keys.into_iter().map(|key| key.into_bytes()).collect())544}