Struct pallet_saft_registry::pallet::Pallet [−][src]
pub struct Pallet<T>(_);Expand description
The pallet implementing the on-chain logic.
Implementations
Adds a new SAFT to the index and mints the amount of
IndexToken according to the record’s nav to reflect the added value of this SAFT
record.
Parameters:
asset_id: The identifier of the asset secured by the SAFT. If the asset identifying the SAFT’s asset does not exist yet, it will get created.nav: The NAV for the asset being secured by the SAFT at time of submission. This will be used to determine the amount of index token this record is worth based on the currentNAVof the index.units: Amount of assets being attested to the total value in index tokens the SAFT is worth.
The amount of token minted and awarded to the LP is determined via the current on chain
NAV of the index token and the nav of the record that was part of the associated
proposal The id that was assigned to the SAFT when it was added with add_saft.
NOTE: For the purpose of calculating the “NAV” of the index, the value
(SAFTRecord::nav) of each record is considered to be denominated in the same currency
pair as the price feeds used for the liquid assets. For example if all price feeds use a
Liquid/USD pair, then the SAFTRecord::nav would describe the USD value of the
record.
Callable by the governance committee.
Weight: O(1)
pub fn force_add_saft(
origin: OriginFor<T>,
recipient: T::AccountId,
asset_id: T::AssetId,
nav: T::Balance,
units: T::Balance
) -> DispatchResult
pub fn force_add_saft(
origin: OriginFor<T>,
recipient: T::AccountId,
asset_id: T::AssetId,
nav: T::Balance,
units: T::Balance
) -> DispatchResult
Adds saft with root origin
pub fn remove_saft(
origin: OriginFor<T>,
asset_id: T::AssetId,
saft_id: SAFTId
) -> DispatchResult
pub fn remove_saft(
origin: OriginFor<T>,
asset_id: T::AssetId,
saft_id: SAFTId
) -> DispatchResult
Removes the SAFT from the registry by purging it from the
ActiveSAFTs storage.
The change in NAV will also be reflected in the index.
Parameters:
asset_id: The identifier of the asset of the SAFTsaft_id: The id that was assigned to the SAFT when it was added withadd_saft
Callable by the governance committee.
Weight: O(1)
pub fn force_remove_saft(
origin: OriginFor<T>,
asset_id: T::AssetId,
saft_id: SAFTId,
who: T::AccountId
) -> DispatchResult
pub fn force_remove_saft(
origin: OriginFor<T>,
asset_id: T::AssetId,
saft_id: SAFTId,
who: T::AccountId
) -> DispatchResult
Removes saft assets with root origin
Called to update the Net Asset Value (NAV) associated with a SAFT record in the registry.
The NAV of a SAFT is subject to change over time, and will be
updated at regular intervals via governance proposals. Changing the
NAV of the record will also be reflected in the asset-index, because this does not
burn any index tokens but rather represents a “changed price” of the future token.
This is a noop if the given latest_nav is equal to the current nav of the SAFT.
Parameters:
asset_id: The identifier of the SAFTsaft_id: The identifier of the targetedSaftRecordwhose value should be updatedlatest_nav: The NAV for theSaftRecordidentified by theindex
Callable by the governance committee.
Weight: O(1)
pub fn convert_to_liquid(
origin: OriginFor<T>,
asset_id: T::AssetId,
location: MultiLocation
) -> DispatchResult
pub fn convert_to_liquid(
origin: OriginFor<T>,
asset_id: T::AssetId,
location: MultiLocation
) -> DispatchResult
Converts the asset secured by the SAFT into a liquid asset with the given location
Callable by the governance committee.
Weight: O(C) where C is the number of SAFTs for the asset as tracked by the
SAFTCounter.
TODO: appropriate fees
pub fn active_safts<KArg1, KArg2>(
k1: KArg1,
k2: KArg2
) -> Option<SAFTRecord<T::Balance, T::Balance>> where
KArg1: EncodeLike<T::AssetId>,
KArg2: EncodeLike<SAFTId>,
pub fn active_safts<KArg1, KArg2>(
k1: KArg1,
k2: KArg2
) -> Option<SAFTRecord<T::Balance, T::Balance>> where
KArg1: EncodeLike<T::AssetId>,
KArg2: EncodeLike<SAFTId>,
Store a mapping (AssetId, SAFTId) -> SAFTRecord
Since SAFTCounter(AssetId) stores a running counter of SAFTRecord,
this map is guaranteed to store less SAFTRecords than the asset’s
SAFTCounter. If this maps stores a None value for a SAFTId lower
than the counter, then this means the record was removed entirely.
A running counter used to determine the next SAFT id for a specific asset.
Store a mapping (AssetId) -> NAV for each SAFT
Stores the aggregated NAV of all SAFTs, which is the sum the nav of
all SAFTRecords for each asset
Trait Implementations
Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”. Read more
fn run_benchmark(
extrinsic: &[u8],
c: &[(BenchmarkParameter, u32)],
whitelist: &[TrackedStorageKey],
verify: bool,
internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>
fn run_benchmark(
extrinsic: &[u8],
c: &[(BenchmarkParameter, u32)],
whitelist: &[TrackedStorageKey],
verify: bool,
internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>
Run the benchmarks for this pallet.
Returns the current storage version as supported by the pallet.
Returns the on-chain storage version of the pallet as stored in the storage.
The block is being finalized. Implement to have something happen.
This will be run when the block is being finalized (before on_finalize).
Implement to have something happen using the remaining weight.
Will not fire if the remaining weight is 0.
Return the weight used, the hook will subtract it from current weight used
and pass the result to the next on_idle hook if it exists. Read more
The block is being initialized. Implement to have something happen. Read more
Perform a module upgrade. Read more
Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain. Read more
Run integrity test. Read more
Run integrity test. Read more
This function is being called after every block import (when fully synced). Read more
The block is being finalized. Implement to have something happen. Read more
Something that should happen at genesis.
The block is being finalized.
Implement to have something happen in case there is leftover weight.
Check the passed remaining_weight to make sure it is high enough to allow for
your pallet’s extra computation. Read more
The block is being initialized. Implement to have something happen. Read more
Perform a module upgrade. Read more
Name of the Rust module containing the pallet.
Version of the crate containing the pallet.
Extend the given vector by all of the pallets’ information that this type represents. Read more
All of the pallets’ information that this type represents.
Returns the value of the assets currently secured by the SAFTS
Auto Trait Implementations
impl<T> RefUnwindSafe for Pallet<T> where
T: RefUnwindSafe,
impl<T> UnwindSafe for Pallet<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s. Read more
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s. Read more
Compare self to key and return true if they are equal.
Causes self to use its Binary implementation when Debug-formatted.
Causes self to use its Display implementation when
Debug-formatted. Read more
Causes self to use its LowerExp implementation when
Debug-formatted. Read more
Causes self to use its LowerHex implementation when
Debug-formatted. Read more
Causes self to use its Octal implementation when Debug-formatted.
Causes self to use its Pointer implementation when
Debug-formatted. Read more
Causes self to use its UpperExp implementation when
Debug-formatted. Read more
Causes self to use its UpperHex implementation when
Debug-formatted. Read more
impl<T> PalletVersionToStorageVersionHelper for T where
T: GetStorageVersion + PalletInfoAccess,
impl<T> PalletVersionToStorageVersionHelper for T where
T: GetStorageVersion + PalletInfoAccess,
Pipes by value. This is generally the method you want to use. Read more
Borrows self and passes that borrow into the pipe function. Read more
Mutably borrows self and passes that borrow into the pipe function. Read more
Borrows self, then passes self.borrow() into the pipe function. Read more
Mutably borrows self, then passes self.borrow_mut() into the pipe
function. Read more
Borrows self, then passes self.as_ref() into the pipe function.
Mutably borrows self, then passes self.as_mut() into the pipe
function. Read more
Borrows self, then passes self.deref() into the pipe function.
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
Pipes a dereference into a function that cannot normally be called in suffix position. Read more
Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more
The inverse inclusion map: attempts to construct self from the equivalent element of its
superset. Read more
Checks if self is actually part of its subset T (and can be converted to it).
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
The inclusion map: converts self to the equivalent element of its superset.
Immutable access to the Borrow<B> of a value. Read more
Mutable access to the BorrowMut<B> of a value. Read more
Immutable access to the AsRef<R> view of a value. Read more
Mutable access to the AsMut<R> view of a value. Read more
Immutable access to the Deref::Target of a value. Read more
Mutable access to the Deref::Target of a value. Read more
Calls .tap() only in debug builds, and is erased in release builds.
Calls .tap_mut() only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow() only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow_mut() only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref() only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref_mut() only in debug builds, and is erased in release
builds. Read more
Calls .tap_deref() only in debug builds, and is erased in release
builds. Read more
Provides immutable access to the reference for inspection.
Calls tap_ref in debug builds, and does nothing in release builds.
Provides mutable access to the reference for modification.
Calls tap_ref_mut in debug builds, and does nothing in release builds.
Provides immutable access to the borrow for inspection. Read more
Calls tap_borrow in debug builds, and does nothing in release builds.
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the borrow for modification.
Immutably dereferences self for inspection.
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Calls tap_deref in debug builds, and does nothing in release builds.
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Mutably dereferences self for modification.
The counterpart to unchecked_from.
Consume self to return an equivalent value of T.
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more