diff --git a/projects/abel-sdk-v2/.gitignore b/projects/abel-sdk-v2/.gitignore index d2a0cb3..e531eb3 100644 --- a/projects/abel-sdk-v2/.gitignore +++ b/projects/abel-sdk-v2/.gitignore @@ -1 +1,2 @@ .npmrc +docs/ diff --git a/projects/abel-sdk-v2/README.md b/projects/abel-sdk-v2/README.md index 478fd6a..e4d1df6 100644 --- a/projects/abel-sdk-v2/README.md +++ b/projects/abel-sdk-v2/README.md @@ -2,6 +2,8 @@ **Abel is an Asset Labeling registry, as well as a provider of batch asset data.** +Docs site: [abel-docs.d13.co](https://abel-docs.d13.co) + ## Install > [!WARNING] @@ -54,14 +56,14 @@ const microData = await abel.getAssetsMicro([312769n, 6547014n, 6587142n, 271659 The available asset views are: -- [AssetMicro](AssetMicro.html) (no labels) -- [AssetMicroLabels](AssetMicroLabels.html) -- [AssetTiny](AssetTiny.html) (no labels) -- [AssetTinyLabels](AssetTinyLabels.html) -- [AssetText](AssetText.html) (no labels) -- [AssetTextLabels](AssetTextLabels.html) -- [AssetSmall](AssetSmall.html) -- [AssetFull](AssetFull.html) +- [AssetMicro](AssetMicro) (no labels) +- [AssetMicroLabels](AssetMicroLabels) +- [AssetTiny](AssetTiny) (no labels) +- [AssetTinyLabels](AssetTinyLabels) +- [AssetText](AssetText) (no labels) +- [AssetTextLabels](AssetTextLabels) +- [AssetSmall](AssetSmall) +- [AssetFull](AssetFull) To fetch asset data in these views, use the corresponding `getXYZ` method of the SDK, e.g. [getAssetMicroLabels](classes/AbelSDK#getassetsmicrolabels). @@ -77,20 +79,20 @@ You will get the best performance and efficiency if you use the smallest possibl ### 128 assets per simulate call -- [AssetMicro](AssetMicro.html) -- [AssetTiny](AssetTiny.html) -- [AssetText](AssetText.html) +- [AssetMicro](AssetMicro) +- [AssetTiny](AssetTiny) +- [AssetText](AssetText) ### 64 assets per simulate call -- [AssetMicroLabels](AssetMicroLabels.html) -- [AssetTinyLabels](AssetTinyLabels.html) -- [AssetTextLabels](AssetTextLabels.html) -- [AssetSmall](AssetSmall.html) +- [AssetMicroLabels](AssetMicroLabels) +- [AssetTinyLabels](AssetTinyLabels) +- [AssetTextLabels](AssetTextLabels) +- [AssetSmall](AssetSmall) ### 42 assets per simulate call -- [AssetFull](AssetFull.html) +- [AssetFull](AssetFull) ### Concurrency diff --git a/projects/abel-sdk-v2/docs/AbelSDK/index.html b/projects/abel-sdk-v2/docs/AbelSDK/index.html deleted file mode 100644 index 99cfd16..0000000 --- a/projects/abel-sdk-v2/docs/AbelSDK/index.html +++ /dev/null @@ -1,197 +0,0 @@ -
Represents an instance of AssetLabelingClient used to read data from the Asset Labeling contract. -Provides functionality to manage and retrieve asset labeling data.
-OptionalwriteAn optional variable representing an account that can authorize and sign transactions.
-The writeAccount variable is either an instance of TransactionSignerAccount or is undefined.
-It is used to execute and authenticate transaction operations.
Represents an instance of AssetLabelingClient or undefined.
-The variable is used to write data to the Asset Labeling contract. -Ensure to properly check for undefined before attempting to invoke any methods or properties -associated with the AssetLabelingClient.
-Retrieves the application ID associated with the current client instance.
-Adds a label to the specified entity with the given details.
-The unique identifier for the label.
-The name of the label.
-The URL associated with the label.
-Returns a promise that resolves to the result of the operation, potentially wrapped with error handling.
-Adds a label to a specified asset by associating the label ID with the asset ID.
-The unique identifier of the asset to which the label will be added.
-The unique identifier of the label to be associated with the asset.
-A promise that resolves to the client response indicating the result of the operation.
-Adds a specified label to a set of asset IDs.
-This function permits assigning a label to assets in batches to optimize performance. -If the list of asset IDs exceeds the maximum limit for a single method invocation, -the function segments the asset IDs into chunks and processes them asynchronously -with controlled concurrency.
-An array of asset IDs to be labeled.
-The identifier of the label to be added to the assets.
-A promise that resolves to the response(s) from the operation. -If the operation involves chunked requests, the responses are returned as an array.
-Add a label to an operator. -This allows the operator address to add/remove operators to the label, as well as label assets with this label.
-Operator address
-Label to add to operator
-Updates the label with the specified ID, changing its name and URL.
-The unique identifier of the label to be changed.
-The new name to assign to the label.
-The new URL to associate with the label.
-A promise that resolves with the response from the client after attempting to update the label.
-Return all asset IDs available on the contract
-Asset IDs
-Return all label IDs available on the contract
-Label IDs
-Return all operator addresses on the contract
-Operator addresses
-Fetches the labels associated with a specific asset.
-The unique identifier of the asset for which labels need to be retrieved.
-A promise that resolves to an array of asset labels.
-Retrieves detailed information for a list of asset IDs as a map of asset ID to asset details.
-If the number of asset IDs exceeds the maximum allowed per method call, the request is automatically divided -into smaller batches to handle the data in chunks.
-An array of asset IDs for which the detailed information is requested.
-A promise resolving to a map where each key is an asset ID and -the value is the corresponding detailed asset information.
-Retrieves asset labels for a given list of asset IDs asynchronously.
-This method performs a simulation of fetching labels for the specified assets by calling
-the logAssetsLabels function through the readClient instance. If the input list of
-asset IDs exceeds the predefined maximum (METHOD_MAX), it automatically splits the call
-into batches for processing.
An array of asset IDs for which labels are to be fetched.
-A promise that resolves to a map where each asset ID -corresponds to its associated array of labels.
-Retrieves a map of asset micro details for the provided asset IDs.
-This function handles querying for the details of multiple assets using their respective IDs. -It ensures batched processing if the number of asset IDs exceeds the maximum method capacity.
-An array of asset IDs for which the micro details are requested.
-A promise that resolves to a map where each key is the asset ID, -and the value is the corresponding AssetMicro data.
-Fetches the micro labels for a given list of asset IDs.
-This method retrieves metadata for the specified assets by making
-a request to the underlying data source. It supports batching
-for optimizing requests, ensuring that if the asset list exceeds
-a predefined maximum limit (METHOD_MAX), it splits the calls
-into batches for processing.
An array of asset IDs for which micro labels are to be fetched.
-A promise resolving to a Map where each key is an asset ID and the value is its corresponding micro label information.
-Retrieves a map of small asset details for the given list of asset IDs.
-If the number of asset IDs exceeds the maximum allowable batch size (METHOD_MAX), the method splits
-the request into batches by recursively calling itself with the appropriate subdivisions of the assetIds array.
The method interacts with a read client to simulate a data retrieval process and parses the resulting logs -to map each asset ID to its corresponding asset data.
-An array of asset IDs for which the small asset details should be retrieved.
-A promise resolving to a map where the keys are asset IDs (bigint)
-and the values are AssetSmall objects containing the corresponding small asset details.
Retrieves asset text details for a given list of asset IDs.
-This function fetches the text descriptors for the specified asset IDs asynchronously.
-If the number of asset IDs exceeds the defined method limit (METHOD_MAX),
-the function breaks the request into smaller batches and calls itself recursively.
An array of bigint values representing the asset IDs.
-A promise that resolves to a Map,
-where each key is an asset ID and the value is an AssetText object containing
-the text descriptor for the respective asset.
Fetches text labels for a given list of asset IDs.
-The function retrieves the text labels associated with the provided asset IDs -by calling the backend services and simulating the results. If the number of -asset IDs exceeds the maximum allowed limit (METHOD_MAX), the function divides -the request into smaller batch calls.
-An array of asset IDs for which text labels are to be fetched.
-A promise that resolves to a map where the keys -are the asset IDs and the values are their associated text label objects.
-Retrieves a mapping of asset IDs to their corresponding "AssetTiny" details. -This asynchronous function fetches details for the provided asset IDs in an optimized manner, -using batching if the number of asset IDs exceeds the allowed limit.
-An array of asset identifiers for which the details are requested.
-A promise that resolves to a Map where each asset ID is mapped -to its corresponding "AssetTiny" details.
-Fetches tiny label details for the given list of asset IDs.
-This method queries asset data in batches if the number of asset IDs exceeds a pre-defined limit. -It uses simulated calls to the read client for retrieving asset label information and parses -the logs to extract the results. The returned data is mapped to each asset ID.
-Array of asset IDs for which tiny labels are to be retrieved.
-A promise that resolves to a map, -where each key is an asset ID (bigint) and the value is an object containing the tiny label details for the asset.
-Get a label descriptor for a label by its ID.
-The label to look up by label ID
-A label descriptor
-Get multiple label descriptors for labels, by their IDs.
-The label IDs to look up
-Result wap with label IDs as keys and LabelDescriptors as values.
-Get all labels for an operator
-The operator address to query
-Labels that this account can operate on
-Return whether an asset has a specific label
-Asset to look up, by asset ID
-label to query for, by label ID
-True if an asset exists and has a label
-Returns whether a specific label ID exists or not
-label ID
-Whether the label exists or not
-Returns whether or not an operator has access to a label
-The operator address to query
-The label ID to look up
-parse typed arc4 structs from logs
-tupleParser is like generated clients' xyzArcStructFromTuple -abiDecodingMethod is a method name that returns the same avi return type as we are logging -e.g. if we are parsing log_label_descriptors() logs that logs LabelDescriptor, abiDecodingMethod can be get_label_descriptor that has ABI return LabelDescriptor
-Removes a label specified by the labelId.
-The unique identifier of the label to be removed.
-A promise that resolves with the result of the removal operation -or rejects with an error if the operation fails.
-Removes a label from a specified asset.
-The unique identifier of the asset from which the label should be removed.
-The unique identifier of the label to be removed from the asset.
-A promise that resolves to a ClientResponse indicating the result of the label removal operation.
-Removes an operator from a specified label.
-The address of the operator to be removed.
-The ID of the label from which the operator is to be removed.
-A promise that resolves to the client response indicating the result of the operation.
-Represents the configuration options for initializing the Abel SDK.
-Represents an instance of the Algorand client used for interacting with the Algorand blockchain. -The client provides functionalities to connect to the network, submit transactions, -retrieve account information, and manage blockchain-related operations.
-This variable is initialized with the required configuration and network details -to establish communication with the desired Algorand network.
-Represents the unique identifier of an application. -This identifier is a BigInt value and is typically used for referencing -and distinguishing one application instance from another within the AVM.
-OptionalconcurrencyThe maximum number of concurrent operations allowed. -This optional parameter defines the upper limit for tasks or processes -that can run simultaneously.
-OptionalreadThe Algorand address for reading
-OptionalwriteAn optional property representing a signer account used for -writing or authorizing transactions.
-ProtectedA client to make calls to the AssetLabeling smart contract
-Creates a new instance of AssetLabelingClient
An AppClient instance which has been created with the AssetLabeling app spec
Creates a new instance of AssetLabelingClient
The parameters to initialise the app client with
-ReadonlyappThe underlying AppClient for when you want to have more flexibility
ReadonlycreateCreate transactions for the current app
-Makes a call to the AssetLabeling smart contract using the add_label(string,string,string)void ABI method.
Makes a call to the AssetLabeling smart contract using the add_label_to_asset(string,asset)void ABI method.
Makes a call to the AssetLabeling smart contract using the add_label_to_assets(string,uint64[])void ABI method.
Makes a call to the AssetLabeling smart contract using the add_operator_to_label(account,string)void ABI method.
Makes a call to the AssetLabeling smart contract using the change_admin(account)void ABI method.
Makes a call to the AssetLabeling smart contract using the change_label(string,string,string)void ABI method.
Makes a clear_state call to an existing instance of the AssetLabeling smart contract.
-Gets available delete methods
-Deletes an existing instance of the AssetLabeling smart contract using a bare call.
-Makes a call to the AssetLabeling smart contract using the get_asset_full(uint64)(string,string,string,uint64,uint8,address,address,address,address,address,bool,byte[],uint64,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_labels(asset)string[] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_micro(uint64)(string,uint8) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_micro_labels(uint64)(string,uint8,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_full(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_labels(uint64[])string[][] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_small(uint64)(string,string,uint8,uint64,bool,bool,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_micro(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_micro_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_small(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_text(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_text_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_tiny(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_tiny_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_text(uint64)(string,string,string) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_text_labels(uint64)(string,string,string,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_tiny(uint64)(string,string,uint8) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_tiny_labels(uint64)(string,string,uint8,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_label(string)(string,string,uint64,uint64) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_operator_labels(account)string[] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the has_asset_label(uint64,string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the has_label(string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the has_operator_label(account,string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the log_assets_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the log_labels(string[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the remove_label(string)void ABI method.
Makes a call to the AssetLabeling smart contract using the remove_label_from_asset(string,asset)void ABI method.
Makes a call to the AssetLabeling smart contract using the remove_operator_from_label(account,string)void ABI method.
Gets available update methods
-Updates an existing instance of the AssetLabeling smart contract using a bare call.
-ReadonlyparamsGet parameters to create transactions for the current app. A good mental model for this is that these parameters represent a deferred transaction creation.
-Makes a call to the AssetLabeling smart contract using the add_label(string,string,string)void ABI method.
Makes a call to the AssetLabeling smart contract using the add_label_to_asset(string,asset)void ABI method.
Makes a call to the AssetLabeling smart contract using the add_label_to_assets(string,uint64[])void ABI method.
Makes a call to the AssetLabeling smart contract using the add_operator_to_label(account,string)void ABI method.
Makes a call to the AssetLabeling smart contract using the change_admin(account)void ABI method.
Makes a call to the AssetLabeling smart contract using the change_label(string,string,string)void ABI method.
Makes a clear_state call to an existing instance of the AssetLabeling smart contract.
-Gets available delete methods
-Deletes an existing instance of the AssetLabeling smart contract using a bare call.
-Makes a call to the AssetLabeling smart contract using the get_asset_full(uint64)(string,string,string,uint64,uint8,address,address,address,address,address,bool,byte[],uint64,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_labels(asset)string[] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_micro(uint64)(string,uint8) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_micro_labels(uint64)(string,uint8,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_full(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_labels(uint64[])string[][] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_small(uint64)(string,string,uint8,uint64,bool,bool,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_micro(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_micro_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_small(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_text(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_text_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_tiny(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_tiny_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_text(uint64)(string,string,string) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_text_labels(uint64)(string,string,string,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_tiny(uint64)(string,string,uint8) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_tiny_labels(uint64)(string,string,uint8,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_label(string)(string,string,uint64,uint64) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_operator_labels(account)string[] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the has_asset_label(uint64,string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the has_label(string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the has_operator_label(account,string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the log_assets_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the log_labels(string[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the remove_label(string)void ABI method.
Makes a call to the AssetLabeling smart contract using the remove_label_from_asset(string,asset)void ABI method.
Makes a call to the AssetLabeling smart contract using the remove_operator_from_label(account,string)void ABI method.
Gets available update methods
-Updates an existing instance of the AssetLabeling smart contract using a bare call.
-ReadonlysendSend calls to the current app
-Makes a call to the AssetLabeling smart contract using the add_label(string,string,string)void ABI method.
Makes a call to the AssetLabeling smart contract using the add_label_to_asset(string,asset)void ABI method.
Makes a call to the AssetLabeling smart contract using the add_label_to_assets(string,uint64[])void ABI method.
Makes a call to the AssetLabeling smart contract using the add_operator_to_label(account,string)void ABI method.
Makes a call to the AssetLabeling smart contract using the change_admin(account)void ABI method.
Makes a call to the AssetLabeling smart contract using the change_label(string,string,string)void ABI method.
Makes a clear_state call to an existing instance of the AssetLabeling smart contract.
-Gets available delete methods
-Deletes an existing instance of the AssetLabeling smart contract using a bare call.
-Makes a call to the AssetLabeling smart contract using the get_asset_full(uint64)(string,string,string,uint64,uint8,address,address,address,address,address,bool,byte[],uint64,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_labels(asset)string[] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_micro(uint64)(string,uint8) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_micro_labels(uint64)(string,uint8,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_full(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_labels(uint64[])string[][] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_small(uint64)(string,string,uint8,uint64,bool,bool,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_micro(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_micro_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_small(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_text(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_text_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_tiny(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_assets_tiny_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_text(uint64)(string,string,string) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_text_labels(uint64)(string,string,string,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_tiny(uint64)(string,string,uint8) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_asset_tiny_labels(uint64)(string,string,uint8,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_label(string)(string,string,uint64,uint64) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the get_operator_labels(account)string[] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the has_asset_label(uint64,string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the has_label(string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the has_operator_label(account,string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the log_assets_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the log_labels(string[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-Makes a call to the AssetLabeling smart contract using the remove_label(string)void ABI method.
Makes a call to the AssetLabeling smart contract using the remove_label_from_asset(string,asset)void ABI method.
Makes a call to the AssetLabeling smart contract using the remove_operator_from_label(account,string)void ABI method.
Gets available update methods
-Updates an existing instance of the AssetLabeling smart contract using a bare call.
-Methods to access state for the current AssetLabeling app
-Methods to access global state for the current AssetLabeling app
-Get the current value of the admin key in global state
-Get all current keyed values from global state
-A reference to the underlying AlgorandClient this app client is using.
The app address of the app instance this client is linked to.
-The ID of the app instance this client is linked to.
-The name of the app.
-The ARC-56 app spec being used
-Clone this app client with different params
-The params to use for the the cloned app client. Omit a param to keep the original value. Set a param to override the original value. Setting to undefined will clear the original value.
-OptionalappId?: bigintThe ID of the app instance this client should make calls against.
-OptionalappName?: stringOptional override for the app name; used for on-chain metadata and lookups. -Defaults to the ARC-32/ARC-56 app spec name
-OptionalapprovalSourceMap?: SourceMapOptional source map for the approval program
-OptionalclearSourceMap?: SourceMapOptional source map for the clear state program
-OptionaldefaultSender?: stringOptional address to use for the account to use as the default sender for calls.
-OptionaldefaultSigner?: TransactionSignerOptional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from AlgorandClient).
A new app client with the altered params
-Checks for decode errors on the given return value and maps the return value to the return type for the given method
-The typed return value or undefined if there was no value
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_asset_full(uint64)(string,string,string,uint64,uint8,address,address,address,address,address,bool,byte[],uint64,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_asset_labels(asset)string[] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_asset_micro(uint64)(string,uint8) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_asset_micro_labels(uint64)(string,uint8,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_assets_full(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_assets_labels(uint64[])string[][] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_asset_small(uint64)(string,string,uint8,uint64,bool,bool,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_assets_micro(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_assets_micro_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_assets_small(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_assets_text(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_assets_text_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_assets_tiny(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_assets_tiny_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_asset_text(uint64)(string,string,string) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_asset_text_labels(uint64)(string,string,string,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_asset_tiny(uint64)(string,string,uint8) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_asset_tiny_labels(uint64)(string,string,uint8,string[]) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_label(string)(string,string,uint64,uint64) ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the get_operator_labels(account)string[] ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the has_asset_label(uint64,string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the has_label(string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the has_operator_label(account,string)uint64 ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the log_assets_labels(uint64[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-Makes a readonly (simulated) call to the AssetLabeling smart contract using the log_labels(string[])void ABI method.
This method is a readonly method; calling it with onComplete of NoOp will result in a simulated transaction rather than a real transaction.
-The params for the smart contract call
-OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-The args for the ABI method call, either as an ordered array or an object
-OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-The call result
-StaticfromReturns a new AssetLabelingClient client, resolving the app by creator address and name
-using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).
The parameters to create the app client
-StaticfromReturns an AssetLabelingClient instance for the current network based on
-pre-determined network-specific app IDs specified in the ARC-56 app spec.
If no IDs are in the app spec or the network isn't recognised, an error is thrown.
-The parameters to create the app client
-A factory to create and deploy one or more instance of the AssetLabeling smart contract and to create one or more app clients to interact with those (or other) app instances
-Creates a new instance of AssetLabelingFactory
The parameters to initialise the app factory with
-ReadonlyappThe underlying AppFactory for when you want to have more flexibility
ReadonlycreateCreate transactions for the current app
-Gets available create methods
-Creates a new instance of the AssetLabeling smart contract using a bare call.
-ReadonlyparamsGet parameters to create transactions (create and deploy related calls) for the current app. A good mental model for this is that these parameters represent a deferred transaction creation.
-Gets available create methods
-Creates a new instance of the AssetLabeling smart contract using a bare call.
-Gets available deployDelete methods
-Deletes an existing instance of the AssetLabeling smart contract using a bare call.
-Gets available deployUpdate methods
-Updates an existing instance of the AssetLabeling smart contract using a bare call.
-ReadonlysendSend calls to the current app
-Gets available create methods
-Creates a new instance of the AssetLabeling smart contract using a bare call.
-A reference to the underlying AlgorandClient this app factory is using.
The name of the app (from the ARC-32 / ARC-56 app spec or override).
-The ARC-56 app spec being used
-Idempotently deploys the AssetLabeling smart contract.
-The arguments for the contract calls and any additional parameters for the call
-OptionalappName?: stringOverride the app name for this deployment
-OptionalcreateParams?: {Create transaction parameters to use if a create needs to be issued as part of deployment; use method to define ABI call (if available) or leave out for a bare call (if available)
OptionalaccountReferences?: string[]Any account addresses to add to the accounts array.
-OptionalappReferences?: bigint[]The ID of any apps to load to the foreign apps array.
-Optionalargs?: Uint8Array<ArrayBufferLike>[]OptionalassetReferences?: bigint[]The ID of any assets to load to the foreign assets array.
-OptionalboxReferences?: (BoxIdentifier | BoxReference)[]Any boxes to load to the boxes array.
-Either the name identifier (which will be set against app ID of 0 i.e.
-the current app), or a box identifier with the name identifier and app ID.
OptionalextraFee?: AlgoAmountThe fee to pay IN ADDITION to the suggested fee. Useful for covering inner transaction fees.
-OptionalextraProgramPages?: numberNumber of extra pages required for the programs. -Defaults to the number needed for the programs in this call if not specified. -This is immutable once the app is created.
-OptionalfirstValidRound?: bigintSet the first round this transaction is valid. -If left undefined, the value from algod will be used.
-We recommend you only set this when you intentionally want this to be some time in the future.
-OptionallastValidRound?: bigintThe last round this transaction is valid. It is recommended to use validityWindow instead.
Optionallease?: string | Uint8Array<ArrayBufferLike>Prevent multiple transactions with the same lease being included within the validity window.
-A lease -enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios).
-OptionalmaxFee?: AlgoAmountThrow an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods.
-Optionalmethod?: undefinedOptionalnote?: string | Uint8Array<ArrayBufferLike>Note to attach to the transaction. Max of 1000 bytes.
-OptionalonComplete?: NoOpOCOptionalrekeyTo?: stringChange the signing key of the sender to the given address.
-Warning: Please be careful with this parameter and be sure to read the official rekey guidance.
-Optionalschema?: {The state schema for the app. This is immutable once the app is created. By default uses the ARC32/ARC-56 spec.
-The number of byte slices saved in global state.
-The number of integers saved in global state.
-The number of byte slices saved in local state.
-The number of integers saved in local state.
-Optionalsender?: stringThe address of the account sending the transaction, if undefined then the app client's defaultSender is used.
-Optionalsigner?: TransactionSigner | TransactionSignerAccountThe function used to sign transaction(s); if not specified then
-an attempt will be made to find a registered signer for the
-given sender or use a default signer (if configured).
OptionalstaticFee?: AlgoAmountThe static transaction fee. In most cases you want to use extraFee unless setting the fee to 0 to be covered by another transaction.
OptionalvalidityWindow?: numberHow many rounds the transaction should be valid for, if not specified then the registered default validity window will be used.
-Optionaldeletable?: booleanWhether or not the contract should have deploy-time permanence control set.
-undefined = use AppFactory constructor value if set or base it on the app spec.
OptionaldeleteParams?: {Delete transaction parameters to use if a create needs to be issued as part of deployment; use method to define ABI call (if available) or leave out for a bare call (if available)
OptionaldeployTimeParams?: TealTemplateParamsAny deploy-time parameters to replace in the TEAL code before compiling it (used if teal code is passed in as a string)
-OptionalexistingDeployments?: AppLookupOptional cached value of the existing apps for the given creator; use this to avoid an indexer lookup
-OptionalignoreCache?: booleanWhether or not to ignore the app metadata cache and force a lookup, default: use the cache *
-OptionalmaxRoundsToWaitForConfirmation?: numberThe number of rounds to wait for confirmation. By default until the latest lastValid has past.
-OptionalonSchemaBreak?: "replace" | "append" | "fail" | OnSchemaBreakWhat action to perform if a schema break (storage schema or extra pages change) is detected:
-fail - Fail the deployment (throw an error, default)replace - Delete the old app and create a new oneappend - Deploy a new app and leave the old one as isOptionalonUpdate?: "replace" | "append" | "fail" | "update" | OnUpdateWhat action to perform if a TEAL code update is detected:
-fail - Fail the deployment (throw an error, default)update - Update the app with the new TEAL codereplace - Delete the old app and create a new oneappend - Deploy a new app and leave the old one as isOptionalpopulateAppCallResources?: booleanWhether to use simulate to automatically populate app call resources in the txn objects. Defaults to Config.populateAppCallResources.
OptionalsuppressLog?: booleanWhether to suppress log messages from transaction send, default: do not suppress.
-Optionalupdatable?: booleanWhether or not the contract should have deploy-time immutability control set.
-undefined = use AppFactory constructor value if set or base it on the app spec.
OptionalupdateParams?: {Update transaction parameters to use if a create needs to be issued as part of deployment; use method to define ABI call (if available) or leave out for a bare call (if available)
The deployment result
-Returns a new AppClient client, resolving the app by creator address and name
-using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note).
Automatically populates appName, defaultSender and source maps from the factory -if not specified in the params.
-The parameters to create the app client
-OptionalappLookupCache?: AppLookupAn optional cached app lookup that matches a name to on-chain details;
-either this is needed or indexer is required to be passed in to this ClientManager on construction.
OptionalappName?: stringOptional override for the app name; used for on-chain metadata and lookups. -Defaults to the ARC-32/ARC-56 app spec name
-OptionalapprovalSourceMap?: SourceMapOptional source map for the approval program
-OptionalclearSourceMap?: SourceMapOptional source map for the clear state program
-The address of the creator account for the app
-OptionaldefaultSender?: stringOptional address to use for the account to use as the default sender for calls.
-OptionaldefaultSigner?: TransactionSignerOptional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from AlgorandClient).
OptionalignoreCache?: booleanWhether or not to ignore the AppDeployer lookup cache and force an on-chain lookup, default: use any cached value
The AppClient
Returns a new AppClient client for an app instance of the given ID.
Automatically populates appName, defaultSender and source maps from the factory -if not specified in the params.
-The parameters to create the app client
-The ID of the app instance this client should make calls against.
-OptionalappName?: stringOptional override for the app name; used for on-chain metadata and lookups. -Defaults to the ARC-32/ARC-56 app spec name
-OptionalapprovalSourceMap?: SourceMapOptional source map for the approval program
-OptionalclearSourceMap?: SourceMapOptional source map for the clear state program
-OptionaldefaultSender?: stringOptional address to use for the account to use as the default sender for calls.
-OptionaldefaultSigner?: TransactionSignerOptional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from AlgorandClient).
The AppClient
ProtectedOptionalreturnsProtectedA label description/configuration
-ProtectedProtectedAbel is an Asset Labeling registry, as well as a provider of batch asset data.
--This version of abel-SDK only supports js-algorand-sdk v2 and its corresponding algokit-utils v7
-npm i abel-sdk
-
-
--Want to explore with a CLI? Check out abel-cil which uses this SDK under the hood.
-The default use case is with a read-only client. This will allow you to fetch asset and label data, but not operate on the registry.
-Create an SDK instance by passing in the abel app ID and an an algokit.AlgorandClient.
For Mainnet:
-import { AlgorandClient } from "@algorandfoundation/algokit-utils";
import { AbelSDK } from "abel-sdk";
const abel = new AbelSDK({
appId: 2914159523n, // Abel Mainnet PoC App ID
algorand: AlgorandClient.fromConfig({
algodConfig: { server: "https://mainnet-api.4160.nodely.dev", port: 443 },
}),
});
-
-
-You can query assets with multiple size views.
-To get the "Asset Micro Labels" view for multiple assets:
-const microData = await abel.getAssetsMicro([312769n, 6547014n, 6587142n, 27165954n]);
// returns
// Map(4) {
// 312769n => { id: 312769n, unitName: 'USDt', decimals: 6n, labels: [ 'pv' ] },
// 6547014n => { id: 6547014n, unitName: 'MCAU', decimals: 5n, labels: [ 'pv' ] },
// 6587142n => { id: 6587142n, unitName: 'MCAG', decimals: 5n, labels: [ 'pv' ] },
// 27165954n => { id: 27165954n, unitName: 'Planets', decimals: 6n, labels: [ 'pv' ] }
// }
-
-
-The available asset views are:
-To fetch asset data in these views, use the corresponding getXYZ method of the SDK, e.g. getAssetMicroLabels.
You can pass in as many asset IDs as you want.
-Under the hood, Abel uses simulate to fetch multiple assets' data from a single simulate call.
-The number of assets per simulate request depends on how many AVM resources are required to compose it.
-You will get the best performance and efficiency if you use the smallest possible view for your needs.
-The Abel SDK supports arbitrarily large asset lookups.
-If you request more assets than a single simulate call can provide for that view, parallel simulate requests will be made in order to fetch your data.
-By default, Abel will use up to 4 simulate "threads", i.e. it will keep up to 4 simulate requests in parallel in order to fetch asset data.
-You can control this level of concurrency by passing in a concurrency property in the Abel SDK constructor.
-The concurrency limit is per-method call, not global. For example, if you have concurrency: 2 and you await two separate getAssetsTiny() methods of more than 128 assets each, there will be 4 simulate requests in flight.
To instantiate the SDK with write capabilities, pass in your privileged account as writeAccount:
import { AlgorandClient } from "@algorandfoundation/algokit-utils";
import { AbelSDK } from "abel-sdk";
const mnemonic = "apple apple ...";
const writeAccount = await algorand.account.fromMnemonic(mnemonic);
const abel = new AbelSDK({
appId: 2914159523n, // Abel Mainnet PoC App ID
algorand: AlgorandClient.fromConfig({
algodConfig: { server: "https://mainnet-api.4160.nodely.dev", port: 443 },
}),
writeAccount,
});
-
-
-You can then operate on your label group, as well as any asset:
-const someAddress = "DTHIRTEENNLSYGLSEXTXC6X4SVDWMFRCPAOAUCXWIXJRCVBWIIGLYARNQE";
const labelId = "13"
// add another operator to your label
await abel.addOperatorToLabel(someAddress, labelId);
// remove operator from your label
await abel.removeOperatorFromLabel(someAddress, labelId);
// add label to asset with ID 1013
await abel.addLabelToAsset(1013n, labelId);
// remove label from asset with ID 1013
await abel.removeLabelFromAsset(1013n, labelId);
-
-
-
The
-AbelSDKclass is an SDK for interacting with an asset labeling system, allowing querying, management, and -association of labels, assets, and operators within a given application. -The class supports read and write operations and relies on Algorand blockchain infrastructure.Example
- -