git.delta.rocks / unique-network / refs/commits / 860bb39fe415

difftreelog

source

client/rpc/src/lib.rs15.5 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>>;187188	#[method(name = "unique_effectiveCollectionLimits")]189	fn effective_collection_limits(190		&self,191		collection_id: CollectionId,192		at: Option<BlockHash>,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<u128>;202}203204mod rmrk_unique_rpc {205	use super::*;206207	#[rpc(server)]208	#[async_trait]209	pub trait RmrkApi<210		BlockHash,211		AccountId,212		CollectionInfo,213		NftInfo,214		ResourceInfo,215		PropertyInfo,216		BaseInfo,217		PartType,218		Theme,219	>220	{221		#[method(name = "rmrk_lastCollectionIdx")]222		/// Get the latest created collection id223		fn last_collection_idx(&self, at: Option<BlockHash>) -> Result<RmrkCollectionId>;224225		#[method(name = "rmrk_collectionById")]226		/// Get collection by id227		fn collection_by_id(228			&self,229			id: RmrkCollectionId,230			at: Option<BlockHash>,231		) -> Result<Option<CollectionInfo>>;232233		#[method(name = "rmrk_nftById")]234		/// Get NFT by collection id and NFT id235		fn nft_by_id(236			&self,237			collection_id: RmrkCollectionId,238			nft_id: RmrkNftId,239			at: Option<BlockHash>,240		) -> Result<Option<NftInfo>>;241242		#[method(name = "rmrk_accountTokens")]243		/// Get tokens owned by an account in a collection244		fn account_tokens(245			&self,246			account_id: AccountId,247			collection_id: RmrkCollectionId,248			at: Option<BlockHash>,249		) -> Result<Vec<RmrkNftId>>;250251		#[method(name = "rmrk_nftChildren")]252		/// Get NFT children253		fn nft_children(254			&self,255			collection_id: RmrkCollectionId,256			nft_id: RmrkNftId,257			at: Option<BlockHash>,258		) -> Result<Vec<RmrkNftChild>>;259260		#[method(name = "rmrk_collectionProperties")]261		/// Get collection properties262		fn collection_properties(263			&self,264			collection_id: RmrkCollectionId,265			filter_keys: Option<Vec<String>>,266			at: Option<BlockHash>,267		) -> Result<Vec<PropertyInfo>>;268269		#[method(name = "rmrk_nftProperties")]270		/// Get NFT properties271		fn nft_properties(272			&self,273			collection_id: RmrkCollectionId,274			nft_id: RmrkNftId,275			filter_keys: Option<Vec<String>>,276			at: Option<BlockHash>,277		) -> Result<Vec<PropertyInfo>>;278279		#[method(name = "rmrk_nftResources")]280		/// Get NFT resources281		fn nft_resources(282			&self,283			collection_id: RmrkCollectionId,284			nft_id: RmrkNftId,285			at: Option<BlockHash>,286		) -> Result<Vec<ResourceInfo>>;287288		#[method(name = "rmrk_nftResourcePriority")]289		/// Get NFT resource priority290		fn nft_resource_priority(291			&self,292			collection_id: RmrkCollectionId,293			nft_id: RmrkNftId,294			resource_id: RmrkResourceId,295			at: Option<BlockHash>,296		) -> Result<Option<u32>>;297298		#[method(name = "rmrk_base")]299		/// Get base info300		fn base(&self, base_id: RmrkBaseId, at: Option<BlockHash>) -> Result<Option<BaseInfo>>;301302		#[method(name = "rmrk_baseParts")]303		/// Get all Base's parts304		fn base_parts(&self, base_id: RmrkBaseId, at: Option<BlockHash>) -> Result<Vec<PartType>>;305306		#[method(name = "rmrk_themeNames")]307		fn theme_names(308			&self,309			base_id: RmrkBaseId,310			at: Option<BlockHash>,311		) -> Result<Vec<RmrkThemeName>>;312313		#[method(name = "rmrk_themes")]314		fn theme(315			&self,316			base_id: RmrkBaseId,317			theme_name: String,318			filter_keys: Option<Vec<String>>,319			at: Option<BlockHash>,320		) -> Result<Option<Theme>>;321	}322}323324pub struct Unique<C, P> {325	client: Arc<C>,326	_marker: std::marker::PhantomData<P>,327}328329impl<C, P> Unique<C, P> {330	pub fn new(client: Arc<C>) -> Self {331		Self {332			client,333			_marker: Default::default(),334		}335	}336}337338pub struct Rmrk<C, P> {339	client: Arc<C>,340	_marker: std::marker::PhantomData<P>,341}342343impl<C, P> Rmrk<C, P> {344	pub fn new(client: Arc<C>) -> Self {345		Self {346			client,347			_marker: Default::default(),348		}349	}350}351352macro_rules! pass_method {353	(354		$method_name:ident(355			$($(#[map(|$map_arg:ident| $map:expr)])? $name:ident: $ty:ty),* $(,)?356		) -> $result:ty $(=> $mapper:expr)?,357		//$runtime_name:ident $(<$($lt: tt),+>)*358		$runtime_api_macro:ident359		$(; changed_in $ver:expr, $changed_method_name:ident ($($changed_name:expr), * $(,)?) => $fixer:expr)*360	) => {361		fn $method_name(362			&self,363			$(364				$name: $ty,365			)*366			at: Option<<Block as BlockT>::Hash>,367		) -> Result<$result> {368			let api = self.client.runtime_api();369			let at = BlockId::hash(at.unwrap_or_else(|| self.client.info().best_hash));370			let _api_version = if let Ok(Some(api_version)) =371				api.api_version::<$runtime_api_macro!()>(&at)372			{373				api_version374			} else {375				// unreachable for our runtime376				return Err(anyhow!("api is not available").into())377			};378379			let result = $(if _api_version < $ver {380				api.$changed_method_name(&at, $($changed_name),*).map(|r| r.map($fixer))381			} else)*382			{ api.$method_name(&at, $($((|$map_arg: $ty| $map))? ($name)),*) };383384			Ok(result385				.map_err(|e| anyhow!("unable to query: {e}"))?386				.map_err(|e| anyhow!("runtime error: {e:?}"))$(.map($mapper))??)387		}388	};389}390391macro_rules! unique_api {392	() => {393		dyn UniqueRuntimeApi<Block, CrossAccountId, AccountId>394	};395}396397macro_rules! rmrk_api {398	() => {399		dyn RmrkRuntimeApi<Block, AccountId, CollectionInfo, NftInfo, ResourceInfo, PropertyInfo, BaseInfo, PartType, Theme>400	};401}402403#[allow(deprecated)]404impl<C, Block, CrossAccountId, AccountId>405	UniqueApiServer<<Block as BlockT>::Hash, CrossAccountId, AccountId> for Unique<C, Block>406where407	Block: BlockT,408	AccountId: Decode,409	C: 'static + ProvideRuntimeApi<Block> + HeaderBackend<Block>,410	C::Api: UniqueRuntimeApi<Block, CrossAccountId, AccountId>,411	CrossAccountId: pallet_evm::account::CrossAccountId<AccountId>,412{413	pass_method!(414		account_tokens(collection: CollectionId, account: CrossAccountId) -> Vec<TokenId>, unique_api415	);416	pass_method!(417		collection_tokens(collection: CollectionId) -> Vec<TokenId>, unique_api418	);419	pass_method!(420		token_exists(collection: CollectionId, token: TokenId) -> bool, unique_api421	);422	pass_method!(423		token_owner(collection: CollectionId, token: TokenId) -> Option<CrossAccountId>, unique_api424	);425	pass_method!(426		topmost_token_owner(collection: CollectionId, token: TokenId) -> Option<CrossAccountId>, unique_api427	);428	pass_method!(token_children(collection: CollectionId, token: TokenId) -> Vec<TokenChild>, unique_api);429	pass_method!(total_supply(collection: CollectionId) -> u32, unique_api);430	pass_method!(account_balance(collection: CollectionId, account: CrossAccountId) -> u32, unique_api);431	pass_method!(balance(collection: CollectionId, account: CrossAccountId, token: TokenId) -> String => |v| v.to_string(), unique_api);432	pass_method!(433		allowance(collection: CollectionId, sender: CrossAccountId, spender: CrossAccountId, token: TokenId) -> String => |v| v.to_string(),434		unique_api435	);436437	pass_method!(collection_properties(438		collection: CollectionId,439440		#[map(|keys| string_keys_to_bytes_keys(keys))]441		keys: Option<Vec<String>>442	) -> Vec<Property>, unique_api);443444	pass_method!(token_properties(445		collection: CollectionId,446		token_id: TokenId,447448		#[map(|keys| string_keys_to_bytes_keys(keys))]449		keys: Option<Vec<String>>450	) -> Vec<Property>, unique_api);451452	pass_method!(property_permissions(453		collection: CollectionId,454455		#[map(|keys| string_keys_to_bytes_keys(keys))]456		keys: Option<Vec<String>>457	) -> Vec<PropertyKeyPermission>, unique_api);458459	pass_method!(token_data(460		collection: CollectionId,461		token_id: TokenId,462463		#[map(|keys| string_keys_to_bytes_keys(keys))]464		keys: Option<Vec<String>>,465	) -> TokenData<CrossAccountId>, unique_api);466467	pass_method!(adminlist(collection: CollectionId) -> Vec<CrossAccountId>, unique_api);468	pass_method!(allowlist(collection: CollectionId) -> Vec<CrossAccountId>, unique_api);469	pass_method!(allowed(collection: CollectionId, user: CrossAccountId) -> bool, unique_api);470	pass_method!(last_token_id(collection: CollectionId) -> TokenId, unique_api);471	pass_method!(collection_by_id(collection: CollectionId) -> Option<RpcCollection<AccountId>>, unique_api);472	pass_method!(collection_stats() -> CollectionStats, unique_api);473	pass_method!(next_sponsored(collection: CollectionId, account: CrossAccountId, token: TokenId) -> Option<u64>, 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) -> u128, unique_api);476}477478#[allow(deprecated)]479impl<480		C,481		Block,482		AccountId,483		CollectionInfo,484		NftInfo,485		ResourceInfo,486		PropertyInfo,487		BaseInfo,488		PartType,489		Theme,490	>491	rmrk_unique_rpc::RmrkApiServer<492		<Block as BlockT>::Hash,493		AccountId,494		CollectionInfo,495		NftInfo,496		ResourceInfo,497		PropertyInfo,498		BaseInfo,499		PartType,500		Theme,501	> for Rmrk<C, Block>502where503	C: Send + Sync + 'static + ProvideRuntimeApi<Block> + HeaderBackend<Block>,504	C::Api: RmrkRuntimeApi<505		Block,506		AccountId,507		CollectionInfo,508		NftInfo,509		ResourceInfo,510		PropertyInfo,511		BaseInfo,512		PartType,513		Theme,514	>,515	AccountId: Decode + Encode,516	CollectionInfo: Decode,517	NftInfo: Decode,518	ResourceInfo: Decode,519	PropertyInfo: Decode,520	BaseInfo: Decode,521	PartType: Decode,522	Theme: Decode,523	Block: BlockT,524{525	pass_method!(last_collection_idx() -> RmrkCollectionId, rmrk_api);526	pass_method!(collection_by_id(id: RmrkCollectionId) -> Option<CollectionInfo>, rmrk_api);527	pass_method!(nft_by_id(collection_id: RmrkCollectionId, nft_id: RmrkNftId) -> Option<NftInfo>, rmrk_api);528	pass_method!(account_tokens(account_id: AccountId, collection_id: RmrkCollectionId) -> Vec<RmrkNftId>, rmrk_api);529	pass_method!(nft_children(collection_id: RmrkCollectionId, nft_id: RmrkNftId) -> Vec<RmrkNftChild>, rmrk_api);530	pass_method!(531		collection_properties(532			collection_id: RmrkCollectionId,533534			#[map(|keys| string_keys_to_bytes_keys(keys))]535			filter_keys: Option<Vec<String>>536		) -> Vec<PropertyInfo>,537		rmrk_api538	);539	pass_method!(540		nft_properties(541			collection_id: RmrkCollectionId,542			nft_id: RmrkNftId,543544			#[map(|keys| string_keys_to_bytes_keys(keys))]545			filter_keys: Option<Vec<String>>546		) -> Vec<PropertyInfo>,547		rmrk_api548	);549	pass_method!(nft_resources(collection_id: RmrkCollectionId, nft_id: RmrkNftId) -> Vec<ResourceInfo>, rmrk_api);550	pass_method!(nft_resource_priority(collection_id: RmrkCollectionId, nft_id: RmrkNftId, resource_id: RmrkResourceId) -> Option<u32>, rmrk_api);551	pass_method!(base(base_id: RmrkBaseId) -> Option<BaseInfo>, rmrk_api);552	pass_method!(base_parts(base_id: RmrkBaseId) -> Vec<PartType>, rmrk_api);553	pass_method!(theme_names(base_id: RmrkBaseId) -> Vec<RmrkThemeName>, rmrk_api);554	pass_method!(555		theme(556			base_id: RmrkBaseId,557558			#[map(|n| n.into_bytes())]559			theme_name: String,560561			#[map(|keys| string_keys_to_bytes_keys(keys))]562			filter_keys: Option<Vec<String>>563		) -> Option<Theme>, rmrk_api);564}565566fn string_keys_to_bytes_keys(keys: Option<Vec<String>>) -> Option<Vec<Vec<u8>>> {567	keys.map(|keys| keys.into_iter().map(|key| key.into_bytes()).collect())568}