Kaptos/xyz.mcxross.kaptos.api/DigitalAsset

DigitalAsset

class DigitalAsset(val config: AptosConfig) : DigitalAsset

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

Constructors

Link copied to clipboard
constructor(config: AptosConfig)

Properties

Link copied to clipboard
val config: AptosConfig

AptosConfig object for configuration

Functions

Link copied to clipboard
open suspend override fun addDigitalAssetPropertyTransaction(creator: Account, propertyKey: String, propertyType: PropertyType, propertyValue: PropertyValue, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId, options: InputGenerateTransactionOptions): SimpleTransaction

Add a property to a digital asset

Link copied to clipboard
open suspend override fun burnDigitalAssetTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId, options: InputGenerateTransactionOptions): SimpleTransaction

Burn a digital asset by its creator

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

Creates a new collection within the specified account.

Link copied to clipboard
open suspend override fun freezeDigitalAssetTransferTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId, options: InputGenerateTransactionOptions): SimpleTransaction

Freeze digital asset transfer ability

Link copied to clipboard
open suspend override 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
open suspend override fun getCollectionDataByCollectionId(collectionId: String, minimumLedgerVersion: Long?): Option<CollectionData?>

Queries data of a specific collection by the collection ID.

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

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

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

Mint a soul bound digital asset.

Link copied to clipboard
open suspend override fun removeDigitalAssetPropertyTransaction(creator: Account, propertyKey: String, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId, options: InputGenerateTransactionOptions): SimpleTransaction

Remove a property from a digital asset

Link copied to clipboard
open suspend override fun setDigitalAssetDescriptionTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, description: String, digitalAssetType: MoveStructId, options: InputGenerateTransactionOptions): SimpleTransaction

Set the digital asset description

Link copied to clipboard
open suspend override fun setDigitalAssetNameTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, name: String, digitalAssetType: MoveStructId): SimpleTransaction

Set the digital asset name

Link copied to clipboard
open suspend override fun setDigitalAssetURITransaction(creator: Account, digitalAssetAddress: AccountAddressInput, uri: String, digitalAssetType: MoveStructId, options: InputGenerateTransactionOptions): SimpleTransaction

Set the digital asset URI

Link copied to clipboard
open suspend override fun transferDigitalAssetTransaction(sender: Account, digitalAssetAddress: AccountAddressInput, recipient: AccountAddressInput, digitalAssetType: MoveStructId, options: InputGenerateTransactionOptions): SimpleTransaction

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

Link copied to clipboard
open suspend override fun unfreezeDigitalAssetTransferTransaction(creator: Account, digitalAssetAddress: AccountAddressInput, digitalAssetType: MoveStructId, options: InputGenerateTransactionOptions): SimpleTransaction

Unfreeze digital asset transfer ability