@aptos-labs/ts-sdk 6.3.1 → 7.0.0

package/dist/internal/digitalAsset.d.ts

@@ -0,0 +1,577 @@
+/**
+ * This file contains the underlying implementations for exposed API surface in
+ * the {@link api/digitalAsset}. By moving the methods out into a separate file,
+ * other namespaces and processes can access these methods without depending on the entire
+ * digitalAsset namespace and without having a dependency cycle error.
+ * @group Implementation
+ */
+import { AptosConfig } from "../api/aptosConfig.js";
+import { AccountAddress, AccountAddressInput } from "../core/index.js";
+import { Account } from "../account/index.js";
+import { InputGenerateTransactionOptions } from "../transactions/types.js";
+import { AnyNumber, GetCollectionDataResponse, GetCurrentTokenOwnershipResponse, GetOwnedTokensResponse, GetTokenActivityResponse, GetTokenDataResponse, MoveStructId, OrderByArg, PaginationArgs, TokenStandardArg, WhereArg } from "../types/index.js";
+import { CurrentCollectionsV2BoolExp } from "../types/generated/types.js";
+import { SimpleTransaction } from "../transactions/instances/simpleTransaction.js";
+declare const PropertyTypeMap: {
+    BOOLEAN: string;
+    U8: string;
+    U16: string;
+    U32: string;
+    U64: string;
+    U128: string;
+    U256: string;
+    ADDRESS: string;
+    STRING: string;
+    ARRAY: string;
+};
+/**
+ * The keys of the PropertyTypeMap, representing different property types.
+ * @group Implementation
+ */
+export type PropertyType = keyof typeof PropertyTypeMap;
+/**
+ * Accepted property value types for user input, including boolean, number, bigint, string, AccountAddress, and Uint8Array.
+ * To pass in an Array, use Uint8Array type
+ * for example `new MoveVector([new MoveString("hello"), new MoveString("world")]).bcsToBytes()`
+ * @group Implementation
+ */
+export type PropertyValue = boolean | number | bigint | string | AccountAddress | Uint8Array;
+/**
+ * Retrieves data for a specific digital asset using its address.
+ *
+ * @param args - The arguments for fetching digital asset data.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.digitalAssetAddress - The address of the digital asset to retrieve data for.
+ * @returns The data of the specified digital asset.
+ * @group Implementation
+ */
+export declare function getDigitalAssetData(args: {
+    aptosConfig: AptosConfig;
+    digitalAssetAddress: AccountAddressInput;
+}): Promise<GetTokenDataResponse>;
+/**
+ * Retrieves the current ownership details of a specified digital asset.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.digitalAssetAddress - The address of the digital asset to query ownership for.
+ * @returns The current ownership details of the specified digital asset.
+ * @group Implementation
+ */
+export declare function getCurrentDigitalAssetOwnership(args: {
+    aptosConfig: AptosConfig;
+    digitalAssetAddress: AccountAddressInput;
+}): Promise<GetCurrentTokenOwnershipResponse>;
+/**
+ * Retrieves the digital assets owned by a specified account address.
+ *
+ * @param args - The arguments for retrieving owned digital assets.
+ * @param args.aptosConfig - The configuration for connecting to the Aptos network.
+ * @param args.ownerAddress - The address of the account whose owned digital assets are being queried.
+ * @param args.options - Optional pagination and ordering parameters for the query.
+ * @param args.options.offset - The number of records to skip for pagination.
+ * @param args.options.limit - The maximum number of records to return.
+ * @param args.options.orderBy - The criteria for ordering the results.
+ *
+ * @returns An array of digital assets currently owned by the specified account.
+ * @group Implementation
+ */
+export declare function getOwnedDigitalAssets(args: {
+    aptosConfig: AptosConfig;
+    ownerAddress: AccountAddressInput;
+    options?: PaginationArgs & OrderByArg<GetTokenActivityResponse[0]>;
+}): Promise<GetOwnedTokensResponse>;
+/**
+ * Retrieves the activity associated with a specific digital asset.
+ * This function allows you to track the token activities for a given digital asset address.
+ *
+ * @param args - The arguments for retrieving digital asset activity.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.digitalAssetAddress - The address of the digital asset to query.
+ * @param args.options - Optional parameters for pagination and ordering.
+ * @param args.options.offset - The number of records to skip before starting to collect the result set.
+ * @param args.options.limit - The maximum number of records to return.
+ * @param args.options.orderBy - The criteria to order the results by.
+ * @returns A promise that resolves to an array of token activities for the specified digital asset.
+ * @group Implementation
+ */
+export declare function getDigitalAssetActivity(args: {
+    aptosConfig: AptosConfig;
+    digitalAssetAddress: AccountAddressInput;
+    options?: PaginationArgs & OrderByArg<GetTokenActivityResponse[0]>;
+}): Promise<GetTokenActivityResponse>;
+/**
+ * Options for creating a collection, allowing customization of various attributes such as supply limits, mutability of metadata,
+ * and royalty settings.
+ *
+ * @param maxSupply - Maximum number of tokens that can be minted in the collection.
+ * @param mutableDescription - Indicates if the collection description can be changed after creation.
+ * @param mutableRoyalty - Indicates if the royalty settings can be modified after creation.
+ * @param mutableURI - Indicates if the collection URI can be updated.
+ * @param mutableTokenDescription - Indicates if individual token descriptions can be modified.
+ * @param mutableTokenName - Indicates if individual token names can be changed.
+ * @param mutableTokenProperties - Indicates if individual token properties can be altered.
+ * @param mutableTokenURI - Indicates if individual token URIs can be updated.
+ * @param tokensBurnableByCreator - Indicates if the creator can burn tokens from the collection.
+ * @param tokensFreezableByCreator - Indicates if the creator can freeze tokens in the collection.
+ * @param royaltyNumerator - The numerator for calculating royalties.
+ * @param royaltyDenominator - The denominator for calculating royalties.
+ * @group Implementation
+ */
+export interface CreateCollectionOptions {
+    maxSupply?: AnyNumber;
+    mutableDescription?: boolean;
+    mutableRoyalty?: boolean;
+    mutableURI?: boolean;
+    mutableTokenDescription?: boolean;
+    mutableTokenName?: boolean;
+    mutableTokenProperties?: boolean;
+    mutableTokenURI?: boolean;
+    tokensBurnableByCreator?: boolean;
+    tokensFreezableByCreator?: boolean;
+    royaltyNumerator?: number;
+    royaltyDenominator?: number;
+}
+/**
+ * Creates a new collection transaction on the Aptos blockchain.
+ * This function allows you to define the properties of the collection, including its name, description, and URI.
+ *
+ * @param args - The parameters for creating the collection transaction.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.creator - The account that will create the collection.
+ * @param args.description - A description of the collection.
+ * @param args.name - The name of the collection.
+ * @param args.uri - The URI associated with the collection.
+ * @param args.options - Optional parameters for generating the transaction.
+ * @param args.maxSupply - The maximum supply of tokens in the collection (optional).
+ * @param args.mutableDescription - Indicates if the collection description can be changed (optional, defaults to true).
+ * @param args.mutableRoyalty - Indicates if the royalty settings can be changed (optional, defaults to true).
+ * @param args.mutableURI - Indicates if the URI can be changed (optional, defaults to true).
+ * @param args.mutableTokenDescription - Indicates if the token description can be changed (optional, defaults to true).
+ * @param args.mutableTokenName - Indicates if the token name can be changed (optional, defaults to true).
+ * @param args.mutableTokenProperties - Indicates if the token properties can be changed (optional, defaults to true).
+ * @param args.mutableTokenURI - Indicates if the token URI can be changed (optional, defaults to true).
+ * @param args.tokensBurnableByCreator - Indicates if tokens can be burned by the creator (optional, defaults to true).
+ * @param args.tokensFreezableByCreator - Indicates if tokens can be frozen by the creator (optional, defaults to true).
+ * @param args.royaltyNumerator - The numerator for calculating royalties (optional, defaults to 0).
+ * @param args.royaltyDenominator - The denominator for calculating royalties (optional, defaults to 1).
+ * @group Implementation
+ */
+export declare function createCollectionTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    description: string;
+    name: string;
+    uri: string;
+    options?: InputGenerateTransactionOptions;
+} & CreateCollectionOptions): Promise<SimpleTransaction>;
+/**
+ * Retrieves data for the current collections based on specified options.
+ *
+ * @param args - The arguments for the function.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.options - Optional parameters for filtering and pagination.
+ * @param args.options.tokenStandard - The token standard to filter the collections (default is "v2").
+ * @param args.options.offset - The offset for pagination.
+ * @param args.options.limit - The limit for pagination.
+ * @param args.options.where - The conditions to filter the collections.
+ * @returns The data of the current collections.
+ * @group Implementation
+ */
+export declare function getCollectionData(args: {
+    aptosConfig: AptosConfig;
+    options?: TokenStandardArg & PaginationArgs & WhereArg<CurrentCollectionsV2BoolExp>;
+}): Promise<GetCollectionDataResponse>;
+/**
+ * Retrieves collection data based on the creator's address and the collection name.
+ *
+ * @param args - The arguments for retrieving the collection data.
+ * @param args.aptosConfig - The Aptos configuration object.
+ * @param args.creatorAddress - The address of the creator whose collection data is being retrieved.
+ * @param args.collectionName - The name of the collection to fetch data for.
+ * @param args.options - Optional parameters for filtering the results, including token standard and pagination options.
+ * @param args.options.tokenStandard - The token standard to filter the results by (optional).
+ * @param args.options.pagination - Pagination options for the results (optional).
+ * @group Implementation
+ */
+export declare function getCollectionDataByCreatorAddressAndCollectionName(args: {
+    aptosConfig: AptosConfig;
+    creatorAddress: AccountAddressInput;
+    collectionName: string;
+    options?: TokenStandardArg & PaginationArgs;
+}): Promise<GetCollectionDataResponse>;
+/**
+ * Retrieves collection data associated with a specific creator's address.
+ * This function allows you to filter the collections based on the creator's address and optional token standards.
+ *
+ * @param args - The arguments for retrieving collection data.
+ * @param args.aptosConfig - The configuration for the Aptos network.
+ * @param args.creatorAddress - The address of the creator whose collection data is being retrieved.
+ * @param args.options - Optional parameters for filtering the results.
+ * @param args.options.tokenStandard - The token standard to filter the collections by.
+ * @param args.options.pagination - Pagination options for the results.
+ * @group Implementation
+ */
+export declare function getCollectionDataByCreatorAddress(args: {
+    aptosConfig: AptosConfig;
+    creatorAddress: AccountAddressInput;
+    options?: TokenStandardArg & PaginationArgs;
+}): Promise<GetCollectionDataResponse>;
+/**
+ * Retrieves data for a specific collection using its unique identifier.
+ * This function allows you to filter the collection data based on the token standard and pagination options.
+ *
+ * @param args - The arguments for retrieving collection data.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.collectionId - The unique identifier for the collection.
+ * @param args.options - Optional parameters for filtering by token standard and pagination.
+ * @param args.options.tokenStandard - The standard of the token to filter the collection data.
+ * @param args.options.page - The page number for pagination.
+ * @param args.options.limit - The number of items per page for pagination.
+ * @group Implementation
+ */
+export declare function getCollectionDataByCollectionId(args: {
+    aptosConfig: AptosConfig;
+    collectionId: AccountAddressInput;
+    options?: TokenStandardArg & PaginationArgs;
+}): Promise<GetCollectionDataResponse>;
+/**
+ * Retrieves the collection ID based on the creator's address and the collection name.
+ * This function helps in identifying a specific collection within the Aptos ecosystem.
+ *
+ * @param args - The parameters for retrieving the collection ID.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.creatorAddress - The address of the creator of the collection.
+ * @param args.collectionName - The name of the collection to look up.
+ * @param args.options - Optional parameters for additional filtering.
+ * @param args.options.tokenStandard - The token standard to filter the collection (default is "v2").
+ * @returns The ID of the specified collection.
+ * @group Implementation
+ */
+export declare function getCollectionId(args: {
+    aptosConfig: AptosConfig;
+    creatorAddress: AccountAddressInput;
+    collectionName: string;
+    options?: TokenStandardArg;
+}): Promise<string>;
+/**
+ * Creates a transaction to mint a digital asset on the Aptos blockchain.
+ * This function allows you to specify various attributes of the asset, including its collection, description, name, and URI.
+ *
+ * @param args - The arguments for minting the digital asset.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.creator - The account that will create the digital asset.
+ * @param args.collection - The name of the collection to which the asset belongs.
+ * @param args.description - A brief description of the digital asset.
+ * @param args.name - The name of the digital asset.
+ * @param args.uri - The URI pointing to the asset's metadata.
+ * @param [args.propertyKeys] - Optional array of property keys associated with the asset.
+ * @param [args.propertyTypes] - Optional array of property types corresponding to the asset's properties.
+ * @param [args.propertyValues] - Optional array of property values for the asset's properties.
+ * @param [args.options] - Optional transaction generation options.
+ * @group Implementation
+ */
+export declare function mintDigitalAssetTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    collection: string;
+    description: string;
+    name: string;
+    uri: string;
+    propertyKeys?: Array<string>;
+    propertyTypes?: Array<PropertyType>;
+    propertyValues?: Array<PropertyValue>;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Initiates a transaction to transfer a digital asset from one account to another.
+ * This function helps in executing the transfer of digital assets securely and efficiently.
+ *
+ * @param args - The arguments required to perform the transfer.
+ * @param args.aptosConfig - Configuration settings for the Aptos client.
+ * @param args.sender - The account initiating the transfer.
+ * @param args.digitalAssetAddress - The address of the digital asset being transferred.
+ * @param args.recipient - The address of the account receiving the digital asset.
+ * @param args.digitalAssetType - (Optional) The type of the digital asset being transferred.
+ * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
+ */
+export declare function transferDigitalAssetTransaction(args: {
+    aptosConfig: AptosConfig;
+    sender: Account;
+    digitalAssetAddress: AccountAddressInput;
+    recipient: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Creates a transaction to mint a soul-bound token.
+ * This function allows you to specify the token's attributes and recipient, facilitating the creation of unique digital assets.
+ *
+ * @param args - The parameters required to mint the soul-bound token.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.account - The account initiating the minting transaction.
+ * @param args.collection - The name of the collection to which the token belongs.
+ * @param args.description - A description of the token being minted.
+ * @param args.name - The name of the token.
+ * @param args.uri - The URI pointing to the token's metadata.
+ * @param args.recipient - The address of the account that will receive the minted token.
+ * @param [args.propertyKeys] - Optional array of property keys associated with the token.
+ * @param [args.propertyTypes] - Optional array of property types corresponding to the property keys.
+ * @param [args.propertyValues] - Optional array of property values that match the property keys and types.
+ * @param [args.options] - Optional transaction generation options.
+ * @throws Error if the counts of property keys, property types, and property values do not match.
+ * @group Implementation
+ */
+export declare function mintSoulBoundTransaction(args: {
+    aptosConfig: AptosConfig;
+    account: Account;
+    collection: string;
+    description: string;
+    name: string;
+    uri: string;
+    recipient: AccountAddressInput;
+    propertyKeys?: Array<string>;
+    propertyTypes?: Array<PropertyType>;
+    propertyValues?: Array<PropertyValue>;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Creates a transaction to burn a specified digital asset.
+ * This function allows users to permanently remove a digital asset from their account.
+ *
+ * @param args - The arguments for the transaction.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.creator - The account that is initiating the burn transaction.
+ * @param args.digitalAssetAddress - The address of the digital asset to be burned.
+ * @param args.digitalAssetType - Optional; the type of the digital asset being burned.
+ * @param args.options - Optional; additional options for generating the transaction.
+ * @group Implementation
+ */
+export declare function burnDigitalAssetTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Creates a transaction to freeze the transfer of a digital asset.
+ * This function helps you prevent the transfer of a specified digital asset by generating the appropriate transaction.
+ *
+ * @param args - The parameters for the transaction.
+ * @param args.aptosConfig - The configuration settings for the Aptos client.
+ * @param args.creator - The account that is creating the transaction.
+ * @param args.digitalAssetAddress - The address of the digital asset to be frozen.
+ * @param args.digitalAssetType - (Optional) The type of the digital asset as a Move struct ID.
+ * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
+ */
+export declare function freezeDigitalAssetTransferTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Unfreezes a digital asset transfer transaction, allowing the transfer of the specified digital asset.
+ *
+ * @param args - The arguments for unfreezing the digital asset transfer transaction.
+ * @param args.aptosConfig - The Aptos configuration settings.
+ * @param args.creator - The account that is initiating the unfreeze transaction.
+ * @param args.digitalAssetAddress - The address of the digital asset to be unfrozen.
+ * @param args.digitalAssetType - (Optional) The type of the digital asset being unfrozen.
+ * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
+ */
+export declare function unfreezeDigitalAssetTransferTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Sets the description for a digital asset, allowing users to provide additional context or information about the asset.
+ *
+ * @param args - The arguments for setting the digital asset description.
+ * @param args.aptosConfig - The Aptos configuration to use for the transaction.
+ * @param args.creator - The account that is creating the transaction.
+ * @param args.description - The new description for the digital asset.
+ * @param args.digitalAssetAddress - The address of the digital asset whose description is being set.
+ * @param args.digitalAssetType - (Optional) The type of the digital asset.
+ * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
+ */
+export declare function setDigitalAssetDescriptionTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    description: string;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Sets the name of a digital asset on the Aptos blockchain.
+ * This function allows you to update the name of a specified digital asset, enabling better identification and categorization.
+ *
+ * @param args - The parameters for setting the digital asset name.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.creator - The account that is creating the transaction.
+ * @param args.name - The new name to assign to the digital asset.
+ * @param args.digitalAssetAddress - The address of the digital asset to update.
+ * @param args.digitalAssetType - (Optional) The type of the digital asset, represented as a Move struct ID.
+ * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
+ */
+export declare function setDigitalAssetNameTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    name: string;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Sets the URI for a digital asset, allowing you to update the metadata associated with it.
+ *
+ * @param args - The arguments for setting the digital asset URI.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.creator - The account that is creating the transaction.
+ * @param args.uri - The new URI to be set for the digital asset.
+ * @param args.digitalAssetAddress - The address of the digital asset whose URI is being set.
+ * @param args.digitalAssetType - The optional type of the digital asset; defaults to a predefined type if not provided.
+ * @param args.options - Optional settings for generating the transaction.
+ * @group Implementation
+ */
+export declare function setDigitalAssetURITransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    uri: string;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Creates a transaction to add a property to a digital asset.
+ * This function helps in enhancing the metadata associated with a digital asset by allowing the addition of custom properties.
+ *
+ * @param args - The arguments for the transaction.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.creator - The account that is creating the transaction.
+ * @param args.propertyKey - The key for the property being added.
+ * @param args.propertyType - The type of the property being added.
+ * @param args.propertyValue - The value of the property being added.
+ * @param args.digitalAssetAddress - The address of the digital asset to which the property is being added.
+ * @param args.digitalAssetType - The optional type of the digital asset.
+ * @param args.options - Optional transaction generation options.
+ * @group Implementation
+ */
+export declare function addDigitalAssetPropertyTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    propertyKey: string;
+    propertyType: PropertyType;
+    propertyValue: PropertyValue;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Removes a property from a digital asset on the Aptos blockchain.
+ * This function helps in managing the attributes of digital assets by allowing the removal of specific properties.
+ *
+ * @param args - The arguments for the transaction.
+ * @param args.aptosConfig - The configuration object for Aptos.
+ * @param args.creator - The account that is creating the transaction.
+ * @param args.propertyKey - The key of the property to be removed.
+ * @param args.digitalAssetAddress - The address of the digital asset from which the property will be removed.
+ * @param args.digitalAssetType - The type of the digital asset (optional).
+ * @param args.options - Additional options for generating the transaction (optional).
+ * @group Implementation
+ */
+export declare function removeDigitalAssetPropertyTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    propertyKey: string;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Updates a property of a digital asset by generating a transaction for the Aptos blockchain.
+ * This function allows you to modify attributes of a digital asset, facilitating dynamic changes to its properties.
+ *
+ * @param args - The arguments for updating the digital asset property.
+ * @param args.aptosConfig - The configuration settings for the Aptos blockchain.
+ * @param args.creator - The account that is creating the transaction.
+ * @param args.propertyKey - The key of the property to be updated.
+ * @param args.propertyType - The type of the property being updated.
+ * @param args.propertyValue - The new value for the property.
+ * @param args.digitalAssetAddress - The address of the digital asset to update.
+ * @param args.digitalAssetType - (Optional) The type of the digital asset.
+ * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
+ */
+export declare function updateDigitalAssetPropertyTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    propertyKey: string;
+    propertyType: PropertyType;
+    propertyValue: PropertyValue;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Creates a transaction to add a typed property to a digital asset.
+ * This function helps in customizing digital assets by associating them with specific properties.
+ *
+ * @param args - The arguments required to create the transaction.
+ * @param args.aptosConfig - The configuration settings for Aptos.
+ * @param args.creator - The account that is creating the transaction.
+ * @param args.propertyKey - The key for the property being added.
+ * @param args.propertyType - The type of the property being added.
+ * @param args.propertyValue - The value of the property being added.
+ * @param args.digitalAssetAddress - The address of the digital asset to which the property is being added.
+ * @param args.digitalAssetType - (Optional) The type of the digital asset.
+ * @param args.options - (Optional) Additional options for generating the transaction.
+ * @group Implementation
+ */
+export declare function addDigitalAssetTypedPropertyTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    propertyKey: string;
+    propertyType: PropertyType;
+    propertyValue: PropertyValue;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+/**
+ * Updates the typed property of a digital asset by generating a transaction for the Aptos blockchain.
+ *
+ * @param args - The arguments for updating the digital asset typed property.
+ * @param args.aptosConfig - The configuration settings for the Aptos network.
+ * @param args.creator - The account that is creating the transaction.
+ * @param args.propertyKey - The key of the property to be updated.
+ * @param args.propertyType - The type of the property being updated.
+ * @param args.propertyValue - The new value for the property.
+ * @param args.digitalAssetAddress - The address of the digital asset to be updated.
+ * @param args.digitalAssetType - Optional. The type of the digital asset, if not provided, defaults to the standard type.
+ * @param args.options - Optional. Additional options for generating the transaction.
+ * @group Implementation
+ */
+export declare function updateDigitalAssetTypedPropertyTransaction(args: {
+    aptosConfig: AptosConfig;
+    creator: Account;
+    propertyKey: string;
+    propertyType: PropertyType;
+    propertyValue: PropertyValue;
+    digitalAssetAddress: AccountAddressInput;
+    digitalAssetType?: MoveStructId;
+    options?: InputGenerateTransactionOptions;
+}): Promise<SimpleTransaction>;
+export {};
+//# sourceMappingURL=digitalAsset.d.ts.map

package/dist/internal/digitalAsset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"digitalAsset.d.ts","sourceRoot":"","sources":["../../src/internal/digitalAsset.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAoB,+BAA+B,EAAE,MAAM,0BAA0B,CAAC;AAC7F,OAAO,EACL,SAAS,EACT,yBAAyB,EACzB,gCAAgC,EAChC,sBAAsB,EACtB,wBAAwB,EACxB,oBAAoB,EAEpB,YAAY,EACZ,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,QAAQ,EACT,MAAM,mBAAmB,CAAC;AAgB3B,OAAO,EACL,2BAA2B,EAG5B,MAAM,6BAA6B,CAAC;AAarC,OAAO,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAC;AAGnF,QAAA,MAAM,eAAe;;;;;;;;;;;CAWpB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,eAAe,CAAC;AAExD;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,cAAc,GAAG,UAAU,CAAC;AAO7F;;;;;;;;GAQG;AACH,wBAAsB,mBAAmB,CAAC,IAAI,EAAE;IAC9C,WAAW,EAAE,WAAW,CAAC;IACzB,mBAAmB,EAAE,mBAAmB,CAAC;CAC1C,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAqBhC;AAED;;;;;;;;GAQG;AACH,wBAAsB,+BAA+B,CAAC,IAAI,EAAE;IAC1D,WAAW,EAAE,WAAW,CAAC;IACzB,mBAAmB,EAAE,mBAAmB,CAAC;CAC1C,GAAG,OAAO,CAAC,gCAAgC,CAAC,CAsB5C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,qBAAqB,CAAC,IAAI,EAAE;IAChD,WAAW,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,mBAAmB,CAAC;IAClC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;CACpE,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAyBlC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,uBAAuB,CAAC,IAAI,EAAE;IAClD,WAAW,EAAE,WAAW,CAAC;IACzB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;CACpE,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAwBpC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAuBD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,2BAA2B,CAC/C,IAAI,EAAE;IACJ,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,uBAAuB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CA6B5B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE;IAC5C,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,CAAC,EAAE,gBAAgB,GAAG,cAAc,GAAG,QAAQ,CAAC,2BAA2B,CAAC,CAAC;CACrF,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAwBrC;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,kDAAkD,CAAC,IAAI,EAAE;IAC7E,WAAW,EAAE,WAAW,CAAC;IACzB,cAAc,EAAE,mBAAmB,CAAC;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC;CAC7C,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAarC;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,iCAAiC,CAAC,IAAI,EAAE;IAC5D,WAAW,EAAE,WAAW,CAAC;IACzB,cAAc,EAAE,mBAAmB,CAAC;IACpC,OAAO,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC;CAC7C,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAYrC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,+BAA+B,CAAC,IAAI,EAAE;IAC1D,WAAW,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,mBAAmB,CAAC;IAClC,OAAO,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC;CAC7C,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAarC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE;IAC1C,WAAW,EAAE,WAAW,CAAC;IACzB,cAAc,EAAE,mBAAmB,CAAC;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC5B,GAAG,OAAO,CAAC,MAAM,CAAC,CAalB;AAiBD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,2BAA2B,CAAC,IAAI,EAAE;IACtD,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IACpC,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAyC7B;AAOD;;;;;;;;;;;;GAYG;AACH,wBAAsB,+BAA+B,CAAC,IAAI,EAAE;IAC1D,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,EAAE,OAAO,CAAC;IAChB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7B;AAgBD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,wBAAwB,CAAC,IAAI,EAAE;IACnD,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,mBAAmB,CAAC;IAC/B,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IACpC,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAwC7B;AAOD;;;;;;;;;;;GAWG;AACH,wBAAsB,2BAA2B,CAAC,IAAI,EAAE;IACtD,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7B;AAOD;;;;;;;;;;;GAWG;AACH,wBAAsB,qCAAqC,CAAC,IAAI,EAAE;IAChE,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7B;AAOD;;;;;;;;;;GAUG;AACH,wBAAsB,uCAAuC,CAAC,IAAI,EAAE;IAClE,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7B;AAOD;;;;;;;;;;;GAWG;AACH,wBAAsB,qCAAqC,CAAC,IAAI,EAAE;IAChE,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7B;AAOD;;;;;;;;;;;;GAYG;AACH,wBAAsB,8BAA8B,CAAC,IAAI,EAAE;IACzD,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7B;AAOD;;;;;;;;;;;GAWG;AACH,wBAAsB,6BAA6B,CAAC,IAAI,EAAE;IACxD,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7B;AAYD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,kCAAkC,CAAC,IAAI,EAAE;IAC7D,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA2B7B;AAOD;;;;;;;;;;;;GAYG;AACH,wBAAsB,qCAAqC,CAAC,IAAI,EAAE;IAChE,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7B;AAYD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,qCAAqC,CAAC,IAAI,EAAE;IAChE,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAoC7B;AAWD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,uCAAuC,CAAC,IAAI,EAAE;IAClE,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAsB7B;AAWD;;;;;;;;;;;;;GAaG;AACH,wBAAsB,0CAA0C,CAAC,IAAI,EAAE;IACrE,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,YAAY,CAAC;IAC3B,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,+BAA+B,CAAC;CAC3C,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAsB7B"}