polymesh_api::polymesh::api::nft

Struct NftCallApi

Source 
pub struct NftCallApi<'api> { /* private fields */ }

Implementations§

Source§

impl<'api> NftCallApi<'api>

Source

pub fn create_nft_collection( &self, asset_id: Option<AssetId>, nft_type: Option<NonFungibleType>, collection_keys: NFTCollectionKeys, ) -> Result<WrappedCall>

Cretes a new NFTCollection.

§Arguments
  • origin - contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
  • asset_id - optional [AssetId] associated to the new collection. None will create a new asset.
  • nft_type - in case the asset hasn’t been created yet, one will be created with the given type.
  • collection_keys - all mandatory metadata keys that the tokens in the collection must have.
§Errors
  • CollectionAlredyRegistered - if the asset_id is already associated to an NFT collection.
  • InvalidAssetType - if the associated asset is not of type NFT.
  • MaxNumberOfKeysExceeded - if the number of metadata keys for the collection is greater than the maximum allowed.
  • UnregisteredMetadataKey - if any of the metadata keys needed for the collection has not been registered.
  • DuplicateMetadataKey - if a duplicate metadata keys has been passed as input.
§Permissions
  • Asset
Source

pub fn issue_nft( &self, asset_id: AssetId, nft_metadata_attributes: Vec<NFTMetadataAttribute>, portfolio_kind: PortfolioKind, ) -> Result<WrappedCall>

Issues an NFT to the caller.

§Arguments
  • origin - is a signer that has permissions to act as an agent of asset_id.
  • asset_id - the [AssetId] of the NFT collection.
  • nft_metadata_attributes - all mandatory metadata keys and values for the NFT.
  • portfolio_kind - the portfolio that will receive the minted nft.
§Errors
  • CollectionNotFound - if the collection associated to the given asset_id has not been created.
  • InvalidMetadataAttribute - if the number of attributes is not equal to the number set in the collection or attempting to set a value for a key not definied in the collection.
  • DuplicateMetadataKey - if a duplicate metadata keys has been passed as input.
§Permissions
  • Asset
  • Portfolio
Source

pub fn redeem_nft( &self, asset_id: AssetId, nft_id: NFTId, portfolio_kind: PortfolioKind, number_of_keys: Option<u8>, ) -> Result<WrappedCall>

Redeems the given NFT from the caller’s portfolio.

§Arguments
  • origin - is a signer that has permissions to act as an agent of asset_id.
  • asset_id - the [AssetId] of the NFT collection.
  • nft_id - the id of the NFT to be burned.
  • portfolio_kind - the portfolio that contains the nft.
§Errors
  • CollectionNotFound - if the collection associated to the given asset_id has not been created.
  • NFTNotFound - if the given NFT does not exist in the portfolio.
§Permissions
  • Asset
  • Portfolio
Source

pub fn controller_transfer( &self, nfts: NFTs, source_portfolio: PortfolioId, callers_portfolio_kind: PortfolioKind, ) -> Result<WrappedCall>

Forces the transfer of NFTs from a given portfolio to the caller’s portfolio.

§Arguments
  • origin - is a signer that has permissions to act as an agent of asset_id.
  • nft_id - the [NFTId] of the NFT to be transferred.
  • source_portfolio - the [PortfolioId] that currently holds the NFT.
  • callers_portfolio_kind - the [PortfolioKind] of the caller’s portfolio.
§Permissions
  • Asset
  • Portfolio

Trait Implementations§

Source§

impl<'api> Clone for NftCallApi<'api>

Source§

fn clone(&self) -> NftCallApi<'api>

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'api> From<&'api Api> for NftCallApi<'api>

Source§

fn from(api: &'api Api) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'api> Freeze for NftCallApi<'api>

§

impl<'api> !RefUnwindSafe for NftCallApi<'api>

§

impl<'api> Send for NftCallApi<'api>

§

impl<'api> Sync for NftCallApi<'api>

§

impl<'api> Unpin for NftCallApi<'api>

§

impl<'api> !UnwindSafe for NftCallApi<'api>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CheckedConversion for T

Source§

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more
Source§

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Src, Dest> IntoTuple<Dest> for Src
where Dest: FromTuple<Src>,

Source§

fn into_tuple(self) -> Dest

Source§

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

Source§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

Source§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatedConversion for T

Source§

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
Source§

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

Source§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
Source§

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

Source§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> JsonSchemaMaybe for T

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSendSync for T