Kaptos/xyz.mcxross.kaptos.protocol/DigitalAsset

DigitalAsset

interface DigitalAsset

Digital asset API namespace. This interface provides functionality to reading and writing digital assets' related information.

Inheritors

Functions

Link copied to clipboard
abstract suspend fun addDigitalAssetPropertyTransaction(creator: Account, propertyKey: String, propertyType: PropertyType, propertyValue: PropertyValue, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId = "0x4::token::Token", options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Add a property to a digital asset

Link copied to clipboard
abstract suspend fun burnDigitalAssetTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId = "0x4::token::Token", options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Burn a digital asset by its creator

Link copied to clipboard
abstract suspend fun createCollectionTransaction(creator: Account, name: String, description: String = "", uri: String = "", collectionOptions: CreateCollectionOptions = CreateCollectionOptions(), options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Creates a new collection within the specified account.

Link copied to clipboard
abstract suspend fun freezeDigitalAssetTransferTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId = "0x4::token::Token", options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Freeze digital asset transfer ability

Link copied to clipboard
abstract suspend fun getCollectionData(creatorAddress: AccountAddressInput, collectionName: String, minimumLedgerVersion: Long?, tokenStandard: TokenStandard?): Option<CollectionData?>

Queries data of a specific collection by the collection creator address and the collection name.

Link copied to clipboard
abstract suspend fun getCollectionDataByCollectionId(collectionId: String, minimumLedgerVersion: Long?): Option<CollectionData?>

Queries data of a specific collection by the collection ID.

Link copied to clipboard
abstract suspend fun getTokenData(offset: Int? = null, limit: Int? = null): Option<TokenData?>
Link copied to clipboard
abstract suspend fun mintDigitalAssetTransaction(creator: Account, collection: String, name: String, description: String, uri: String, propertyKeys: List<String>? = emptyList(), propertyTypes: List<String>? = emptyList(), propertyValues: List<String>? = emptyList(), options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Create a transaction to mint a digital asset into the creators account within an existing collection.

Link copied to clipboard
abstract suspend fun mintSoulBoundTransaction(account: Account, collection: String, name: String, description: String, uri: String, recipient: AccountAddressInput, propertyKeys: List<String> = emptyList(), propertyTypes: List<String> = emptyList(), propertyValues: List<String> = emptyList(), options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Mint a soul bound digital asset.

Link copied to clipboard
abstract suspend fun removeDigitalAssetPropertyTransaction(creator: Account, propertyKey: String, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId = "0x4::token::Token", options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Remove a property from a digital asset

Link copied to clipboard
abstract suspend fun setDigitalAssetDescriptionTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, description: String, digitalAssetType: MoveStructId = "0x4::token::Token", options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Set the digital asset description

Link copied to clipboard
abstract suspend fun setDigitalAssetNameTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, name: String, digitalAssetType: MoveStructId = "0x4::token::Token"): SimpleTransaction

Set the digital asset name

Link copied to clipboard
abstract suspend fun setDigitalAssetURITransaction(creator: Account, digitalAssetAddress: AccountAddressInput, uri: String, digitalAssetType: MoveStructId = "0x4::token::Token", options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Set the digital asset URI

Link copied to clipboard
abstract suspend fun transferDigitalAssetTransaction(sender: Account, digitalAssetAddress: AccountAddressInput, recipient: AccountAddressInput, digitalAssetType: MoveStructId = "0x4::token::Token", options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Transfer a digital asset (non-fungible digital asset) ownership.

Link copied to clipboard
abstract suspend fun unfreezeDigitalAssetTransferTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId = "0x4::token::Token", options: InputGenerateTransactionOptions = InputGenerateTransactionOptions()): SimpleTransaction

Unfreeze digital asset transfer ability