-
Notifications
You must be signed in to change notification settings - Fork 23
/
infer.ts
2408 lines (1947 loc) · 78 KB
/
infer.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { Decimal } from "decimal.js";
import { gte, lt } from "semver";
import {
AnyResolvable,
ArrayTypeName,
Assignment,
ASTNode,
BinaryOperation,
Conditional,
ContractDefinition,
ContractKind,
ElementaryTypeName,
ElementaryTypeNameExpression,
encodeEventSignature,
encodeFuncSignature,
EnumDefinition,
ErrorDefinition,
EventDefinition,
Expression,
ExpressionStatement,
ExternalReferenceType,
FunctionCall,
FunctionCallKind,
FunctionCallOptions,
FunctionDefinition,
FunctionStateMutability,
FunctionTypeName,
FunctionVisibility,
Identifier,
IdentifierPath,
ImportDirective,
IndexAccess,
IndexRangeAccess,
Literal,
LiteralKind,
Mapping,
MemberAccess,
ModifierDefinition,
NewExpression,
ParameterList,
resolveAny,
SourceUnit,
StateVariableVisibility,
StructDefinition,
TupleExpression,
TypeName,
UnaryOperation,
UserDefinedTypeName,
UserDefinedValueTypeDefinition,
VariableDeclaration,
VariableDeclarationStatement
} from "../ast";
import { DataLocation } from "../ast/constants";
import { assert, eq, forAny, pp } from "../misc";
import { ABIEncoderVersion, abiTypeToCanonicalName, abiTypeToLibraryCanonicalName } from "./abi";
import {
AddressType,
ArrayType,
BoolType,
BuiltinFunctionType,
BuiltinStructType,
BytesType,
ErrorType,
EventType,
FixedBytesType,
FunctionLikeSetType,
FunctionType,
ImportRefType,
IntLiteralType,
IntType,
MappingType,
ModifierType,
NumericLiteralType,
PackedArrayType,
PointerType,
RationalLiteralType,
StringLiteralType,
StringType,
SuperType,
TupleType,
TypeNameType,
TypeNode,
TypeNodeConstructor,
UserDefinedType
} from "./ast";
import {
address06Builtins,
address06PayableBuiltins,
addressBuiltins,
globalBuiltins,
typeContract,
typeInt,
typeInterface
} from "./builtins";
import { evalConstantExpr } from "./eval_const";
import { SolTypeError } from "./misc";
import {
applySubstitution,
applySubstitutions,
buildSubstitutions,
TypeSubstituion
} from "./polymorphic";
import { types } from "./reserved";
import {
BINARY_OPERATOR_GROUPS,
castable,
decimalToRational,
enumToIntType,
generalizeType,
getFallbackRecvFuns,
getFQDefName,
inferCommonVisiblity,
isReferenceType,
isVisiblityExternallyCallable,
mergeFunTypes,
smallestFittingType,
specializeType,
stripSingletonParens,
SUBDENOMINATION_MULTIPLIERS
} from "./utils";
const unaryImpureOperators = ["++", "--"];
const RX_ADDRESS = /^address *(payable)?$/;
const RX_INTEGER = /^(u?)int([0-9]*)$/;
const RX_FIXED_BYTES = /^bytes([0-9]+)$/;
/**
* Some builtins have types that are not easy to express with our current hacky polymorphic support.
* For those we have the custom type constructors before, that introspect the AST to determine the type.
*/
export const builtinTypes: { [key: string]: (arg: ASTNode) => TypeNode } = {
revert: (arg: ASTNode) => {
const hasMsg = arg.parent instanceof FunctionCall && arg.parent.vArguments.length === 1;
const argTs = hasMsg ? [types.stringMemory] : [];
return new BuiltinFunctionType("revert", argTs, []);
},
require: (arg: ASTNode) => {
const hasMsg = arg.parent instanceof FunctionCall && arg.parent.vArguments.length === 2;
const argTs = hasMsg ? [types.bool, types.stringMemory] : [types.bool];
return new BuiltinFunctionType("require", argTs, []);
},
this: (node) => {
const contract = node.getClosestParentByType(ContractDefinition);
assert(contract !== undefined, "this ({0}) used outside of a contract", node);
return new UserDefinedType(contract.name, contract);
}
};
function typesAreUnordered<T1 extends TypeNode, T2 extends TypeNode>(
a: TypeNode,
b: TypeNode,
T1Const: TypeNodeConstructor<T1>,
T2Const: TypeNodeConstructor<T2>
): [T1, T2] | [undefined, undefined] {
if (a instanceof T1Const && b instanceof T2Const) {
return [a, b];
}
if (b instanceof T1Const && a instanceof T2Const) {
return [b, a];
}
return [undefined, undefined];
}
/**
* Given a `FunctionType` or `FunctionSetType` `arg` return a new `FunctionType`/`FunctionSetType` with
* all first arguments marked as implicit.
*/
function markFirstArgImplicit<T extends FunctionType | FunctionLikeSetType<FunctionType>>(
arg: T
): T {
if (arg instanceof FunctionType) {
return new FunctionType(
arg.name,
arg.parameters,
arg.returns,
arg.visibility,
arg.mutability,
true,
arg.src
) as T;
}
return new FunctionLikeSetType(arg.defs.map(markFirstArgImplicit)) as T;
}
export class InferType {
constructor(
public readonly version: string,
public readonly encoderVersion: ABIEncoderVersion
) {}
/**
* Infer the type of the assignment `node`. (In solidity assignments are expressions)
*/
typeOfAssignment(node: Assignment): TypeNode {
const lhs = stripSingletonParens(node.vLeftHandSide);
if (lhs instanceof TupleExpression) {
// For tuple assignments some part of the LHS may be omitted. We still need to compute a type for them those
// due to nested assignments. E.g. in `(a, b) = (c, ) = ("foo", true))` we still need to compute a type for the
// second field in the inner tuple assignment, even though there is LHS there.
const rhsT = this.typeOf(node.vRightHandSide);
assert(
rhsT instanceof TupleType,
"Unexpected non-tuple in rhs of tuple assignment {0}",
node
);
const comps = lhs.vOriginalComponents;
// Its possible to do assignments (a, b,) = fun() where fun returns more than 3 elements.
assert(
rhsT.elements.length >= comps.length,
`Unexpected more lhs tuple elements (${comps.length}) than rhs tuple elements (${rhsT.elements.length}) in {0}`,
node
);
const resTs: TypeNode[] = [];
for (let i = 0; i < comps.length; i++) {
const lhsComp = comps[i];
resTs.push(lhsComp === null ? rhsT.elements[i] : this.typeOf(lhsComp));
}
return new TupleType(resTs);
}
return this.typeOf(lhs);
}
/**
* Given to numeric expressions infer a common type to which they can both be implicitly casted.
*/
inferCommonIntType(
a: IntType | IntLiteralType,
b: IntType | IntLiteralType
): IntType | IntLiteralType {
// If both are literals evaluate the expression
if (a instanceof IntLiteralType && b instanceof IntLiteralType) {
assert(
a.literal !== undefined && b.literal !== undefined,
"Unexpected missing literals"
);
const res = smallestFittingType(a.literal, b.literal);
assert(res !== undefined, "Couldn't find concrete types for {0} and {1}", a, b);
return res;
}
// If one of them is an int literal, and the other is not, we have 2 cases
// 1) The literal fits in the int type - take the int type
// 2) The literal doesn't fit in the int type - widen the int type.
if (a instanceof IntLiteralType || b instanceof IntLiteralType) {
const [literalT, concreteT] = typesAreUnordered(a, b, IntLiteralType, IntType) as [
IntLiteralType,
IntType
];
assert(literalT.literal !== undefined, "TODO: Remove when we remove typestring parser");
const decMin = concreteT.min();
const decMax = concreteT.max();
/// Literal less than the minimum for the concrete type
if (decMin > literalT.literal) {
return this.inferCommonIntType(
new IntLiteralType(literalT.literal),
new IntLiteralType(decMax)
);
}
if (decMax < literalT.literal) {
return this.inferCommonIntType(
new IntLiteralType(decMin),
new IntLiteralType(literalT.literal)
);
}
/// Literal fits
return concreteT;
}
// Otherwise find a common type to which they cast
if (a.signed === b.signed) {
return new IntType(Math.max(a.nBits, b.nBits), a.signed);
}
const unsigned = a.signed ? b : a;
const signed = a.signed ? a : b;
// Prior to 0.8.1 you could implicitly cast uintN to intM if M > N
if (lt(this.version, "0.8.1") && signed.nBits > unsigned.nBits) {
return new IntType(signed.nBits, true);
}
throw new SolTypeError(`Can't figure out a common type for ${pp(a)} and ${pp(b)}`);
}
/**
* Given two types `a` and `b` infer the common type that they are both
* implicitly casted to, when appearing in a binary op/conditional.
* Its currently usually `a` or `b`
*/
inferCommonType(a: TypeNode, b: TypeNode): TypeNode {
/**
* The common type for two string literals is string memory.
* For example the type of `flag ? "a" : "b"` is string memory,
* not string literal.
*
* @todo This edge case is ugly. It suggests that perhaps we should
* remove StringLiteralType from the type system.
*/
if (a instanceof StringLiteralType && b instanceof StringLiteralType) {
return types.stringMemory;
}
if (eq(a, b)) {
return a;
}
if (
(a instanceof IntType || a instanceof IntLiteralType) &&
(b instanceof IntType || b instanceof IntLiteralType)
) {
return this.inferCommonIntType(a, b);
}
if (
a instanceof PointerType &&
b instanceof PointerType &&
eq(a.to, b.to) &&
a.location !== b.location
) {
return new PointerType(a.to, DataLocation.Memory);
}
const [stringLitT, stringT] = typesAreUnordered(a, b, StringLiteralType, PointerType);
// Note: Can't rely on implicit casting here as the common type for "abcd" and string storage is string memory.
if (stringT !== undefined && stringLitT !== undefined && stringT.to instanceof StringType) {
return this.inferCommonType(stringT, types.stringMemory);
}
if (
a instanceof TupleType &&
b instanceof TupleType &&
a.elements.length === b.elements.length
) {
const commonElTs: TypeNode[] = [];
for (let i = 0; i < a.elements.length; i++) {
let commonElT = this.inferCommonType(a.elements[i], b.elements[i]);
if (commonElT instanceof IntLiteralType && commonElT.literal !== undefined) {
const fittingT = smallestFittingType(commonElT.literal);
assert(
fittingT !== undefined,
"Can't infer common type for tuple elements {0} between {1} and {2}",
i,
a,
b
);
commonElT = fittingT;
}
commonElTs.push(commonElT);
}
return new TupleType(commonElTs);
}
const [fun, funSet] = typesAreUnordered(a, b, FunctionType, FunctionLikeSetType);
if (fun && funSet) {
for (const funT of funSet.defs) {
if (
funT instanceof FunctionType &&
eq(new TupleType(fun.parameters), new TupleType(funT.parameters)) &&
eq(new TupleType(fun.returns), new TupleType(funT.returns)) &&
(fun.visibility === FunctionVisibility.External) ===
(funT.visibility === FunctionVisibility.External)
) {
return fun;
}
}
}
if (
a instanceof FunctionType &&
b instanceof FunctionType &&
eq(new TupleType(a.parameters), new TupleType(b.parameters)) &&
eq(new TupleType(a.returns), new TupleType(b.returns)) &&
a.mutability === b.mutability
) {
const commonVis = inferCommonVisiblity(a.visibility, b.visibility);
if (commonVis) {
return new FunctionType(
undefined,
a.parameters,
a.returns,
commonVis,
a.mutability
);
}
}
// a implicitly castable to b - return b
if (castable(a, b, this.version)) {
return b;
}
// b implicitly castable to a - return a
if (castable(b, a, this.version)) {
return a;
}
throw new SolTypeError(`Cannot infer commmon type for ${pp(a)} and ${pp(b)}`);
}
/**
* Infer the type of the binary op
*/
typeOfBinaryOperation(node: BinaryOperation): TypeNode {
if (
BINARY_OPERATOR_GROUPS.Comparison.includes(node.operator) ||
BINARY_OPERATOR_GROUPS.Equality.includes(node.operator) ||
BINARY_OPERATOR_GROUPS.Logical.includes(node.operator)
) {
return types.bool;
}
const a = this.typeOf(node.vLeftExpression);
const b = this.typeOf(node.vRightExpression);
if (a instanceof NumericLiteralType && b instanceof NumericLiteralType) {
const res = evalConstantExpr(node);
assert(
res instanceof Decimal || typeof res === "bigint",
"Unexpected result of const binary op"
);
return typeof res === "bigint"
? new IntLiteralType(res)
: new RationalLiteralType(decimalToRational(res));
}
// After 0.6.0 the type of ** is just the type of the lhs
// Between 0.6.0 and 0.7.0 if the lhs is an int literal type it
// took the type of the rhs if it wasn't a literal type. After 0.7.0 it
// just assumes uint256.
if (node.operator === "**") {
if (gte(this.version, "0.7.0")) {
return a instanceof IntLiteralType ? types.uint256 : a;
}
if (gte(this.version, "0.6.0")) {
if (a instanceof IntLiteralType) {
return b instanceof IntType ? b : types.uint256;
}
return a;
}
}
if (BINARY_OPERATOR_GROUPS.Arithmetic.includes(node.operator)) {
assert(
a instanceof IntType || a instanceof IntLiteralType,
"Unexpected type of {0}",
a
);
assert(
b instanceof IntType || b instanceof IntLiteralType,
"Unexpected type of {0}",
b
);
return this.inferCommonIntType(a, b);
}
if (BINARY_OPERATOR_GROUPS.Bitwise.includes(node.operator)) {
// For bitshifts just take the type of the lhs
if ([">>", "<<"].includes(node.operator)) {
if (a instanceof IntLiteralType) {
return gte(this.version, "0.7.0") ? types.uint256 : b;
}
return a;
}
// For all other bitwise operators infer a common type. In earlier versions it wa allowed
// to have bitwise ops between differing sizes
return this.inferCommonType(a, b);
}
throw new Error(`NYI Binary op ${node.operator}`);
}
/**
* Infer the type of the conditional expression
*/
typeOfConditional(node: Conditional): TypeNode {
const trueT = this.typeOf(node.vTrueExpression);
const falseT = this.typeOf(node.vFalseExpression);
return this.inferCommonType(trueT, falseT);
}
/**
* Infer the type of a struct constructor expression
*/
typeOfStructConstructorCall(node: FunctionCall): TypeNode {
const callee = node.vCallee;
assert(
callee instanceof Identifier ||
callee instanceof IdentifierPath ||
callee instanceof MemberAccess,
`Unexpected node in Struct construction call ${callee.constructor.name}`,
callee
);
const calleeT = this.typeOf(callee);
assert(
calleeT instanceof TypeNameType &&
calleeT.type instanceof UserDefinedType &&
calleeT.type.definition instanceof StructDefinition,
"Unexpected callee type {0}",
calleeT
);
return new PointerType(calleeT.type, DataLocation.Memory, "ref");
}
/**
* Casts to address (address(0x...) or address(<some contract>)) have some edge cases
* due to the introduction of 'payable' in 0.5.0.
* In solc >=0.5.0 an address cast returns payable if
* 1. The address is a constant
* 2. The cast is from a contract that has a payable fallback or receive function
* (see https://docs.soliditylang.org/en/latest/050-breaking-changes.html#explicitness-requirements)
* However sometimes in the AST the payability of the cast differs from the payability of the
* elementary typename itself. We fix up the payability of the fun call here.
*/
private typeOfAddressCast(node: FunctionCall, calleeT: AddressType): TypeNode {
// In solc <0.5.0 there is no address payable
if (lt(this.version, "0.5.0")) {
return calleeT;
}
if (calleeT.payable) {
return calleeT;
}
// After 0.8.0 all explicit casts to address are non-payable
if (gte(this.version, "0.8.0")) {
return calleeT;
}
assert(node.vArguments.length === 1, `Unexpected number of args to type cast {0}`, node);
const arg = node.vArguments[0];
if (arg instanceof Literal && arg.value.startsWith("0x") && arg.value.length === 42) {
return lt(this.version, "0.6.0") ? types.addressPayable : types.address;
}
const argT = this.typeOf(arg);
if (
argT instanceof IntType ||
argT instanceof IntLiteralType ||
argT instanceof FixedBytesType
) {
return types.addressPayable;
}
if (argT instanceof AddressType && lt(this.version, "0.6.0")) {
return argT;
}
if (argT instanceof UserDefinedType && argT.definition instanceof ContractDefinition) {
if (
forAny(
getFallbackRecvFuns(argT.definition),
(fn) => fn.stateMutability === FunctionStateMutability.Payable
)
) {
return types.addressPayable;
}
}
return calleeT;
}
/**
* Infer the type of a type cast
*/
typeOfTypeConversion(node: FunctionCall): TypeNode {
const callee = node.vCallee;
assert(
callee instanceof TupleExpression ||
callee instanceof ElementaryTypeNameExpression ||
callee instanceof Identifier ||
callee instanceof IdentifierPath ||
callee instanceof MemberAccess ||
callee instanceof IndexAccess,
`Unexpected node in type convertion call ${callee.constructor.name}`,
callee
);
const calleeT = this.typeOf(callee);
if (!(calleeT instanceof TypeNameType)) {
throw new SolTypeError(`Unexpected base type in type cast ${pp(calleeT)}`);
}
if (calleeT.type instanceof AddressType) {
return this.typeOfAddressCast(node, calleeT.type);
}
const innerT = this.typeOf(node.vArguments[0]);
const loc = innerT instanceof PointerType ? innerT.location : DataLocation.Memory;
return specializeType(calleeT.type, loc);
}
/**
* Infer the type of a call with a `new` expression as callee
*/
typeOfNewCall(node: FunctionCall): TypeNode {
const newExpr = node.vCallee;
assert(newExpr instanceof NewExpression, 'Unexpected "new" call {0}', newExpr);
const typ = this.typeNameToTypeNode(newExpr.vTypeName);
const loc =
typ instanceof UserDefinedType && typ.definition instanceof ContractDefinition
? DataLocation.Storage
: DataLocation.Memory;
return specializeType(typ, loc);
}
private matchArguments(
funs: Array<FunctionType | BuiltinFunctionType>,
args: Expression[],
callExp: Expression
): FunctionType | BuiltinFunctionType | undefined {
const argTs: TypeNode[] = args.map((arg) => this.typeOf(arg));
const argTsWithImplictArg =
callExp instanceof MemberAccess ? [this.typeOf(callExp.vExpression), ...argTs] : argTs;
for (const funT of funs) {
const actualTs =
funT instanceof FunctionType && funT.implicitFirstArg ? argTsWithImplictArg : argTs;
if (funT.parameters.length !== actualTs.length) {
continue;
}
let argsMatch = true;
for (let i = 0; i < funT.parameters.length; i++) {
argsMatch = castable(actualTs[i], funT.parameters[i], this.version);
if (!argsMatch) {
break;
}
}
if (argsMatch) {
return funT;
}
}
return undefined;
}
/**
* Infer the type of the function call
*/
typeOfFunctionCall(node: FunctionCall): TypeNode {
if (node.kind === FunctionCallKind.StructConstructorCall) {
return this.typeOfStructConstructorCall(node);
}
if (node.kind === FunctionCallKind.TypeConversion) {
return this.typeOfTypeConversion(node);
}
if (node.vCallee instanceof NewExpression) {
return this.typeOfNewCall(node);
}
let calleeT = this.typeOf(node.vCallee);
let rets: TypeNode[];
if (node.vFunctionCallType === ExternalReferenceType.Builtin) {
if (calleeT instanceof FunctionLikeSetType) {
calleeT = calleeT.defs.filter((d) => d instanceof BuiltinFunctionType)[0];
}
if (!(calleeT instanceof BuiltinFunctionType || calleeT instanceof FunctionType)) {
throw new SolTypeError(
`Unexpected builtin ${pp(node.vCallee)} in function call ${pp(node)}`
);
}
const argTs = node.vArguments.map((arg) => this.typeOf(arg));
const m: TypeSubstituion = new Map();
/**
* We can push fixed sized arrays (e.g. uint[1]) to storage arrays of arrays (uint[][]).
* Add this implicit cast here
*/
if (
calleeT instanceof BuiltinFunctionType &&
node.vFunctionName === "push" &&
!eq(calleeT.parameters[0], argTs[0]) &&
castable(argTs[0], calleeT.parameters[0], this.version)
) {
argTs[0] = calleeT.parameters[0];
}
buildSubstitutions(calleeT.parameters, argTs, m, this.version);
rets = applySubstitutions(calleeT.returns, m);
} else {
if (calleeT instanceof FunctionType || calleeT instanceof BuiltinFunctionType) {
rets = calleeT.returns;
} else if (calleeT instanceof EventType || calleeT instanceof ErrorType) {
rets = [];
} else if (calleeT instanceof FunctionLikeSetType) {
if (calleeT.defs[0] instanceof EventDefinition) {
rets = [];
} else {
// Match based on args. Needs castable.
const funT = this.matchArguments(
calleeT.defs,
node.vArguments,
node.vExpression
);
if (funT === undefined) {
throw new SolTypeError(
`Couldn't resolve function ${node.vFunctionName} in ${pp(node)}`
);
}
rets = funT.returns;
}
} else {
throw new SolTypeError(
`Unexpected type ${calleeT.pp()} in function call ${pp(node)}`
);
}
}
// No returns - return the empty type ()
if (rets.length === 0) {
return types.noType;
}
if (rets.length === 1) {
return rets[0];
}
return new TupleType(rets);
}
typeOfIndexAccess(node: IndexAccess): TypeNode {
const baseT = this.typeOf(node.vBaseExpression);
if (baseT instanceof FixedBytesType) {
return types.byte;
}
if (baseT instanceof PointerType) {
const toT = baseT.to;
if (toT instanceof ArrayType) {
return toT.elementT;
}
if (toT instanceof MappingType) {
return toT.valueType;
}
if (toT instanceof BytesType) {
return types.byte;
}
}
/// Array index in an elementary type-name expression (e.g. new Contract[](4))
if (baseT instanceof TypeNameType) {
const size =
node.vIndexExpression &&
node.vIndexExpression instanceof Literal &&
node.vIndexExpression.kind === LiteralKind.Number
? BigInt(node.vIndexExpression.value)
: undefined;
return new TypeNameType(new ArrayType(baseT.type, size));
}
throw new SolTypeError(`Cannot index into type ${pp(baseT)} in ${pp(node)}`);
}
typeOfIndexRangeAccess(node: IndexRangeAccess): TypeNode {
const baseT = this.typeOf(node.vBaseExpression);
if (
!(
baseT instanceof PointerType &&
baseT.to instanceof BytesType &&
baseT.location === DataLocation.CallData
)
) {
throw new SolTypeError(`Unexpected base type ${pp(baseT)} in slice ${pp(node)}`);
}
/**
* @todo (dimo): This typing is not precise. We should add a special slice type as described
* in the documentation here https://docs.soliditylang.org/en/latest/types.html#array-slices
*/
return baseT;
}
/**
* Infer the type of the builtin 'type' keyword. This is a function from a
* type name to a struct with fields that depend on whether the argument is
* a contract, interface, or numeric type. See
* https://docs.soliditylang.org/en/v0.6.10/units-and-global-variables.html
* for details.
*/
typeOfBuiltinType(node: Identifier): TypeNode {
assert(
node.parent instanceof FunctionCall && node.parent.vArguments.length === 1,
"Unexpected use of builtin type {0}",
node
);
const typeOfArg = this.typeOf(node.parent.vArguments[0]);
if (!(typeOfArg instanceof TypeNameType)) {
throw new SolTypeError(
`Unexpected argument to type() ${pp(node.parent.vArguments[0])}`
);
}
const innerT = typeOfArg.type;
if (
innerT instanceof IntType ||
(innerT instanceof UserDefinedType && innerT.definition instanceof EnumDefinition)
) {
return applySubstitution(typeInt, new Map([["T", innerT]]));
}
if (innerT instanceof UserDefinedType && innerT.definition instanceof ContractDefinition) {
const resTemplateT =
innerT.definition.kind === ContractKind.Interface || innerT.definition.abstract
? typeInterface
: typeContract;
return applySubstitution(resTemplateT, new Map([["T", innerT]]));
}
throw new SolTypeError(`Unexpected type ${innerT.pp()} in type() node ${pp(node)}`);
}
/**
* Infer the type of a builtin identifier `node`.
*/
typeOfBuiltin(node: Identifier): TypeNode {
if (node.name === "type") {
return this.typeOfBuiltinType(node);
}
if (node.name === "super") {
const contract = node.getClosestParentByType(ContractDefinition);
assert(contract !== undefined, "Use of super outside of contract in {0}", node);
return new SuperType(contract);
}
const globalBuiltin = globalBuiltins.getFieldForVersion(node.name, this.version);
if (globalBuiltin) {
return globalBuiltin;
}
assert(node.name in builtinTypes, 'NYI builtin "{0}" for {1}', node.name, node);
return builtinTypes[node.name](node);
}
private getRHSTypeForDecl(
decl: VariableDeclaration,
stmt: VariableDeclarationStatement
): TypeNode | undefined {
if (stmt.vInitialValue === undefined) {
return undefined;
}
const rhsT = this.typeOf(stmt.vInitialValue);
if (rhsT instanceof TupleType && stmt.assignments.length > 0) {
const tupleIdx = stmt.assignments.indexOf(decl.id);
assert(tupleIdx > -1, "Var decl {0} not found in assignments of {1}", decl, stmt);
assert(rhsT.elements.length > tupleIdx, "Rhs not a tuple of right size in {0}", stmt);
return rhsT.elements[tupleIdx];
}
return rhsT;
}
/**
* Infer the type of the identifier
*/
typeOfIdentifier(node: Identifier): TypeNode {
const def = node.vReferencedDeclaration;
if (def === undefined) {
// Identifiers in import definitions (e.g. the `a` in `import a from
// "foo.sol"` also have undefined vReferencedDeclaration and look
// like builtins. Disambiguate them here.
if (node.parent instanceof ImportDirective) {
const imp = node.parent;
// Sanity check that vSymbolAliases were built correctly
assert(
node.parent.symbolAliases.length === node.parent.vSymbolAliases.length,
`Unexpected import directive with missing symbolic aliases {0}`,
node.parent
);
for (let i = 0; i < imp.symbolAliases.length; i++) {
const alias = imp.symbolAliases[i];
if (!(alias.foreign instanceof Identifier && alias.foreign.id === node.id)) {
continue;
}
const originalSym = imp.vSymbolAliases[i][0];
if (
originalSym instanceof ContractDefinition ||
originalSym instanceof StructDefinition ||
originalSym instanceof EnumDefinition ||
originalSym instanceof UserDefinedValueTypeDefinition
) {
return new TypeNameType(
new UserDefinedType(getFQDefName(originalSym), originalSym)
);
}
if (originalSym instanceof ImportDirective) {
return new ImportRefType(originalSym);
}
if (originalSym instanceof ErrorDefinition) {
return this.errDefToType(originalSym);
}
if (originalSym instanceof FunctionDefinition) {
return this.funDefToType(originalSym);
}
return this.variableDeclarationToTypeNode(originalSym);
}
}
// If not an imported identifier must be a builtin