difftreelog
Merge pull request #882 from UniqueNetwork/feature/app-promo-unstake-behaviour
in: master
Feature/app promo unstake behaviour
14 files changed
Cargo.lockdiffbeforeafterboth--- a/Cargo.lock
+++ b/Cargo.lock
@@ -5782,7 +5782,7 @@
[[package]]
name = "pallet-app-promotion"
-version = "0.1.4"
+version = "0.1.5"
dependencies = [
"frame-benchmarking",
"frame-support",
pallets/app-promotion/CHANGELOG.mddiffbeforeafterboth--- a/pallets/app-promotion/CHANGELOG.md
+++ b/pallets/app-promotion/CHANGELOG.md
@@ -4,6 +4,12 @@
<!-- bureaucrate goes here -->
+## [0.1.5] - 2023-02-14
+
+### Added
+
+- `unstake_partial` extrinsic.
+
## [0.1.4] - 2023-01-31
### Changed
pallets/app-promotion/Cargo.tomldiffbeforeafterboth--- a/pallets/app-promotion/Cargo.toml
+++ b/pallets/app-promotion/Cargo.toml
@@ -9,7 +9,7 @@
license = 'GPLv3'
name = 'pallet-app-promotion'
repository = 'https://github.com/UniqueNetwork/unique-chain'
-version = '0.1.4'
+version = '0.1.5'
[package.metadata.docs.rs]
targets = ['x86_64-unknown-linux-gnu']
pallets/app-promotion/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/app-promotion/src/benchmarking.rs
+++ b/pallets/app-promotion/src/benchmarking.rs
@@ -65,7 +65,7 @@
let staker = account::<T::AccountId>("staker", index, SEED);
<T as Config>::Currency::make_free_balance_be(&staker, Perbill::from_rational(1u32, 2) * BalanceOf::<T>::max_value());
PromototionPallet::<T>::stake(RawOrigin::Signed(staker.clone()).into(), Into::<BalanceOf<T>>::into(100u128) * T::Nominal::get())?;
- PromototionPallet::<T>::unstake(RawOrigin::Signed(staker.clone()).into()).map_err(|e| e.error)?;
+ PromototionPallet::<T>::unstake_all(RawOrigin::Signed(staker.clone()).into())?;
Result::<(), sp_runtime::DispatchError>::Ok(())
})?;
let block_number = <frame_system::Pallet<T>>::current_block_number() + T::PendingInterval::get();
@@ -115,7 +115,7 @@
let _ = <T as Config>::Currency::make_free_balance_be(&caller, Perbill::from_rational(1u32, 2) * BalanceOf::<T>::max_value());
} : _(RawOrigin::Signed(caller.clone()), share * <T as Config>::Currency::total_balance(&caller))
- unstake {
+ unstake_all {
let caller = account::<T::AccountId>("caller", 0, SEED);
let share = Perbill::from_rational(1u32, 20);
let _ = <T as Config>::Currency::make_free_balance_be(&caller, Perbill::from_rational(1u32, 2) * BalanceOf::<T>::max_value());
@@ -130,6 +130,21 @@
} : _(RawOrigin::Signed(caller.clone()))
+ unstake_partial {
+ let caller = account::<T::AccountId>("caller", 0, SEED);
+ let share = Perbill::from_rational(1u32, 20);
+ let _ = <T as Config>::Currency::make_free_balance_be(&caller, Perbill::from_rational(1u32, 2) * BalanceOf::<T>::max_value());
+ (1..11).map(|i| {
+ // used to change block number
+ <frame_system::Pallet<T>>::set_block_number(i.into());
+ T::RelayBlockNumberProvider::set_block_number((2*i).into());
+ assert_eq!(<frame_system::Pallet<T>>::block_number(), i.into());
+ assert_eq!(T::RelayBlockNumberProvider::current_block_number(), (2*i).into());
+ PromototionPallet::<T>::stake(RawOrigin::Signed(caller.clone()).into(), Into::<BalanceOf<T>>::into(100u128) * T::Nominal::get())
+ }).collect::<Result<Vec<_>, _>>()?;
+
+ } : _(RawOrigin::Signed(caller.clone()), Into::<BalanceOf<T>>::into(1000u128) * T::Nominal::get())
+
sponsor_collection {
let pallet_admin = account::<T::AccountId>("admin", 0, SEED);
PromototionPallet::<T>::set_admin_address(RawOrigin::Root.into(), T::CrossAccountId::from_sub(pallet_admin.clone()))?;
pallets/app-promotion/src/lib.rsdiffbeforeafterboth--- a/pallets/app-promotion/src/lib.rs
+++ b/pallets/app-promotion/src/lib.rs
@@ -72,7 +72,7 @@
traits::{
Currency, Get, LockableCurrency, WithdrawReasons, tokens::Balance, ExistenceRequirement,
},
- ensure,
+ ensure, BoundedVec,
};
use weights::WeightInfo;
@@ -156,7 +156,7 @@
pub struct Pallet<T>(_);
#[pallet::event]
- #[pallet::generate_deposit(fn deposit_event)]
+ #[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config> {
/// Staking recalculation was performed
///
@@ -208,6 +208,8 @@
SponsorNotSet,
/// Errors caused by incorrect actions with a locked balance.
IncorrectLockedBalanceOperation,
+ /// Errors caused by insufficient staked balance.
+ InsufficientStakedBalance,
}
/// Stores the total staked amount.
@@ -489,53 +491,30 @@
}
/// Unstakes all stakes.
- /// Moves the sum of all stakes to the `reserved` state.
/// After the end of `PendingInterval` this sum becomes completely
/// free for further use.
#[pallet::call_index(2)]
- #[pallet::weight(<T as Config>::WeightInfo::unstake())]
- pub fn unstake(staker: OriginFor<T>) -> DispatchResultWithPostInfo {
+ #[pallet::weight(<T as Config>::WeightInfo::unstake_all())]
+ pub fn unstake_all(staker: OriginFor<T>) -> DispatchResult {
let staker_id = ensure_signed(staker)?;
- let config = <PalletConfiguration<T>>::get();
- // calculate block number where the sum would be free
- let block = <frame_system::Pallet<T>>::block_number() + config.pending_interval;
+ Self::unstake_all_internal(staker_id)
+ }
- let mut pendings = <PendingUnstake<T>>::get(block);
-
- // checks that we can do unreserve stakes in the block
- ensure!(!pendings.is_full(), Error::<T>::PendingForBlockOverflow);
-
- let mut total_stakes = 0u64;
-
- let total_staked: BalanceOf<T> = Staked::<T>::drain_prefix((&staker_id,))
- .map(|(_, (amount, _))| {
- total_stakes += 1;
- amount
- })
- .sum();
+ /// Unstakes the amount of balance for the staker.
+ /// After the end of `PendingInterval` this sum becomes completely
+ /// free for further use.
+ ///
+ /// # Arguments
+ ///
+ /// * `staker`: staker account.
+ /// * `amount`: amount of unstaked funds.
+ #[pallet::call_index(8)]
+ #[pallet::weight(<T as Config>::WeightInfo::unstake_partial())]
+ pub fn unstake_partial(staker: OriginFor<T>, amount: BalanceOf<T>) -> DispatchResult {
+ let staker_id = ensure_signed(staker)?;
- if total_staked.is_zero() {
- return Ok(None::<Weight>.into()); // TO-DO
- }
-
- pendings
- .try_push((staker_id.clone(), total_staked))
- .map_err(|_| Error::<T>::PendingForBlockOverflow)?;
-
- <PendingUnstake<T>>::insert(block, pendings);
-
- TotalStaked::<T>::set(
- TotalStaked::<T>::get()
- .checked_sub(&total_staked)
- .ok_or(ArithmeticError::Underflow)?,
- );
-
- StakesPerAccount::<T>::remove(&staker_id);
-
- Self::deposit_event(Event::Unstake(staker_id, total_staked));
-
- Ok(None::<Weight>.into())
+ Self::unstake_partial_internal(staker_id, amount)
}
/// Sets the pallet to be the sponsor for the collection.
@@ -809,6 +788,100 @@
T::PalletId::get().into_account_truncating()
}
+ /// Unstakes the balance for the staker.
+ ///
+ /// - `staker`: staker account.
+ /// - `amount`: amount of unstaked funds.
+ fn unstake_partial_internal(
+ staker_id: T::AccountId,
+ unstaked_balance: BalanceOf<T>,
+ ) -> DispatchResult {
+ if unstaked_balance == Default::default() {
+ return Ok(());
+ }
+
+ let config = <PalletConfiguration<T>>::get();
+
+ // calculate block number where the sum would be free
+ let unpending_block = <frame_system::Pallet<T>>::block_number() + config.pending_interval;
+
+ let mut pendings = <PendingUnstake<T>>::get(unpending_block);
+
+ // checks that we can do unstake in the block
+ ensure!(!pendings.is_full(), Error::<T>::PendingForBlockOverflow);
+
+ let mut stakes = Staked::<T>::iter_prefix((&staker_id,)).collect::<Vec<_>>();
+
+ let total_staked = stakes
+ .iter()
+ .fold(<BalanceOf<T>>::default(), |acc, (_, (balance, _))| {
+ acc + *balance
+ });
+
+ ensure!(
+ unstaked_balance <= total_staked,
+ <Error<T>>::InsufficientStakedBalance
+ );
+
+ <TotalStaked<T>>::set(
+ <TotalStaked<T>>::get()
+ .checked_sub(&unstaked_balance)
+ .ok_or(ArithmeticError::Underflow)?,
+ );
+
+ stakes.sort_by_key(|(block, _)| *block);
+
+ let mut acc_amount = unstaked_balance;
+ let mut will_deleted_stakes_count = 0u8;
+
+ let changed_stakes = stakes
+ .into_iter()
+ .map_while(|(block, (balance_per_block, _))| {
+ if acc_amount == <BalanceOf<T>>::default() {
+ return None;
+ }
+ if acc_amount < balance_per_block {
+ let res = (block, balance_per_block - acc_amount);
+ acc_amount = <BalanceOf<T>>::default();
+ return Some(res);
+ } else {
+ acc_amount -= balance_per_block;
+ will_deleted_stakes_count += 1;
+ return Some((block, <BalanceOf<T>>::default()));
+ }
+ })
+ .collect::<Vec<_>>();
+
+ pendings
+ .try_push((staker_id.clone(), unstaked_balance))
+ .map_err(|_| Error::<T>::PendingForBlockOverflow)?;
+
+ StakesPerAccount::<T>::try_mutate(&staker_id, |stakes| -> DispatchResult {
+ *stakes = stakes
+ .checked_sub(will_deleted_stakes_count)
+ .ok_or(ArithmeticError::Underflow)?;
+ Ok(())
+ })?;
+
+ changed_stakes
+ .into_iter()
+ .for_each(|(staked_block, current_stake_state)| {
+ if current_stake_state == Default::default() {
+ <Staked<T>>::remove((&staker_id, staked_block));
+ } else {
+ <Staked<T>>::mutate((&staker_id, staked_block), |(old_stake_state, _)| {
+ *old_stake_state = current_stake_state
+ });
+ }
+ });
+
+ <PendingUnstake<T>>::insert(unpending_block, pendings);
+
+ Self::deposit_event(Event::Unstake(staker_id, total_staked));
+
+ Ok(())
+ }
+
/// Adds the balance to locked by the pallet.
///
/// - `staker`: staker account.
@@ -1005,4 +1078,47 @@
unsorted_res.sort_by_key(|(block, _)| *block);
unsorted_res
}
+
+ fn unstake_all_internal(staker_id: T::AccountId) -> DispatchResult {
+ let config = <PalletConfiguration<T>>::get();
+
+ // calculate block number where the sum would be free
+ let block = <frame_system::Pallet<T>>::block_number() + config.pending_interval;
+
+ let mut pendings = <PendingUnstake<T>>::get(block);
+
+ // checks that we can do unstake in the block
+ ensure!(!pendings.is_full(), Error::<T>::PendingForBlockOverflow);
+
+ let mut total_stakes = 0u64;
+
+ let total_staked: BalanceOf<T> = Staked::<T>::drain_prefix((&staker_id,))
+ .map(|(_, (amount, _))| {
+ total_stakes += 1;
+ amount
+ })
+ .sum();
+
+ if total_staked.is_zero() {
+ return Ok(());
+ }
+
+ pendings
+ .try_push((staker_id.clone(), total_staked))
+ .map_err(|_| Error::<T>::PendingForBlockOverflow)?;
+
+ <PendingUnstake<T>>::insert(block, pendings);
+
+ TotalStaked::<T>::set(
+ TotalStaked::<T>::get()
+ .checked_sub(&total_staked)
+ .ok_or(ArithmeticError::Underflow)?,
+ );
+
+ StakesPerAccount::<T>::remove(&staker_id);
+
+ Self::deposit_event(Event::Unstake(staker_id, total_staked));
+
+ Ok(())
+ }
}
pallets/app-promotion/src/weights.rsdiffbeforeafterboth--- a/pallets/app-promotion/src/weights.rs
+++ b/pallets/app-promotion/src/weights.rs
@@ -3,7 +3,7 @@
//! Autogenerated weights for pallet_app_promotion
//!
//! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 4.0.0-dev
-//! DATE: 2022-12-25, STEPS: `50`, REPEAT: 80, LOW RANGE: `[]`, HIGH RANGE: `[]`
+//! DATE: 2023-02-15, STEPS: `50`, REPEAT: 80, LOW RANGE: `[]`, HIGH RANGE: `[]`
//! EXECUTION: None, WASM-EXECUTION: Compiled, CHAIN: None, DB CACHE: 1024
// Executed Command:
@@ -38,7 +38,8 @@
fn set_admin_address() -> Weight;
fn payout_stakers(b: u32, ) -> Weight;
fn stake() -> Weight;
- fn unstake() -> Weight;
+ fn unstake_all() -> Weight;
+ fn unstake_partial() -> Weight;
fn sponsor_collection() -> Weight;
fn stop_sponsoring_collection() -> Weight;
fn sponsor_contract() -> Weight;
@@ -49,18 +50,19 @@
pub struct SubstrateWeight<T>(PhantomData<T>);
impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
// Storage: AppPromotion PendingUnstake (r:1 w:0)
+ // Storage: Balances Locks (r:1 w:1)
// Storage: System Account (r:1 w:1)
fn on_initialize(b: u32, ) -> Weight {
- Weight::from_ref_time(3_079_948 as u64)
- // Standard Error: 30_376
- .saturating_add(Weight::from_ref_time(6_343_630 as u64).saturating_mul(b as u64))
+ Weight::from_ref_time(2_592_346 as u64)
+ // Standard Error: 23_629
+ .saturating_add(Weight::from_ref_time(7_523_802 as u64).saturating_mul(b as u64))
.saturating_add(T::DbWeight::get().reads(1 as u64))
- .saturating_add(T::DbWeight::get().reads((1 as u64).saturating_mul(b as u64)))
- .saturating_add(T::DbWeight::get().writes((1 as u64).saturating_mul(b as u64)))
+ .saturating_add(T::DbWeight::get().reads((2 as u64).saturating_mul(b as u64)))
+ .saturating_add(T::DbWeight::get().writes((2 as u64).saturating_mul(b as u64)))
}
// Storage: AppPromotion Admin (r:0 w:1)
fn set_admin_address() -> Weight {
- Weight::from_ref_time(6_653_000 as u64)
+ Weight::from_ref_time(6_209_000 as u64)
.saturating_add(T::DbWeight::get().writes(1 as u64))
}
// Storage: AppPromotion Admin (r:1 w:0)
@@ -72,9 +74,9 @@
// Storage: Balances Locks (r:1 w:1)
// Storage: AppPromotion TotalStaked (r:1 w:1)
fn payout_stakers(b: u32, ) -> Weight {
- Weight::from_ref_time(74_048_000 as u64)
- // Standard Error: 33_223
- .saturating_add(Weight::from_ref_time(57_702_092 as u64).saturating_mul(b as u64))
+ Weight::from_ref_time(64_917_000 as u64)
+ // Standard Error: 34_206
+ .saturating_add(Weight::from_ref_time(51_518_500 as u64).saturating_mul(b as u64))
.saturating_add(T::DbWeight::get().reads(7 as u64))
.saturating_add(T::DbWeight::get().reads((12 as u64).saturating_mul(b as u64)))
.saturating_add(T::DbWeight::get().writes(3 as u64))
@@ -88,47 +90,55 @@
// Storage: AppPromotion Staked (r:1 w:1)
// Storage: AppPromotion TotalStaked (r:1 w:1)
fn stake() -> Weight {
- Weight::from_ref_time(20_314_000 as u64)
+ Weight::from_ref_time(18_208_000 as u64)
.saturating_add(T::DbWeight::get().reads(7 as u64))
.saturating_add(T::DbWeight::get().writes(5 as u64))
}
// Storage: Configuration AppPromomotionConfigurationOverride (r:1 w:0)
// Storage: AppPromotion PendingUnstake (r:1 w:1)
// Storage: AppPromotion Staked (r:11 w:10)
- // Storage: Balances Locks (r:1 w:1)
- // Storage: System Account (r:1 w:1)
// Storage: AppPromotion TotalStaked (r:1 w:1)
// Storage: AppPromotion StakesPerAccount (r:0 w:1)
- fn unstake() -> Weight {
- Weight::from_ref_time(64_582_000 as u64)
- .saturating_add(T::DbWeight::get().reads(16 as u64))
- .saturating_add(T::DbWeight::get().writes(15 as u64))
+ fn unstake_all() -> Weight {
+ Weight::from_ref_time(45_018_000 as u64)
+ .saturating_add(T::DbWeight::get().reads(14 as u64))
+ .saturating_add(T::DbWeight::get().writes(13 as u64))
+ }
+ // Storage: Configuration AppPromomotionConfigurationOverride (r:1 w:0)
+ // Storage: AppPromotion PendingUnstake (r:1 w:1)
+ // Storage: AppPromotion Staked (r:11 w:10)
+ // Storage: AppPromotion TotalStaked (r:1 w:1)
+ // Storage: AppPromotion StakesPerAccount (r:1 w:1)
+ fn unstake_partial() -> Weight {
+ Weight::from_ref_time(49_066_000 as u64)
+ .saturating_add(T::DbWeight::get().reads(15 as u64))
+ .saturating_add(T::DbWeight::get().writes(13 as u64))
}
// Storage: AppPromotion Admin (r:1 w:0)
// Storage: Common CollectionById (r:1 w:1)
fn sponsor_collection() -> Weight {
- Weight::from_ref_time(16_364_000 as u64)
+ Weight::from_ref_time(15_039_000 as u64)
.saturating_add(T::DbWeight::get().reads(2 as u64))
.saturating_add(T::DbWeight::get().writes(1 as u64))
}
// Storage: AppPromotion Admin (r:1 w:0)
// Storage: Common CollectionById (r:1 w:1)
fn stop_sponsoring_collection() -> Weight {
- Weight::from_ref_time(15_710_000 as u64)
+ Weight::from_ref_time(14_692_000 as u64)
.saturating_add(T::DbWeight::get().reads(2 as u64))
.saturating_add(T::DbWeight::get().writes(1 as u64))
}
// Storage: AppPromotion Admin (r:1 w:0)
// Storage: EvmContractHelpers Sponsoring (r:0 w:1)
fn sponsor_contract() -> Weight {
- Weight::from_ref_time(12_669_000 as u64)
+ Weight::from_ref_time(11_810_000 as u64)
.saturating_add(T::DbWeight::get().reads(1 as u64))
.saturating_add(T::DbWeight::get().writes(1 as u64))
}
// Storage: AppPromotion Admin (r:1 w:0)
// Storage: EvmContractHelpers Sponsoring (r:1 w:1)
fn stop_sponsoring_contract() -> Weight {
- Weight::from_ref_time(14_406_000 as u64)
+ Weight::from_ref_time(13_570_000 as u64)
.saturating_add(T::DbWeight::get().reads(2 as u64))
.saturating_add(T::DbWeight::get().writes(1 as u64))
}
@@ -137,18 +147,19 @@
// For backwards compatibility and tests
impl WeightInfo for () {
// Storage: AppPromotion PendingUnstake (r:1 w:0)
+ // Storage: Balances Locks (r:1 w:1)
// Storage: System Account (r:1 w:1)
fn on_initialize(b: u32, ) -> Weight {
- Weight::from_ref_time(3_079_948 as u64)
- // Standard Error: 30_376
- .saturating_add(Weight::from_ref_time(6_343_630 as u64).saturating_mul(b as u64))
+ Weight::from_ref_time(2_592_346 as u64)
+ // Standard Error: 23_629
+ .saturating_add(Weight::from_ref_time(7_523_802 as u64).saturating_mul(b as u64))
.saturating_add(RocksDbWeight::get().reads(1 as u64))
- .saturating_add(RocksDbWeight::get().reads((1 as u64).saturating_mul(b as u64)))
- .saturating_add(RocksDbWeight::get().writes((1 as u64).saturating_mul(b as u64)))
+ .saturating_add(RocksDbWeight::get().reads((2 as u64).saturating_mul(b as u64)))
+ .saturating_add(RocksDbWeight::get().writes((2 as u64).saturating_mul(b as u64)))
}
// Storage: AppPromotion Admin (r:0 w:1)
fn set_admin_address() -> Weight {
- Weight::from_ref_time(6_653_000 as u64)
+ Weight::from_ref_time(6_209_000 as u64)
.saturating_add(RocksDbWeight::get().writes(1 as u64))
}
// Storage: AppPromotion Admin (r:1 w:0)
@@ -160,9 +171,9 @@
// Storage: Balances Locks (r:1 w:1)
// Storage: AppPromotion TotalStaked (r:1 w:1)
fn payout_stakers(b: u32, ) -> Weight {
- Weight::from_ref_time(74_048_000 as u64)
- // Standard Error: 33_223
- .saturating_add(Weight::from_ref_time(57_702_092 as u64).saturating_mul(b as u64))
+ Weight::from_ref_time(64_917_000 as u64)
+ // Standard Error: 34_206
+ .saturating_add(Weight::from_ref_time(51_518_500 as u64).saturating_mul(b as u64))
.saturating_add(RocksDbWeight::get().reads(7 as u64))
.saturating_add(RocksDbWeight::get().reads((12 as u64).saturating_mul(b as u64)))
.saturating_add(RocksDbWeight::get().writes(3 as u64))
@@ -176,47 +187,55 @@
// Storage: AppPromotion Staked (r:1 w:1)
// Storage: AppPromotion TotalStaked (r:1 w:1)
fn stake() -> Weight {
- Weight::from_ref_time(20_314_000 as u64)
+ Weight::from_ref_time(18_208_000 as u64)
.saturating_add(RocksDbWeight::get().reads(7 as u64))
.saturating_add(RocksDbWeight::get().writes(5 as u64))
}
// Storage: Configuration AppPromomotionConfigurationOverride (r:1 w:0)
// Storage: AppPromotion PendingUnstake (r:1 w:1)
// Storage: AppPromotion Staked (r:11 w:10)
- // Storage: Balances Locks (r:1 w:1)
- // Storage: System Account (r:1 w:1)
// Storage: AppPromotion TotalStaked (r:1 w:1)
// Storage: AppPromotion StakesPerAccount (r:0 w:1)
- fn unstake() -> Weight {
- Weight::from_ref_time(64_582_000 as u64)
- .saturating_add(RocksDbWeight::get().reads(16 as u64))
- .saturating_add(RocksDbWeight::get().writes(15 as u64))
+ fn unstake_all() -> Weight {
+ Weight::from_ref_time(45_018_000 as u64)
+ .saturating_add(RocksDbWeight::get().reads(14 as u64))
+ .saturating_add(RocksDbWeight::get().writes(13 as u64))
}
+ // Storage: Configuration AppPromomotionConfigurationOverride (r:1 w:0)
+ // Storage: AppPromotion PendingUnstake (r:1 w:1)
+ // Storage: AppPromotion Staked (r:11 w:10)
+ // Storage: AppPromotion TotalStaked (r:1 w:1)
+ // Storage: AppPromotion StakesPerAccount (r:1 w:1)
+ fn unstake_partial() -> Weight {
+ Weight::from_ref_time(49_066_000 as u64)
+ .saturating_add(RocksDbWeight::get().reads(15 as u64))
+ .saturating_add(RocksDbWeight::get().writes(13 as u64))
+ }
// Storage: AppPromotion Admin (r:1 w:0)
// Storage: Common CollectionById (r:1 w:1)
fn sponsor_collection() -> Weight {
- Weight::from_ref_time(16_364_000 as u64)
+ Weight::from_ref_time(15_039_000 as u64)
.saturating_add(RocksDbWeight::get().reads(2 as u64))
.saturating_add(RocksDbWeight::get().writes(1 as u64))
}
// Storage: AppPromotion Admin (r:1 w:0)
// Storage: Common CollectionById (r:1 w:1)
fn stop_sponsoring_collection() -> Weight {
- Weight::from_ref_time(15_710_000 as u64)
+ Weight::from_ref_time(14_692_000 as u64)
.saturating_add(RocksDbWeight::get().reads(2 as u64))
.saturating_add(RocksDbWeight::get().writes(1 as u64))
}
// Storage: AppPromotion Admin (r:1 w:0)
// Storage: EvmContractHelpers Sponsoring (r:0 w:1)
fn sponsor_contract() -> Weight {
- Weight::from_ref_time(12_669_000 as u64)
+ Weight::from_ref_time(11_810_000 as u64)
.saturating_add(RocksDbWeight::get().reads(1 as u64))
.saturating_add(RocksDbWeight::get().writes(1 as u64))
}
// Storage: AppPromotion Admin (r:1 w:0)
// Storage: EvmContractHelpers Sponsoring (r:1 w:1)
fn stop_sponsoring_contract() -> Weight {
- Weight::from_ref_time(14_406_000 as u64)
+ Weight::from_ref_time(13_570_000 as u64)
.saturating_add(RocksDbWeight::get().reads(2 as u64))
.saturating_add(RocksDbWeight::get().writes(1 as u64))
}
pallets/nonfungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/benchmarking.rs
+++ b/pallets/nonfungible/src/benchmarking.rs
@@ -24,7 +24,10 @@
CommonCollectionOperations,
};
use sp_std::prelude::*;
-use up_data_structs::{CollectionMode, MAX_ITEMS_PER_BATCH, MAX_PROPERTIES_PER_ITEM, budget::Unlimited};
+use up_data_structs::{
+ CollectionMode, MAX_ITEMS_PER_BATCH, MAX_PROPERTIES_PER_ITEM, budget::Unlimited,
+ PropertyPermission,
+};
const SEED: u32 = 1;
pallets/refungible/src/benchmarking.rsdiffbeforeafterboth--- a/pallets/refungible/src/benchmarking.rs
+++ b/pallets/refungible/src/benchmarking.rs
@@ -25,7 +25,10 @@
benchmarking::{create_collection_raw, property_key, property_value},
};
use sp_std::prelude::*;
-use up_data_structs::{CollectionMode, MAX_ITEMS_PER_BATCH, MAX_PROPERTIES_PER_ITEM, budget::Unlimited};
+use up_data_structs::{
+ CollectionMode, MAX_ITEMS_PER_BATCH, MAX_PROPERTIES_PER_ITEM, budget::Unlimited,
+ PropertyPermission,
+};
const SEED: u32 = 1;
tests/src/sub/appPromotion/appPromotion.test.tsdiffbeforeafterboth--- a/tests/src/sub/appPromotion/appPromotion.test.ts
+++ b/tests/src/sub/appPromotion/appPromotion.test.ts
@@ -26,6 +26,13 @@
let nominal: bigint;
let palletAddress: string;
let accounts: IKeyringPair[];
+let usedAccounts: IKeyringPair[] = [];
+
+function getAccount(accountsNumber: number) {
+ const accs = accounts.splice(0, accountsNumber);
+ usedAccounts.push(...accs);
+ return accs;
+}
// App promotion periods:
// LOCKING_PERIOD = 12 blocks of relay
// UNLOCKING_PERIOD = 6 blocks of parachain
@@ -39,15 +46,29 @@
palletAdmin = await privateKey('//PromotionAdmin');
nominal = helper.balance.getOneTokenNominal();
- const accountBalances = new Array(100);
- accountBalances.fill(1000n);
+ const accountBalances = new Array(200).fill(1000n);
accounts = await helper.arrange.createAccounts(accountBalances, donor); // create accounts-pool to speed up tests
});
});
+ afterEach(async () => {
+ await usingPlaygrounds(async (helper) => {
+ let unstakeTxs = [];
+ for (const account of usedAccounts) {
+ if (unstakeTxs.length === 3) {
+ await Promise.all(unstakeTxs);
+ unstakeTxs = [];
+ }
+ unstakeTxs.push(helper.staking.unstakeAll(account));
+ }
+ await Promise.all(unstakeTxs);
+ usedAccounts = [];
+ });
+ });
+
describe('stake extrinsic', () => {
itSub('should "lock" staking balance, add it to "staked" map, and increase "totalStaked" amount', async ({helper}) => {
- const [staker, recepient] = [accounts.pop()!, accounts.pop()!];
+ const [staker, recepient] = getAccount(2);
const totalStakedBefore = await helper.staking.getTotalStaked();
// Minimum stake amount is 100:
@@ -73,26 +94,48 @@
expect(totalStakedPerBlock[1].amount).to.equal(200n * nominal);
});
- itSub('should allow to create maximum 10 stakes for account', async ({helper}) => {
- const [staker] = await helper.arrange.createAccounts([2000n], donor);
- for (let i = 0; i < 10; i++) {
- await helper.staking.stake(staker, 100n * nominal);
- }
+ [
+ {unstake: 'unstakeAll' as const},
+ {unstake: 'unstakePartial' as const},
+ ].map(testCase => {
+ itSub('should allow to create maximum 10 stakes for account', async ({helper}) => {
+ const [staker] = await helper.arrange.createAccounts([2000n], donor);
+ const ONE_STAKE = 100n * nominal;
+ for (let i = 0; i < 10; i++) {
+ await helper.staking.stake(staker, ONE_STAKE);
+ }
+
+ // can have 10 stakes
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(1000n * nominal);
+ expect(await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).to.have.length(10);
- // can have 10 stakes
- expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(1000n * nominal);
- expect(await helper.staking.getTotalStakedPerBlock({Substrate: staker.address})).to.have.length(10);
+ await expect(helper.staking.stake(staker, ONE_STAKE)).to.be.rejectedWith('appPromotion.NoPermission');
- await expect(helper.staking.stake(staker, 100n * nominal)).to.be.rejectedWith('appPromotion.NoPermission');
+ // After unstake can stake again
- // After unstake can stake again
- await helper.staking.unstake(staker);
- await helper.staking.stake(staker, 100n * nominal);
- expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.equal(100n * nominal);
+ // CASE 1: unstakeAll
+ if (testCase.unstake === 'unstakeAll') {
+ await helper.staking.unstakeAll(staker);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(0);
+ await helper.staking.stake(staker, 100n * nominal);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.equal(100n * nominal);
+ }
+ // CASE 2: unstakePartial
+ else {
+ await helper.staking.unstakePartial(staker, ONE_STAKE);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(9);
+ await helper.staking.stake(staker, 100n * nominal);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(10);
+ await expect(helper.staking.stake(staker, 100n * nominal)).to.be.rejectedWith('appPromotion.NoPermission');
+ await helper.staking.unstakePartial(staker, 150n * nominal);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(9);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.equal(850n * nominal);
+ }
+ });
});
itSub('should allow to stake() if balance is locked with different id', async ({helper}) => {
- const staker = accounts.pop()!;
+ const [staker] = getAccount(1);
// staker has tokens locked with vesting id:
await helper.balance.vestedTransfer(donor, staker.address, {start: 0n, period: 1n, periodCount: 1n, perPeriod: 200n * nominal});
@@ -109,7 +152,7 @@
expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.eq(1199n * nominal);
// staker can unstake
- await helper.staking.unstake(staker);
+ await helper.staking.unstakeAll(staker);
expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.eq(1199n * nominal);
const [pendingUnstake] = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
await helper.wait.forParachainBlockNumber(pendingUnstake.block);
@@ -125,7 +168,7 @@
});
itSub('should not allow to stake(), if stake amount is more than total free balance minus locked by staking', async ({helper}) => {
- const staker = accounts.pop()!;
+ const [staker] = getAccount(1);
// Can't stake full balance because Alice needs to pay some fee
await expect(helper.staking.stake(staker, 1000n * nominal)).to.be.rejected; // With('Arithmetic')
@@ -137,7 +180,7 @@
});
itSub('for different accounts in one block is possible', async ({helper}) => {
- const crowd = [accounts.pop()!, accounts.pop()!, accounts.pop()!, accounts.pop()!];
+ const crowd = getAccount(4);
const crowdStartsToStake = crowd.map(user => helper.staking.stake(user, 100n * nominal));
await expect(Promise.all(crowdStartsToStake)).to.be.fulfilled;
@@ -147,132 +190,271 @@
});
});
- describe('unstake extrinsic', () => {
- itSub('should move tokens to "pendingUnstake" map and subtract it from totalStaked', async ({helper}) => {
- const [staker, recepient] = [accounts.pop()!, accounts.pop()!];
- const totalStakedBefore = await helper.staking.getTotalStaked();
- await helper.staking.stake(staker, 900n * nominal);
- await helper.staking.unstake(staker);
+ describe('Unstaking', () => {
+ [
+ {method: 'unstakeAll' as const},
+ {method: 'unstakePartial' as const},
+ ].map(testCase => {
+ itSub(`[${testCase.method}] should move tokens to "pendingUnstake" and subtract it from totalStaked`, async ({helper}) => {
+ const [staker, recepient] = getAccount(2);
+ const totalStakedBefore = await helper.staking.getTotalStaked();
+ const STAKE_AMOUNT = 900n * nominal;
- // Right after unstake tokens are still locked
- expect(await helper.balance.getLocked(staker.address)).to.deep.eq([{id: 'appstake', amount: 900n * nominal, reasons: 'All'}]);
- expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, miscFrozen: 900n * nominal, feeFrozen: 900n * nominal});
- // Staker can not transfer
- await expect(helper.balance.transferToSubstrate(staker, recepient.address, 100n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions');
- expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(900n * nominal);
- expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);
- expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore);
+ await helper.staking.stake(staker, STAKE_AMOUNT);
+ testCase.method === 'unstakeAll'
+ ? await helper.staking.unstakeAll(staker)
+ : await helper.staking.unstakePartial(staker, STAKE_AMOUNT);
+
+ // Right after unstake tokens are still locked
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(0);
+ expect(await helper.balance.getLocked(staker.address)).to.deep.eq([{id: 'appstake', amount: STAKE_AMOUNT, reasons: 'All'}]);
+ expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, miscFrozen: STAKE_AMOUNT, feeFrozen: STAKE_AMOUNT});
+ // Staker can not transfer
+ await expect(helper.balance.transferToSubstrate(staker, recepient.address, 100n * nominal)).to.be.rejectedWith('balances.LiquidityRestrictions');
+ expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(STAKE_AMOUNT);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);
+ expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedBefore);
+ });
});
- itSub('should unlock balance after unlocking period ends and remove it from "pendingUnstake"', async ({helper}) => {
- const staker = accounts.pop()!;
- await helper.staking.stake(staker, 100n * nominal);
- await helper.staking.unstake(staker);
- const [pendingUnstake] = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
+ [
+ {method: 'unstakeAll' as const},
+ {method: 'unstakePartial' as const},
+ ].map(testCase => {
+ itSub(`[${testCase.method}] should unlock balance after unlocking period ends and remove it from "pendingUnstake"`, async ({helper}) => {
+ const [staker] = getAccount(1);
+ await helper.staking.stake(staker, 100n * nominal);
+ testCase.method === 'unstakeAll'
+ ? await helper.staking.unstakeAll(staker)
+ : await helper.staking.unstakePartial(staker, 100n * nominal);
+ const [pendingUnstake] = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
- // Wait for unstaking period. Balance now free ~1000; reserved, frozen, miscFrozeb: 0n
- await helper.wait.forParachainBlockNumber(pendingUnstake.block);
- expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, miscFrozen: 0n, feeFrozen: 0n});
- expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);
+ // Wait for unstaking period. Balance now free ~1000; reserved, frozen, miscFrozeb: 0n
+ await helper.wait.forParachainBlockNumber(pendingUnstake.block);
+ expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, miscFrozen: 0n, feeFrozen: 0n});
+ expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);
- // staker can transfer:
- await helper.balance.transferToSubstrate(staker, donor.address, 998n * nominal);
- expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(1n);
+ // staker can transfer:
+ await helper.balance.transferToSubstrate(staker, donor.address, 998n * nominal);
+ expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(1n);
+ });
});
- itSub('should successfully unstake multiple stakes', async ({helper}) => {
- const staker = accounts.pop()!;
- await helper.staking.stake(staker, 100n * nominal);
- await helper.staking.stake(staker, 200n * nominal);
- await helper.staking.stake(staker, 300n * nominal);
+ [
+ {method: 'unstakeAll' as const},
+ {method: 'unstakePartial' as const},
+ ].map(testCase => {
+ itSub(`[${testCase.method}] should successfully unstake multiple stakes`, async ({helper}) => {
+ const [staker] = getAccount(1);
+ await helper.staking.stake(staker, 100n * nominal);
+ await helper.staking.stake(staker, 200n * nominal);
+ await helper.staking.stake(staker, 300n * nominal);
+
+ // staked: [100, 200, 300]; unstaked: 0
+ let totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address});
+ let pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
+ let stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
+ expect(totalPendingUnstake).to.be.deep.equal(0n);
+ expect(pendingUnstake).to.be.deep.equal([]);
+ expect(stakes[0].amount).to.equal(100n * nominal);
+ expect(stakes[1].amount).to.equal(200n * nominal);
+ expect(stakes[2].amount).to.equal(300n * nominal);
- // staked: [100, 200, 300]; unstaked: 0
- let totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address});
- let pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
- let stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
- expect(totalPendingUnstake).to.be.deep.equal(0n);
- expect(pendingUnstake).to.be.deep.equal([]);
- expect(stakes[0].amount).to.equal(100n * nominal);
- expect(stakes[1].amount).to.equal(200n * nominal);
- expect(stakes[2].amount).to.equal(300n * nominal);
+ // Can unstake multiple stakes
+ testCase.method === 'unstakeAll'
+ ? await helper.staking.unstakeAll(staker)
+ : await helper.staking.unstakePartial(staker, 600n * nominal);
- // Can unstake multiple stakes
- await helper.staking.unstake(staker);
- pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
- totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address});
- stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
- expect(totalPendingUnstake).to.be.equal(600n * nominal);
- expect(stakes).to.be.deep.equal([]);
- expect(pendingUnstake[0].amount).to.equal(600n * nominal);
+ pendingUnstake = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
+ totalPendingUnstake = await helper.staking.getPendingUnstake({Substrate: staker.address});
+ stakes = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
+ expect(totalPendingUnstake).to.be.equal(600n * nominal);
+ expect(stakes).to.be.deep.equal([]);
+ expect(pendingUnstake[0].amount).to.equal(600n * nominal);
- expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, feeFrozen: 600n * nominal, miscFrozen: 600n * nominal});
- expect (await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);
- await helper.wait.forParachainBlockNumber(pendingUnstake[0].block);
- expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, feeFrozen: 0n, miscFrozen: 0n});
- expect (await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);
+ expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, feeFrozen: 600n * nominal, miscFrozen: 600n * nominal});
+ expect (await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);
+ await helper.wait.forParachainBlockNumber(pendingUnstake[0].block);
+ expect (await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, feeFrozen: 0n, miscFrozen: 0n});
+ expect (await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n);
+ });
});
- itSub('should not have any effects if no active stakes', async ({helper}) => {
- const staker = accounts.pop()!;
+ [
+ {method: 'unstakeAll' as const},
+ {method: 'unstakePartial' as const},
+ ].map(testCase => {
+ itSub(`[${testCase.method}] should not have any effects if no active stakes`, async ({helper}) => {
+ const [staker] = getAccount(1);
+
+ // unstake has no effect if no stakes at all
+ testCase.method === 'unstakeAll'
+ ? await helper.staking.unstakeAll(staker)
+ : await expect(helper.staking.unstakePartial(staker, 100n * nominal)).to.be.rejectedWith('appPromotion.InsufficientStakedBalance');
+
+ expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(0n);
+ expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); // TODO bigint closeTo helper
- // unstake has no effect if no stakes at all
- await helper.staking.unstake(staker);
- expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(0n);
- expect(await helper.balance.getSubstrate(staker.address) / nominal).to.be.equal(999n); // TODO bigint closeTo helper
+ // TODO stake() unstake() waitUnstaked() unstake();
- // TODO stake() unstake() waitUnstaked() unstake();
+ // can't unstake if there are only pendingUnstakes
+ await helper.staking.stake(staker, 100n * nominal);
- // can't unstake if there are only pendingUnstakes
- await helper.staking.stake(staker, 100n * nominal);
- await helper.staking.unstake(staker);
- await helper.staking.unstake(staker);
+ if (testCase.method === 'unstakeAll') {
+ await helper.staking.unstakeAll(staker);
+ await helper.staking.unstakeAll(staker);
+ } else {
+ await helper.staking.unstakePartial(staker, 100n * nominal);
+ await expect(helper.staking.unstakePartial(staker, 100n * nominal)).to.be.rejectedWith('appPromotion.InsufficientStakedBalance');
+ }
- expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal);
- expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(0);
+ expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);
+ });
});
- itSub('should keep different unlocking block for each unlocking stake', async ({helper}) => {
- const staker = accounts.pop()!;
- await helper.staking.stake(staker, 100n * nominal);
- await helper.staking.unstake(staker);
- await helper.staking.stake(staker, 120n * nominal);
- await helper.staking.unstake(staker);
+ [
+ {method: 'unstakeAll' as const},
+ {method: 'unstakePartial' as const},
+ ].map(testCase => {
+ itSub(`[${testCase.method}] should create different pending-unlock for each unlocking stake`, async ({helper}) => {
+ const [staker] = getAccount(1);
+ await helper.staking.stake(staker, 100n * nominal);
+ testCase.method === 'unstakeAll'
+ ? await helper.staking.unstakeAll(staker)
+ : await helper.staking.unstakePartial(staker, 100n * nominal);
+ await helper.staking.stake(staker, 120n * nominal);
+ testCase.method === 'unstakeAll'
+ ? await helper.staking.unstakeAll(staker)
+ : await helper.staking.unstakePartial(staker, 120n * nominal);
- const unstakingPerBlock = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
- expect(unstakingPerBlock).has.length(2);
- expect(unstakingPerBlock[0].amount).to.equal(100n * nominal);
- expect(unstakingPerBlock[1].amount).to.equal(120n * nominal);
+ const unstakingPerBlock = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
+ expect(unstakingPerBlock).has.length(2);
+ expect(unstakingPerBlock[0].amount).to.equal(100n * nominal);
+ expect(unstakingPerBlock[1].amount).to.equal(120n * nominal);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.equal(0);
+ });
});
- itSub('should be possible for 3 accounts in one block', async ({helper}) => {
- const stakers = [accounts.pop()!, accounts.pop()!, accounts.pop()!];
+ [
+ {method: 'unstakeAll' as const},
+ {method: 'unstakePartial' as const},
+ ].map(testCase => {
+ itSub(`[${testCase.method}] should be possible for 3 accounts in one block`, async ({helper}) => {
+ const stakers = getAccount(3);
- await Promise.all(stakers.map(staker => helper.staking.stake(staker, 100n * nominal)));
- await Promise.all(stakers.map(staker => helper.staking.unstake(staker)));
+ await Promise.all(stakers.map(staker => helper.staking.stake(staker, 100n * nominal)));
+ await Promise.all(stakers.map(staker => {
+ return testCase.method === 'unstakeAll'
+ ? helper.staking.unstakeAll(staker)
+ : helper.staking.unstakePartial(staker, 100n * nominal);
+ }));
- await Promise.all(stakers.map(async (staker) => {
- expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal);
- expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);
- }));
+ await Promise.all(stakers.map(async (staker) => {
+ expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.be.equal(100n * nominal);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.be.equal(0n);
+ }));
+ });
});
itSub('should not be possible for more than 3 accounts in one block', async ({helper}) => {
if (!await helper.arrange.isDevNode()) {
- const stakers = await helper.arrange.createAccounts([200n,200n,200n,200n,200n,200n,200n,200n,200n,200n], donor);
+ const stakers = getAccount(10);
await Promise.all(stakers.map(staker => helper.staking.stake(staker, 100n * nominal)));
- const unstakingResults = await Promise.allSettled(stakers.map(staker => helper.staking.unstake(staker)));
+ const unstakingResults = await Promise.allSettled(stakers.map((staker, i) => {
+ return i % 2 === 0
+ ? helper.staking.unstakeAll(staker)
+ : helper.staking.unstakePartial(staker, 100n * nominal);
+ }));
const successfulUnstakes = unstakingResults.filter(result => result.status === 'fulfilled');
expect(successfulUnstakes).to.have.length(3);
}
});
+
+ itSub('Cannot partially unstake more than staked', async ({helper}) => {
+ const [staker] = getAccount(1);
+ // Staker stakes 300:
+ await helper.staking.stake(staker, 100n * nominal);
+ await helper.staking.stake(staker, 200n * nominal);
+
+ // cannot usntake 300.00000...1
+ await expect(helper.staking.unstakePartial(staker, 300n * nominal + 1n)).to.be.rejectedWith('appPromotion.InsufficientStakedBalance');
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).eq(2);
+
+ await helper.staking.unstakePartial(staker, 150n * nominal);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).eq(1);
+ await expect(helper.staking.unstakePartial(staker, 150n * nominal + 1n)).to.be.rejectedWith('appPromotion.InsufficientStakedBalance');
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).eq(1);
+
+ // nothing broken, can unstake full amount:
+ await helper.staking.unstakePartial(staker, 150n * nominal);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).eq(0);
+ });
+
+ itSub('Can partially unstake arbitrary amount', async ({helper}) => {
+ const [staker] = getAccount(1);
+ await helper.staking.stake(staker, 100n * nominal);
+ await helper.staking.stake(staker, 200n * nominal);
+
+ // 0. Staker cannot unstake negative amount
+ await expect(helper.staking.unstakePartial(staker, -1n)).to.be.rejected;
+
+ // 1. Staker can unstake 0 wei
+ await helper.staking.unstakePartial(staker, 0n);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(2);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.eq(300n * nominal);
+ expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.eq(0n);
+
+ // 2. Staker can unstake 1 wei
+ await helper.staking.unstakePartial(staker, 1n);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(2);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.eq(300n * nominal - 1n);
+ expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.eq(1n);
+ // 2.1 The oldest stake decreased:
+ let [stake1, stake2] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
+ expect(stake1.amount).to.eq(100n * nominal - 1n);
+ expect(stake2.amount).to.eq(200n * nominal);
+
+ // 3. Staker can unstake all but 1 wei
+ await helper.staking.unstakePartial(staker, 100n * nominal - 2n);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(2);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.eq(200n * nominal + 1n);
+ expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.eq(100n * nominal - 1n);
+ [stake1, stake2] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
+ expect(stake1.amount).to.eq(1n);
+ expect(stake2.amount).to.eq(200n * nominal);
+ });
+
+ itSub('can mix different type of unstakes', async ({helper}) => {
+ const [staker] = getAccount(1);
+ await helper.staking.stake(staker, 100n * nominal);
+ await helper.staking.stake(staker, 200n * nominal);
+
+ await helper.staking.unstakePartial(staker, 50n * nominal);
+ await helper.staking.unstakeAll(staker);
+ expect(await helper.staking.getStakesNumber({Substrate: staker.address})).to.eq(0);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.eq(0n);
+ expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.eq(300n * nominal);
+
+ const [_unstake1, unstake2] = await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address});
+ await helper.wait.forParachainBlockNumber(unstake2.block);
+
+ expect(await helper.balance.getLocked(staker.address)).to.deep.eq([]);
+ expect(await helper.balance.getSubstrateFull(staker.address)).to.deep.contain({reserved: 0n, miscFrozen: 0n, feeFrozen: 0n});
+ expect(await helper.balance.getSubstrate(staker.address) / nominal).to.eq(999n);
+ expect(await helper.staking.getTotalStaked({Substrate: staker.address})).to.eq(0n);
+ expect(await helper.staking.getPendingUnstake({Substrate: staker.address})).to.eq(0n);
+ expect(await helper.staking.getPendingUnstakePerBlock({Substrate: staker.address})).to.deep.eq([]);
+ });
});
describe('collection sponsoring', () => {
itSub('should actually sponsor transactions', async ({helper}) => {
const api = helper.getApi();
- const [collectionOwner, tokenSender, receiver] = [accounts.pop()!, accounts.pop()!, accounts.pop()!];
+ const [collectionOwner, tokenSender, receiver] = getAccount(3);
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'Name', description: 'Description', tokenPrefix: 'Prefix', limits: {sponsorTransferTimeout: 0}});
const token = await collection.mintToken(collectionOwner, {Substrate: tokenSender.address});
await helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId));
@@ -289,7 +471,7 @@
itSub('can not be set by non admin', async ({helper}) => {
const api = helper.getApi();
- const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!];
+ const [collectionOwner, nonAdmin] = getAccount(2);
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
@@ -299,7 +481,7 @@
itSub('should set pallet address as confirmed admin', async ({helper}) => {
const api = helper.getApi();
- const [collectionOwner, oldSponsor] = [accounts.pop()!, accounts.pop()!];
+ const [collectionOwner, oldSponsor] = getAccount(2);
// Can set sponsoring for collection without sponsor
const collectionWithoutSponsor = await helper.nft.mintCollection(collectionOwner, {name: 'No-sponsor', description: 'New Collection', tokenPrefix: 'Promotion'});
@@ -321,7 +503,7 @@
itSub('can be overwritten by collection owner', async ({helper}) => {
const api = helper.getApi();
- const [collectionOwner, newSponsor] = [accounts.pop()!, accounts.pop()!];
+ const [collectionOwner, newSponsor] = getAccount(2);
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
const collectionId = collection.collectionId;
@@ -340,7 +522,7 @@
itSub('should not overwrite collection limits set by the owner earlier', async ({helper}) => {
const api = helper.getApi();
const limits = {ownerCanDestroy: true, ownerCanTransfer: true, sponsorTransferTimeout: 0};
- const collectionWithLimits = await helper.nft.mintCollection(accounts.pop()!, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits});
+ const collectionWithLimits = await helper.nft.mintCollection(getAccount(1)[0], {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits});
await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collectionWithLimits.collectionId))).to.be.fulfilled;
expect((await collectionWithLimits.getData())?.raw.limits).to.be.deep.contain(limits);
@@ -348,7 +530,7 @@
itSub('should reject transaction if collection doesn\'t exist', async ({helper}) => {
const api = helper.getApi();
- const collectionOwner = accounts.pop()!;
+ const [collectionOwner] = getAccount(1);
// collection has never existed
await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(999999999))).to.be.rejected;
@@ -363,7 +545,7 @@
describe('stopSponsoringCollection', () => {
itSub('can not be called by non-admin', async ({helper}) => {
const api = helper.getApi();
- const [collectionOwner, nonAdmin] = [accounts.pop()!, accounts.pop()!];
+ const [collectionOwner, nonAdmin] = getAccount(2);
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
await expect(helper.signTransaction(palletAdmin, api.tx.appPromotion.sponsorCollection(collection.collectionId))).to.be.fulfilled;
@@ -374,7 +556,7 @@
itSub('should set sponsoring as disabled', async ({helper}) => {
const api = helper.getApi();
- const [collectionOwner, recepient] = [accounts.pop()!, accounts.pop()!];
+ const [collectionOwner, recepient] = getAccount(2);
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', limits: {sponsorTransferTimeout: 0}});
const token = await collection.mintToken(collectionOwner, {Substrate: collectionOwner.address});
@@ -392,7 +574,7 @@
itSub('should not affect collection which is not sponsored by pallete', async ({helper}) => {
const api = helper.getApi();
- const collectionOwner = accounts.pop()!;
+ const [collectionOwner] = getAccount(1);
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion', pendingSponsor: collectionOwner.address});
await collection.confirmSponsorship(collectionOwner);
@@ -402,7 +584,7 @@
});
itSub('should reject transaction if collection does not exist', async ({helper}) => {
- const collectionOwner = accounts.pop()!;
+ const [collectionOwner] = getAccount(1);
const collection = await helper.nft.mintCollection(collectionOwner, {name: 'New', description: 'New Collection', tokenPrefix: 'Promotion'});
await collection.burn(collectionOwner);
@@ -476,7 +658,7 @@
});
itEth('can not be set by non admin', async ({helper}) => {
- const nonAdmin = accounts.pop()!;
+ const [nonAdmin] = getAccount(1);
const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();
const flipper = await helper.eth.deployFlipper(contractOwner); // await deployFlipper(web3, contractOwner);
const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner);
@@ -558,7 +740,7 @@
});
itEth('can not be called by non-admin', async ({helper}) => {
- const nonAdmin = accounts.pop()!;
+ const [nonAdmin] = getAccount(1);
const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();
const flipper = await helper.eth.deployFlipper(contractOwner);
@@ -568,7 +750,7 @@
});
itEth('should not affect a contract which is not sponsored by pallete', async ({helper}) => {
- const nonAdmin = accounts.pop()!;
+ const [nonAdmin] = getAccount(1);
const contractOwner = (await helper.eth.createAccountWithBalance(donor, 1000n)).toLowerCase();
const flipper = await helper.eth.deployFlipper(contractOwner);
const contractHelper = await helper.ethNativeContract.contractHelpers(contractOwner);
@@ -580,12 +762,12 @@
describe('payoutStakers', () => {
itSub('can not be called by non admin', async ({helper}) => {
- const nonAdmin = accounts.pop()!;
+ const [nonAdmin] = getAccount(1);
await expect(helper.admin.payoutStakers(nonAdmin, 100)).to.be.rejectedWith('appPromotion.NoPermission');
});
itSub('should increase total staked', async ({helper}) => {
- const staker = accounts.pop()!;
+ const [staker] = getAccount(1);
const totalStakedBefore = await helper.staking.getTotalStaked();
await helper.staking.stake(staker, 100n * nominal);
@@ -597,12 +779,12 @@
const totalStakedAfter = await helper.staking.getTotalStaked();
expect(totalStakedAfter).to.equal(totalStakedBefore + (100n * nominal) + totalPayout);
// staker can unstake
- await helper.staking.unstake(staker);
+ await helper.staking.unstakeAll(staker);
expect(await helper.staking.getTotalStaked()).to.be.equal(totalStakedAfter - calculateIncome(100n * nominal));
});
itSub('should credit 0.05% for staking period', async ({helper}) => {
- const staker = accounts.pop()!;
+ const [staker] = getAccount(1);
await waitPromotionPeriodDoesntEnd(helper);
@@ -628,7 +810,7 @@
});
itSub('shoud be paid for more than one period if payments was missed', async ({helper}) => {
- const staker = accounts.pop()!;
+ const [staker] = getAccount(1);
await helper.staking.stake(staker, 100n * nominal);
// wait for two rewards are available:
@@ -647,11 +829,11 @@
itSub('should not be credited for pending-unstaked tokens', async ({helper}) => {
// staker unstakes before rewards been payed
- const staker = accounts.pop()!;
+ const [staker] = getAccount(1);
await helper.staking.stake(staker, 100n * nominal);
const [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block) + LOCKING_PERIOD);
- await helper.staking.unstake(staker);
+ await helper.staking.unstakeAll(staker);
// so he did not receive any rewards
const totalBalanceBefore = await helper.balance.getSubstrate(staker.address);
@@ -662,7 +844,7 @@
});
itSub('should bring compound interest', async ({helper}) => {
- const staker = accounts.pop()!;
+ const [staker] = getAccount(1);
await helper.staking.stake(staker, 100n * nominal);
@@ -679,36 +861,48 @@
expect(stake.amount).to.equal(calculateIncome(100n * nominal, 2));
});
- itSub.skip('can be paid 1000 rewards in a time', async ({helper}) => {
- // all other stakes should be unstaked
- const oneHundredStakers = await helper.arrange.createCrowd(100, 1050n, donor);
+ itSub('can calculate reward for tiny stake', async ({helper}) => {
+ const [staker] = getAccount(1);
+ await helper.staking.stake(staker, 100n * nominal);
+ await helper.staking.stake(staker, 100n * nominal);
+ await helper.staking.unstakePartial(staker, 100n * nominal - 1n);
- // stakers stakes 10 times each
- for (let i = 0; i < 10; i++) {
- await Promise.all(oneHundredStakers.map(staker => helper.staking.stake(staker, 100n * nominal)));
- }
- await helper.wait.newBlocks(40);
- await helper.admin.payoutStakers(palletAdmin, 100);
+ const [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
+ await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block));
+
+ const payouts = await helper.admin.payoutStakers(palletAdmin, 100);
+ const stakerPayout = payouts.find(p => p.staker === staker.address);
+ expect(stakerPayout!.stake).to.eq(100n * nominal + 1n);
});
- itSub.skip('can handle 40.000 rewards', async ({helper}) => {
- const crowdStakes = async () => {
- // each account in the crowd stakes 2 times
- const crowd = await helper.arrange.createCrowd(500, 300n, donor);
- await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal)));
- await Promise.all(crowd.map(account => helper.staking.stake(account, 100n * nominal)));
- //
- };
+ itSub('can eventually pay all rewards', async ({helper}) => {
+ const stakers = getAccount(30);
+ // Create 30 stakes:
+ await Promise.all(stakers.map(staker => helper.staking.stake(staker, 100n * nominal)));
- for (let i = 0; i < 40; i++) {
- await crowdStakes();
+ let unstakingTxs = [];
+ for (const staker of stakers) {
+ if (unstakingTxs.length == 3) {
+ await Promise.all(unstakingTxs);
+ unstakingTxs = [];
+ }
+ unstakingTxs.push(helper.staking.unstakePartial(staker, 100n * nominal - 1n));
}
- // TODO pay rewards for some period
+ const [staker] = getAccount(1);
+ await helper.staking.stake(staker, 100n * nominal);
+ const [stake] = await helper.staking.getTotalStakedPerBlock({Substrate: staker.address});
+ await helper.wait.forRelayBlockNumber(rewardAvailableInBlock(stake.block));
+
+ let payouts;
+ do {
+ payouts = await helper.admin.payoutStakers(palletAdmin, 20);
+ } while (payouts.length !== 0);
});
});
});
+
function calculateIncome(base: bigint, iter = 0, calcPeriod: bigint = UNLOCKING_PERIOD): bigint {
const DAY = 7200n;
const ACCURACY = 1_000_000_000n;
tests/src/util/globalSetup.tsdiffbeforeafterboth--- a/tests/src/util/globalSetup.ts
+++ b/tests/src/util/globalSetup.ts
@@ -29,8 +29,8 @@
const api = helper.getApi();
await helper.signTransaction(superuser, api.tx.sudo.sudo(api.tx.appPromotion.setAdminAddress({Substrate: palletAdmin.address})));
const nominal = helper.balance.getOneTokenNominal();
- await helper.balance.transferToSubstrate(superuser, palletAdmin.address, 1000n * nominal);
- await helper.balance.transferToSubstrate(superuser, palletAddress, 1000n * nominal);
+ await helper.balance.transferToSubstrate(superuser, palletAdmin.address, 10000n * nominal);
+ await helper.balance.transferToSubstrate(superuser, palletAddress, 10000n * nominal);
await helper.executeExtrinsic(superuser, 'api.tx.sudo.sudo', [api.tx.configuration
.setAppPromotionConfigurationOverride({
recalculationInterval: LOCKING_PERIOD,
tests/src/util/index.tsdiffbeforeafterboth--- a/tests/src/util/index.ts
+++ b/tests/src/util/index.ts
@@ -94,7 +94,7 @@
};
export const MINIMUM_DONOR_FUND = 100_000n;
-export const DONOR_FUNDING = 1_000_000n;
+export const DONOR_FUNDING = 2_000_000n;
// App-promotion periods:
export const LOCKING_PERIOD = 12n; // 12 blocks of relay
tests/src/util/playgrounds/types.tsdiffbeforeafterboth--- a/tests/src/util/playgrounds/types.ts
+++ b/tests/src/util/playgrounds/types.ts
@@ -20,7 +20,8 @@
event: IEvent;
}[];
},
- moduleError?: string;
+ blockHash: string,
+ moduleError?: string | object;
}
export interface ISubscribeBlockEventsData {
tests/src/util/playgrounds/unique.dev.tsdiffbeforeafterboth--- a/tests/src/util/playgrounds/unique.dev.ts
+++ b/tests/src/util/playgrounds/unique.dev.ts
@@ -214,7 +214,7 @@
accounts.push(recipient);
if (balance !== 0n) {
const tx = this.helper.constructApiCall('api.tx.balances.transfer', [{Id: recipient.address}, balance * tokenNominal]);
- transactions.push(this.helper.signTransaction(donor, tx, {nonce}, 'account generation'));
+ transactions.push(this.helper.signTransaction(donor, tx, {nonce, era: 0}, 'account generation'));
nonce++;
}
}
tests/src/util/playgrounds/unique.tsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {SignerOptions} from '@polkadot/api/types/submittable';10import {ApiInterfaceEvents} from '@polkadot/api/types';11import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm, base58Encode, blake2AsU8a} from '@polkadot/util-crypto';12import {IKeyringPair} from '@polkadot/types/types';13import {hexToU8a} from '@polkadot/util/hex';14import {u8aConcat} from '@polkadot/util/u8a';15import {16 IApiListeners,17 IBlock,18 IEvent,19 IChainProperties,20 ICollectionCreationOptions,21 ICollectionLimits,22 ICollectionPermissions,23 ICrossAccountId,24 ICrossAccountIdLower,25 ILogger,26 INestingPermissions,27 IProperty,28 IStakingInfo,29 ISchedulerOptions,30 ISubstrateBalance,31 IToken,32 ITokenPropertyPermission,33 ITransactionResult,34 IUniqueHelperLog,35 TApiAllowedListeners,36 TEthereumAccount,37 TSigner,38 TSubstrateAccount,39 TNetworks,40 IForeignAssetMetadata,41 AcalaAssetMetadata,42 MoonbeamAssetInfo,43 DemocracyStandardAccountVote,44 IEthCrossAccountId,45} from './types';46import {RuntimeDispatchInfo} from '@polkadot/types/interfaces';47import type {Vec} from '@polkadot/types-codec';48import {FrameSystemEventRecord} from '@polkadot/types/lookup';4950export class CrossAccountId implements ICrossAccountId {51 Substrate?: TSubstrateAccount;52 Ethereum?: TEthereumAccount;5354 constructor(account: ICrossAccountId) {55 if (account.Substrate) this.Substrate = account.Substrate;56 if (account.Ethereum) this.Ethereum = account.Ethereum;57 }5859 static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {60 switch (domain) {61 case 'Substrate': return new CrossAccountId({Substrate: account.address});62 case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();63 }64 }6566 static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {67 return new CrossAccountId({Substrate: address.substrate, Ethereum: address.ethereum});68 }6970 static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {71 return encodeAddress(decodeAddress(address), ss58Format);72 }7374 static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {75 return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});76 }7778 withNormalizedSubstrate(ss58Format = 42): CrossAccountId {79 if (this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);80 return this;81 }8283 static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {84 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));85 }8687 toEthereum(): CrossAccountId {88 if (this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});89 return this;90 }9192 static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {93 return evmToAddress(address, ss58Format);94 }9596 toSubstrate(ss58Format?: number): CrossAccountId {97 if (this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});98 return this;99 }100101 toLowerCase(): CrossAccountId {102 if (this.Substrate) this.Substrate = this.Substrate.toLowerCase();103 if (this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();104 return this;105 }106}107108const nesting = {109 toChecksumAddress(address: string): string {110 if (typeof address === 'undefined') return '';111112 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);113114 address = address.toLowerCase().replace(/^0x/i,'');115 const addressHash = keccakAsHex(address).replace(/^0x/i,'');116 const checksumAddress = ['0x'];117118 for (let i = 0; i < address.length; i++) {119 // If ith character is 8 to f then make it uppercase120 if (parseInt(addressHash[i], 16) > 7) {121 checksumAddress.push(address[i].toUpperCase());122 } else {123 checksumAddress.push(address[i]);124 }125 }126 return checksumAddress.join('');127 },128 tokenIdToAddress(collectionId: number, tokenId: number) {129 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);130 },131};132133class UniqueUtil {134 static transactionStatus = {135 NOT_READY: 'NotReady',136 FAIL: 'Fail',137 SUCCESS: 'Success',138 };139140 static chainLogType = {141 EXTRINSIC: 'extrinsic',142 RPC: 'rpc',143 };144145 static getTokenAccount(token: IToken): CrossAccountId {146 return new CrossAccountId({Ethereum: this.getTokenAddress(token)});147 }148149 static getTokenAddress(token: IToken): string {150 return nesting.tokenIdToAddress(token.collectionId, token.tokenId);151 }152153 static getDefaultLogger(): ILogger {154 return {155 log(msg: any, level = 'INFO') {156 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));157 },158 level: {159 ERROR: 'ERROR',160 WARNING: 'WARNING',161 INFO: 'INFO',162 },163 };164 }165166 static vec2str(arr: string[] | number[]) {167 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');168 }169170 static str2vec(string: string) {171 if (typeof string !== 'string') return string;172 return Array.from(string).map(x => x.charCodeAt(0));173 }174175 static fromSeed(seed: string, ss58Format = 42) {176 const keyring = new Keyring({type: 'sr25519', ss58Format});177 return keyring.addFromUri(seed);178 }179180 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {181 if (creationResult.status !== this.transactionStatus.SUCCESS) {182 throw Error('Unable to create collection!');183 }184185 let collectionId = null;186 creationResult.result.events.forEach(({event: {data, method, section}}) => {187 if ((section === 'common') && (method === 'CollectionCreated')) {188 collectionId = parseInt(data[0].toString(), 10);189 }190 });191192 if (collectionId === null) {193 throw Error('No CollectionCreated event was found!');194 }195196 return collectionId;197 }198199 static extractTokensFromCreationResult(creationResult: ITransactionResult): {200 success: boolean,201 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],202 } {203 if (creationResult.status !== this.transactionStatus.SUCCESS) {204 throw Error('Unable to create tokens!');205 }206 let success = false;207 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];208 creationResult.result.events.forEach(({event: {data, method, section}}) => {209 if (method === 'ExtrinsicSuccess') {210 success = true;211 } else if ((section === 'common') && (method === 'ItemCreated')) {212 tokens.push({213 collectionId: parseInt(data[0].toString(), 10),214 tokenId: parseInt(data[1].toString(), 10),215 owner: data[2].toHuman(),216 amount: data[3].toBigInt(),217 });218 }219 });220 return {success, tokens};221 }222223 static extractTokensFromBurnResult(burnResult: ITransactionResult): {224 success: boolean,225 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],226 } {227 if (burnResult.status !== this.transactionStatus.SUCCESS) {228 throw Error('Unable to burn tokens!');229 }230 let success = false;231 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];232 burnResult.result.events.forEach(({event: {data, method, section}}) => {233 if (method === 'ExtrinsicSuccess') {234 success = true;235 } else if ((section === 'common') && (method === 'ItemDestroyed')) {236 tokens.push({237 collectionId: parseInt(data[0].toString(), 10),238 tokenId: parseInt(data[1].toString(), 10),239 owner: data[2].toHuman(),240 amount: data[3].toBigInt(),241 });242 }243 });244 return {success, tokens};245 }246247 static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {248 let eventId = null;249 events.forEach(({event: {data, method, section}}) => {250 if ((section === expectedSection) && (method === expectedMethod)) {251 eventId = parseInt(data[0].toString(), 10);252 }253 });254255 if (eventId === null) {256 throw Error(`No ${expectedMethod} event was found!`);257 }258 return eventId === collectionId;259 }260261 static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {262 const normalizeAddress = (address: string | ICrossAccountId) => {263 if(typeof address === 'string') return address;264 const obj = {} as any;265 Object.keys(address).forEach(k => {266 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];267 });268 if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);269 if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();270 return address;271 };272 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;273 events.forEach(({event: {data, method, section}}) => {274 if ((section === 'common') && (method === 'Transfer')) {275 const hData = (data as any).toJSON();276 transfer = {277 collectionId: hData[0],278 tokenId: hData[1],279 from: normalizeAddress(hData[2]),280 to: normalizeAddress(hData[3]),281 amount: BigInt(hData[4]),282 };283 }284 });285 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;286 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);287 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);288 isSuccess = isSuccess && amount === transfer.amount;289 return isSuccess;290 }291292 static bigIntToDecimals(number: bigint, decimals = 18) {293 const numberStr = number.toString();294 const dotPos = numberStr.length - decimals;295296 if (dotPos <= 0) {297 return '0.' + '0'.repeat(Math.abs(dotPos)) + numberStr;298 } else {299 const intPart = numberStr.substring(0, dotPos);300 const fractPart = numberStr.substring(dotPos);301 return intPart + '.' + fractPart;302 }303 }304}305306class UniqueEventHelper {307 private static extractIndex(index: any): [number, number] | string {308 if(index.toRawType() === '[u8;2]') return [index[0], index[1]];309 return index.toJSON();310 }311312 private static extractSub(data: any, subTypes: any): {[key: string]: any} {313 let obj: any = {};314 let index = 0;315316 if (data.entries) {317 for(const [key, value] of data.entries()) {318 obj[key] = this.extractData(value, subTypes[index]);319 index++;320 }321 } else obj = data.toJSON();322323 return obj;324 }325326 private static toHuman(data: any) {327 return data && data.toHuman ? data.toHuman() : `${data}`;328 }329330 private static extractData(data: any, type: any): any {331 if(!type) return this.toHuman(data);332 if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();333 if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();334 if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);335 return this.toHuman(data);336 }337338 public static extractEvents(events: {event: any, phase: any}[]): IEvent[] {339 const parsedEvents: IEvent[] = [];340341 events.forEach((record) => {342 const {event, phase} = record;343 const types = event.typeDef;344345 const eventData: IEvent = {346 section: event.section.toString(),347 method: event.method.toString(),348 index: this.extractIndex(event.index),349 data: [],350 phase: phase.toJSON(),351 };352353 event.data.forEach((val: any, index: number) => {354 eventData.data.push(this.extractData(val, types[index]));355 });356357 parsedEvents.push(eventData);358 });359360 return parsedEvents;361 }362}363364export class ChainHelperBase {365 helperBase: any;366367 transactionStatus = UniqueUtil.transactionStatus;368 chainLogType = UniqueUtil.chainLogType;369 util: typeof UniqueUtil;370 eventHelper: typeof UniqueEventHelper;371 logger: ILogger;372 api: ApiPromise | null;373 forcedNetwork: TNetworks | null;374 network: TNetworks | null;375 wsEndpoint: string | null;376 chainLog: IUniqueHelperLog[];377 children: ChainHelperBase[];378 address: AddressGroup;379 chain: ChainGroup;380381 constructor(logger?: ILogger, helperBase?: any) {382 this.helperBase = helperBase;383384 this.util = UniqueUtil;385 this.eventHelper = UniqueEventHelper;386 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();387 this.logger = logger;388 this.api = null;389 this.forcedNetwork = null;390 this.network = null;391 this.wsEndpoint = null;392 this.chainLog = [];393 this.children = [];394 this.address = new AddressGroup(this);395 this.chain = new ChainGroup(this);396 }397398 clone(helperCls: ChainHelperBaseConstructor, options: {[key: string]: any} = {}) {399 Object.setPrototypeOf(helperCls.prototype, this);400 const newHelper = new helperCls(this.logger, options);401402 newHelper.api = this.api;403 newHelper.network = this.network;404 newHelper.forceNetwork = this.forceNetwork;405406 this.children.push(newHelper);407408 return newHelper;409 }410411 getEndpoint(): string {412 if (this.wsEndpoint === null) throw Error('No connection was established');413 return this.wsEndpoint;414 }415416 getApi(): ApiPromise {417 if(this.api === null) throw Error('API not initialized');418 return this.api;419 }420421 async subscribeEvents(expectedEvents: {section: string, names: string[]}[]) {422 const collectedEvents: IEvent[] = [];423 const unsubscribe = await this.getApi().query.system.events((events: Vec<FrameSystemEventRecord>) => {424 const ievents = this.eventHelper.extractEvents(events);425 ievents.forEach((event) => {426 expectedEvents.forEach((e => {427 if (event.section === e.section && e.names.includes(event.method)) {428 collectedEvents.push(event);429 }430 }));431 });432 });433 return {unsubscribe: unsubscribe as any, collectedEvents};434 }435436 clearChainLog(): void {437 this.chainLog = [];438 }439440 forceNetwork(value: TNetworks): void {441 this.forcedNetwork = value;442 }443444 async connect(wsEndpoint: string, listeners?: IApiListeners) {445 if (this.api !== null) throw Error('Already connected');446 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);447 this.wsEndpoint = wsEndpoint;448 this.api = api;449 this.network = network;450 }451452 async disconnect() {453 for (const child of this.children) {454 child.clearApi();455 }456457 if (this.api === null) return;458 await this.api.disconnect();459 this.clearApi();460 }461462 clearApi() {463 this.api = null;464 this.network = null;465 }466467 static async detectNetwork(api: ApiPromise): Promise<TNetworks> {468 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;469 const xcmChains = ['rococo', 'westend', 'westmint', 'acala', 'karura', 'moonbeam', 'moonriver'];470471 if(xcmChains.indexOf(spec.specName) > -1) return spec.specName;472473 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;474 return 'opal';475 }476477 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TNetworks> {478 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});479 await api.isReady;480481 const network = await this.detectNetwork(api);482483 await api.disconnect();484485 return network;486 }487488 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TNetworks | null): Promise<{489 api: ApiPromise;490 network: TNetworks;491 }> {492 if(typeof network === 'undefined' || network === null) network = 'opal';493 const supportedRPC = {494 opal: {495 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,496 },497 quartz: {498 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,499 },500 unique: {501 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,502 },503 rococo: {},504 westend: {},505 moonbeam: {},506 moonriver: {},507 acala: {},508 karura: {},509 westmint: {},510 };511 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);512 const rpc = supportedRPC[network];513514 // TODO: investigate how to replace rpc in runtime515 // api._rpcCore.addUserInterfaces(rpc);516517 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});518519 await api.isReadyOrError;520521 if (typeof listeners === 'undefined') listeners = {};522 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {523 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;524 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);525 }526527 return {api, network};528 }529530 getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {531 const {events, status} = data;532 if (status.isReady) {533 return this.transactionStatus.NOT_READY;534 }535 if (status.isBroadcast) {536 return this.transactionStatus.NOT_READY;537 }538 if (status.isInBlock || status.isFinalized) {539 const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');540 if (errors.length > 0) {541 return this.transactionStatus.FAIL;542 }543 if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {544 return this.transactionStatus.SUCCESS;545 }546 }547548 return this.transactionStatus.FAIL;549 }550551 signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {552 const sign = (callback: any) => {553 if(options !== null) return transaction.signAndSend(sender, options, callback);554 return transaction.signAndSend(sender, callback);555 };556 // eslint-disable-next-line no-async-promise-executor557 return new Promise(async (resolve, reject) => {558 try {559 const unsub = await sign((result: any) => {560 const status = this.getTransactionStatus(result);561562 if (status === this.transactionStatus.SUCCESS) {563 this.logger.log(`${label} successful`);564 unsub();565 resolve({result, status, blockHash: result.status.asInBlock.toHuman()});566 } else if (status === this.transactionStatus.FAIL) {567 let moduleError = null;568569 if (result.hasOwnProperty('dispatchError')) {570 const dispatchError = result['dispatchError'];571572 if (dispatchError) {573 if (dispatchError.isModule) {574 const modErr = dispatchError.asModule;575 const errorMeta = dispatchError.registry.findMetaError(modErr);576577 moduleError = `${errorMeta.section}.${errorMeta.name}`;578 } else {579 moduleError = dispatchError.toHuman();580 }581 } else {582 this.logger.log(result, this.logger.level.ERROR);583 }584 }585586 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);587 unsub();588 reject({status, moduleError, result});589 }590 });591 } catch (e) {592 this.logger.log(e, this.logger.level.ERROR);593 reject(e);594 }595 });596 }597598 async signTransactionWithoutSending(signer: TSigner, tx: any) {599 const api = this.getApi();600 const signingInfo = await api.derive.tx.signingInfo(signer.address);601602 tx.sign(signer, {603 blockHash: api.genesisHash,604 genesisHash: api.genesisHash,605 runtimeVersion: api.runtimeVersion,606 nonce: signingInfo.nonce,607 });608609 return tx.toHex();610 }611612 async getPaymentInfo(signer: TSigner, tx: any, len: number | null) {613 const api = this.getApi();614 const signingInfo = await api.derive.tx.signingInfo(signer.address);615616 // We need to sign the tx because617 // unsigned transactions does not have an inclusion fee618 tx.sign(signer, {619 blockHash: api.genesisHash,620 genesisHash: api.genesisHash,621 runtimeVersion: api.runtimeVersion,622 nonce: signingInfo.nonce,623 });624625 if (len === null) {626 return (await this.callRpc('api.rpc.payment.queryInfo', [tx.toHex()])) as RuntimeDispatchInfo;627 } else {628 return (await api.call.transactionPaymentApi.queryInfo(tx, len)) as RuntimeDispatchInfo;629 }630 }631632 constructApiCall(apiCall: string, params: any[]) {633 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);634 let call = this.getApi() as any;635 for(const part of apiCall.slice(4).split('.')) {636 call = call[part];637 if (!call) {638 const advice = part.includes('_') ? ' Looks like it needs to be converted to camel case.' : '';639 throw Error(`Function ${part} of api call ${apiCall} not found.${advice}`);640 }641 }642 return call(...params);643 }644645 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {646 if(this.api === null) throw Error('API not initialized');647 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);648649 const startTime = (new Date()).getTime();650 let result: ITransactionResult;651 let events: IEvent[] = [];652 try {653 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;654 events = this.eventHelper.extractEvents(result.result.events);655 const errorEvent = events.find((event) => event.method == 'ExecutedFailed' || event.method == 'CreatedFailed');656 if (errorEvent)657 throw Error(errorEvent.method + ': ' + extrinsic);658 }659 catch(e) {660 if(!(e as object).hasOwnProperty('status')) throw e;661 result = e as ITransactionResult;662 }663664 const endTime = (new Date()).getTime();665666 const log = {667 executedAt: endTime,668 executionTime: endTime - startTime,669 type: this.chainLogType.EXTRINSIC,670 status: result.status,671 call: extrinsic,672 signer: this.getSignerAddress(sender),673 params,674 } as IUniqueHelperLog;675676 let errorMessage = '';677678 if(result.status !== this.transactionStatus.SUCCESS) {679 if (result.moduleError) {680 errorMessage = typeof result.moduleError === 'string'681 ? result.moduleError682 : `${Object.keys(result.moduleError)[0]}: ${Object.values(result.moduleError)[0]}`;683 log.moduleError = errorMessage;684 }685 else if (result.result.dispatchError) log.dispatchError = result.result.dispatchError;686 }687 if(events.length > 0) log.events = events;688689 this.chainLog.push(log);690691 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) {692 if (result.moduleError) throw Error(`${errorMessage}`);693 else if (result.result.dispatchError) throw Error(JSON.stringify(result.result.dispatchError));694 }695 return result;696 }697698 async callRpc(rpc: string, params?: any[]) {699 if(typeof params === 'undefined') params = [];700 if(this.api === null) throw Error('API not initialized');701 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);702703 const startTime = (new Date()).getTime();704 let result;705 let error = null;706 const log = {707 type: this.chainLogType.RPC,708 call: rpc,709 params,710 } as IUniqueHelperLog;711712 try {713 result = await this.constructApiCall(rpc, params);714 }715 catch(e) {716 error = e;717 }718719 const endTime = (new Date()).getTime();720721 log.executedAt = endTime;722 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';723 log.executionTime = endTime - startTime;724725 this.chainLog.push(log);726727 if(error !== null) throw error;728729 return result;730 }731732 getSignerAddress(signer: IKeyringPair | string): string {733 if(typeof signer === 'string') return signer;734 return signer.address;735 }736737 fetchAllPalletNames(): string[] {738 if(this.api === null) throw Error('API not initialized');739 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());740 }741742 fetchMissingPalletNames(requiredPallets: string[]): string[] {743 const palletNames = this.fetchAllPalletNames();744 return requiredPallets.filter(p => !palletNames.includes(p));745 }746}747748749class HelperGroup<T extends ChainHelperBase> {750 helper: T;751752 constructor(uniqueHelper: T) {753 this.helper = uniqueHelper;754 }755}756757758class CollectionGroup extends HelperGroup<UniqueHelper> {759 /**760 * Get number of blocks when sponsored transaction is available.761 *762 * @param collectionId ID of collection763 * @param tokenId ID of token764 * @param addressObj address for which the sponsorship is checked765 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});766 * @returns number of blocks or null if sponsorship hasn't been set767 */768 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {769 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();770 }771772 /**773 * Get the number of created collections.774 *775 * @returns number of created collections776 */777 async getTotalCount(): Promise<number> {778 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();779 }780781 /**782 * Get information about the collection with additional data,783 * including the number of tokens it contains, its administrators,784 * the normalized address of the collection's owner, and decoded name and description.785 *786 * @param collectionId ID of collection787 * @example await getData(2)788 * @returns collection information object789 */790 async getData(collectionId: number): Promise<{791 id: number;792 name: string;793 description: string;794 tokensCount: number;795 admins: CrossAccountId[];796 normalizedOwner: TSubstrateAccount;797 raw: any798 } | null> {799 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);800 const humanCollection = collection.toHuman(), collectionData = {801 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],802 raw: humanCollection,803 } as any, jsonCollection = collection.toJSON();804 if (humanCollection === null) return null;805 collectionData.raw.limits = jsonCollection.limits;806 collectionData.raw.permissions = jsonCollection.permissions;807 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);808 for (const key of ['name', 'description']) {809 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);810 }811812 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))813 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)814 : 0;815 collectionData.admins = await this.getAdmins(collectionId);816817 return collectionData;818 }819820 /**821 * Get the addresses of the collection's administrators, optionally normalized.822 *823 * @param collectionId ID of collection824 * @param normalize whether to normalize the addresses to the default ss58 format825 * @example await getAdmins(1)826 * @returns array of administrators827 */828 async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {829 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();830831 return normalize832 ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())833 : admins;834 }835836 /**837 * Get the addresses added to the collection allow-list, optionally normalized.838 * @param collectionId ID of collection839 * @param normalize whether to normalize the addresses to the default ss58 format840 * @example await getAllowList(1)841 * @returns array of allow-listed addresses842 */843 async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {844 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();845 return normalize846 ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())847 : allowListed;848 }849850 /**851 * Get the effective limits of the collection instead of null for default values852 *853 * @param collectionId ID of collection854 * @example await getEffectiveLimits(2)855 * @returns object of collection limits856 */857 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {858 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();859 }860861 /**862 * Burns the collection if the signer has sufficient permissions and collection is empty.863 *864 * @param signer keyring of signer865 * @param collectionId ID of collection866 * @example await helper.collection.burn(aliceKeyring, 3);867 * @returns ```true``` if extrinsic success, otherwise ```false```868 */869 async burn(signer: TSigner, collectionId: number): Promise<boolean> {870 const result = await this.helper.executeExtrinsic(871 signer,872 'api.tx.unique.destroyCollection', [collectionId],873 true,874 );875876 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');877 }878879 /**880 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.881 *882 * @param signer keyring of signer883 * @param collectionId ID of collection884 * @param sponsorAddress Sponsor substrate address885 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")886 * @returns ```true``` if extrinsic success, otherwise ```false```887 */888 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {889 const result = await this.helper.executeExtrinsic(890 signer,891 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],892 true,893 );894895 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorSet');896 }897898 /**899 * Confirms consent to sponsor the collection on behalf of the signer.900 *901 * @param signer keyring of signer902 * @param collectionId ID of collection903 * @example confirmSponsorship(aliceKeyring, 10)904 * @returns ```true``` if extrinsic success, otherwise ```false```905 */906 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {907 const result = await this.helper.executeExtrinsic(908 signer,909 'api.tx.unique.confirmSponsorship', [collectionId],910 true,911 );912913 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'SponsorshipConfirmed');914 }915916 /**917 * Removes the sponsor of a collection, regardless if it consented or not.918 *919 * @param signer keyring of signer920 * @param collectionId ID of collection921 * @example removeSponsor(aliceKeyring, 10)922 * @returns ```true``` if extrinsic success, otherwise ```false```923 */924 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {925 const result = await this.helper.executeExtrinsic(926 signer,927 'api.tx.unique.removeCollectionSponsor', [collectionId],928 true,929 );930931 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorRemoved');932 }933934 /**935 * Sets the limits of the collection. At least one limit must be specified for a correct call.936 *937 * @param signer keyring of signer938 * @param collectionId ID of collection939 * @param limits collection limits object940 * @example941 * await setLimits(942 * aliceKeyring,943 * 10,944 * {945 * sponsorTransferTimeout: 0,946 * ownerCanDestroy: false947 * }948 * )949 * @returns ```true``` if extrinsic success, otherwise ```false```950 */951 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {952 const result = await this.helper.executeExtrinsic(953 signer,954 'api.tx.unique.setCollectionLimits', [collectionId, limits],955 true,956 );957958 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionLimitSet');959 }960961 /**962 * Changes the owner of the collection to the new Substrate address.963 *964 * @param signer keyring of signer965 * @param collectionId ID of collection966 * @param ownerAddress substrate address of new owner967 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")968 * @returns ```true``` if extrinsic success, otherwise ```false```969 */970 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {971 const result = await this.helper.executeExtrinsic(972 signer,973 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],974 true,975 );976977 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionOwnerChanged');978 }979980 /**981 * Adds a collection administrator.982 *983 * @param signer keyring of signer984 * @param collectionId ID of collection985 * @param adminAddressObj Administrator address (substrate or ethereum)986 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})987 * @returns ```true``` if extrinsic success, otherwise ```false```988 */989 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {990 const result = await this.helper.executeExtrinsic(991 signer,992 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],993 true,994 );995996 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminAdded');997 }998999 /**1000 * Removes a collection administrator.1001 *1002 * @param signer keyring of signer1003 * @param collectionId ID of collection1004 * @param adminAddressObj Administrator address (substrate or ethereum)1005 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})1006 * @returns ```true``` if extrinsic success, otherwise ```false```1007 */1008 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {1009 const result = await this.helper.executeExtrinsic(1010 signer,1011 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],1012 true,1013 );10141015 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminRemoved');1016 }10171018 /**1019 * Check if user is in allow list.1020 *1021 * @param collectionId ID of collection1022 * @param user Account to check1023 * @example await getAdmins(1)1024 * @returns is user in allow list1025 */1026 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {1027 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();1028 }10291030 /**1031 * Adds an address to allow list1032 * @param signer keyring of signer1033 * @param collectionId ID of collection1034 * @param addressObj address to add to the allow list1035 * @returns ```true``` if extrinsic success, otherwise ```false```1036 */1037 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1038 const result = await this.helper.executeExtrinsic(1039 signer,1040 'api.tx.unique.addToAllowList', [collectionId, addressObj],1041 true,1042 );10431044 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressAdded');1045 }10461047 /**1048 * Removes an address from allow list1049 *1050 * @param signer keyring of signer1051 * @param collectionId ID of collection1052 * @param addressObj address to remove from the allow list1053 * @returns ```true``` if extrinsic success, otherwise ```false```1054 */1055 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1056 const result = await this.helper.executeExtrinsic(1057 signer,1058 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],1059 true,1060 );10611062 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressRemoved');1063 }10641065 /**1066 * Sets onchain permissions for selected collection.1067 *1068 * @param signer keyring of signer1069 * @param collectionId ID of collection1070 * @param permissions collection permissions object1071 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});1072 * @returns ```true``` if extrinsic success, otherwise ```false```1073 */1074 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {1075 const result = await this.helper.executeExtrinsic(1076 signer,1077 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],1078 true,1079 );10801081 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPermissionSet');1082 }10831084 /**1085 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.1086 *1087 * @param signer keyring of signer1088 * @param collectionId ID of collection1089 * @param permissions nesting permissions object1090 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});1091 * @returns ```true``` if extrinsic success, otherwise ```false```1092 */1093 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {1094 return await this.setPermissions(signer, collectionId, {nesting: permissions});1095 }10961097 /**1098 * Disables nesting for selected collection.1099 *1100 * @param signer keyring of signer1101 * @param collectionId ID of collection1102 * @example disableNesting(aliceKeyring, 10);1103 * @returns ```true``` if extrinsic success, otherwise ```false```1104 */1105 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {1106 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});1107 }11081109 /**1110 * Sets onchain properties to the collection.1111 *1112 * @param signer keyring of signer1113 * @param collectionId ID of collection1114 * @param properties array of property objects1115 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);1116 * @returns ```true``` if extrinsic success, otherwise ```false```1117 */1118 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {1119 const result = await this.helper.executeExtrinsic(1120 signer,1121 'api.tx.unique.setCollectionProperties', [collectionId, properties],1122 true,1123 );11241125 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');1126 }11271128 /**1129 * Get collection properties.1130 *1131 * @param collectionId ID of collection1132 * @param propertyKeys optionally filter the returned properties to only these keys1133 * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);1134 * @returns array of key-value pairs1135 */1136 async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1137 return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();1138 }11391140 async getPropertiesConsumedSpace(collectionId: number): Promise<number> {1141 const api = this.helper.getApi();1142 const props = (await api.query.common.collectionProperties(collectionId)).toJSON();11431144 return (props! as any).consumedSpace;1145 }11461147 async getCollectionOptions(collectionId: number) {1148 return (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1149 }11501151 /**1152 * Deletes onchain properties from the collection.1153 *1154 * @param signer keyring of signer1155 * @param collectionId ID of collection1156 * @param propertyKeys array of property keys to delete1157 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);1158 * @returns ```true``` if extrinsic success, otherwise ```false```1159 */1160 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {1161 const result = await this.helper.executeExtrinsic(1162 signer,1163 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],1164 true,1165 );11661167 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');1168 }11691170 /**1171 * Changes the owner of the token.1172 *1173 * @param signer keyring of signer1174 * @param collectionId ID of collection1175 * @param tokenId ID of token1176 * @param addressObj address of a new owner1177 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1178 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1179 * @returns true if the token success, otherwise false1180 */1181 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1182 const result = await this.helper.executeExtrinsic(1183 signer,1184 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],1185 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1186 );11871188 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1189 }11901191 /**1192 *1193 * Change ownership of a token(s) on behalf of the owner.1194 *1195 * @param signer keyring of signer1196 * @param collectionId ID of collection1197 * @param tokenId ID of token1198 * @param fromAddressObj address on behalf of which the token will be sent1199 * @param toAddressObj new token owner1200 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1201 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1202 * @returns true if the token success, otherwise false1203 */1204 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1205 const result = await this.helper.executeExtrinsic(1206 signer,1207 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1208 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1209 );1210 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1211 }12121213 /**1214 *1215 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1216 *1217 * @param signer keyring of signer1218 * @param collectionId ID of collection1219 * @param tokenId ID of token1220 * @param amount amount of tokens to be burned. For NFT must be set to 1n1221 * @example burnToken(aliceKeyring, 10, 5);1222 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1223 */1224 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1225 const burnResult = await this.helper.executeExtrinsic(1226 signer,1227 'api.tx.unique.burnItem', [collectionId, tokenId, amount],1228 true, // `Unable to burn token for ${label}`,1229 );1230 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1231 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1232 return burnedTokens.success;1233 }12341235 /**1236 * Destroys a concrete instance of NFT on behalf of the owner1237 *1238 * @param signer keyring of signer1239 * @param collectionId ID of collection1240 * @param tokenId ID of token1241 * @param fromAddressObj address on behalf of which the token will be burnt1242 * @param amount amount of tokens to be burned. For NFT must be set to 1n1243 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1244 * @returns ```true``` if extrinsic success, otherwise ```false```1245 */1246 async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1247 const burnResult = await this.helper.executeExtrinsic(1248 signer,1249 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1250 true, // `Unable to burn token from for ${label}`,1251 );1252 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1253 return burnedTokens.success && burnedTokens.tokens.length > 0;1254 }12551256 /**1257 * Set, change, or remove approved address to transfer the ownership of the NFT.1258 *1259 * @param signer keyring of signer1260 * @param collectionId ID of collection1261 * @param tokenId ID of token1262 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1263 * @param amount amount of token to be approved. For NFT must be set to 1n1264 * @returns ```true``` if extrinsic success, otherwise ```false```1265 */1266 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1267 const approveResult = await this.helper.executeExtrinsic(1268 signer,1269 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1270 true, // `Unable to approve token for ${label}`,1271 );12721273 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1274 }12751276 /**1277 * Set, change, or remove approved address to transfer the ownership of the NFT from eth mirror.1278 *1279 * @param signer keyring of signer1280 * @param collectionId ID of collection1281 * @param tokenId ID of token1282 * @param fromAddressObj Signer's Ethereum address containing her tokens1283 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1284 * @param amount amount of token to be approved. For NFT must be set to 1n1285 * @returns ```true``` if extrinsic success, otherwise ```false```1286 */1287 async approveTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {1288 const approveResult = await this.helper.executeExtrinsic(1289 signer,1290 'api.tx.unique.approveFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1291 true, // `Unable to approve token for ${label}`,1292 );12931294 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1295 }12961297 /**1298 * Set, change, or remove approved address to transfer the ownership of the NFT from eth mirror.1299 *1300 * @param signer keyring of signer1301 * @param collectionId ID of collection1302 * @param tokenId ID of token1303 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1304 * @param amount amount of token to be approved. For NFT must be set to 1n1305 * @returns ```true``` if extrinsic success, otherwise ```false```1306 */1307 async approveTokenFromEth(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1308 const ethMirror = CrossAccountId.fromKeyring(signer).toEthereum();1309 return await this.approveTokenFrom(signer, collectionId, tokenId, ethMirror, toAddressObj, amount);1310 }13111312 /**1313 * Get the amount of token pieces approved to transfer or burn. Normally 0.1314 *1315 * @param collectionId ID of collection1316 * @param tokenId ID of token1317 * @param toAccountObj address which is approved to use token pieces1318 * @param fromAccountObj address which may have allowed the use of its owned tokens1319 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1320 * @returns number of approved to transfer pieces1321 */1322 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1323 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1324 }13251326 /**1327 * Get the last created token ID in a collection1328 *1329 * @param collectionId ID of collection1330 * @example getLastTokenId(10);1331 * @returns id of the last created token1332 */1333 async getLastTokenId(collectionId: number): Promise<number> {1334 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1335 }13361337 /**1338 * Check if token exists1339 *1340 * @param collectionId ID of collection1341 * @param tokenId ID of token1342 * @example doesTokenExist(10, 20);1343 * @returns true if the token exists, otherwise false1344 */1345 async doesTokenExist(collectionId: number, tokenId: number): Promise<boolean> {1346 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1347 }1348}13491350class NFTnRFT extends CollectionGroup {1351 /**1352 * Get tokens owned by account1353 *1354 * @param collectionId ID of collection1355 * @param addressObj tokens owner1356 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1357 * @returns array of token ids owned by account1358 */1359 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1360 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1361 }13621363 /**1364 * Get token data1365 *1366 * @param collectionId ID of collection1367 * @param tokenId ID of token1368 * @param propertyKeys optionally filter the token properties to only these keys1369 * @param blockHashAt optionally query the data at some block with this hash1370 * @example getToken(10, 5);1371 * @returns human readable token data1372 */1373 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1374 properties: IProperty[];1375 owner: CrossAccountId;1376 normalizedOwner: CrossAccountId;1377 }| null> {1378 let tokenData;1379 if(typeof blockHashAt === 'undefined') {1380 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1381 }1382 else {1383 if(propertyKeys.length == 0) {1384 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1385 if(!collection) return null;1386 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1387 }1388 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1389 }1390 tokenData = tokenData.toHuman();1391 if (tokenData === null || tokenData.owner === null) return null;1392 const owner = {} as any;1393 for (const key of Object.keys(tokenData.owner)) {1394 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate'1395 ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key])1396 : tokenData.owner[key];1397 }1398 tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1399 return tokenData;1400 }14011402 /**1403 * Get token's owner1404 * @param collectionId ID of collection1405 * @param tokenId ID of token1406 * @param blockHashAt optionally query the data at the block with this hash1407 * @example getTokenOwner(10, 5);1408 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1409 */1410 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1411 let owner;1412 if (typeof blockHashAt === 'undefined') {1413 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1414 } else {1415 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1416 }1417 return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1418 }14191420 /**1421 * Recursively find the address that owns the token1422 * @param collectionId ID of collection1423 * @param tokenId ID of token1424 * @param blockHashAt1425 * @example getTokenTopmostOwner(10, 5);1426 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1427 */1428 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1429 let owner;1430 if (typeof blockHashAt === 'undefined') {1431 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1432 } else {1433 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1434 }14351436 if (owner === null) return null;14371438 return owner.toHuman();1439 }14401441 /**1442 * Nest one token into another1443 * @param signer keyring of signer1444 * @param tokenObj token to be nested1445 * @param rootTokenObj token to be parent1446 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1447 * @returns ```true``` if extrinsic success, otherwise ```false```1448 */1449 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1450 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1451 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1452 if(!result) {1453 throw Error('Unable to nest token!');1454 }1455 return result;1456 }14571458 /**1459 * Remove token from nested state1460 * @param signer keyring of signer1461 * @param tokenObj token to unnest1462 * @param rootTokenObj parent of a token1463 * @param toAddressObj address of a new token owner1464 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1465 * @returns ```true``` if extrinsic success, otherwise ```false```1466 */1467 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1468 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1469 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1470 if(!result) {1471 throw Error('Unable to unnest token!');1472 }1473 return result;1474 }14751476 /**1477 * Set permissions to change token properties1478 *1479 * @param signer keyring of signer1480 * @param collectionId ID of collection1481 * @param permissions permissions to change a property by the collection admin or token owner1482 * @example setTokenPropertyPermissions(1483 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1484 * )1485 * @returns true if extrinsic success otherwise false1486 */1487 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1488 const result = await this.helper.executeExtrinsic(1489 signer,1490 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1491 true,1492 );14931494 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1495 }14961497 /**1498 * Get token property permissions.1499 *1500 * @param collectionId ID of collection1501 * @param propertyKeys optionally filter the returned property permissions to only these keys1502 * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1503 * @returns array of key-permission pairs1504 */1505 async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1506 return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1507 }15081509 /**1510 * Set token properties1511 *1512 * @param signer keyring of signer1513 * @param collectionId ID of collection1514 * @param tokenId ID of token1515 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1516 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1517 * @returns ```true``` if extrinsic success, otherwise ```false```1518 */1519 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1520 const result = await this.helper.executeExtrinsic(1521 signer,1522 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1523 true,1524 );15251526 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1527 }15281529 /**1530 * Get properties, metadata assigned to a token.1531 *1532 * @param collectionId ID of collection1533 * @param tokenId ID of token1534 * @param propertyKeys optionally filter the returned properties to only these keys1535 * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1536 * @returns array of key-value pairs1537 */1538 async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1539 return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1540 }15411542 /**1543 * Delete the provided properties of a token1544 * @param signer keyring of signer1545 * @param collectionId ID of collection1546 * @param tokenId ID of token1547 * @param propertyKeys property keys to be deleted1548 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1549 * @returns ```true``` if extrinsic success, otherwise ```false```1550 */1551 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1552 const result = await this.helper.executeExtrinsic(1553 signer,1554 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1555 true,1556 );15571558 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1559 }15601561 /**1562 * Mint new collection1563 *1564 * @param signer keyring of signer1565 * @param collectionOptions basic collection options and properties1566 * @param mode NFT or RFT type of a collection1567 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1568 * @returns object of the created collection1569 */1570 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1571 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1572 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1573 for (const key of ['name', 'description', 'tokenPrefix']) {1574 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1575 }1576 const creationResult = await this.helper.executeExtrinsic(1577 signer,1578 'api.tx.unique.createCollectionEx', [collectionOptions],1579 true, // errorLabel,1580 );1581 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1582 }15831584 getCollectionObject(_collectionId: number): any {1585 return null;1586 }15871588 getTokenObject(_collectionId: number, _tokenId: number): any {1589 return null;1590 }15911592 /**1593 * Tells whether the given `owner` approves the `operator`.1594 * @param collectionId ID of collection1595 * @param owner owner address1596 * @param operator operator addrees1597 * @returns true if operator is enabled1598 */1599 async allowanceForAll(collectionId: number, owner: ICrossAccountId, operator: ICrossAccountId): Promise<boolean> {1600 return (await this.helper.callRpc('api.rpc.unique.allowanceForAll', [collectionId, owner, operator])).toJSON();1601 }16021603 /** Sets or unsets the approval of a given operator.1604 * The `operator` is allowed to transfer all tokens of the `caller` on their behalf.1605 * @param operator Operator1606 * @param approved Should operator status be granted or revoked?1607 * @returns ```true``` if extrinsic success, otherwise ```false```1608 */1609 async setAllowanceForAll(signer: TSigner, collectionId: number, operator: ICrossAccountId, approved: boolean): Promise<boolean> {1610 const result = await this.helper.executeExtrinsic(1611 signer,1612 'api.tx.unique.setAllowanceForAll', [collectionId, operator, approved],1613 true,1614 );1615 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'ApprovedForAll');1616 }1617}161816191620class NFTGroup extends NFTnRFT {1621 /**1622 * Get collection object1623 * @param collectionId ID of collection1624 * @example getCollectionObject(2);1625 * @returns instance of UniqueNFTCollection1626 */1627 getCollectionObject(collectionId: number): UniqueNFTCollection {1628 return new UniqueNFTCollection(collectionId, this.helper);1629 }16301631 /**1632 * Get token object1633 * @param collectionId ID of collection1634 * @param tokenId ID of token1635 * @example getTokenObject(10, 5);1636 * @returns instance of UniqueNFTToken1637 */1638 getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1639 return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1640 }16411642 /**1643 * Is token approved to transfer1644 * @param collectionId ID of collection1645 * @param tokenId ID of token1646 * @param toAccountObj address to be approved1647 * @returns ```true``` if extrinsic success, otherwise ```false```1648 */1649 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1650 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1651 }16521653 /**1654 * Changes the owner of the token.1655 *1656 * @param signer keyring of signer1657 * @param collectionId ID of collection1658 * @param tokenId ID of token1659 * @param addressObj address of a new owner1660 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1661 * @returns ```true``` if extrinsic success, otherwise ```false```1662 */1663 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1664 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1665 }16661667 /**1668 *1669 * Change ownership of a NFT on behalf of the owner.1670 *1671 * @param signer keyring of signer1672 * @param collectionId ID of collection1673 * @param tokenId ID of token1674 * @param fromAddressObj address on behalf of which the token will be sent1675 * @param toAddressObj new token owner1676 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1677 * @returns ```true``` if extrinsic success, otherwise ```false```1678 */1679 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1680 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1681 }16821683 /**1684 * Get tokens nested in the provided token1685 * @param collectionId ID of collection1686 * @param tokenId ID of token1687 * @param blockHashAt optionally query the data at the block with this hash1688 * @example getTokenChildren(10, 5);1689 * @returns tokens whose depth of nesting is <= 51690 */1691 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1692 let children;1693 if(typeof blockHashAt === 'undefined') {1694 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1695 } else {1696 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1697 }16981699 return children.toJSON().map((x: any) => {1700 return {collectionId: x.collection, tokenId: x.token};1701 });1702 }17031704 /**1705 * Mint new collection1706 * @param signer keyring of signer1707 * @param collectionOptions Collection options1708 * @example1709 * mintCollection(aliceKeyring, {1710 * name: 'New',1711 * description: 'New collection',1712 * tokenPrefix: 'NEW',1713 * })1714 * @returns object of the created collection1715 */1716 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1717 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1718 }17191720 /**1721 * Mint new token1722 * @param signer keyring of signer1723 * @param data token data1724 * @returns created token object1725 */1726 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1727 const creationResult = await this.helper.executeExtrinsic(1728 signer,1729 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1730 nft: {1731 properties: data.properties,1732 },1733 }],1734 true,1735 );1736 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1737 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1738 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1739 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1740 }17411742 /**1743 * Mint multiple NFT tokens1744 * @param signer keyring of signer1745 * @param collectionId ID of collection1746 * @param tokens array of tokens with owner and properties1747 * @example1748 * mintMultipleTokens(aliceKeyring, 10, [{1749 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1750 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1751 * },{1752 * owner: {Ethereum: "0x9F0583DbB855d..."},1753 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1754 * }]);1755 * @returns ```true``` if extrinsic success, otherwise ```false```1756 */1757 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1758 const creationResult = await this.helper.executeExtrinsic(1759 signer,1760 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1761 true,1762 );1763 const collection = this.getCollectionObject(collectionId);1764 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1765 }17661767 /**1768 * Mint multiple NFT tokens with one owner1769 * @param signer keyring of signer1770 * @param collectionId ID of collection1771 * @param owner tokens owner1772 * @param tokens array of tokens with owner and properties1773 * @example1774 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1775 * properties: [{1776 * key: "gender",1777 * value: "female",1778 * },{1779 * key: "age",1780 * value: "33",1781 * }],1782 * }]);1783 * @returns array of newly created tokens1784 */1785 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1786 const rawTokens = [];1787 for (const token of tokens) {1788 const raw = {NFT: {properties: token.properties}};1789 rawTokens.push(raw);1790 }1791 const creationResult = await this.helper.executeExtrinsic(1792 signer,1793 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1794 true,1795 );1796 const collection = this.getCollectionObject(collectionId);1797 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1798 }17991800 /**1801 * Set, change, or remove approved address to transfer the ownership of the NFT.1802 *1803 * @param signer keyring of signer1804 * @param collectionId ID of collection1805 * @param tokenId ID of token1806 * @param toAddressObj address to approve1807 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1808 * @returns ```true``` if extrinsic success, otherwise ```false```1809 */1810 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1811 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1812 }1813}181418151816class RFTGroup extends NFTnRFT {1817 /**1818 * Get collection object1819 * @param collectionId ID of collection1820 * @example getCollectionObject(2);1821 * @returns instance of UniqueRFTCollection1822 */1823 getCollectionObject(collectionId: number): UniqueRFTCollection {1824 return new UniqueRFTCollection(collectionId, this.helper);1825 }18261827 /**1828 * Get token object1829 * @param collectionId ID of collection1830 * @param tokenId ID of token1831 * @example getTokenObject(10, 5);1832 * @returns instance of UniqueNFTToken1833 */1834 getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1835 return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1836 }18371838 /**1839 * Get top 10 token owners with the largest number of pieces1840 * @param collectionId ID of collection1841 * @param tokenId ID of token1842 * @example getTokenTop10Owners(10, 5);1843 * @returns array of top 10 owners1844 */1845 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1846 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1847 }18481849 /**1850 * Get number of pieces owned by address1851 * @param collectionId ID of collection1852 * @param tokenId ID of token1853 * @param addressObj address token owner1854 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1855 * @returns number of pieces ownerd by address1856 */1857 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1858 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1859 }18601861 /**1862 * Transfer pieces of token to another address1863 * @param signer keyring of signer1864 * @param collectionId ID of collection1865 * @param tokenId ID of token1866 * @param addressObj address of a new owner1867 * @param amount number of pieces to be transfered1868 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1869 * @returns ```true``` if extrinsic success, otherwise ```false```1870 */1871 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1872 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1873 }18741875 /**1876 * Change ownership of some pieces of RFT on behalf of the owner.1877 * @param signer keyring of signer1878 * @param collectionId ID of collection1879 * @param tokenId ID of token1880 * @param fromAddressObj address on behalf of which the token will be sent1881 * @param toAddressObj new token owner1882 * @param amount number of pieces to be transfered1883 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1884 * @returns ```true``` if extrinsic success, otherwise ```false```1885 */1886 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1887 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1888 }18891890 /**1891 * Mint new collection1892 * @param signer keyring of signer1893 * @param collectionOptions Collection options1894 * @example1895 * mintCollection(aliceKeyring, {1896 * name: 'New',1897 * description: 'New collection',1898 * tokenPrefix: 'NEW',1899 * })1900 * @returns object of the created collection1901 */1902 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1903 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1904 }19051906 /**1907 * Mint new token1908 * @param signer keyring of signer1909 * @param data token data1910 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1911 * @returns created token object1912 */1913 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1914 const creationResult = await this.helper.executeExtrinsic(1915 signer,1916 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1917 refungible: {1918 pieces: data.pieces,1919 properties: data.properties,1920 },1921 }],1922 true,1923 );1924 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1925 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1926 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1927 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1928 }19291930 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1931 throw Error('Not implemented');1932 const creationResult = await this.helper.executeExtrinsic(1933 signer,1934 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1935 true, // `Unable to mint RFT tokens for ${label}`,1936 );1937 const collection = this.getCollectionObject(collectionId);1938 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1939 }19401941 /**1942 * Mint multiple RFT tokens with one owner1943 * @param signer keyring of signer1944 * @param collectionId ID of collection1945 * @param owner tokens owner1946 * @param tokens array of tokens with properties and pieces1947 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1948 * @returns array of newly created RFT tokens1949 */1950 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1951 const rawTokens = [];1952 for (const token of tokens) {1953 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1954 rawTokens.push(raw);1955 }1956 const creationResult = await this.helper.executeExtrinsic(1957 signer,1958 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1959 true,1960 );1961 const collection = this.getCollectionObject(collectionId);1962 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1963 }19641965 /**1966 * Destroys a concrete instance of RFT.1967 * @param signer keyring of signer1968 * @param collectionId ID of collection1969 * @param tokenId ID of token1970 * @param amount number of pieces to be burnt1971 * @example burnToken(aliceKeyring, 10, 5);1972 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1973 */1974 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1975 return await super.burnToken(signer, collectionId, tokenId, amount);1976 }19771978 /**1979 * Destroys a concrete instance of RFT on behalf of the owner.1980 * @param signer keyring of signer1981 * @param collectionId ID of collection1982 * @param tokenId ID of token1983 * @param fromAddressObj address on behalf of which the token will be burnt1984 * @param amount number of pieces to be burnt1985 * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1986 * @returns ```true``` if extrinsic success, otherwise ```false```1987 */1988 async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1989 return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1990 }19911992 /**1993 * Set, change, or remove approved address to transfer the ownership of the RFT.1994 *1995 * @param signer keyring of signer1996 * @param collectionId ID of collection1997 * @param tokenId ID of token1998 * @param toAddressObj address to approve1999 * @param amount number of pieces to be approved2000 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);2001 * @returns true if the token success, otherwise false2002 */2003 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {2004 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);2005 }20062007 /**2008 * Get total number of pieces2009 * @param collectionId ID of collection2010 * @param tokenId ID of token2011 * @example getTokenTotalPieces(10, 5);2012 * @returns number of pieces2013 */2014 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {2015 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();2016 }20172018 /**2019 * Change number of token pieces. Signer must be the owner of all token pieces.2020 * @param signer keyring of signer2021 * @param collectionId ID of collection2022 * @param tokenId ID of token2023 * @param amount new number of pieces2024 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);2025 * @returns true if the repartion was success, otherwise false2026 */2027 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {2028 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);2029 const repartitionResult = await this.helper.executeExtrinsic(2030 signer,2031 'api.tx.unique.repartition', [collectionId, tokenId, amount],2032 true,2033 );2034 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');2035 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');2036 }2037}203820392040class FTGroup extends CollectionGroup {2041 /**2042 * Get collection object2043 * @param collectionId ID of collection2044 * @example getCollectionObject(2);2045 * @returns instance of UniqueFTCollection2046 */2047 getCollectionObject(collectionId: number): UniqueFTCollection {2048 return new UniqueFTCollection(collectionId, this.helper);2049 }20502051 /**2052 * Mint new fungible collection2053 * @param signer keyring of signer2054 * @param collectionOptions Collection options2055 * @param decimalPoints number of token decimals2056 * @example2057 * mintCollection(aliceKeyring, {2058 * name: 'New',2059 * description: 'New collection',2060 * tokenPrefix: 'NEW',2061 * }, 18)2062 * @returns newly created fungible collection2063 */2064 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {2065 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object2066 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');2067 collectionOptions.mode = {fungible: decimalPoints};2068 for (const key of ['name', 'description', 'tokenPrefix']) {2069 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);2070 }2071 const creationResult = await this.helper.executeExtrinsic(2072 signer,2073 'api.tx.unique.createCollectionEx', [collectionOptions],2074 true,2075 );2076 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));2077 }20782079 /**2080 * Mint tokens2081 * @param signer keyring of signer2082 * @param collectionId ID of collection2083 * @param owner address owner of new tokens2084 * @param amount amount of tokens to be meanted2085 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);2086 * @returns ```true``` if extrinsic success, otherwise ```false```2087 */2088 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {2089 const creationResult = await this.helper.executeExtrinsic(2090 signer,2091 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {2092 fungible: {2093 value: amount,2094 },2095 }],2096 true, // `Unable to mint fungible tokens for ${label}`,2097 );2098 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2099 }21002101 /**2102 * Mint multiple Fungible tokens with one owner2103 * @param signer keyring of signer2104 * @param collectionId ID of collection2105 * @param owner tokens owner2106 * @param tokens array of tokens with properties and pieces2107 * @returns ```true``` if extrinsic success, otherwise ```false```2108 */2109 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {2110 const rawTokens = [];2111 for (const token of tokens) {2112 const raw = {Fungible: {Value: token.value}};2113 rawTokens.push(raw);2114 }2115 const creationResult = await this.helper.executeExtrinsic(2116 signer,2117 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],2118 true,2119 );2120 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2121 }21222123 /**2124 * Get the top 10 owners with the largest balance for the Fungible collection2125 * @param collectionId ID of collection2126 * @example getTop10Owners(10);2127 * @returns array of ```ICrossAccountId```2128 */2129 async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {2130 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);2131 }21322133 /**2134 * Get account balance2135 * @param collectionId ID of collection2136 * @param addressObj address of owner2137 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})2138 * @returns amount of fungible tokens owned by address2139 */2140 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {2141 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();2142 }21432144 /**2145 * Transfer tokens to address2146 * @param signer keyring of signer2147 * @param collectionId ID of collection2148 * @param toAddressObj address recipient2149 * @param amount amount of tokens to be sent2150 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2151 * @returns ```true``` if extrinsic success, otherwise ```false```2152 */2153 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {2154 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);2155 }21562157 /**2158 * Transfer some tokens on behalf of the owner.2159 * @param signer keyring of signer2160 * @param collectionId ID of collection2161 * @param fromAddressObj address on behalf of which tokens will be sent2162 * @param toAddressObj address where token to be sent2163 * @param amount number of tokens to be sent2164 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);2165 * @returns ```true``` if extrinsic success, otherwise ```false```2166 */2167 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2168 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);2169 }21702171 /**2172 * Destroy some amount of tokens2173 * @param signer keyring of signer2174 * @param collectionId ID of collection2175 * @param amount amount of tokens to be destroyed2176 * @example burnTokens(aliceKeyring, 10, 1000n);2177 * @returns ```true``` if extrinsic success, otherwise ```false```2178 */2179 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {2180 return await super.burnToken(signer, collectionId, 0, amount);2181 }21822183 /**2184 * Burn some tokens on behalf of the owner.2185 * @param signer keyring of signer2186 * @param collectionId ID of collection2187 * @param fromAddressObj address on behalf of which tokens will be burnt2188 * @param amount amount of tokens to be burnt2189 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2190 * @returns ```true``` if extrinsic success, otherwise ```false```2191 */2192 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {2193 return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);2194 }21952196 /**2197 * Get total collection supply2198 * @param collectionId2199 * @returns2200 */2201 async getTotalPieces(collectionId: number): Promise<bigint> {2202 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();2203 }22042205 /**2206 * Set, change, or remove approved address to transfer tokens.2207 *2208 * @param signer keyring of signer2209 * @param collectionId ID of collection2210 * @param toAddressObj address to be approved2211 * @param amount amount of tokens to be approved2212 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)2213 * @returns ```true``` if extrinsic success, otherwise ```false```2214 */2215 approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {2216 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);2217 }22182219 /**2220 * Get amount of fungible tokens approved to transfer2221 * @param collectionId ID of collection2222 * @param fromAddressObj owner of tokens2223 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner2224 * @returns number of tokens approved for the transfer2225 */2226 getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2227 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);2228 }2229}223022312232class ChainGroup extends HelperGroup<ChainHelperBase> {2233 /**2234 * Get system properties of a chain2235 * @example getChainProperties();2236 * @returns ss58Format, token decimals, and token symbol2237 */2238 getChainProperties(): IChainProperties {2239 const properties = (this.helper.getApi() as any).registry.getChainProperties().toJSON();2240 return {2241 ss58Format: properties.ss58Format.toJSON(),2242 tokenDecimals: properties.tokenDecimals.toJSON(),2243 tokenSymbol: properties.tokenSymbol.toJSON(),2244 };2245 }22462247 /**2248 * Get chain header2249 * @example getLatestBlockNumber();2250 * @returns the number of the last block2251 */2252 async getLatestBlockNumber(): Promise<number> {2253 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2254 }22552256 /**2257 * Get block hash by block number2258 * @param blockNumber number of block2259 * @example getBlockHashByNumber(12345);2260 * @returns hash of a block2261 */2262 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2263 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2264 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2265 return blockHash;2266 }22672268 // TODO add docs2269 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2270 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2271 if (!blockHash) return null;2272 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2273 }22742275 /**2276 * Get latest relay block2277 * @returns {number} relay block2278 */2279 async getRelayBlockNumber(): Promise<bigint> {2280 const blockNumber = (await this.helper.callRpc('api.query.parachainSystem.validationData')).toJSON().relayParentNumber;2281 return BigInt(blockNumber);2282 }22832284 /**2285 * Get account nonce2286 * @param address substrate address2287 * @example getNonce("5GrwvaEF5zXb26Fz...");2288 * @returns number, account's nonce2289 */2290 async getNonce(address: TSubstrateAccount): Promise<number> {2291 return (await this.helper.callRpc('api.query.system.account', [address])).nonce.toNumber();2292 }2293}22942295class SubstrateBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2296 /**2297 * Get substrate address balance2298 * @param address substrate address2299 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2300 * @returns amount of tokens on address2301 */2302 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2303 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2304 }23052306 /**2307 * Transfer tokens to substrate address2308 * @param signer keyring of signer2309 * @param address substrate address of a recipient2310 * @param amount amount of tokens to be transfered2311 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2312 * @returns ```true``` if extrinsic success, otherwise ```false```2313 */2314 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2315 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true/*, `Unable to transfer balance from ${this.helper.getSignerAddress(signer)} to ${address}`*/);23162317 let transfer = {from: null, to: null, amount: 0n} as any;2318 result.result.events.forEach(({event: {data, method, section}}) => {2319 if ((section === 'balances') && (method === 'Transfer')) {2320 transfer = {2321 from: this.helper.address.normalizeSubstrate(data[0]),2322 to: this.helper.address.normalizeSubstrate(data[1]),2323 amount: BigInt(data[2]),2324 };2325 }2326 });2327 const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from2328 && this.helper.address.normalizeSubstrate(address) === transfer.to2329 && BigInt(amount) === transfer.amount;2330 return isSuccess;2331 }23322333 /**2334 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2335 * @param address substrate address2336 * @returns2337 */2338 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2339 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2340 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2341 }23422343 async getLocked(address: TSubstrateAccount): Promise<[{id: string, amount: bigint, reason: string}]> {2344 const locks = (await this.helper.callRpc('api.query.balances.locks', [address])).toHuman();2345 return locks.map((lock: any) => {return {id: lock.id, amount: BigInt(lock.amount.replace(/,/g, '')), reasons: lock.reasons};});2346 }2347}23482349class EthereumBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2350 /**2351 * Get ethereum address balance2352 * @param address ethereum address2353 * @example getEthereum("0x9F0583DbB855d...")2354 * @returns amount of tokens on address2355 */2356 async getEthereum(address: TEthereumAccount): Promise<bigint> {2357 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2358 }23592360 /**2361 * Transfer tokens to address2362 * @param signer keyring of signer2363 * @param address Ethereum address of a recipient2364 * @param amount amount of tokens to be transfered2365 * @example transferToEthereum(alithKeyring, "0x9F0583DbB855d...", 100_000_000_000n);2366 * @returns ```true``` if extrinsic success, otherwise ```false```2367 */2368 async transferToEthereum(signer: TSigner, address: TEthereumAccount, amount: bigint | string): Promise<boolean> {2369 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true);23702371 let transfer = {from: null, to: null, amount: 0n} as any;2372 result.result.events.forEach(({event: {data, method, section}}) => {2373 if ((section === 'balances') && (method === 'Transfer')) {2374 transfer = {2375 from: data[0].toString(),2376 to: data[1].toString(),2377 amount: BigInt(data[2]),2378 };2379 }2380 });2381 const isSuccess = (typeof signer === 'string' ? signer : signer.address) === transfer.from2382 && address === transfer.to2383 && BigInt(amount) === transfer.amount;2384 return isSuccess;2385 }2386}23872388class BalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2389 subBalanceGroup: SubstrateBalanceGroup<T>;2390 ethBalanceGroup: EthereumBalanceGroup<T>;23912392 constructor(helper: T) {2393 super(helper);2394 this.subBalanceGroup = new SubstrateBalanceGroup(helper);2395 this.ethBalanceGroup = new EthereumBalanceGroup(helper);2396 }23972398 getCollectionCreationPrice(): bigint {2399 return 2n * this.getOneTokenNominal();2400 }2401 /**2402 * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2403 * @example getOneTokenNominal()2404 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2405 */2406 getOneTokenNominal(): bigint {2407 const chainProperties = this.helper.chain.getChainProperties();2408 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2409 }24102411 /**2412 * Get substrate address balance2413 * @param address substrate address2414 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2415 * @returns amount of tokens on address2416 */2417 getSubstrate(address: TSubstrateAccount): Promise<bigint> {2418 return this.subBalanceGroup.getSubstrate(address);2419 }24202421 /**2422 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2423 * @param address substrate address2424 * @returns2425 */2426 getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2427 return this.subBalanceGroup.getSubstrateFull(address);2428 }24292430 /**2431 * Get locked balances2432 * @param address substrate address2433 * @returns locked balances with reason via api.query.balances.locks2434 */2435 getLocked(address: TSubstrateAccount) {2436 return this.subBalanceGroup.getLocked(address);2437 }24382439 /**2440 * Get ethereum address balance2441 * @param address ethereum address2442 * @example getEthereum("0x9F0583DbB855d...")2443 * @returns amount of tokens on address2444 */2445 getEthereum(address: TEthereumAccount): Promise<bigint> {2446 return this.ethBalanceGroup.getEthereum(address);2447 }24482449 /**2450 * Transfer tokens to substrate address2451 * @param signer keyring of signer2452 * @param address substrate address of a recipient2453 * @param amount amount of tokens to be transfered2454 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2455 * @returns ```true``` if extrinsic success, otherwise ```false```2456 */2457 transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2458 return this.subBalanceGroup.transferToSubstrate(signer, address, amount);2459 }24602461 async forceTransferToSubstrate(signer: TSigner, from: TSubstrateAccount, to: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2462 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.forceTransfer', [from, to, amount], true);24632464 let transfer = {from: null, to: null, amount: 0n} as any;2465 result.result.events.forEach(({event: {data, method, section}}) => {2466 if ((section === 'balances') && (method === 'Transfer')) {2467 transfer = {2468 from: this.helper.address.normalizeSubstrate(data[0]),2469 to: this.helper.address.normalizeSubstrate(data[1]),2470 amount: BigInt(data[2]),2471 };2472 }2473 });2474 let isSuccess = this.helper.address.normalizeSubstrate(from) === transfer.from;2475 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(to) === transfer.to;2476 isSuccess = isSuccess && BigInt(amount) === transfer.amount;2477 return isSuccess;2478 }24792480 /**2481 * Transfer tokens with the unlock period2482 * @param signer signers Keyring2483 * @param address Substrate address of recipient2484 * @param schedule Schedule params2485 * @example vestedTransfer(signer, recepient.address, 20000, 100, 10, 50 * nominal); // total amount of vested tokens will be 100 * 50 = 50002486 */2487 async vestedTransfer(signer: TSigner, address: TSubstrateAccount, schedule: {start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}): Promise<void> {2488 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.vestedTransfer', [address, schedule]);2489 const event = result.result.events2490 .find(e => e.event.section === 'vesting' &&2491 e.event.method === 'VestingScheduleAdded' &&2492 e.event.data[0].toHuman() === signer.address);2493 if (!event) throw Error('Cannot find transfer in events');2494 }24952496 /**2497 * Get schedule for recepient of vested transfer2498 * @param address Substrate address of recipient2499 * @returns2500 */2501 async getVestingSchedules(address: TSubstrateAccount): Promise<{start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}[]> {2502 const schedule = (await this.helper.callRpc('api.query.vesting.vestingSchedules', [address])).toJSON();2503 return schedule.map((schedule: any) => {2504 return {2505 start: BigInt(schedule.start),2506 period: BigInt(schedule.period),2507 periodCount: BigInt(schedule.periodCount),2508 perPeriod: BigInt(schedule.perPeriod),2509 };2510 });2511 }25122513 /**2514 * Claim vested tokens2515 * @param signer signers Keyring2516 */2517 async claim(signer: TSigner) {2518 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.claim', []);2519 const event = result.result.events2520 .find(e => e.event.section === 'vesting' &&2521 e.event.method === 'Claimed' &&2522 e.event.data[0].toHuman() === signer.address);2523 if (!event) throw Error('Cannot find claim in events');2524 }2525}25262527class AddressGroup extends HelperGroup<ChainHelperBase> {2528 /**2529 * Normalizes the address to the specified ss58 format, by default ```42```.2530 * @param address substrate address2531 * @param ss58Format format for address conversion, by default ```42```2532 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2533 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2534 */2535 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2536 return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2537 }25382539 /**2540 * Get address in the connected chain format2541 * @param address substrate address2542 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2543 * @returns address in chain format2544 */2545 normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2546 return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2547 }25482549 /**2550 * Get substrate mirror of an ethereum address2551 * @param ethAddress ethereum address2552 * @param toChainFormat false for normalized account2553 * @example ethToSubstrate('0x9F0583DbB855d...')2554 * @returns substrate mirror of a provided ethereum address2555 */2556 ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): TSubstrateAccount {2557 return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2558 }25592560 /**2561 * Get ethereum mirror of a substrate address2562 * @param subAddress substrate account2563 * @example substrateToEth("5DnSF6RRjwteE3BrC...")2564 * @returns ethereum mirror of a provided substrate address2565 */2566 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2567 return CrossAccountId.translateSubToEth(subAddress);2568 }25692570 /**2571 * Encode key to substrate address2572 * @param key key for encoding address2573 * @param ss58Format prefix for encoding to the address of the corresponding network2574 * @returns encoded substrate address2575 */2576 encodeSubstrateAddress (key: Uint8Array | string | bigint, ss58Format = 42): string {2577 const u8a :Uint8Array = typeof key === 'string'2578 ? hexToU8a(key)2579 : typeof key === 'bigint'2580 ? hexToU8a(key.toString(16))2581 : key;25822583 if (ss58Format < 0 || ss58Format > 16383 || [46, 47].includes(ss58Format)) {2584 throw new Error(`ss58Format is not valid, received ${typeofss58Format} "${ss58Format}"`);2585 }25862587 const allowedDecodedLengths = [1, 2, 4, 8, 32, 33];2588 if (!allowedDecodedLengths.includes(u8a.length)) {2589 throw new Error(`key length is not valid, received ${u8a.length}, valid values are ${allowedDecodedLengths.join(', ')}`);2590 }25912592 const u8aPrefix = ss58Format < 642593 ? new Uint8Array([ss58Format])2594 : new Uint8Array([2595 ((ss58Format & 0xfc) >> 2) | 0x40,2596 (ss58Format >> 8) | ((ss58Format & 0x03) << 6),2597 ]);25982599 const input = u8aConcat(u8aPrefix, u8a);26002601 return base58Encode(u8aConcat(2602 input,2603 blake2AsU8a(input).subarray(0, [32, 33].includes(u8a.length) ? 2 : 1),2604 ));2605 }26062607 /**2608 * Restore substrate address from bigint representation2609 * @param number decimal representation of substrate address2610 * @returns substrate address2611 */2612 restoreCrossAccountFromBigInt(number: bigint): TSubstrateAccount {2613 if (this.helper.api === null) {2614 throw 'Not connected';2615 }2616 const res = this.helper.api.registry.createType('AccountId', '0x' + number.toString(16).padStart(64, '0')).toJSON();2617 if (res === undefined || res === null) {2618 throw 'Restore address error';2619 }2620 return res.toString();2621 }26222623 /**2624 * Convert etherium cross account id to substrate cross account id2625 * @param ethCrossAccount etherium cross account2626 * @returns substrate cross account id2627 */2628 convertCrossAccountFromEthCrossAccount(ethCrossAccount: IEthCrossAccountId): ICrossAccountId {2629 if (ethCrossAccount.sub === '0') {2630 return {Ethereum: ethCrossAccount.eth.toLocaleLowerCase()};2631 }26322633 const ss58 = this.restoreCrossAccountFromBigInt(BigInt(ethCrossAccount.sub));2634 return {Substrate: ss58};2635 }26362637 paraSiblingSovereignAccount(paraid: number) {2638 // We are getting a *sibling* parachain sovereign account,2639 // so we need a sibling prefix: encoded(b"sibl") == 0x7369626c2640 const siblingPrefix = '0x7369626c';26412642 const encodedParaId = this.helper.getApi().createType('u32', paraid).toHex(true).substring(2);2643 const suffix = '000000000000000000000000000000000000000000000000';26442645 return siblingPrefix + encodedParaId + suffix;2646 }2647}26482649class StakingGroup extends HelperGroup<UniqueHelper> {2650 /**2651 * Stake tokens for App Promotion2652 * @param signer keyring of signer2653 * @param amountToStake amount of tokens to stake2654 * @param label extra label for log2655 * @returns2656 */2657 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2658 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2659 const _stakeResult = await this.helper.executeExtrinsic(2660 signer, 'api.tx.appPromotion.stake',2661 [amountToStake], true,2662 );2663 // TODO extract info from stakeResult2664 return true;2665 }26662667 /**2668 * Unstake all staked tokens2669 * @param signer keyring of signer2670 * @param amountToUnstake amount of tokens to unstake2671 * @param label extra label for log2672 * @returns block hash where unstake happened2673 */2674 async unstakeAll(signer: TSigner, label?: string): Promise<string> {2675 if(typeof label === 'undefined') label = `${signer.address}`;2676 const unstakeResult = await this.helper.executeExtrinsic(2677 signer, 'api.tx.appPromotion.unstakeAll',2678 [], true,2679 );2680 return unstakeResult.blockHash;2681 }26822683 /**2684 * Unstake the part of a staked tokens2685 * @param signer keyring of signer2686 * @param amount amount of tokens to unstake2687 * @param label extra label for log2688 * @returns block hash where unstake happened2689 */2690 async unstakePartial(signer: TSigner, amount: bigint, label?: string): Promise<string> {2691 if(typeof label === 'undefined') label = `${signer.address}`;2692 const unstakeResult = await this.helper.executeExtrinsic(2693 signer, 'api.tx.appPromotion.unstakePartial',2694 [amount], true,2695 );2696 return unstakeResult.blockHash;2697 }26982699 /**2700 * Get total number of active stakes2701 * @param address substrate address2702 * @returns {number}2703 */2704 async getStakesNumber(address: ICrossAccountId): Promise<number> {2705 if (address.Ethereum) throw Error('only substrate address');2706 return (await this.helper.callRpc('api.query.appPromotion.stakesPerAccount', [address.Substrate])).toNumber();2707 }27082709 /**2710 * Get total staked amount for address2711 * @param address substrate or ethereum address2712 * @returns total staked amount2713 */2714 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2715 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2716 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2717 }27182719 /**2720 * Get total staked per block2721 * @param address substrate or ethereum address2722 * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2723 */2724 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2725 const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2726 return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2727 return {2728 block: block.toBigInt(),2729 amount: amount.toBigInt(),2730 };2731 });2732 }27332734 /**2735 * Get total pending unstake amount for address2736 * @param address substrate or ethereum address2737 * @returns total pending unstake amount2738 */2739 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2740 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2741 }27422743 /**2744 * Get pending unstake amount per block for address2745 * @param address substrate or ethereum address2746 * @returns array of pending stakes. `block` – the number of the block in which the unstake was made. `amount` - the number of tokens unstaked in the block2747 */2748 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2749 const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2750 const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2751 return {2752 block: block.toBigInt(),2753 amount: amount.toBigInt(),2754 };2755 });2756 return result;2757 }2758}27592760class SchedulerGroup extends HelperGroup<UniqueHelper> {2761 constructor(helper: UniqueHelper) {2762 super(helper);2763 }27642765 cancelScheduled(signer: TSigner, scheduledId: string) {2766 return this.helper.executeExtrinsic(2767 signer,2768 'api.tx.scheduler.cancelNamed',2769 [scheduledId],2770 true,2771 );2772 }27732774 changePriority(signer: TSigner, scheduledId: string, priority: number) {2775 return this.helper.executeExtrinsic(2776 signer,2777 'api.tx.scheduler.changeNamedPriority',2778 [scheduledId, priority],2779 true,2780 );2781 }27822783 scheduleAt<T extends UniqueHelper>(2784 executionBlockNumber: number,2785 options: ISchedulerOptions = {},2786 ) {2787 return this.schedule<T>('schedule', executionBlockNumber, options);2788 }27892790 scheduleAfter<T extends UniqueHelper>(2791 blocksBeforeExecution: number,2792 options: ISchedulerOptions = {},2793 ) {2794 return this.schedule<T>('scheduleAfter', blocksBeforeExecution, options);2795 }27962797 schedule<T extends UniqueHelper>(2798 scheduleFn: 'schedule' | 'scheduleAfter',2799 blocksNum: number,2800 options: ISchedulerOptions = {},2801 ) {2802 // eslint-disable-next-line @typescript-eslint/naming-convention2803 const ScheduledHelperType = ScheduledUniqueHelper(this.helper.helperBase);2804 return this.helper.clone(ScheduledHelperType, {2805 scheduleFn,2806 blocksNum,2807 options,2808 }) as T;2809 }2810}28112812class CollatorSelectionGroup extends HelperGroup<UniqueHelper> {2813 //todo:collator documentation2814 addInvulnerable(signer: TSigner, address: string) {2815 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.addInvulnerable', [address]);2816 }28172818 removeInvulnerable(signer: TSigner, address: string) {2819 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.removeInvulnerable', [address]);2820 }28212822 async getInvulnerables(): Promise<string[]> {2823 return (await this.helper.callRpc('api.query.collatorSelection.invulnerables')).map((x: any) => x.toHuman());2824 }28252826 /** and also total max invulnerables */2827 maxCollators(): number {2828 return (this.helper.getApi().consts.configuration.defaultCollatorSelectionMaxCollators.toJSON() as number);2829 }28302831 async getDesiredCollators(): Promise<number> {2832 return (await this.helper.callRpc('api.query.configuration.collatorSelectionDesiredCollatorsOverride')).toNumber();2833 }28342835 setLicenseBond(signer: TSigner, amount: bigint) {2836 return this.helper.executeExtrinsic(signer, 'api.tx.configuration.setCollatorSelectionLicenseBond', [amount]);2837 }28382839 async getLicenseBond(): Promise<bigint> {2840 return (await this.helper.callRpc('api.query.configuration.collatorSelectionLicenseBondOverride')).toBigInt();2841 }28422843 obtainLicense(signer: TSigner) {2844 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.getLicense', []);2845 }28462847 releaseLicense(signer: TSigner) {2848 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.releaseLicense', []);2849 }28502851 forceReleaseLicense(signer: TSigner, released: string) {2852 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.forceReleaseLicense', [released]);2853 }28542855 async hasLicense(address: string): Promise<bigint> {2856 return (await this.helper.callRpc('api.query.collatorSelection.licenseDepositOf', [address])).toBigInt();2857 }28582859 onboard(signer: TSigner) {2860 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.onboard', []);2861 }28622863 offboard(signer: TSigner) {2864 return this.helper.executeExtrinsic(signer, 'api.tx.collatorSelection.offboard', []);2865 }28662867 async getCandidates(): Promise<string[]> {2868 return (await this.helper.callRpc('api.query.collatorSelection.candidates')).map((x: any) => x.toHuman());2869 }2870}28712872class ForeignAssetsGroup extends HelperGroup<UniqueHelper> {2873 async register(signer: TSigner, ownerAddress: TSubstrateAccount, location: any, metadata: IForeignAssetMetadata) {2874 await this.helper.executeExtrinsic(2875 signer,2876 'api.tx.foreignAssets.registerForeignAsset',2877 [ownerAddress, location, metadata],2878 true,2879 );2880 }28812882 async update(signer: TSigner, foreignAssetId: number, location: any, metadata: IForeignAssetMetadata) {2883 await this.helper.executeExtrinsic(2884 signer,2885 'api.tx.foreignAssets.updateForeignAsset',2886 [foreignAssetId, location, metadata],2887 true,2888 );2889 }2890}28912892class XcmGroup<T extends ChainHelperBase> extends HelperGroup<T> {2893 palletName: string;28942895 constructor(helper: T, palletName: string) {2896 super(helper);28972898 this.palletName = palletName;2899 }29002901 async limitedReserveTransferAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number, weightLimit: any) {2902 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.limitedReserveTransferAssets`, [destination, beneficiary, assets, feeAssetItem, weightLimit], true);2903 }29042905 async teleportAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number) {2906 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.teleportAssets`, [destination, beneficiary, assets, feeAssetItem], true);2907 }29082909 async teleportNativeAsset(signer: TSigner, destinationParaId: number, targetAccount: Uint8Array, amount: bigint) {2910 const destination = {2911 V1: {2912 parents: 0,2913 interior: {2914 X1: {2915 Parachain: destinationParaId,2916 },2917 },2918 },2919 };29202921 const beneficiary = {2922 V1: {2923 parents: 0,2924 interior: {2925 X1: {2926 AccountId32: {2927 network: 'Any',2928 id: targetAccount,2929 },2930 },2931 },2932 },2933 };29342935 const assets = {2936 V1: [2937 {2938 id: {2939 Concrete: {2940 parents: 0,2941 interior: 'Here',2942 },2943 },2944 fun: {2945 Fungible: amount,2946 },2947 },2948 ],2949 };29502951 const feeAssetItem = 0;29522953 await this.teleportAssets(signer, destination, beneficiary, assets, feeAssetItem);2954 }2955}29562957class XTokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2958 async transfer(signer: TSigner, currencyId: any, amount: bigint, destination: any, destWeight: any) {2959 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transfer', [currencyId, amount, destination, destWeight], true);2960 }29612962 async transferMultiasset(signer: TSigner, asset: any, destination: any, destWeight: any) {2963 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMultiasset', [asset, destination, destWeight], true);2964 }29652966 async transferMulticurrencies(signer: TSigner, currencies: any[], feeItem: number, destLocation: any, destWeight: any) {2967 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMulticurrencies', [currencies, feeItem, destLocation, destWeight], true);2968 }2969}29702971class TokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2972 async accounts(address: string, currencyId: any) {2973 const {free} = (await this.helper.callRpc('api.query.tokens.accounts', [address, currencyId])).toJSON() as any;2974 return BigInt(free);2975 }2976}29772978class AssetsGroup<T extends ChainHelperBase> extends HelperGroup<T> {2979 async create(signer: TSigner, assetId: number, admin: string, minimalBalance: bigint) {2980 await this.helper.executeExtrinsic(signer, 'api.tx.assets.create', [assetId, admin, minimalBalance], true);2981 }29822983 async setMetadata(signer: TSigner, assetId: number, name: string, symbol: string, decimals: number) {2984 await this.helper.executeExtrinsic(signer, 'api.tx.assets.setMetadata', [assetId, name, symbol, decimals], true);2985 }29862987 async mint(signer: TSigner, assetId: number, beneficiary: string, amount: bigint) {2988 await this.helper.executeExtrinsic(signer, 'api.tx.assets.mint', [assetId, beneficiary, amount], true);2989 }29902991 async account(assetId: string | number, address: string) {2992 const accountAsset = (2993 await this.helper.callRpc('api.query.assets.account', [assetId, address])2994 ).toJSON()! as any;29952996 if (accountAsset !== null) {2997 return BigInt(accountAsset['balance']);2998 } else {2999 return null;3000 }3001 }3002}30033004class AcalaAssetRegistryGroup extends HelperGroup<AcalaHelper> {3005 async registerForeignAsset(signer: TSigner, destination: any, metadata: AcalaAssetMetadata) {3006 await this.helper.executeExtrinsic(signer, 'api.tx.assetRegistry.registerForeignAsset', [destination, metadata], true);3007 }3008}30093010class MoonbeamAssetManagerGroup extends HelperGroup<MoonbeamHelper> {3011 makeRegisterForeignAssetProposal(assetInfo: MoonbeamAssetInfo) {3012 const apiPrefix = 'api.tx.assetManager.';30133014 const registerTx = this.helper.constructApiCall(3015 apiPrefix + 'registerForeignAsset',3016 [assetInfo.location, assetInfo.metadata, assetInfo.existentialDeposit, assetInfo.isSufficient],3017 );30183019 const setUnitsTx = this.helper.constructApiCall(3020 apiPrefix + 'setAssetUnitsPerSecond',3021 [assetInfo.location, assetInfo.unitsPerSecond, assetInfo.numAssetsWeightHint],3022 );30233024 const batchCall = this.helper.getApi().tx.utility.batchAll([registerTx, setUnitsTx]);3025 const encodedProposal = batchCall?.method.toHex() || '';3026 return encodedProposal;3027 }30283029 async assetTypeId(location: any) {3030 return await this.helper.callRpc('api.query.assetManager.assetTypeId', [location]);3031 }3032}30333034class MoonbeamDemocracyGroup extends HelperGroup<MoonbeamHelper> {3035 notePreimagePallet: string;30363037 constructor(helper: MoonbeamHelper, options: {[key: string]: any} = {}) {3038 super(helper);3039 this.notePreimagePallet = options.notePreimagePallet;3040 }30413042 async notePreimage(signer: TSigner, encodedProposal: string) {3043 await this.helper.executeExtrinsic(signer, `api.tx.${this.notePreimagePallet}.notePreimage`, [encodedProposal], true);3044 }30453046 externalProposeMajority(proposal: any) {3047 return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [proposal]);3048 }30493050 fastTrack(proposalHash: string, votingPeriod: number, delayPeriod: number) {3051 return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);3052 }30533054 async referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {3055 await this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);3056 }3057}30583059class MoonbeamCollectiveGroup extends HelperGroup<MoonbeamHelper> {3060 collective: string;30613062 constructor(helper: MoonbeamHelper, collective: string) {3063 super(helper);30643065 this.collective = collective;3066 }30673068 async propose(signer: TSigner, threshold: number, proposalHash: string, lengthBound: number) {3069 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [threshold, proposalHash, lengthBound], true);3070 }30713072 async vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {3073 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve], true);3074 }30753076 async close(signer: TSigner, proposalHash: string, proposalIndex: number, weightBound: any, lengthBound: number) {3077 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [proposalHash, proposalIndex, weightBound, lengthBound], true);3078 }30793080 async proposalCount() {3081 return Number(await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, []));3082 }3083}30843085export type ChainHelperBaseConstructor = new(...args: any[]) => ChainHelperBase;3086export type UniqueHelperConstructor = new(...args: any[]) => UniqueHelper;30873088export class UniqueHelper extends ChainHelperBase {3089 balance: BalanceGroup<UniqueHelper>;3090 collection: CollectionGroup;3091 nft: NFTGroup;3092 rft: RFTGroup;3093 ft: FTGroup;3094 staking: StakingGroup;3095 scheduler: SchedulerGroup;3096 collatorSelection: CollatorSelectionGroup;3097 foreignAssets: ForeignAssetsGroup;3098 xcm: XcmGroup<UniqueHelper>;3099 xTokens: XTokensGroup<UniqueHelper>;3100 tokens: TokensGroup<UniqueHelper>;31013102 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3103 super(logger, options.helperBase ?? UniqueHelper);31043105 this.balance = new BalanceGroup(this);3106 this.collection = new CollectionGroup(this);3107 this.nft = new NFTGroup(this);3108 this.rft = new RFTGroup(this);3109 this.ft = new FTGroup(this);3110 this.staking = new StakingGroup(this);3111 this.scheduler = new SchedulerGroup(this);3112 this.collatorSelection = new CollatorSelectionGroup(this);3113 this.foreignAssets = new ForeignAssetsGroup(this);3114 this.xcm = new XcmGroup(this, 'polkadotXcm');3115 this.xTokens = new XTokensGroup(this);3116 this.tokens = new TokensGroup(this);3117 }31183119 getSudo<T extends UniqueHelper>() {3120 // eslint-disable-next-line @typescript-eslint/naming-convention3121 const SudoHelperType = SudoHelper(this.helperBase);3122 return this.clone(SudoHelperType) as T;3123 }3124}31253126export class XcmChainHelper extends ChainHelperBase {3127 async connect(wsEndpoint: string, _listeners?: any): Promise<void> {3128 const wsProvider = new WsProvider(wsEndpoint);3129 this.api = new ApiPromise({3130 provider: wsProvider,3131 });3132 await this.api.isReadyOrError;3133 this.network = await UniqueHelper.detectNetwork(this.api);3134 }3135}31363137export class RelayHelper extends XcmChainHelper {3138 balance: SubstrateBalanceGroup<RelayHelper>;3139 xcm: XcmGroup<RelayHelper>;31403141 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3142 super(logger, options.helperBase ?? RelayHelper);31433144 this.balance = new SubstrateBalanceGroup(this);3145 this.xcm = new XcmGroup(this, 'xcmPallet');3146 }3147}31483149export class WestmintHelper extends XcmChainHelper {3150 balance: SubstrateBalanceGroup<WestmintHelper>;3151 xcm: XcmGroup<WestmintHelper>;3152 assets: AssetsGroup<WestmintHelper>;3153 xTokens: XTokensGroup<WestmintHelper>;31543155 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3156 super(logger, options.helperBase ?? WestmintHelper);31573158 this.balance = new SubstrateBalanceGroup(this);3159 this.xcm = new XcmGroup(this, 'polkadotXcm');3160 this.assets = new AssetsGroup(this);3161 this.xTokens = new XTokensGroup(this);3162 }3163}31643165export class MoonbeamHelper extends XcmChainHelper {3166 balance: EthereumBalanceGroup<MoonbeamHelper>;3167 assetManager: MoonbeamAssetManagerGroup;3168 assets: AssetsGroup<MoonbeamHelper>;3169 xTokens: XTokensGroup<MoonbeamHelper>;3170 democracy: MoonbeamDemocracyGroup;3171 collective: {3172 council: MoonbeamCollectiveGroup,3173 techCommittee: MoonbeamCollectiveGroup,3174 };31753176 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3177 super(logger, options.helperBase ?? MoonbeamHelper);31783179 this.balance = new EthereumBalanceGroup(this);3180 this.assetManager = new MoonbeamAssetManagerGroup(this);3181 this.assets = new AssetsGroup(this);3182 this.xTokens = new XTokensGroup(this);3183 this.democracy = new MoonbeamDemocracyGroup(this, options);3184 this.collective = {3185 council: new MoonbeamCollectiveGroup(this, 'councilCollective'),3186 techCommittee: new MoonbeamCollectiveGroup(this, 'techCommitteeCollective'),3187 };3188 }3189}31903191export class AcalaHelper extends XcmChainHelper {3192 balance: SubstrateBalanceGroup<AcalaHelper>;3193 assetRegistry: AcalaAssetRegistryGroup;3194 xTokens: XTokensGroup<AcalaHelper>;3195 tokens: TokensGroup<AcalaHelper>;31963197 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {3198 super(logger, options.helperBase ?? AcalaHelper);31993200 this.balance = new SubstrateBalanceGroup(this);3201 this.assetRegistry = new AcalaAssetRegistryGroup(this);3202 this.xTokens = new XTokensGroup(this);3203 this.tokens = new TokensGroup(this);3204 }32053206 getSudo<T extends AcalaHelper>() {3207 // eslint-disable-next-line @typescript-eslint/naming-convention3208 const SudoHelperType = SudoHelper(this.helperBase);3209 return this.clone(SudoHelperType) as T;3210 }3211}32123213// eslint-disable-next-line @typescript-eslint/naming-convention3214function ScheduledUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {3215 return class extends Base {3216 scheduleFn: 'schedule' | 'scheduleAfter';3217 blocksNum: number;3218 options: ISchedulerOptions;32193220 constructor(...args: any[]) {3221 const logger = args[0] as ILogger;3222 const options = args[1] as {3223 scheduleFn: 'schedule' | 'scheduleAfter',3224 blocksNum: number,3225 options: ISchedulerOptions3226 };32273228 super(logger);32293230 this.scheduleFn = options.scheduleFn;3231 this.blocksNum = options.blocksNum;3232 this.options = options.options;3233 }32343235 executeExtrinsic(sender: IKeyringPair, scheduledExtrinsic: string, scheduledParams: any[], expectSuccess?: boolean): Promise<ITransactionResult> {3236 const scheduledTx = this.constructApiCall(scheduledExtrinsic, scheduledParams);32373238 const mandatorySchedArgs = [3239 this.blocksNum,3240 this.options.periodic ? [this.options.periodic.period, this.options.periodic.repetitions] : null,3241 this.options.priority ?? null,3242 scheduledTx,3243 ];32443245 let schedArgs;3246 let scheduleFn;32473248 if (this.options.scheduledId) {3249 schedArgs = [this.options.scheduledId!, ...mandatorySchedArgs];32503251 if (this.scheduleFn == 'schedule') {3252 scheduleFn = 'scheduleNamed';3253 } else if (this.scheduleFn == 'scheduleAfter') {3254 scheduleFn = 'scheduleNamedAfter';3255 }3256 } else {3257 schedArgs = mandatorySchedArgs;3258 scheduleFn = this.scheduleFn;3259 }32603261 const extrinsic = 'api.tx.scheduler.' + scheduleFn;32623263 return super.executeExtrinsic(3264 sender,3265 extrinsic,3266 schedArgs,3267 expectSuccess,3268 );3269 }3270 };3271}32723273// eslint-disable-next-line @typescript-eslint/naming-convention3274function SudoHelper<T extends ChainHelperBaseConstructor>(Base: T) {3275 return class extends Base {3276 constructor(...args: any[]) {3277 super(...args);3278 }32793280 async executeExtrinsic(3281 sender: IKeyringPair,3282 extrinsic: string,3283 params: any[],3284 expectSuccess?: boolean,3285 options: Partial<SignerOptions>|null = null,3286 ): Promise<ITransactionResult> {3287 const call = this.constructApiCall(extrinsic, params);3288 const result = await super.executeExtrinsic(3289 sender,3290 'api.tx.sudo.sudo',3291 [call],3292 expectSuccess,3293 options,3294 );32953296 if (result.status === 'Fail') return result;32973298 const data = (result.result.events.find(x => x.event.section == 'sudo' && x.event.method == 'Sudid')?.event.data as any).sudoResult;3299 if (data.isErr) {3300 if (data.asErr.isModule) {3301 const error = (result.result.events[1].event.data as any).sudoResult.asErr.asModule;3302 const metaError = super.getApi()?.registry.findMetaError(error);3303 throw new Error(`${metaError.section}.${metaError.name}`);3304 } else {3305 throw new Error(data.asErr.toHuman());3306 }3307 }3308 return result;3309 }3310 };3311}33123313export class UniqueBaseCollection {3314 helper: UniqueHelper;3315 collectionId: number;33163317 constructor(collectionId: number, uniqueHelper: UniqueHelper) {3318 this.collectionId = collectionId;3319 this.helper = uniqueHelper;3320 }33213322 async getData() {3323 return await this.helper.collection.getData(this.collectionId);3324 }33253326 async getLastTokenId() {3327 return await this.helper.collection.getLastTokenId(this.collectionId);3328 }33293330 async doesTokenExist(tokenId: number) {3331 return await this.helper.collection.doesTokenExist(this.collectionId, tokenId);3332 }33333334 async getAdmins() {3335 return await this.helper.collection.getAdmins(this.collectionId);3336 }33373338 async getAllowList() {3339 return await this.helper.collection.getAllowList(this.collectionId);3340 }33413342 async getEffectiveLimits() {3343 return await this.helper.collection.getEffectiveLimits(this.collectionId);3344 }33453346 async getProperties(propertyKeys?: string[] | null) {3347 return await this.helper.collection.getProperties(this.collectionId, propertyKeys);3348 }33493350 async getPropertiesConsumedSpace() {3351 return await this.helper.collection.getPropertiesConsumedSpace(this.collectionId);3352 }33533354 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {3355 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);3356 }33573358 async getOptions() {3359 return await this.helper.collection.getCollectionOptions(this.collectionId);3360 }33613362 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {3363 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);3364 }33653366 async confirmSponsorship(signer: TSigner) {3367 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);3368 }33693370 async removeSponsor(signer: TSigner) {3371 return await this.helper.collection.removeSponsor(signer, this.collectionId);3372 }33733374 async setLimits(signer: TSigner, limits: ICollectionLimits) {3375 return await this.helper.collection.setLimits(signer, this.collectionId, limits);3376 }33773378 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {3379 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);3380 }33813382 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {3383 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);3384 }33853386 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {3387 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);3388 }33893390 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {3391 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);3392 }33933394 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {3395 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);3396 }33973398 async setProperties(signer: TSigner, properties: IProperty[]) {3399 return await this.helper.collection.setProperties(signer, this.collectionId, properties);3400 }34013402 async deleteProperties(signer: TSigner, propertyKeys: string[]) {3403 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);3404 }34053406 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {3407 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);3408 }34093410 async enableNesting(signer: TSigner, permissions: INestingPermissions) {3411 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);3412 }34133414 async disableNesting(signer: TSigner) {3415 return await this.helper.collection.disableNesting(signer, this.collectionId);3416 }34173418 async burn(signer: TSigner) {3419 return await this.helper.collection.burn(signer, this.collectionId);3420 }34213422 scheduleAt<T extends UniqueHelper>(3423 executionBlockNumber: number,3424 options: ISchedulerOptions = {},3425 ) {3426 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3427 return new UniqueBaseCollection(this.collectionId, scheduledHelper);3428 }34293430 scheduleAfter<T extends UniqueHelper>(3431 blocksBeforeExecution: number,3432 options: ISchedulerOptions = {},3433 ) {3434 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3435 return new UniqueBaseCollection(this.collectionId, scheduledHelper);3436 }34373438 getSudo<T extends UniqueHelper>() {3439 return new UniqueBaseCollection(this.collectionId, this.helper.getSudo<T>());3440 }3441}344234433444export class UniqueNFTCollection extends UniqueBaseCollection {3445 getTokenObject(tokenId: number) {3446 return new UniqueNFToken(tokenId, this);3447 }34483449 async getTokensByAddress(addressObj: ICrossAccountId) {3450 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);3451 }34523453 async getToken(tokenId: number, blockHashAt?: string) {3454 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);3455 }34563457 async getTokenOwner(tokenId: number, blockHashAt?: string) {3458 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);3459 }34603461 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {3462 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);3463 }34643465 async getTokenChildren(tokenId: number, blockHashAt?: string) {3466 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);3467 }34683469 async getPropertyPermissions(propertyKeys: string[] | null = null) {3470 return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);3471 }34723473 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {3474 return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);3475 }34763477 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {3478 const api = this.helper.getApi();3479 const props = (await api.query.nonfungible.tokenProperties(this.collectionId, tokenId)).toJSON();34803481 return (props! as any).consumedSpace;3482 }34833484 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {3485 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);3486 }34873488 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3489 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);3490 }34913492 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {3493 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);3494 }34953496 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {3497 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);3498 }34993500 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {3501 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});3502 }35033504 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {3505 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);3506 }35073508 async burnToken(signer: TSigner, tokenId: number) {3509 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);3510 }35113512 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {3513 return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);3514 }35153516 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {3517 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);3518 }35193520 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {3521 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);3522 }35233524 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {3525 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);3526 }35273528 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {3529 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);3530 }35313532 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3533 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);3534 }35353536 scheduleAt<T extends UniqueHelper>(3537 executionBlockNumber: number,3538 options: ISchedulerOptions = {},3539 ) {3540 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3541 return new UniqueNFTCollection(this.collectionId, scheduledHelper);3542 }35433544 scheduleAfter<T extends UniqueHelper>(3545 blocksBeforeExecution: number,3546 options: ISchedulerOptions = {},3547 ) {3548 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3549 return new UniqueNFTCollection(this.collectionId, scheduledHelper);3550 }35513552 getSudo<T extends UniqueHelper>() {3553 return new UniqueNFTCollection(this.collectionId, this.helper.getSudo<T>());3554 }3555}355635573558export class UniqueRFTCollection extends UniqueBaseCollection {3559 getTokenObject(tokenId: number) {3560 return new UniqueRFToken(tokenId, this);3561 }35623563 async getToken(tokenId: number, blockHashAt?: string) {3564 return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);3565 }35663567 async getTokenOwner(tokenId: number, blockHashAt?: string) {3568 return await this.helper.rft.getTokenOwner(this.collectionId, tokenId, blockHashAt);3569 }35703571 async getTokensByAddress(addressObj: ICrossAccountId) {3572 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);3573 }35743575 async getTop10TokenOwners(tokenId: number) {3576 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);3577 }35783579 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {3580 return await this.helper.rft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);3581 }35823583 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {3584 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);3585 }35863587 async getTokenTotalPieces(tokenId: number) {3588 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);3589 }35903591 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3592 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);3593 }35943595 async getPropertyPermissions(propertyKeys: string[] | null = null) {3596 return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);3597 }35983599 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {3600 return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);3601 }36023603 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {3604 const api = this.helper.getApi();3605 const props = (await api.query.refungible.tokenProperties(this.collectionId, tokenId)).toJSON();36063607 return (props! as any).consumedSpace;3608 }36093610 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {3611 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);3612 }36133614 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3615 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);3616 }36173618 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {3619 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);3620 }36213622 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {3623 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);3624 }36253626 async mintToken(signer: TSigner, pieces = 1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {3627 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});3628 }36293630 async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {3631 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);3632 }36333634 async burnToken(signer: TSigner, tokenId: number, amount=1n) {3635 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);3636 }36373638 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n) {3639 return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);3640 }36413642 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {3643 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);3644 }36453646 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {3647 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);3648 }36493650 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {3651 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);3652 }36533654 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {3655 return await this.helper.rft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);3656 }36573658 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3659 return await this.helper.rft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);3660 }36613662 scheduleAt<T extends UniqueHelper>(3663 executionBlockNumber: number,3664 options: ISchedulerOptions = {},3665 ) {3666 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3667 return new UniqueRFTCollection(this.collectionId, scheduledHelper);3668 }36693670 scheduleAfter<T extends UniqueHelper>(3671 blocksBeforeExecution: number,3672 options: ISchedulerOptions = {},3673 ) {3674 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3675 return new UniqueRFTCollection(this.collectionId, scheduledHelper);3676 }36773678 getSudo<T extends UniqueHelper>() {3679 return new UniqueRFTCollection(this.collectionId, this.helper.getSudo<T>());3680 }3681}368236833684export class UniqueFTCollection extends UniqueBaseCollection {3685 async getBalance(addressObj: ICrossAccountId) {3686 return await this.helper.ft.getBalance(this.collectionId, addressObj);3687 }36883689 async getTotalPieces() {3690 return await this.helper.ft.getTotalPieces(this.collectionId);3691 }36923693 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3694 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);3695 }36963697 async getTop10Owners() {3698 return await this.helper.ft.getTop10Owners(this.collectionId);3699 }37003701 async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {3702 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);3703 }37043705 async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {3706 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);3707 }37083709 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3710 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);3711 }37123713 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3714 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);3715 }37163717 async burnTokens(signer: TSigner, amount=1n) {3718 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);3719 }37203721 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3722 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);3723 }37243725 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3726 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);3727 }37283729 scheduleAt<T extends UniqueHelper>(3730 executionBlockNumber: number,3731 options: ISchedulerOptions = {},3732 ) {3733 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3734 return new UniqueFTCollection(this.collectionId, scheduledHelper);3735 }37363737 scheduleAfter<T extends UniqueHelper>(3738 blocksBeforeExecution: number,3739 options: ISchedulerOptions = {},3740 ) {3741 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3742 return new UniqueFTCollection(this.collectionId, scheduledHelper);3743 }37443745 getSudo<T extends UniqueHelper>() {3746 return new UniqueFTCollection(this.collectionId, this.helper.getSudo<T>());3747 }3748}374937503751export class UniqueBaseToken {3752 collection: UniqueNFTCollection | UniqueRFTCollection;3753 collectionId: number;3754 tokenId: number;37553756 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {3757 this.collection = collection;3758 this.collectionId = collection.collectionId;3759 this.tokenId = tokenId;3760 }37613762 async getNextSponsored(addressObj: ICrossAccountId) {3763 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);3764 }37653766 async getProperties(propertyKeys?: string[] | null) {3767 return await this.collection.getTokenProperties(this.tokenId, propertyKeys);3768 }37693770 async getTokenPropertiesConsumedSpace() {3771 return await this.collection.getTokenPropertiesConsumedSpace(this.tokenId);3772 }37733774 async setProperties(signer: TSigner, properties: IProperty[]) {3775 return await this.collection.setTokenProperties(signer, this.tokenId, properties);3776 }37773778 async deleteProperties(signer: TSigner, propertyKeys: string[]) {3779 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);3780 }37813782 async doesExist() {3783 return await this.collection.doesTokenExist(this.tokenId);3784 }37853786 nestingAccount() {3787 return this.collection.helper.util.getTokenAccount(this);3788 }37893790 scheduleAt<T extends UniqueHelper>(3791 executionBlockNumber: number,3792 options: ISchedulerOptions = {},3793 ) {3794 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3795 return new UniqueBaseToken(this.tokenId, scheduledCollection);3796 }37973798 scheduleAfter<T extends UniqueHelper>(3799 blocksBeforeExecution: number,3800 options: ISchedulerOptions = {},3801 ) {3802 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3803 return new UniqueBaseToken(this.tokenId, scheduledCollection);3804 }38053806 getSudo<T extends UniqueHelper>() {3807 return new UniqueBaseToken(this.tokenId, this.collection.getSudo<T>());3808 }3809}381038113812export class UniqueNFToken extends UniqueBaseToken {3813 collection: UniqueNFTCollection;38143815 constructor(tokenId: number, collection: UniqueNFTCollection) {3816 super(tokenId, collection);3817 this.collection = collection;3818 }38193820 async getData(blockHashAt?: string) {3821 return await this.collection.getToken(this.tokenId, blockHashAt);3822 }38233824 async getOwner(blockHashAt?: string) {3825 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);3826 }38273828 async getTopmostOwner(blockHashAt?: string) {3829 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);3830 }38313832 async getChildren(blockHashAt?: string) {3833 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);3834 }38353836 async nest(signer: TSigner, toTokenObj: IToken) {3837 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);3838 }38393840 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3841 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);3842 }38433844 async transfer(signer: TSigner, addressObj: ICrossAccountId) {3845 return await this.collection.transferToken(signer, this.tokenId, addressObj);3846 }38473848 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3849 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);3850 }38513852 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {3853 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);3854 }38553856 async isApproved(toAddressObj: ICrossAccountId) {3857 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);3858 }38593860 async burn(signer: TSigner) {3861 return await this.collection.burnToken(signer, this.tokenId);3862 }38633864 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {3865 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);3866 }38673868 scheduleAt<T extends UniqueHelper>(3869 executionBlockNumber: number,3870 options: ISchedulerOptions = {},3871 ) {3872 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3873 return new UniqueNFToken(this.tokenId, scheduledCollection);3874 }38753876 scheduleAfter<T extends UniqueHelper>(3877 blocksBeforeExecution: number,3878 options: ISchedulerOptions = {},3879 ) {3880 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3881 return new UniqueNFToken(this.tokenId, scheduledCollection);3882 }38833884 getSudo<T extends UniqueHelper>() {3885 return new UniqueNFToken(this.tokenId, this.collection.getSudo<T>());3886 }3887}38883889export class UniqueRFToken extends UniqueBaseToken {3890 collection: UniqueRFTCollection;38913892 constructor(tokenId: number, collection: UniqueRFTCollection) {3893 super(tokenId, collection);3894 this.collection = collection;3895 }38963897 async getData(blockHashAt?: string) {3898 return await this.collection.getToken(this.tokenId, blockHashAt);3899 }39003901 async getOwner(blockHashAt?: string) {3902 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);3903 }39043905 async getTop10Owners() {3906 return await this.collection.getTop10TokenOwners(this.tokenId);3907 }39083909 async getTopmostOwner(blockHashAt?: string) {3910 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);3911 }39123913 async nest(signer: TSigner, toTokenObj: IToken) {3914 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);3915 }39163917 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3918 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);3919 }39203921 async getBalance(addressObj: ICrossAccountId) {3922 return await this.collection.getTokenBalance(this.tokenId, addressObj);3923 }39243925 async getTotalPieces() {3926 return await this.collection.getTokenTotalPieces(this.tokenId);3927 }39283929 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {3930 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);3931 }39323933 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {3934 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);3935 }39363937 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3938 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);3939 }39403941 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3942 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);3943 }39443945 async repartition(signer: TSigner, amount: bigint) {3946 return await this.collection.repartitionToken(signer, this.tokenId, amount);3947 }39483949 async burn(signer: TSigner, amount=1n) {3950 return await this.collection.burnToken(signer, this.tokenId, amount);3951 }39523953 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3954 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);3955 }39563957 scheduleAt<T extends UniqueHelper>(3958 executionBlockNumber: number,3959 options: ISchedulerOptions = {},3960 ) {3961 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3962 return new UniqueRFToken(this.tokenId, scheduledCollection);3963 }39643965 scheduleAfter<T extends UniqueHelper>(3966 blocksBeforeExecution: number,3967 options: ISchedulerOptions = {},3968 ) {3969 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3970 return new UniqueRFToken(this.tokenId, scheduledCollection);3971 }39723973 getSudo<T extends UniqueHelper>() {3974 return new UniqueRFToken(this.tokenId, this.collection.getSudo<T>());3975 }3976}