Trait TokenizationApi

Source
pub trait TokenizationApi: Send + Sync {
    // Required methods
    fn burn_collection_token<'life0, 'async_trait>(
        &'life0 self,
        params: BurnCollectionTokenParams,
    ) -> Pin<Box<dyn Future<Output = Result<CollectionBurnResponseDto, Error<BurnCollectionTokenError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_new_collection<'life0, 'async_trait>(
        &'life0 self,
        params: CreateNewCollectionParams,
    ) -> Pin<Box<dyn Future<Output = Result<CollectionLinkDto, Error<CreateNewCollectionError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn fetch_collection_token_details<'life0, 'async_trait>(
        &'life0 self,
        params: FetchCollectionTokenDetailsParams,
    ) -> Pin<Box<dyn Future<Output = Result<CollectionLinkDto, Error<FetchCollectionTokenDetailsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_collection_by_id<'life0, 'async_trait>(
        &'life0 self,
        params: GetCollectionByIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<CollectionLinkDto, Error<GetCollectionByIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_linked_collections<'life0, 'async_trait>(
        &'life0 self,
        params: GetLinkedCollectionsParams,
    ) -> Pin<Box<dyn Future<Output = Result<GetLinkedCollectionsPaginatedResponse, Error<GetLinkedCollectionsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_linked_token<'life0, 'async_trait>(
        &'life0 self,
        params: GetLinkedTokenParams,
    ) -> Pin<Box<dyn Future<Output = Result<TokenLinkDto, Error<GetLinkedTokenError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_linked_tokens<'life0, 'async_trait>(
        &'life0 self,
        params: GetLinkedTokensParams,
    ) -> Pin<Box<dyn Future<Output = Result<TokensPaginatedResponse, Error<GetLinkedTokensError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn issue_new_token<'life0, 'async_trait>(
        &'life0 self,
        params: IssueNewTokenParams,
    ) -> Pin<Box<dyn Future<Output = Result<TokenLinkDto, Error<IssueNewTokenError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn link<'life0, 'async_trait>(
        &'life0 self,
        params: LinkParams,
    ) -> Pin<Box<dyn Future<Output = Result<TokenLinkDto, Error<LinkError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn mint_collection_token<'life0, 'async_trait>(
        &'life0 self,
        params: MintCollectionTokenParams,
    ) -> Pin<Box<dyn Future<Output = Result<CollectionMintResponseDto, Error<MintCollectionTokenError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn unlink<'life0, 'async_trait>(
        &'life0 self,
        params: UnlinkParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<UnlinkError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn unlink_collection<'life0, 'async_trait>(
        &'life0 self,
        params: UnlinkCollectionParams,
    ) -> Pin<Box<dyn Future<Output = Result<(), Error<UnlinkCollectionError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

Required Methods§

Source

fn burn_collection_token<'life0, 'async_trait>( &'life0 self, params: BurnCollectionTokenParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionBurnResponseDto, Error<BurnCollectionTokenError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /tokenization/collections/{id}/tokens/burn

Burn tokens in a collection.
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.

Source

fn create_new_collection<'life0, 'async_trait>( &'life0 self, params: CreateNewCollectionParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionLinkDto, Error<CreateNewCollectionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /tokenization/collections

Create a new collection and link it as a token.
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.

Source

fn fetch_collection_token_details<'life0, 'async_trait>( &'life0 self, params: FetchCollectionTokenDetailsParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionLinkDto, Error<FetchCollectionTokenDetailsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /tokenization/collections/{id}/tokens/{tokenId}

Get collection token details by id.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_collection_by_id<'life0, 'async_trait>( &'life0 self, params: GetCollectionByIdParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionLinkDto, Error<GetCollectionByIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /tokenization/collections/{id}

Get a collection by id.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_linked_collections<'life0, 'async_trait>( &'life0 self, params: GetLinkedCollectionsParams, ) -> Pin<Box<dyn Future<Output = Result<GetLinkedCollectionsPaginatedResponse, Error<GetLinkedCollectionsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /tokenization/collections

Get collections (paginated).
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Source

fn get_linked_token<'life0, 'async_trait>( &'life0 self, params: GetLinkedTokenParams, ) -> Pin<Box<dyn Future<Output = Result<TokenLinkDto, Error<GetLinkedTokenError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /tokenization/tokens/{id}

Return a linked token, with its status and metadata.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_linked_tokens<'life0, 'async_trait>( &'life0 self, params: GetLinkedTokensParams, ) -> Pin<Box<dyn Future<Output = Result<TokensPaginatedResponse, Error<GetLinkedTokensError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /tokenization/tokens

Return all linked tokens (paginated).
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn issue_new_token<'life0, 'async_trait>( &'life0 self, params: IssueNewTokenParams, ) -> Pin<Box<dyn Future<Output = Result<TokenLinkDto, Error<IssueNewTokenError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /tokenization/tokens

Facilitates the creation of a new token, supporting both EVM-based and Stellar/Ripple platforms. For EVM, it deploys the corresponding contract template to the blockchain and links the token to the workspace. For Stellar/Ripple, it links a newly created token directly to the workspace without deploying a contract. Returns the token link with status "PENDING" until the token is deployed or "SUCCESS" if no deployment is needed.
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.

POST /tokenization/tokens/link

Link a contract.
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.

Source

fn mint_collection_token<'life0, 'async_trait>( &'life0 self, params: MintCollectionTokenParams, ) -> Pin<Box<dyn Future<Output = Result<CollectionMintResponseDto, Error<MintCollectionTokenError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /tokenization/collections/{id}/tokens/mint

Mint tokens and upload metadata.
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, Editor.

DELETE /tokenization/tokens/{id}

Unlink a token. The token will be unlinked from the workspace. The token will not be deleted on chain nor the refId, only the link to the workspace will be removed.
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.

DELETE /tokenization/collections/{id}

Delete a collection link.
Endpoint Permission: Owner, Admin, Non-Signing Admin, Signer, and Editor.

Implementors§