feat: api fungibles pallet

Cargo.toml

@@ -20,6 +20,7 @@ members = [
     "runtime/devnet",
     "runtime/testnet",
     "integration-tests",
+    "pallets/*",
     "primitives",
     "scripts/fund-dev-accounts",
 ]
@@ -51,10 +52,11 @@ substrate-wasm-builder = "18.0.1"
 substrate-build-script-utils = "11.0.0"
 
 # Local
+pallet-api = { path = "pallets/api", default-features = false }
 pop-runtime-devnet = { path = "runtime/devnet", default-features = true } # default-features=true required for `-p pop-node` builds
 pop-runtime-testnet = { path = "runtime/testnet", default-features = true } # default-features=true required for `-p pop-node` builds
 pop-runtime-common = { path = "runtime/common", default-features = false }
-pop-primitives = { path = "./primitives", default-features = false }
+primitives = { path = "./primitives", default-features = false }
 
 # Substrate
 sc-basic-authorship = "0.35.0"

pallets/api/Cargo.toml

@@ -0,0 +1,52 @@
+[package]
+name = "pallet-api"
+authors.workspace = true
+description = "Api pallet, enabling smart(er) contracts with the power of Polkadot"
+edition.workspace = true
+license.workspace = true
+version = "0.1.0"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+codec.workspace = true
+scale-info.workspace = true
+
+# Substrate
+frame-benchmarking.workspace = true
+frame-support.workspace = true
+frame-system.workspace = true
+pallet-assets.workspace = true
+primitives = { workspace = true, features = ["fungibles"] }
+sp-runtime.workspace = true
+
+[dev-dependencies]
+sp-core.workspace = true
+sp-io.workspace = true
+
+[features]
+default = ["std"]
+runtime-benchmarks = [
+    "frame-benchmarking/runtime-benchmarks",
+    "frame-support/runtime-benchmarks",
+    "frame-system/runtime-benchmarks",
+    "sp-runtime/runtime-benchmarks",
+]
+std = [
+    "codec/std",
+    "frame-benchmarking/std",
+    "frame-support/std",
+    "frame-system/std",
+    "pallet-assets/std",
+    "primitives/std",
+    "scale-info/std",
+    "sp-core/std",
+    "sp-io/std",
+    "sp-runtime/std",
+]
+try-runtime = [
+    "frame-support/try-runtime",
+    "frame-system/try-runtime",
+    "sp-runtime/try-runtime",
+]

pallets/api/src/fungibles/mod.rs

@@ -0,0 +1,122 @@
+#![cfg_attr(not(feature = "std"), no_std)]
+
+pub use pallet::*;
+
+#[cfg(test)]
+mod tests;
+
+#[frame_support::pallet]
+pub mod pallet {
+	use frame_support::{
+		dispatch::{DispatchResult, DispatchResultWithPostInfo, WithPostDispatchInfo},
+		pallet_prelude::*,
+		traits::fungibles::{
+			approvals::Inspect as ApprovalInspect, metadata::Inspect as MetadataInspect, Inspect,
+		},
+	};
+	use frame_system::pallet_prelude::*;
+	use pallet_assets::WeightInfo;
+	use sp_runtime::traits::StaticLookup;
+
+	use primitives::constants::fungibles::*;
+
+	type AccountIdOf<T> = <T as frame_system::Config>::AccountId;
+	type AssetIdOf<T> = <pallet_assets::Pallet<T, AssetsInstanceOf<T>> as Inspect<
+		<T as frame_system::Config>::AccountId,
+	>>::AssetId;
+	type AssetIdParameterOf<T> =
+		<T as pallet_assets::Config<AssetsInstanceOf<T>>>::AssetIdParameter;
+	type Assets<T> = pallet_assets::Pallet<T, AssetsInstanceOf<T>>;
+	type AssetsInstanceOf<T> = <T as Config>::AssetsInstance;
+	type AssetsWeightInfo<T> = <T as pallet_assets::Config<AssetsInstanceOf<T>>>::WeightInfo;
+	type BalanceOf<T> = <pallet_assets::Pallet<T, AssetsInstanceOf<T>> as Inspect<
+		<T as frame_system::Config>::AccountId,
+	>>::Balance;
+
+	/// The required input for state queries in pallet assets.
+	#[derive(Encode, Decode, Debug, MaxEncodedLen)]
+	#[repr(u8)]
+	#[allow(clippy::unnecessary_cast)]
+	pub enum Keys<T: Config> {
+		TotalSupply(AssetIdOf<T>) = TOTAL_SUPPLY,
+		BalanceOf(AssetIdOf<T>, AccountIdOf<T>) = BALANCE_OF,
+		Allowance(AssetIdOf<T>, AccountIdOf<T>, AccountIdOf<T>) = ALLOWANCE,
+		TokenName(AssetIdOf<T>) = TOKEN_NAME,
+		TokenSymbol(AssetIdOf<T>) = TOKEN_SYMBOL,
+		TokenDecimals(AssetIdOf<T>) = TOKEN_DECIMALS,
+	}
+
+	#[pallet::config]
+	pub trait Config: frame_system::Config + pallet_assets::Config<Self::AssetsInstance> {
+		type AssetsInstance;
+	}
+
+	#[pallet::pallet]
+	pub struct Pallet<T>(_);
+
+	#[pallet::call]
+	impl<T: Config> Pallet<T> {
+		#[pallet::call_index(9)]
+		#[pallet::weight(AssetsWeightInfo::<T>::transfer_keep_alive())]
+		pub fn transfer(
+			origin: OriginFor<T>,
+			id: AssetIdOf<T>,
+			target: AccountIdOf<T>,
+			amount: BalanceOf<T>,
+		) -> DispatchResult {
+			let target = T::Lookup::unlookup(target);
+			Assets::<T>::transfer_keep_alive(origin, id.into(), target, amount)
+		}
+
+		#[pallet::call_index(10)]
+		#[pallet::weight(AssetsWeightInfo::<T>::cancel_approval() + AssetsWeightInfo::<T>::approve_transfer())]
+		pub fn approve(
+			origin: OriginFor<T>,
+			id: AssetIdOf<T>,
+			spender: AccountIdOf<T>,
+			value: BalanceOf<T>,
+		) -> DispatchResultWithPostInfo {
+			let spender = T::Lookup::unlookup(spender);
+			let id: AssetIdParameterOf<T> = id.into();
+			Assets::<T>::cancel_approval(origin.clone(), id.clone(), spender.clone())
+				.map_err(|e| e.with_weight(AssetsWeightInfo::<T>::cancel_approval()))?;
+			Assets::<T>::approve_transfer(origin, id, spender, value).map_err(|e| {
+				e.with_weight(
+					AssetsWeightInfo::<T>::cancel_approval()
+						+ AssetsWeightInfo::<T>::approve_transfer(),
+				)
+			})?;
+			Ok(().into())
+		}
+	}
+
+	impl<T: Config> Pallet<T> {
+		pub fn total_supply(id: AssetIdOf<T>) -> BalanceOf<T> {
+			Assets::<T>::total_supply(id)
+		}
+
+		pub fn balance_of(id: AssetIdOf<T>, owner: &AccountIdOf<T>) -> BalanceOf<T> {
+			Assets::<T>::balance(id, owner)
+		}
+
+		pub fn allowance(
+			id: AssetIdOf<T>,
+			owner: &AccountIdOf<T>,
+			spender: &AccountIdOf<T>,
+		) -> BalanceOf<T> {
+			Assets::<T>::allowance(id, owner, spender)
+		}
+
+		pub fn token_name(id: AssetIdOf<T>) -> Vec<u8> {
+			<Assets<T> as MetadataInspect<AccountIdOf<T>>>::name(id)
+		}
+
+		pub fn token_symbol(id: AssetIdOf<T>) -> Vec<u8> {
+			<Assets<T> as MetadataInspect<AccountIdOf<T>>>::symbol(id)
+		}
+
+		pub fn token_decimals(id: AssetIdOf<T>) -> u8 {
+			<Assets<T> as MetadataInspect<AccountIdOf<T>>>::decimals(id)
+		}
+	}
+}

pallets/api/src/fungibles/tests.rs

@@ -0,0 +1,22 @@
+use crate::{mock::*, Error};
+use frame_support::{assert_noop, assert_ok};
+
+// https://docs.substrate.io/test/
+
+#[test]
+fn it_works_for_default_value() {
+	new_test_ext().execute_with(|| {
+		// Dispatch a signed extrinsic.
+		assert_ok!(fungibles::do_something(RuntimeOrigin::signed(1), 42));
+		// Read pallet storage and assert an expected result.
+		assert_eq!(fungibles::something(), Some(42));
+	});
+}
+
+#[test]
+fn correct_error_for_none_value() {
+	new_test_ext().execute_with(|| {
+		// Ensure the expected error is thrown when no value is present.
+		assert_noop!(fungibles::cause_error(RuntimeOrigin::signed(1)), Error::<Test>::NoneValue);
+	});
+}

pallets/api/src/lib.rs

@@ -0,0 +1,3 @@
+#![cfg_attr(not(feature = "std"), no_std)]
+
+pub mod fungibles;

pallets/api/src/mock.rs

@@ -0,0 +1,60 @@
+use frame_support::{parameter_types, traits::Everything};
+use frame_system as system;
+use sp_core::H256;
+use sp_runtime::{
+	traits::{BlakeTwo256, IdentityLookup},
+	BuildStorage,
+};
+
+type Block = frame_system::mocking::MockBlock<Test>;
+
+// Configure a mock runtime to test the pallet.
+frame_support::construct_runtime!(
+	pub enum Test
+	{
+		System: frame_system::{Pallet, Call, Config<T>, Storage, Event<T>},
+		fungibles: crate::{Pallet, Call, Storage, Event<T>},
+	}
+);
+
+parameter_types! {
+	pub const BlockHashCount: u64 = 250;
+	pub const SS58Prefix: u8 = 42;
+}
+
+#[derive_impl(frame_system::config_preludes::TestDefaultConfig)]
+impl system::Config for Test {
+	type BaseCallFilter = Everything;
+	type BlockWeights = ();
+	type BlockLength = ();
+	type DbWeight = ();
+	type RuntimeOrigin = RuntimeOrigin;
+	type RuntimeCall = RuntimeCall;
+	type Nonce = u64;
+	type Hash = H256;
+	type Hashing = BlakeTwo256;
+	type AccountId = u64;
+	type Lookup = IdentityLookup<Self::AccountId>;
+	type Block = Block;
+	type RuntimeEvent = RuntimeEvent;
+	type BlockHashCount = BlockHashCount;
+	type Version = ();
+	type PalletInfo = PalletInfo;
+	type AccountData = ();
+	type OnNewAccount = ();
+	type OnKilledAccount = ();
+	type SystemWeightInfo = ();
+	type SS58Prefix = SS58Prefix;
+	type OnSetCode = ();
+	type MaxConsumers = frame_support::traits::ConstU32<16>;
+}
+
+impl crate::Config for Test {
+	type RuntimeEvent = RuntimeEvent;
+	type WeightInfo = ();
+}
+
+// Build genesis storage according to the mock runtime.
+pub fn new_test_ext() -> sp_io::TestExternalities {
+	system::GenesisConfig::<Test>::default().build_storage().unwrap().into()
+}

pop-api/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pop-api"
-description = "Easily access the power of Polkadot via the Pop Network"
+description = "Enabling smart(er) contracts with the power of Polkadot"
 license = "GPL-3.0-only"
 version = "0.0.0"
 edition = "2021"
@@ -10,7 +10,7 @@ enumflags2 = { version = "0.7.7" }
 ink = { version = "5.0.0", default-features = false }
 sp-io = { version = "31.0.0", default-features = false, features = ["disable_panic_handler", "disable_oom", "disable_allocator"] }
 
-pop-primitives = { path = "../primitives", default-features = false }
+primitives = { path = "../primitives", default-features = false }
 
 [lib]
 name = "pop_api"
@@ -22,10 +22,7 @@ default = ["std"]
 std = [
     "enumflags2/std",
     "ink/std",
-    "pop-primitives/std",
+    "primitives/std",
     "sp-io/std",
 ]
-assets = ["pop-primitives/assets"]
-balances = []
-nfts = ["pop-primitives/nfts"]
-cross-chain = ["pop-primitives/cross-chain"]
+fungibles = ["primitives/fungibles"]