Class ContractDefinition

Hierarchy (view full)

ASTNodeWithChildren<ASTNode>
- ContractDefinition

Implements

Index

Constructors

Properties

abstract context? danglingDocString? docString? fullyImplemented id kind linearizedBaseContracts name nameLocation? parent? raw? scope src usedErrors usedEvents

Constructors

constructor

new ContractDefinition(id, src, name, scope, kind, abstract, fullyImplemented, linearizedBaseContracts, usedErrors, usedEvents, documentation?, children?, nameLocation?, raw?): ContractDefinition
Parameters
- id: number
- src: string
- name: string
- scope: number
- kind: ContractKind
- abstract: boolean
- fullyImplemented: boolean
- linearizedBaseContracts: number[]
- usedErrors: number[]
- usedEvents: number[]
- Optional documentation: string | StructuredDocumentation
- Optional children: Iterable<ASTNode>
- Optional nameLocation: string
- Optional raw: any
Returns ContractDefinition
Overrides ASTNodeWithChildren.constructor
- Defined in src/ast/implementation/declaration/contract_definition.ts:81

Properties

abstract

abstract: boolean

Is true if contract is declared as an abstract (using abstract keyword since Solidity 0.6).

Is false otherwise.

`Optional` context

context?: ASTContext

Current tree context of the node

`Optional` danglingDocString

danglingDocString?: string

This field is used as a storage field for string, if string is set as value for danglingDocumentation.

`Optional` docString

docString?: string

This field is used as a storage field for string, if string is set as value for documentation.

fullyImplemented

fullyImplemented: boolean

Is false if one of the functions is not implemented.

Is true otherwise.

id

id: number

Unique identifier number for the node in the tree context

kind

kind: ContractKind

Type of contract declaration, e.g. contract, library or interface.

linearizedBaseContracts

linearizedBaseContracts: number[]

C3-linearized base contract ids including the current contract's id

name

name: string

The contract name

`Optional` nameLocation

nameLocation?: string

The source range for name string

`Optional` parent

parent?: ASTNode

The AST node that is containing current node

`Optional` raw

raw?: any

Raw original Solc AST node that was used to create current node.

scope

scope: number

Id of its scoped source unit

src

src: string

Source mapping data corresponting to the AST node.

The value has format start:length:sourceIndex:

start is the starting index of the corresponding code fragment substring in the source string;
length is the length of corresponding code fragment substring;
sourceIndex is the index number of the source unit (file), that contains the AST node.

To get parsed values, use sourceInfo accessor.

usedErrors

usedErrors: number[]

Used error definition ids (including external definition ids)

usedEvents

usedEvents: number[]

Used events definition ids (including external definition ids)

Accessors

children

get children(): readonly T[]
Returns children nodes of the current node

Returns readonly T[]
Inherited from ASTNodeWithChildren.children
- Defined in src/ast/ast_node.ts:353

danglingDocumentation

get danglingDocumentation(): undefined | string | StructuredDocumentation
Optional documentation that is dangling in the source fragment, that is after end of last child and before the end of the current node.

It is:
- Is undefined when not detected.
- Is type of string for compatibility reasons.
Returns undefined | string | StructuredDocumentation
Implementation of WithDanglingDocs.danglingDocumentation
- Defined in src/ast/implementation/declaration/contract_definition.ts:140
set danglingDocumentation(value): void
Parameters
- value: undefined | string | StructuredDocumentation
Returns void
Implementation of WithDanglingDocs.danglingDocumentation
- Defined in src/ast/implementation/declaration/contract_definition.ts:144

documentation

get documentation(): undefined | string | StructuredDocumentation
Optional documentation appearing above the contract definition:
- Is undefined when not specified.
- Is type of string when specified and compiler version is older than 0.6.3.
- Is instance of StructuredDocumentation when specified and compiler version is 0.6.3 or newer.
Returns undefined | string | StructuredDocumentation
Implementation of WithPrecedingDocs.documentation
- Defined in src/ast/implementation/declaration/contract_definition.ts:124
set documentation(value): void
Parameters
- value: undefined | string | StructuredDocumentation
Returns void
Implementation of WithPrecedingDocs.documentation
- Defined in src/ast/implementation/declaration/contract_definition.ts:128

firstChild

get firstChild(): undefined | ASTNode
Returns the first immediate child of the node, or undefined if the node has no children.

Returns undefined | ASTNode
Inherited from ASTNodeWithChildren.firstChild
- Defined in src/ast/ast_node.ts:105

lastChild

get lastChild(): undefined | ASTNode
Returns the last immediate child of the node, or undefined if the node has no children.

Returns undefined | ASTNode
Inherited from ASTNodeWithChildren.lastChild
- Defined in src/ast/ast_node.ts:113

nextSibling

get nextSibling(): undefined | ASTNode
Returns the node immediately following the current one in its parent's children.

Returns undefined if the current node is the last child in its parent's children.

Returns undefined | ASTNode
Inherited from ASTNodeWithChildren.nextSibling
- Defined in src/ast/ast_node.ts:142

previousSibling

get previousSibling(): undefined | ASTNode
Returns the node immediately preceding the current one in its parent's children.

Returns undefined if the current node is the first child in its parent's children.

Returns undefined | ASTNode
Inherited from ASTNodeWithChildren.previousSibling
- Defined in src/ast/ast_node.ts:124

requiredContext

get requiredContext(): ASTContext
Returns current node AST context. Throws an error if no context is set.

Returns ASTContext
Inherited from ASTNodeWithChildren.requiredContext
- Defined in src/ast/ast_node.ts:86

root

get root(): ASTNode
Returns most parent node in tree hierarchy

Returns ASTNode
Inherited from ASTNodeWithChildren.root
- Defined in src/ast/ast_node.ts:156

sourceInfo

get sourceInfo(): SourceLocation
Returns parsed parts of the src property value

Returns SourceLocation
Inherited from ASTNodeWithChildren.sourceInfo
- Defined in src/ast/ast_node.ts:169

type

get type(): string
Type of the AST node

Returns string
Inherited from ASTNodeWithChildren.type
- Defined in src/ast/ast_node.ts:79

vConstructor

get vConstructor(): undefined | FunctionDefinition
Constructor reference (if definition is present for this contract)

Returns undefined | FunctionDefinition
- Defined in src/ast/implementation/declaration/contract_definition.ts:285

vLinearizedBaseContracts

get vLinearizedBaseContracts(): readonly ContractDefinition[]
C3-linearized base contract references including the current contract

Returns readonly ContractDefinition[]
- Defined in src/ast/implementation/declaration/contract_definition.ts:166

vModifiers

get vModifiers(): readonly ModifierDefinition[]
Modifiers of the contract

Returns readonly ModifierDefinition[]
- Defined in src/ast/implementation/declaration/contract_definition.ts:213

vScope

get vScope(): SourceUnit
Reference to its scoped source unit

Returns SourceUnit
- Defined in src/ast/implementation/declaration/contract_definition.ts:151
set vScope(value): void
Parameters
- value: SourceUnit
Returns void
- Defined in src/ast/implementation/declaration/contract_definition.ts:155

vStateVariables

get vStateVariables(): readonly VariableDeclaration[]
State variables are VariableDeclarations that have the attribute stateVariable set to true and that are direct children of a contract

Returns readonly VariableDeclaration[]
- Defined in src/ast/implementation/declaration/contract_definition.ts:204

vStructs

get vStructs(): readonly StructDefinition[]
Structs of the contract

Returns readonly StructDefinition[]
- Defined in src/ast/implementation/declaration/contract_definition.ts:258

vUsedErrors

get vUsedErrors(): readonly ErrorDefinition[]
Used error definitions (including external definitions)

Returns readonly ErrorDefinition[]
- Defined in src/ast/implementation/declaration/contract_definition.ts:175

vUsedEvents

get vUsedEvents(): readonly EventDefinition[]
Used event definitions (including external definitions)

Returns readonly EventDefinition[]
- Defined in src/ast/implementation/declaration/contract_definition.ts:184

vUserDefinedValueTypes

get vUserDefinedValueTypes(): readonly UserDefinedValueTypeDefinition[]
User-defined value type definitions of contract

Returns readonly UserDefinedValueTypeDefinition[]
- Defined in src/ast/implementation/declaration/contract_definition.ts:276

vUsingForDirectives

get vUsingForDirectives(): readonly UsingForDirective[]
Type-bound libraries directives of the contract

Returns readonly UsingForDirective[]
- Defined in src/ast/implementation/declaration/contract_definition.ts:249

Methods

acceptChildren

acceptChildren(): void
Sets parent to the current node for each of the accessible children node.

Returns void
Inherited from ASTNodeWithChildren.acceptChildren
- Defined in src/ast/ast_node.ts:70

appendChild

appendChild(node): ASTNode
Parameters
- node: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.appendChild
- Defined in src/ast/ast_node.ts:371

extractSourceFragment

extractSourceFragment(source): Uint8Array
Extracts and returns substring from source, that corresponds to src property value of the current node.

In other words, returns corresponding code fragment substring.
Parameters
- source: Uint8Array
Returns Uint8Array
Inherited from ASTNodeWithChildren.extractSourceFragment
- Defined in src/ast/ast_node.ts:331

getChildren

getChildren(inclusive?): ASTNode[]
Parameters
- inclusive: boolean = false
Returns ASTNode[]
Inherited from ASTNodeWithChildren.getChildren
- Defined in src/ast/ast_node.ts:197

getChildrenBySelector

getChildrenBySelector<T>(selector, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
- inclusive: boolean = true
Returns T[]
Inherited from ASTNodeWithChildren.getChildrenBySelector
- Defined in src/ast/ast_node.ts:212

getChildrenByType

getChildrenByType<T>(type, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- type: ASTNodeConstructor<T>
- inclusive: boolean = false
Returns T[]
Inherited from ASTNodeWithChildren.getChildrenByType
- Defined in src/ast/ast_node.ts:229

getChildrenByTypeString

getChildrenByTypeString<T>(typeString, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- typeString: string
- inclusive: boolean = false
Returns T[]
Inherited from ASTNodeWithChildren.getChildrenByTypeString
- Defined in src/ast/ast_node.ts:233

getClosestParentBySelector

getClosestParentBySelector<T>(selector): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
Returns undefined | T
Inherited from ASTNodeWithChildren.getClosestParentBySelector
- Defined in src/ast/ast_node.ts:247

getClosestParentByType

getClosestParentByType<T>(type): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- type: ASTNodeConstructor<T>
Returns undefined | T
Inherited from ASTNodeWithChildren.getClosestParentByType
- Defined in src/ast/ast_node.ts:261

getClosestParentByTypeString

getClosestParentByTypeString<T>(typeString): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- typeString: string
Returns undefined | T
Inherited from ASTNodeWithChildren.getClosestParentByTypeString
- Defined in src/ast/ast_node.ts:265

getFieldValues

getFieldValues(): Map<string, any>
Returns Map<string, any>
Inherited from ASTNodeWithChildren.getFieldValues
- Defined in src/ast/ast_node.ts:291

getGettersValues

getGettersValues(): Map<string, any>
Returns Map<string, any>
Inherited from ASTNodeWithChildren.getGettersValues
- Defined in src/ast/ast_node.ts:295

getParents

getParents(): ASTNode[]
Returns ASTNode[]
Inherited from ASTNodeWithChildren.getParents
- Defined in src/ast/ast_node.ts:237

getParentsBySelector

getParentsBySelector<T>(selector): T[]
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
Returns T[]
Inherited from ASTNodeWithChildren.getParentsBySelector
- Defined in src/ast/ast_node.ts:269

insertAfter

insertAfter(node, referenceNode): ASTNode
Parameters
- node: ASTNode
- referenceNode: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.insertAfter
- Defined in src/ast/ast_node.ts:393

insertAtBeginning

insertAtBeginning(node): ASTNode
Parameters
- node: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.insertAtBeginning
- Defined in src/ast/ast_node.ts:403

insertBefore

insertBefore(node, referenceNode): ASTNode
Parameters
- node: ASTNode
- referenceNode: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.insertBefore
- Defined in src/ast/ast_node.ts:379

isSubclassOf

isSubclassOf(other): boolean
Returns true if other contract is present in the inheritance chain of the current contract. Returns false otherwise.
Parameters
- other: ContractDefinition
Returns boolean
- Defined in src/ast/implementation/declaration/contract_definition.ts:293

print

print(depth?): string
Returns string representation of the node properties.
Parameters
- depth: number = 0
  The number of children node levels to output
Returns string
Inherited from ASTNodeWithChildren.print
- Defined in src/ast/ast_node.ts:287

removeChild

removeChild(node): ASTNode
Parameters
- node: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.removeChild
- Defined in src/ast/ast_node.ts:357

replaceChild

replaceChild(newNode, oldNode): ASTNode
Parameters
- newNode: ASTNode
- oldNode: ASTNode
Returns ASTNode
Inherited from ASTNodeWithChildren.replaceChild
- Defined in src/ast/ast_node.ts:409

walk

walk(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
Inherited from ASTNodeWithChildren.walk
- Defined in src/ast/ast_node.ts:173

walkChildren

walkChildren(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
Inherited from ASTNodeWithChildren.walkChildren
- Defined in src/ast/ast_node.ts:179

walkParents

walkParents(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
Inherited from ASTNodeWithChildren.walkParents
- Defined in src/ast/ast_node.ts:187

Class ContractDefinition

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ContractDefinition

Properties

abstract

Optional context

Optional danglingDocString

Optional docString

fullyImplemented

id

kind

linearizedBaseContracts

name

Optional nameLocation

Optional parent

Optional raw

scope

src

usedErrors

usedEvents

Accessors

children

Returns readonly T[]

danglingDocumentation

Returns undefined | string | StructuredDocumentation

Parameters

Returns void

documentation

Returns undefined | string | StructuredDocumentation

Parameters

Returns void

firstChild

Returns undefined | ASTNode

lastChild

Returns undefined | ASTNode

nextSibling

Returns undefined | ASTNode

previousSibling

Returns undefined | ASTNode

requiredContext

Returns ASTContext

root

Returns ASTNode

sourceInfo

Returns SourceLocation

type

Returns string

vConstructor

Returns undefined | FunctionDefinition

vEnums

Returns readonly EnumDefinition[]

vErrors

Returns readonly ErrorDefinition[]

vEvents

Returns readonly EventDefinition[]

vFunctions

Returns readonly FunctionDefinition[]

vInheritanceSpecifiers

Returns readonly InheritanceSpecifier[]

vLinearizedBaseContracts

Returns readonly ContractDefinition[]

vModifiers

Returns readonly ModifierDefinition[]

vScope

Returns SourceUnit

Parameters

Returns void

vStateVariables

Returns readonly VariableDeclaration[]

vStructs

Returns readonly StructDefinition[]

`Optional` context

`Optional` danglingDocString

`Optional` docString

`Optional` nameLocation

`Optional` parent

`Optional` raw