git.delta.rocks / unique-network / refs/commits / da952fd3c8fb

difftreelog

source

client/rpc/src/lib.rs15.8 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>>;7374	#[method(name = "unique_tokenOwners")]75	fn token_owners(76		&self,77		collection: CollectionId,78		token: TokenId,79		at: Option<BlockHash>,80	) -> Result<Vec<CrossAccountId>>;8182	#[method(name = "unique_topmostTokenOwner")]83	fn topmost_token_owner(84		&self,85		collection: CollectionId,86		token: TokenId,87		at: Option<BlockHash>,88	) -> Result<Option<CrossAccountId>>;89	#[method(name = "unique_tokenChildren")]90	fn token_children(91		&self,92		collection: CollectionId,93		token: TokenId,94		at: Option<BlockHash>,95	) -> Result<Vec<TokenChild>>;9697	#[method(name = "unique_collectionProperties")]98	fn collection_properties(99		&self,100		collection: CollectionId,101		keys: Option<Vec<String>>,102		at: Option<BlockHash>,103	) -> Result<Vec<Property>>;104105	#[method(name = "unique_tokenProperties")]106	fn token_properties(107		&self,108		collection: CollectionId,109		token_id: TokenId,110		keys: Option<Vec<String>>,111		at: Option<BlockHash>,112	) -> Result<Vec<Property>>;113114	#[method(name = "unique_propertyPermissions")]115	fn property_permissions(116		&self,117		collection: CollectionId,118		keys: Option<Vec<String>>,119		at: Option<BlockHash>,120	) -> Result<Vec<PropertyKeyPermission>>;121122	#[method(name = "unique_tokenData")]123	fn token_data(124		&self,125		collection: CollectionId,126		token_id: TokenId,127		keys: Option<Vec<String>>,128		at: Option<BlockHash>,129	) -> Result<TokenData<CrossAccountId>>;130131	#[method(name = "unique_totalSupply")]132	fn total_supply(&self, collection: CollectionId, at: Option<BlockHash>) -> Result<u32>;133	#[method(name = "unique_accountBalance")]134	fn account_balance(135		&self,136		collection: CollectionId,137		account: CrossAccountId,138		at: Option<BlockHash>,139	) -> Result<u32>;140	#[method(name = "unique_balance")]141	fn balance(142		&self,143		collection: CollectionId,144		account: CrossAccountId,145		token: TokenId,146		at: Option<BlockHash>,147	) -> Result<String>;148	#[method(name = "unique_allowance")]149	fn allowance(150		&self,151		collection: CollectionId,152		sender: CrossAccountId,153		spender: CrossAccountId,154		token: TokenId,155		at: Option<BlockHash>,156	) -> Result<String>;157158	#[method(name = "unique_adminlist")]159	fn adminlist(160		&self,161		collection: CollectionId,162		at: Option<BlockHash>,163	) -> Result<Vec<CrossAccountId>>;164	#[method(name = "unique_allowlist")]165	fn allowlist(166		&self,167		collection: CollectionId,168		at: Option<BlockHash>,169	) -> Result<Vec<CrossAccountId>>;170	#[method(name = "unique_allowed")]171	fn allowed(172		&self,173		collection: CollectionId,174		user: CrossAccountId,175		at: Option<BlockHash>,176	) -> Result<bool>;177	#[method(name = "unique_lastTokenId")]178	fn last_token_id(&self, collection: CollectionId, at: Option<BlockHash>) -> Result<TokenId>;179	#[method(name = "unique_collectionById")]180	fn collection_by_id(181		&self,182		collection: CollectionId,183		at: Option<BlockHash>,184	) -> Result<Option<RpcCollection<AccountId>>>;185	#[method(name = "unique_collectionStats")]186	fn collection_stats(&self, at: Option<BlockHash>) -> Result<CollectionStats>;187188	#[method(name = "unique_nextSponsored")]189	fn next_sponsored(190		&self,191		collection: CollectionId,192		account: CrossAccountId,193		token: TokenId,194		at: Option<BlockHash>,195	) -> Result<Option<u64>>;196197	#[method(name = "unique_effectiveCollectionLimits")]198	fn effective_collection_limits(199		&self,200		collection_id: CollectionId,201		at: Option<BlockHash>,202	) -> Result<Option<CollectionLimits>>;203204	#[method(name = "unique_totalPieces")]205	fn total_pieces(206		&self,207		collection_id: CollectionId,208		token_id: TokenId,209		at: Option<BlockHash>,210	) -> Result<Option<u128>>;211}212213mod rmrk_unique_rpc {214	use super::*;215216	#[rpc(server)]217	#[async_trait]218	pub trait RmrkApi<219		BlockHash,220		AccountId,221		CollectionInfo,222		NftInfo,223		ResourceInfo,224		PropertyInfo,225		BaseInfo,226		PartType,227		Theme,228	>229	{230		#[method(name = "rmrk_lastCollectionIdx")]231		/// Get the latest created collection id232		fn last_collection_idx(&self, at: Option<BlockHash>) -> Result<RmrkCollectionId>;233234		#[method(name = "rmrk_collectionById")]235		/// Get collection by id236		fn collection_by_id(237			&self,238			id: RmrkCollectionId,239			at: Option<BlockHash>,240		) -> Result<Option<CollectionInfo>>;241242		#[method(name = "rmrk_nftById")]243		/// Get NFT by collection id and NFT id244		fn nft_by_id(245			&self,246			collection_id: RmrkCollectionId,247			nft_id: RmrkNftId,248			at: Option<BlockHash>,249		) -> Result<Option<NftInfo>>;250251		#[method(name = "rmrk_accountTokens")]252		/// Get tokens owned by an account in a collection253		fn account_tokens(254			&self,255			account_id: AccountId,256			collection_id: RmrkCollectionId,257			at: Option<BlockHash>,258		) -> Result<Vec<RmrkNftId>>;259260		#[method(name = "rmrk_nftChildren")]261		/// Get NFT children262		fn nft_children(263			&self,264			collection_id: RmrkCollectionId,265			nft_id: RmrkNftId,266			at: Option<BlockHash>,267		) -> Result<Vec<RmrkNftChild>>;268269		#[method(name = "rmrk_collectionProperties")]270		/// Get collection properties271		fn collection_properties(272			&self,273			collection_id: RmrkCollectionId,274			filter_keys: Option<Vec<String>>,275			at: Option<BlockHash>,276		) -> Result<Vec<PropertyInfo>>;277278		#[method(name = "rmrk_nftProperties")]279		/// Get NFT properties280		fn nft_properties(281			&self,282			collection_id: RmrkCollectionId,283			nft_id: RmrkNftId,284			filter_keys: Option<Vec<String>>,285			at: Option<BlockHash>,286		) -> Result<Vec<PropertyInfo>>;287288		#[method(name = "rmrk_nftResources")]289		/// Get NFT resources290		fn nft_resources(291			&self,292			collection_id: RmrkCollectionId,293			nft_id: RmrkNftId,294			at: Option<BlockHash>,295		) -> Result<Vec<ResourceInfo>>;296297		#[method(name = "rmrk_nftResourcePriority")]298		/// Get NFT resource priority299		fn nft_resource_priority(300			&self,301			collection_id: RmrkCollectionId,302			nft_id: RmrkNftId,303			resource_id: RmrkResourceId,304			at: Option<BlockHash>,305		) -> Result<Option<u32>>;306307		#[method(name = "rmrk_base")]308		/// Get base info309		fn base(&self, base_id: RmrkBaseId, at: Option<BlockHash>) -> Result<Option<BaseInfo>>;310311		#[method(name = "rmrk_baseParts")]312		/// Get all Base's parts313		fn base_parts(&self, base_id: RmrkBaseId, at: Option<BlockHash>) -> Result<Vec<PartType>>;314315		#[method(name = "rmrk_themeNames")]316		fn theme_names(317			&self,318			base_id: RmrkBaseId,319			at: Option<BlockHash>,320		) -> Result<Vec<RmrkThemeName>>;321322		#[method(name = "rmrk_themes")]323		fn theme(324			&self,325			base_id: RmrkBaseId,326			theme_name: String,327			filter_keys: Option<Vec<String>>,328			at: Option<BlockHash>,329		) -> Result<Option<Theme>>;330	}331}332333pub struct Unique<C, P> {334	client: Arc<C>,335	_marker: std::marker::PhantomData<P>,336}337338impl<C, P> Unique<C, P> {339	pub fn new(client: Arc<C>) -> Self {340		Self {341			client,342			_marker: Default::default(),343		}344	}345}346347pub struct Rmrk<C, P> {348	client: Arc<C>,349	_marker: std::marker::PhantomData<P>,350}351352impl<C, P> Rmrk<C, P> {353	pub fn new(client: Arc<C>) -> Self {354		Self {355			client,356			_marker: Default::default(),357		}358	}359}360361macro_rules! pass_method {362	(363		$method_name:ident(364			$($(#[map(|$map_arg:ident| $map:expr)])? $name:ident: $ty:ty),* $(,)?365		) -> $result:ty $(=> $mapper:expr)?,366		//$runtime_name:ident $(<$($lt: tt),+>)*367		$runtime_api_macro:ident368		$(; changed_in $ver:expr, $changed_method_name:ident ($($changed_name:expr), * $(,)?) => $fixer:expr)*369	) => {370		fn $method_name(371			&self,372			$(373				$name: $ty,374			)*375			at: Option<<Block as BlockT>::Hash>,376		) -> Result<$result> {377			let api = self.client.runtime_api();378			let at = BlockId::hash(at.unwrap_or_else(|| self.client.info().best_hash));379			let _api_version = if let Ok(Some(api_version)) =380				api.api_version::<$runtime_api_macro!()>(&at)381			{382				api_version383			} else {384				// unreachable for our runtime385				return Err(anyhow!("api is not available").into())386			};387388			let result = $(if _api_version < $ver {389				api.$changed_method_name(&at, $($changed_name),*).map(|r| r.map($fixer))390			} else)*391			{ api.$method_name(&at, $($((|$map_arg: $ty| $map))? ($name)),*) };392393			Ok(result394				.map_err(|e| anyhow!("unable to query: {e}"))?395				.map_err(|e| anyhow!("runtime error: {e:?}"))$(.map($mapper))??)396		}397	};398}399400macro_rules! unique_api {401	() => {402		dyn UniqueRuntimeApi<Block, CrossAccountId, AccountId>403	};404}405406macro_rules! rmrk_api {407	() => {408		dyn RmrkRuntimeApi<Block, AccountId, CollectionInfo, NftInfo, ResourceInfo, PropertyInfo, BaseInfo, PartType, Theme>409	};410}411412#[allow(deprecated)]413impl<C, Block, CrossAccountId, AccountId>414	UniqueApiServer<<Block as BlockT>::Hash, CrossAccountId, AccountId> for Unique<C, Block>415where416	Block: BlockT,417	AccountId: Decode,418	C: 'static + ProvideRuntimeApi<Block> + HeaderBackend<Block>,419	C::Api: UniqueRuntimeApi<Block, CrossAccountId, AccountId>,420	CrossAccountId: pallet_evm::account::CrossAccountId<AccountId>,421{422	pass_method!(423		account_tokens(collection: CollectionId, account: CrossAccountId) -> Vec<TokenId>, unique_api424	);425	pass_method!(426		collection_tokens(collection: CollectionId) -> Vec<TokenId>, unique_api427	);428	pass_method!(429		token_exists(collection: CollectionId, token: TokenId) -> bool, unique_api430	);431	pass_method!(432		token_owner(collection: CollectionId, token: TokenId) -> Option<CrossAccountId>, unique_api433	);434	pass_method!(435		topmost_token_owner(collection: CollectionId, token: TokenId) -> Option<CrossAccountId>, unique_api436	);437	pass_method!(token_children(collection: CollectionId, token: TokenId) -> Vec<TokenChild>, unique_api);438	pass_method!(total_supply(collection: CollectionId) -> u32, unique_api);439	pass_method!(account_balance(collection: CollectionId, account: CrossAccountId) -> u32, unique_api);440	pass_method!(balance(collection: CollectionId, account: CrossAccountId, token: TokenId) -> String => |v| v.to_string(), unique_api);441	pass_method!(442		allowance(collection: CollectionId, sender: CrossAccountId, spender: CrossAccountId, token: TokenId) -> String => |v| v.to_string(),443		unique_api444	);445446	pass_method!(collection_properties(447		collection: CollectionId,448449		#[map(|keys| string_keys_to_bytes_keys(keys))]450		keys: Option<Vec<String>>451	) -> Vec<Property>, unique_api);452453	pass_method!(token_properties(454		collection: CollectionId,455		token_id: TokenId,456457		#[map(|keys| string_keys_to_bytes_keys(keys))]458		keys: Option<Vec<String>>459	) -> Vec<Property>, unique_api);460461	pass_method!(property_permissions(462		collection: CollectionId,463464		#[map(|keys| string_keys_to_bytes_keys(keys))]465		keys: Option<Vec<String>>466	) -> Vec<PropertyKeyPermission>, unique_api);467468	pass_method!(token_data(469		collection: CollectionId,470		token_id: TokenId,471472		#[map(|keys| string_keys_to_bytes_keys(keys))]473		keys: Option<Vec<String>>,474	) -> TokenData<CrossAccountId>, unique_api);475476	pass_method!(adminlist(collection: CollectionId) -> Vec<CrossAccountId>, unique_api);477	pass_method!(allowlist(collection: CollectionId) -> Vec<CrossAccountId>, unique_api);478	pass_method!(allowed(collection: CollectionId, user: CrossAccountId) -> bool, unique_api);479	pass_method!(last_token_id(collection: CollectionId) -> TokenId, unique_api);480	pass_method!(collection_by_id(collection: CollectionId) -> Option<RpcCollection<AccountId>>, unique_api);481	pass_method!(collection_stats() -> CollectionStats, unique_api);482	pass_method!(next_sponsored(collection: CollectionId, account: CrossAccountId, token: TokenId) -> Option<u64>, unique_api);483	pass_method!(effective_collection_limits(collection_id: CollectionId) -> Option<CollectionLimits>, unique_api);484	pass_method!(total_pieces(collection_id: CollectionId, token_id: TokenId) -> Option<u128>, unique_api);485	pass_method!(token_owners(collection: CollectionId, token: TokenId) -> Vec<CrossAccountId>, unique_api);486}487488#[allow(deprecated)]489impl<490		C,491		Block,492		AccountId,493		CollectionInfo,494		NftInfo,495		ResourceInfo,496		PropertyInfo,497		BaseInfo,498		PartType,499		Theme,500	>501	rmrk_unique_rpc::RmrkApiServer<502		<Block as BlockT>::Hash,503		AccountId,504		CollectionInfo,505		NftInfo,506		ResourceInfo,507		PropertyInfo,508		BaseInfo,509		PartType,510		Theme,511	> for Rmrk<C, Block>512where513	C: Send + Sync + 'static + ProvideRuntimeApi<Block> + HeaderBackend<Block>,514	C::Api: RmrkRuntimeApi<515		Block,516		AccountId,517		CollectionInfo,518		NftInfo,519		ResourceInfo,520		PropertyInfo,521		BaseInfo,522		PartType,523		Theme,524	>,525	AccountId: Decode + Encode,526	CollectionInfo: Decode,527	NftInfo: Decode,528	ResourceInfo: Decode,529	PropertyInfo: Decode,530	BaseInfo: Decode,531	PartType: Decode,532	Theme: Decode,533	Block: BlockT,534{535	pass_method!(last_collection_idx() -> RmrkCollectionId, rmrk_api);536	pass_method!(collection_by_id(id: RmrkCollectionId) -> Option<CollectionInfo>, rmrk_api);537	pass_method!(nft_by_id(collection_id: RmrkCollectionId, nft_id: RmrkNftId) -> Option<NftInfo>, rmrk_api);538	pass_method!(account_tokens(account_id: AccountId, collection_id: RmrkCollectionId) -> Vec<RmrkNftId>, rmrk_api);539	pass_method!(nft_children(collection_id: RmrkCollectionId, nft_id: RmrkNftId) -> Vec<RmrkNftChild>, rmrk_api);540	pass_method!(541		collection_properties(542			collection_id: RmrkCollectionId,543544			#[map(|keys| string_keys_to_bytes_keys(keys))]545			filter_keys: Option<Vec<String>>546		) -> Vec<PropertyInfo>,547		rmrk_api548	);549	pass_method!(550		nft_properties(551			collection_id: RmrkCollectionId,552			nft_id: RmrkNftId,553554			#[map(|keys| string_keys_to_bytes_keys(keys))]555			filter_keys: Option<Vec<String>>556		) -> Vec<PropertyInfo>,557		rmrk_api558	);559	pass_method!(nft_resources(collection_id: RmrkCollectionId, nft_id: RmrkNftId) -> Vec<ResourceInfo>, rmrk_api);560	pass_method!(nft_resource_priority(collection_id: RmrkCollectionId, nft_id: RmrkNftId, resource_id: RmrkResourceId) -> Option<u32>, rmrk_api);561	pass_method!(base(base_id: RmrkBaseId) -> Option<BaseInfo>, rmrk_api);562	pass_method!(base_parts(base_id: RmrkBaseId) -> Vec<PartType>, rmrk_api);563	pass_method!(theme_names(base_id: RmrkBaseId) -> Vec<RmrkThemeName>, rmrk_api);564	pass_method!(565		theme(566			base_id: RmrkBaseId,567568			#[map(|n| n.into_bytes())]569			theme_name: String,570571			#[map(|keys| string_keys_to_bytes_keys(keys))]572			filter_keys: Option<Vec<String>>573		) -> Option<Theme>, rmrk_api);574}575576fn string_keys_to_bytes_keys(keys: Option<Vec<String>>) -> Option<Vec<Vec<u8>>> {577	keys.map(|keys| keys.into_iter().map(|key| key.into_bytes()).collect())578}