Class TactASTStore

Provides access to AST elements defined within a single Tact project.

The generated AST entries includes all the dependent elements, including imported code which is included in the project AST in C/C++ style.

Constructors

constructor

new TactASTStore(stdlibIds?, contractConstants?, programEntries, functions, constants, contracts, nativeFunctions, asmFunctions, primitives, structs, messages, traits, statements): TactASTStore
Constructs a TactASTStore with mappings to all major AST components accessible by their unique AST identifiers.
Parameters
- stdlibIds: Set<number> = ...
  Identifiers of AST elements defined in stdlib.
- contractConstants: Set<number> = ...
  Identifiers of constants defined within contracts.
- programEntries: Set<number>
  Identifiers of AST elements defined on the top-level.
- functions: Map<number, AstFunctionDef | AstContractInit | AstReceiver>
  Functions and methods including user-defined and special methods.
- constants: Map<number, AstConstantDef>
  Constants defined across the compilation unit.
- contracts: Map<number, AstContract>
  Contracts defined within the project.
- nativeFunctions: Map<number, AstNativeFunctionDecl>
  Functions defined natively (not in user's source code).
- asmFunctions: Map<number, AstAsmFunctionDef>
  Tact asm functions.
- primitives: Map<number, AstPrimitiveTypeDecl>
  Primitive types defined in the project.
- structs: Map<number, AstStructDecl>
  Structs defined in the project.
- messages: Map<number, AstMessageDecl>
  Messages defined in the project.
- traits: Map<number, AstTrait>
  Traits defined in the project.
- statements: Map<number, AstStatement>
  All executable statements within all functions of the project.
Returns TactASTStore
- Defined in internals/ir/astStore.ts:44

Methods

findTrait

findTrait(name): undefined | AstTrait
Parameters
- name: string
Returns undefined | AstTrait
- Defined in internals/ir/astStore.ts:307

getAsmFunction

getAsmFunction(id): undefined | AstAsmFunctionDef
Retrieves an asm function by its ID.
Parameters
- id: number
  The unique identifier of the asm function.
Returns undefined | AstAsmFunctionDef
The asm function if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:247

getAsmFunctions

getAsmFunctions(): IterableIterator<AstAsmFunctionDef>
Returns IterableIterator<AstAsmFunctionDef>
- Defined in internals/ir/astStore.ts:161

getConstant

getConstant(id): undefined | AstConstantDef
Retrieves a constant by its ID.
Parameters
- id: number
  The unique identifier of the constant.
Returns undefined | AstConstantDef
The constant if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:208

getConstants

getConstants(params?): IterableIterator<AstConstantDef>
Returns all the constants defined within the program, including top-level constants and contract constants.
Parameters
- params: Partial<{
  includeContract: boolean;
  includeStdlib: boolean;
  }> = {}
  Additional parameters:
  - includeStdlib: If true, includes constants defined in stdlib.
  - includeContract: If true, includes constants defined within a contract.
Returns IterableIterator<AstConstantDef>
- Defined in internals/ir/astStore.ts:133

getContract

getContract(id): undefined | AstContract
Retrieves a contract by its ID.
Parameters
- id: number
  The unique identifier of the contract.
Returns undefined | AstContract
The contract if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:221

getContractConstants

getContractConstants(contractId): undefined | number[]
Retrieves the IDs of constants associated with a specified contract.
Parameters
- contractId: number
  The ID of the contract.
Returns undefined | number[]
An array of constant IDs or undefined if no contract is found.
- Defined in internals/ir/astStore.ts:367

getContractFields

getContractFields(contractId): undefined | AstFieldDecl[]
Retrieves the fields defined within a specified contract.
Parameters
- contractId: number
  The ID of the contract.
Returns undefined | AstFieldDecl[]
An array of AstFieldDecl or undefined if no contract is found.
- Defined in internals/ir/astStore.ts:385

getContracts

getContracts(): IterableIterator<AstContract>
Returns IterableIterator<AstContract>
- Defined in internals/ir/astStore.ts:153

getFunction

getFunction(id):
    | undefined
    | AstFunctionDef
    | AstContractInit
    | AstReceiver
Retrieves a function or method by its ID.
Parameters
- id: number
  The unique identifier of the function or method.
Returns
    | undefined
    | AstFunctionDef
    | AstContractInit
    | AstReceiver
The function or method if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:193

getFunctions

getFunctions(params?): IterableIterator<AstFunctionDef | AstContractInit | AstReceiver>
Returns all the functions and methods defined within the program.
Parameters
- params: Partial<{
  includeStdlib: boolean;
  }> = {}
  Additional parameters:
  - includeStdlib: If true, includes functions defined in stdlib.
Returns IterableIterator<AstFunctionDef | AstContractInit | AstReceiver>
- Defined in internals/ir/astStore.ts:120

getInitId

getInitId(contractId): undefined | number
Retrieves the ID of the initialization function for a specified contract.
Parameters
- contractId: number
  The ID of the contract.
Returns undefined | number
The ID of the init function or undefined if the contract does not exist.
- Defined in internals/ir/astStore.ts:351

getMessage

getMessage(id): undefined | AstMessageDecl
Retrieves a message by its ID.
Parameters
- id: number
  The unique identifier of the message.
Returns undefined | AstMessageDecl
The message if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:286

getMessages

getMessages(): IterableIterator<AstMessageDecl>
Returns IterableIterator<AstMessageDecl>
- Defined in internals/ir/astStore.ts:173

getMethods

getMethods(contractId): undefined | number[]
Retrieves the IDs of methods for a specified contract which have one of the following types: AstFunctionDef, AstReceiver, AstContractInit.
Parameters
- contractId: number
  The ID of the contract.
Returns undefined | number[]
An array of method IDs or undefined if no contract is found.
- Defined in internals/ir/astStore.ts:329

getNativeFunction

getNativeFunction(id): undefined | AstNativeFunctionDecl
Retrieves a native function by its ID.
Parameters
- id: number
  The unique identifier of the native function.
Returns undefined | AstNativeFunctionDecl
The native function if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:234

getNativeFunctions

getNativeFunctions(): IterableIterator<AstNativeFunctionDecl>
Returns IterableIterator<AstNativeFunctionDecl>
- Defined in internals/ir/astStore.ts:157

getPrimitive

getPrimitive(id): undefined | AstPrimitiveTypeDecl
Retrieves a primitive type by its ID.
Parameters
- id: number
  The unique identifier of the primitive type.
Returns undefined | AstPrimitiveTypeDecl
The primitive type if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:260

getPrimitives

getPrimitives(): IterableIterator<AstPrimitiveTypeDecl>
Returns IterableIterator<AstPrimitiveTypeDecl>
- Defined in internals/ir/astStore.ts:165

getProgramEntries

getProgramEntries(includeStdlib?): AstNode[]
Returns top-level program entries in order as they defined.
Parameters
- includeStdlib: boolean = false
Returns AstNode[]
- Defined in internals/ir/astStore.ts:66

getStatement

getStatement(id): undefined | AstStatement
Retrieves a statement by its ID.
Parameters
- id: number
  The unique identifier of the statement.
Returns undefined | AstStatement
The statement if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:316

getStatements

getStatements(): IterableIterator<AstStatement>
Returns all the statements defined within the program.

Returns IterableIterator<AstStatement>
- Defined in internals/ir/astStore.ts:184

getStruct

getStruct(id): undefined | AstStructDecl
Retrieves a struct by its ID.
Parameters
- id: number
  The unique identifier of the struct.
Returns undefined | AstStructDecl
The struct if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:273

getStructs

getStructs(): IterableIterator<AstStructDecl>
Returns IterableIterator<AstStructDecl>
- Defined in internals/ir/astStore.ts:169

getTrait

getTrait(id): undefined | AstTrait
Retrieves a trait by its ID.
Parameters
- id: number
  The unique identifier of the trait.
Returns undefined | AstTrait
The trait if found, otherwise undefined.
- Defined in internals/ir/astStore.ts:299

getTraits

getTraits(): IterableIterator<AstTrait>
Returns IterableIterator<AstTrait>
- Defined in internals/ir/astStore.ts:177

hasAsmFunction

hasAsmFunction(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:251

hasConstant

hasConstant(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:212

hasContract

hasContract(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:225

hasFunction

hasFunction(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:199

hasMessage

hasMessage(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:290

hasNativeFunction

hasNativeFunction(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:238

hasPrimitive

hasPrimitive(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:264

hasStatement

hasStatement(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:320

hasStruct

hasStruct(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:277

hasTrait

hasTrait(id): boolean
Parameters
- id: number
Returns boolean
- Defined in internals/ir/astStore.ts:303

Class TactASTStore

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TactASTStore

Methods

findTrait

Parameters

Returns undefined | AstTrait

getAsmFunction

Parameters

Returns undefined | AstAsmFunctionDef

getAsmFunctions

Returns IterableIterator<AstAsmFunctionDef>

getConstant

Parameters

Returns undefined | AstConstantDef

getConstants

Parameters

Returns IterableIterator<AstConstantDef>

getContract

Parameters

Returns undefined | AstContract

getContractConstants

Parameters

Returns undefined | number[]

getContractFields

Parameters

Returns undefined | AstFieldDecl[]

getContracts

Returns IterableIterator<AstContract>

getFunction

Parameters

Returns | undefined | AstFunctionDef | AstContractInit | AstReceiver

getFunctions

Parameters

Returns IterableIterator<AstFunctionDef | AstContractInit | AstReceiver>

getInitId

Parameters

Returns undefined | number

getMessage

Parameters

Returns undefined | AstMessageDecl

getMessages

Returns IterableIterator<AstMessageDecl>

getMethods

Parameters

Returns undefined | number[]

getNativeFunction

Parameters

Returns undefined | AstNativeFunctionDecl

getNativeFunctions

Returns IterableIterator<AstNativeFunctionDecl>

getPrimitive

Parameters

Returns undefined | AstPrimitiveTypeDecl

getPrimitives

Returns IterableIterator<AstPrimitiveTypeDecl>

getProgramEntries

Parameters

Returns AstNode[]

getStatement

Parameters

Returns undefined | AstStatement

getStatements

Returns IterableIterator<AstStatement>

getStruct

Parameters

Returns undefined | AstStructDecl

getStructs

Returns IterableIterator<AstStructDecl>

getTrait

Parameters

Returns undefined | AstTrait

getTraits

Returns IterableIterator<AstTrait>

hasAsmFunction

Returns
| undefined
| AstFunctionDef
| AstContractInit
| AstReceiver