Digital
interface DigitalAssetService
Digital-asset operations exposed as client.digitalAssets.
Functions
Link copied to clipboard
abstract suspend fun buildAddProperty(sender: AccountAddressInput, assetId: AccountAddressInput, property: DigitalAssetProperty, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a typed property-add transaction.
Link copied to clipboard
abstract suspend fun buildBurn(sender: AccountAddressInput, assetId: AccountAddressInput, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a burn transaction for assetId.
Link copied to clipboard
abstract suspend fun buildCreateCollection(sender: AccountAddressInput, name: String, description: String = "", uri: String = "", collection: DigitalAssetCollectionOptions = DigitalAssetCollectionOptions(), options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a collection-creation transaction with explicit mutability and royalty options.
Link copied to clipboard
abstract suspend fun buildFreezeTransfer(sender: AccountAddressInput, assetId: AccountAddressInput, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a creator-authorized transfer freeze for assetId.
Link copied to clipboard
abstract suspend fun buildMint(sender: AccountAddressInput, collection: String, name: String, description: String = "", uri: String = "", properties: List<DigitalAssetProperty> = emptyList(), options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a mint transaction for a standard digital asset.
Link copied to clipboard
abstract suspend fun buildMintSoulbound(sender: AccountAddressInput, recipient: AccountAddressInput, collection: String, name: String, description: String = "", uri: String = "", properties: List<DigitalAssetProperty> = emptyList(), options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a mint transaction whose new asset is initially soulbound to recipient.
Link copied to clipboard
abstract suspend fun buildRemoveProperty(sender: AccountAddressInput, assetId: AccountAddressInput, key: String, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a transaction that removes property key.
Link copied to clipboard
abstract suspend fun buildSetDescription(sender: AccountAddressInput, assetId: AccountAddressInput, description: String, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a transaction that changes an asset's description.
Link copied to clipboard
abstract suspend fun buildSetName(sender: AccountAddressInput, assetId: AccountAddressInput, name: String, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a transaction that changes an asset's display name.
Link copied to clipboard
abstract suspend fun buildSetUri(sender: AccountAddressInput, assetId: AccountAddressInput, uri: String, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a transaction that changes an asset's metadata URI.
Link copied to clipboard
abstract suspend fun buildTransfer(sender: AccountAddressInput, assetId: AccountAddressInput, recipient: AccountAddressInput, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds an ownership transfer for assetId.
Link copied to clipboard
abstract suspend fun buildUnfreezeTransfer(sender: AccountAddressInput, assetId: AccountAddressInput, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a creator-authorized transfer unfreeze for assetId.
Link copied to clipboard
abstract suspend fun buildUpdateProperty(sender: AccountAddressInput, assetId: AccountAddressInput, property: DigitalAssetProperty, assetType: StructTag = DEFAULT_DIGITAL_ASSET_TYPE, options: TransactionOptions = TransactionOptions()): AptosResult<UnsignedTransaction.Simple>
Builds a typed property-update transaction.
Link copied to clipboard
abstract suspend fun getActivity(assetId: AccountAddressInput, page: PageRequest = PageRequest()): AptosResult<AptosPage<DigitalAssetActivity>>
Returns a typed page of activity for assetId.
Link copied to clipboard
abstract suspend fun getCollection(collectionId: AccountAddressInput): AptosResult<CollectionRecord?>
Looks up a collection by object address.
abstract suspend fun getCollection(creator: AccountAddressInput, name: String): AptosResult<CollectionRecord?>
Link copied to clipboard
abstract suspend fun getOwned(owner: AccountAddressInput, page: PageRequest = PageRequest()): AptosResult<AptosPage<DigitalAssetOwnership>>
Returns a typed page of digital assets currently owned by owner.