@aptos-labs/ts-sdk 1.33.1 → 1.33.2

package/src/transactions/typeTag/index.ts

@@ -16,6 +16,8 @@ import { TypeTagVariants } from "../../types";
  * to determine the specific type of the tag at runtime.
  *
  * @extends Serializable
+ * @group Implementation
+ * @category Transactions
  */
 export abstract class TypeTag extends Serializable {
   abstract serialize(serializer: Serializer): void;
@@ -25,6 +27,8 @@ export abstract class TypeTag extends Serializable {
    * This function allows you to reconstruct a StructTag object from its serialized form.
    *
    * @param deserializer - The deserializer instance used to read the serialized data.
+   * @group Implementation
+   * @category Transactions
    */
   deserialize(deserializer: Deserializer): StructTag {
     const address = AccountAddress.deserialize(deserializer);
@@ -73,6 +77,8 @@ export abstract class TypeTag extends Serializable {
    * Determines if the current instance is of type TypeTagBool.
    *
    * @returns {boolean} True if the instance is a TypeTagBool, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isBool(): this is TypeTagBool {
     return this instanceof TypeTagBool;
@@ -82,6 +88,8 @@ export abstract class TypeTag extends Serializable {
    * Determines if the current instance is of type TypeTagAddress.
    *
    * @returns {boolean} True if the instance is a TypeTagAddress, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isAddress(): this is TypeTagAddress {
     return this instanceof TypeTagAddress;
@@ -91,6 +99,8 @@ export abstract class TypeTag extends Serializable {
    * Determines if the current instance is of type TypeTagGeneric.
    *
    * @returns {boolean} Returns true if the instance is a TypeTagGeneric, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isGeneric(): this is TypeTagGeneric {
     return this instanceof TypeTagGeneric;
@@ -100,6 +110,8 @@ export abstract class TypeTag extends Serializable {
    * Determine if the current instance is a TypeTagSigner.
    *
    * @returns {boolean} Returns true if the instance is a TypeTagSigner, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isSigner(): this is TypeTagSigner {
     return this instanceof TypeTagSigner;
@@ -110,6 +122,8 @@ export abstract class TypeTag extends Serializable {
    * This can help determine the specific type of data structure being used.
    *
    * @returns {boolean} True if the instance is of type TypeTagVector, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isVector(): this is TypeTagVector {
     return this instanceof TypeTagVector;
@@ -119,6 +133,8 @@ export abstract class TypeTag extends Serializable {
    * Determines if the current instance is a structure type.
    *
    * @returns {boolean} True if the instance is of type TypeTagStruct, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isStruct(): this is TypeTagStruct {
     return this instanceof TypeTagStruct;
@@ -128,6 +144,8 @@ export abstract class TypeTag extends Serializable {
    * Determines if the current instance is of type `TypeTagU8`.
    *
    * @returns {boolean} Returns true if the instance is of type `TypeTagU8`, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isU8(): this is TypeTagU8 {
     return this instanceof TypeTagU8;
@@ -137,6 +155,8 @@ export abstract class TypeTag extends Serializable {
    * Checks if the current instance is of type TypeTagU16.
    *
    * @returns {boolean} True if the instance is TypeTagU16, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isU16(): this is TypeTagU16 {
     return this instanceof TypeTagU16;
@@ -146,6 +166,8 @@ export abstract class TypeTag extends Serializable {
    * Checks if the current instance is of type TypeTagU32.
    *
    * @returns {boolean} Returns true if the instance is TypeTagU32, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isU32(): this is TypeTagU32 {
     return this instanceof TypeTagU32;
@@ -155,6 +177,8 @@ export abstract class TypeTag extends Serializable {
    * Checks if the current instance is of type TypeTagU64.
    *
    * @returns {boolean} True if the instance is a TypeTagU64, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isU64(): this is TypeTagU64 {
     return this instanceof TypeTagU64;
@@ -164,6 +188,8 @@ export abstract class TypeTag extends Serializable {
    * Determines if the current instance is of the TypeTagU128 type.
    *
    * @returns {boolean} True if the instance is of TypeTagU128, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isU128(): this is TypeTagU128 {
     return this instanceof TypeTagU128;
@@ -173,6 +199,8 @@ export abstract class TypeTag extends Serializable {
    * Checks if the current instance is of type TypeTagU256.
    *
    * @returns {boolean} Returns true if the instance is of type TypeTagU256, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isU256(): this is TypeTagU256 {
     return this instanceof TypeTagU256;
@@ -200,12 +228,16 @@ export abstract class TypeTag extends Serializable {
  * type tag.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagBool extends TypeTag {
   /**
    * Returns the string representation of the object.
    *
    * @returns {string} The string representation of the object.
+   * @group Implementation
+   * @category Transactions
    */
   toString(): string {
     return "bool";
@@ -216,6 +248,8 @@ export class TypeTagBool extends TypeTag {
    * This function ensures that the address, module name, name, and type arguments are properly serialized.
    *
    * @param serializer - The serializer instance used to serialize the properties.
+   * @group Implementation
+   * @category Transactions
    */
   serialize(serializer: Serializer): void {
     serializer.serializeU32AsUleb128(TypeTagVariants.Bool);
@@ -225,6 +259,8 @@ export class TypeTagBool extends TypeTag {
    * Deserializes a StructTag and returns a new TypeTagStruct instance.
    *
    * @param _deserializer - The deserializer used to read the StructTag data.
+   * @group Implementation
+   * @category Transactions
    */
   static load(_deserializer: Deserializer): TypeTagBool {
     return new TypeTagBool();
@@ -237,6 +273,8 @@ export class TypeTagBool extends TypeTag {
  * for serialization and deserialization specific to the u8 type.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagU8 extends TypeTag {
   toString(): string {
@@ -257,6 +295,8 @@ export class TypeTagU8 extends TypeTag {
  * This class extends the base TypeTag class and provides methods for serialization and deserialization.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagU16 extends TypeTag {
   toString(): string {
@@ -278,6 +318,8 @@ export class TypeTagU16 extends TypeTag {
  * and deserialization specific to the u32 type.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagU32 extends TypeTag {
   toString(): string {
@@ -298,6 +340,8 @@ export class TypeTagU32 extends TypeTag {
  * This class extends the base TypeTag class and provides methods for serialization and deserialization.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagU64 extends TypeTag {
   toString(): string {
@@ -318,6 +362,8 @@ export class TypeTagU64 extends TypeTag {
  * This class extends the base TypeTag class and provides methods for serialization and deserialization.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagU128 extends TypeTag {
   toString(): string {
@@ -338,6 +384,8 @@ export class TypeTagU128 extends TypeTag {
  * This class extends the base TypeTag class and provides methods for serialization and deserialization.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagU256 extends TypeTag {
   toString(): string {
@@ -359,6 +407,8 @@ export class TypeTagU256 extends TypeTag {
  * to serialize the address type and load it from a deserializer.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagAddress extends TypeTag {
   toString(): string {
@@ -380,6 +430,8 @@ export class TypeTagAddress extends TypeTag {
  * related to the signer type.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagSigner extends TypeTag {
   toString(): string {
@@ -401,6 +453,8 @@ export class TypeTagSigner extends TypeTag {
  * to serialize and deserialize type tag references.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagReference extends TypeTag {
   toString(): `&${string}` {
@@ -411,6 +465,8 @@ export class TypeTagReference extends TypeTag {
    * Initializes a new instance of the class with the specified parameters.
    *
    * @param value - The TypeTag to reference.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(public readonly value: TypeTag) {
     super();
@@ -431,6 +487,8 @@ export class TypeTagReference extends TypeTag {
  * Generics are not serialized into a real type, so they cannot be used as a type directly.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagGeneric extends TypeTag {
   toString(): `T${number}` {
@@ -459,6 +517,8 @@ export class TypeTagGeneric extends TypeTag {
  * deserialization, and string representation of the vector type tag.
  *
  * @extends TypeTag
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagVector extends TypeTag {
   toString(): `vector<${string}>` {
@@ -473,6 +533,8 @@ export class TypeTagVector extends TypeTag {
    * Creates a new TypeTagVector instance with a TypeTagU8 type.
    *
    * @returns {TypeTagVector} A new TypeTagVector initialized with TypeTagU8.
+   * @group Implementation
+   * @category Transactions
    */
   static u8(): TypeTagVector {
     return new TypeTagVector(new TypeTagU8());
@@ -495,6 +557,8 @@ export class TypeTagVector extends TypeTag {
  * module name, and type arguments, and provides methods for serialization and type checking.
  *
  * @param value - The StructTag instance containing the details of the structured type.
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagStruct extends TypeTag {
   toString(): `0x${string}::${string}::${string}` {
@@ -530,6 +594,8 @@ export class TypeTagStruct extends TypeTag {
    * @param moduleName - The name of the module to compare against the type tag.
    * @param structName - The name of the struct to compare against the type tag.
    * @returns True if the address, module name, and struct name match the type tag; otherwise, false.
+   * @group Implementation
+   * @category Transactions
    */
   isTypeTag(address: AccountAddress, moduleName: string, structName: string): boolean {
     return (
@@ -544,6 +610,8 @@ export class TypeTagStruct extends TypeTag {
    * This function can help ensure that the data being processed is in the correct format before further operations.
    *
    * @returns {boolean} Returns true if the value is a string, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isString(): boolean {
     return this.isTypeTag(AccountAddress.ONE, "string", "String");
@@ -553,6 +621,8 @@ export class TypeTagStruct extends TypeTag {
    * Checks if the specified account address is of type "option".
    *
    * @returns {boolean} Returns true if the account address is an option type, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isOption(): boolean {
     return this.isTypeTag(AccountAddress.ONE, "option", "Option");
@@ -563,6 +633,8 @@ export class TypeTagStruct extends TypeTag {
    * This function helps determine if a value can be treated as an object type in the context of the SDK.
    *
    * @returns {boolean} Returns true if the value is an object, otherwise false.
+   * @group Implementation
+   * @category Transactions
    */
   isObject(): boolean {
     return this.isTypeTag(AccountAddress.ONE, "object", "Object");
@@ -578,6 +650,8 @@ export class TypeTagStruct extends TypeTag {
  * @property {Identifier} moduleName - The name of the module that contains the struct.
  * @property {Identifier} name - The name of the struct.
  * @property {Array<TypeTag>} typeArgs - An array of type arguments associated with the struct.
+ * @group Implementation
+ * @category Transactions
  */
 export class StructTag extends Serializable {
   public readonly address: AccountAddress;
@@ -616,6 +690,8 @@ export class StructTag extends Serializable {
  * Retrieves the StructTag for the AptosCoin, which represents the Aptos Coin in the Aptos blockchain.
  *
  * @returns {StructTag} The StructTag for the AptosCoin.
+ * @group Implementation
+ * @category Transactions
  */
 export function aptosCoinStructTag(): StructTag {
   return new StructTag(AccountAddress.ONE, new Identifier("aptos_coin"), new Identifier("AptosCoin"), []);
@@ -625,6 +701,8 @@ export function aptosCoinStructTag(): StructTag {
  * Returns a new StructTag representing a string type.
  *
  * @returns {StructTag} A StructTag for the string type.
+ * @group Implementation
+ * @category Transactions
  */
 export function stringStructTag(): StructTag {
   return new StructTag(AccountAddress.ONE, new Identifier("string"), new Identifier("String"), []);
@@ -635,6 +713,8 @@ export function stringStructTag(): StructTag {
  * This can help in defining a specific instance of an Option type in your application.
  *
  * @param typeArg - The type tag that specifies the type of the value contained in the Option.
+ * @group Implementation
+ * @category Transactions
  */
 export function optionStructTag(typeArg: TypeTag): StructTag {
   return new StructTag(AccountAddress.ONE, new Identifier("option"), new Identifier("Option"), [typeArg]);
@@ -645,6 +725,8 @@ export function optionStructTag(typeArg: TypeTag): StructTag {
  * This function helps in defining a structured representation of an Object with a specific type.
  *
  * @param typeArg - The type tag that specifies the type of the Object.
+ * @group Implementation
+ * @category Transactions
  */
 export function objectStructTag(typeArg: TypeTag): StructTag {
   return new StructTag(AccountAddress.ONE, new Identifier("object"), new Identifier("Object"), [typeArg]);

package/src/transactions/typeTag/parser.ts

@@ -24,6 +24,8 @@ import { Identifier } from "../instances/identifier";
 /**
  * Determines if the provided string is a valid Move identifier, which can only contain alphanumeric characters and underscores.
  * @param str - The string to validate as a Move identifier.
+ * @group Implementation
+ * @category Transactions
  */
 function isValidIdentifier(str: string) {
   return !!str.match(/^[_a-zA-Z0-9]+$/);
@@ -32,6 +34,8 @@ function isValidIdentifier(str: string) {
 /**
  * Determines if the provided character is a whitespace character. This function only works for single characters.
  * @param char - The character to check for whitespace.
+ * @group Implementation
+ * @category Transactions
  */
 function isValidWhitespaceCharacter(char: string) {
   return !!char.match(/\s/);
@@ -40,6 +44,8 @@ function isValidWhitespaceCharacter(char: string) {
 /**
  * Determines if a given string represents a generic type from the ABI, specifically in the format T0, T1, etc.
  * @param str - The string to evaluate for generic type format.
+ * @group Implementation
+ * @category Transactions
  */
 function isGeneric(str: string) {
   return !!str.match(/^T[0-9]+$/);
@@ -48,6 +54,8 @@ function isGeneric(str: string) {
 /**
  * Determines if the provided string is a reference type, which is indicated by starting with an ampersand (&).
  * @param str - The string to evaluate for reference type.
+ * @group Implementation
+ * @category Transactions
  */
 function isRef(str: string) {
   return !!str.match(/^&.+$/);
@@ -57,6 +65,8 @@ function isRef(str: string) {
  * Determines if the provided string represents a primitive type.
  * @param str - The string to evaluate as a potential primitive type.
  * @returns A boolean indicating whether the string is a primitive type.
+ * @group Implementation
+ * @category Transactions
  */
 function isPrimitive(str: string) {
   switch (str) {
@@ -81,6 +91,8 @@ function isPrimitive(str: string) {
  * @param tagStr - The string from which to consume whitespace.
  * @param pos - The position in the string to start consuming whitespace from.
  * @returns The new position in the string after consuming whitespace.
+ * @group Implementation
+ * @category Transactions
  */
 function consumeWhitespace(tagStr: string, pos: number) {
   let i = pos;
@@ -97,6 +109,8 @@ function consumeWhitespace(tagStr: string, pos: number) {
 
 /**
  * State for TypeTag parsing, maintained on a stack to track the current parsing state.
+ * @group Implementation
+ * @category Transactions
  */
 type TypeTagState = {
   savedExpectedTypes: number;
@@ -106,6 +120,8 @@ type TypeTagState = {
 
 /**
  * Error types related to parsing type tags, indicating various issues encountered during the parsing process.
+ * @group Implementation
+ * @category Transactions
  */
 export enum TypeTagParserErrorType {
   InvalidTypeTag = "unknown type",
@@ -131,6 +147,8 @@ export enum TypeTagParserErrorType {
  *
  * @param typeTagStr - The type tag string that failed to be parsed.
  * @param invalidReason - The reason why the type tag string is considered invalid.
+ * @group Implementation
+ * @category Transactions
  */
 export class TypeTagParserError extends Error {
   /**
@@ -139,6 +157,8 @@ export class TypeTagParserError extends Error {
    *
    * @param typeTagStr - The string representation of the type tag that failed to parse.
    * @param invalidReason - The reason why the type tag is considered invalid.
+   * @group Implementation
+   * @category Transactions
    */
   constructor(typeTagStr: string, invalidReason: TypeTagParserErrorType) {
     super(`Failed to parse typeTag '${typeTagStr}', ${invalidReason}`);
@@ -167,6 +187,8 @@ export class TypeTagParserError extends Error {
  * @param options.allowGenerics - A flag indicating whether to allow generics in the parsing process.
  * @returns The parsed type tag representation.
  * @throws TypeTagParserError if the type string is malformed or does not conform to expected formats.
+ * @group Implementation
+ * @category Transactions
  */
 export function parseTypeTag(typeStr: string, options?: { allowGenerics?: boolean }) {
   const allowGenerics = options?.allowGenerics ?? false;
@@ -301,6 +323,8 @@ export function parseTypeTag(typeStr: string, options?: { allowGenerics?: boolea
  * @param str - The string representation of the type tag to parse.
  * @param types - An array of TypeTag instances that represent internal types associated with the type tag.
  * @param allowGenerics - A boolean indicating whether generics are allowed in the parsing of the type tag.
+ * @group Implementation
+ * @category Transactions
  */
 function parseTypeTagInner(str: string, types: Array<TypeTag>, allowGenerics: boolean): TypeTag {
   const trimmedStr = str.trim();