feat: Improve typing on expressions

RomarQ · Mar 21, 2022 · ba19cff · ba19cff
1 parent 4d68eb0
commit ba19cff
Show file tree

Hide file tree

Showing 33 changed files with 222 additions and 175 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@tezwell/smartts-sdk",
-    "version": "0.7.0",
+    "version": "0.7.1",
     "description": "SmartTS SDK is a metaprogramming framework for building Tezos smart contracts from Javascript.",
     "keywords": [
         "Tezos",

diff --git a/src/core/contract.ts b/src/core/contract.ts
@@ -8,7 +8,7 @@ import { Expression } from './expression';
 import { Proxied, proxy } from '../misc/proxy';
 import { SetType } from '../statement';
 import { TUnit, TUnknown } from '../type';
-import ValueAtom from './enums/literal';
+import { MichelsonType } from './enums/type';
 
 abstract class View {
     public name: string;
@@ -209,7 +209,7 @@ export class Contract {
         return this;
     }
 
-    public setConfig(options?: { initialBalance?: ILiteral<ValueAtom.mutez>; flags?: Flag[] }) {
+    public setConfig(options?: { initialBalance?: ILiteral<MichelsonType.mutez>; flags?: Flag[] }) {
         if (options?.flags) {
             this.#options.flags = options.flags;
         }

diff --git a/src/core/enums/literal.ts b/src/core/enums/literal.ts
@@ -29,12 +29,6 @@ export enum ValueAtom {
     ticket = 'ticket',
     sapling_state = 'sapling_empty_state',
     lambda = 'lambda',
-    //
-    operation = 'operation',
-    option = 'option',
-    contract = 'contract',
-    chain_id = 'chain_id',
-    sapling_transaction = 'sapling_transaction',
 }
 
 export default ValueAtom;
diff --git a/src/core/enums/type.ts b/src/core/enums/type.ts
@@ -34,4 +34,37 @@ export enum TypeAtom {
     sapling_transaction = 'sapling_transaction',
 }
 
-export default TypeAtom;
+export enum MichelsonType {
+    unit = 'unit',
+    never = 'never',
+    nat = 'nat',
+    int = 'int',
+    mutez = 'mutez',
+    timestamp = 'timestamp',
+    string = 'string',
+    address = 'address',
+    key = 'key',
+    key_hash = 'key_hash',
+    signature = 'signature',
+    option = 'option',
+    bytes = 'bytes',
+    chain_id = 'chain_id',
+    bool = 'bool',
+    list = 'list',
+    pair = 'pair',
+    or = 'or',
+    set = 'set',
+    operation = 'operation',
+    contract = 'contract',
+    ticket = 'ticket',
+    lambda = 'lambda',
+    map = 'map',
+    big_map = 'big_map',
+    bls12_381_g1 = 'bls12_381_g1',
+    bls12_381_g2 = 'bls12_381_g2',
+    bls12_381_fr = 'bls12_381_fr',
+    sapling_transaction = 'sapling_transaction',
+    sapling_state = 'sapling_state',
+    chest = 'chest',
+    chest_key = 'chest_key',
+}
diff --git a/src/core/expression.ts b/src/core/expression.ts
@@ -5,12 +5,12 @@ import type { IType } from '../typings/type';
 import { GetProperty, LambdaArgument } from '../expression/variables';
 import { capitalizeBoolean, LineInfo, parenthesis } from '../misc/utils';
 import ValueAtom from './enums/literal';
-import TypeAtom from './enums/type';
+import { MichelsonType, TypeAtom } from './enums/type';
 import { Proxied } from '../misc/proxy';
 import { AsType } from '../expression/type';
 import { TLambda, TUnknown } from '../type';
 
-export class Expression<T extends ValueAtom> implements IExpression<T> {
+export class Expression<T extends MichelsonType> implements IExpression<T> {
     _isExpression = true as const;
     // Used for type checking
     _type = {} as T;
@@ -38,12 +38,16 @@ export class Expression<T extends ValueAtom> implements IExpression<T> {
     }
 }
 
-export class LiteralExpression<T extends ValueAtom> implements ILiteral<T> {
+export class LiteralExpression<T extends MichelsonType> implements ILiteral<T> {
     _isExpression = true as const;
     // Used for type checking
     _type = {} as T;
 
-    constructor(private name: T, private values: (number | string | boolean | IExpression)[], private line: LineInfo) {}
+    constructor(
+        private name: ValueAtom,
+        private values: (number | string | boolean | IExpression)[],
+        private line: LineInfo,
+    ) {}
 
     toString() {
         switch (this.name) {
@@ -80,10 +84,10 @@ export class LiteralExpression<T extends ValueAtom> implements ILiteral<T> {
     }
 }
 
-export class RecordLiteral implements ILiteral<ValueAtom.record> {
+export class RecordLiteral implements ILiteral<MichelsonType.pair> {
     _isExpression = true as const;
     // Used for type checking
-    _type = {} as ValueAtom.record;
+    _type = MichelsonType.pair as const;
 
     constructor(private fields: Record<string, IExpression>, private line: LineInfo) {}
 
@@ -96,13 +100,12 @@ export class RecordLiteral implements ILiteral<ValueAtom.record> {
     }
 }
 
-export class MapLiteral<T extends ValueAtom.map | ValueAtom.big_map> implements ILiteral<T> {
+export class MapLiteral<T extends MichelsonType.map | MichelsonType.big_map> implements ILiteral<T> {
     _isExpression = true as const;
     _type = {} as T;
-    type = {} as IType;
 
     constructor(
-        private prim: T,
+        private prim: ValueAtom.map | ValueAtom.big_map,
         private rows: IExpression[][],
         keyType: IType,
         valueType: IType,
@@ -118,11 +121,10 @@ export class MapLiteral<T extends ValueAtom.map | ValueAtom.big_map> implements
     }
 }
 
-export class LambdaLiteral implements ILiteral<ValueAtom.lambda> {
+export class LambdaLiteral implements ILiteral<MichelsonType.lambda> {
     _isExpression = true as const;
     // Used for type checking
-    _type = ValueAtom.lambda as const;
-    type = {} as IType;
+    _type = MichelsonType.lambda as const;
     static idCounter = 0;
     private identifier: number;
     private withStorage?: 'read-write' | 'read-only';

diff --git a/src/core/type.ts b/src/core/type.ts
@@ -2,7 +2,7 @@ import { composeRightCombLayout, parenthesis } from '../misc/utils';
 import { ILayout } from '../typings/literal';
 import { IType } from '../typings/type';
 import { Layout } from './enums/layout';
-import TypeAtom from './enums/type';
+import { TypeAtom } from './enums/type';
 
 export class SimpleType<T extends TypeAtom> implements IType<T> {
     // Used for type checking

diff --git a/src/expression/blockchain_properties.ts b/src/expression/blockchain_properties.ts
@@ -2,8 +2,8 @@ import type { ILiteral } from '../typings/literal';
 import ExpressionAtom from '../core/enums/expression';
 import { Expression } from '../core/expression';
 import { LineInfo } from '../misc/utils';
-import ValueAtom from '../core/enums/literal';
 import { IExpression } from '../typings/expression';
+import { MichelsonType } from '../core/enums/type';
 
 /**
  * Get the amount sent in the transaction.
@@ -17,7 +17,7 @@ import { IExpression } from '../typings/expression';
  *
  * @returns {IExpression} An expression
  */
-export const GetAmount = (): IExpression<ValueAtom.mutez> => new Expression(ExpressionAtom.amount);
+export const GetAmount = () => new Expression<MichelsonType.mutez>(ExpressionAtom.amount);
 
 /**
  * Get the contract balance.
@@ -31,7 +31,7 @@ export const GetAmount = (): IExpression<ValueAtom.mutez> => new Expression(Expr
  *
  * @returns {IExpression} An expression
  */
-export const GetBalance = (): IExpression<ValueAtom.mutez> => new Expression(ExpressionAtom.balance);
+export const GetBalance = () => new Expression<MichelsonType.mutez>(ExpressionAtom.balance);
 
 /**
  * Get an entrypoint of the current contract.
@@ -45,8 +45,8 @@ export const GetBalance = (): IExpression<ValueAtom.mutez> => new Expression(Exp
  *
  * @returns {IExpression} An expression
  */
-export const GetSelf = (entry_point: string, line = new LineInfo()): IExpression<ValueAtom.contract> =>
-    new Expression(ExpressionAtom.self, `"${entry_point}"`, line);
+export const GetSelf = (entry_point: string, line = new LineInfo()) =>
+    new Expression<MichelsonType.contract>(ExpressionAtom.self, `"${entry_point}"`, line);
 
 /**
  * Get current contract address.
@@ -60,7 +60,7 @@ export const GetSelf = (entry_point: string, line = new LineInfo()): IExpression
  *
  * @returns {IExpression} An expression
  */
-export const GetSelfAddress = (): IExpression<ValueAtom.address> => new Expression(ExpressionAtom.self_address);
+export const GetSelfAddress = () => new Expression<MichelsonType.address>(ExpressionAtom.self_address);
 
 /**
  * Get transaction sender.
@@ -74,7 +74,7 @@ export const GetSelfAddress = (): IExpression<ValueAtom.address> => new Expressi
  *
  * @returns {IExpression} An expression
  */
-export const GetSender = (): IExpression<ValueAtom.address> => new Expression(ExpressionAtom.sender);
+export const GetSender = () => new Expression<MichelsonType.address>(ExpressionAtom.sender);
 
 /**
  * Get transaction source.
@@ -88,7 +88,7 @@ export const GetSender = (): IExpression<ValueAtom.address> => new Expression(Ex
  *
  * @returns {IExpression} An expression
  */
-export const GetSource = (): IExpression<ValueAtom.address> => new Expression(ExpressionAtom.source);
+export const GetSource = () => new Expression<MichelsonType.address>(ExpressionAtom.source);
 
 /**
  * Get the chain identifier.
@@ -102,7 +102,7 @@ export const GetSource = (): IExpression<ValueAtom.address> => new Expression(Ex
  *
  * @returns {IExpression} An expression
  */
-export const GetChain_id = (): IExpression<ValueAtom.chain_id> => new Expression(ExpressionAtom.chain_id);
+export const GetChain_id = () => new Expression<MichelsonType.chain_id>(ExpressionAtom.chain_id);
 
 /**
  * Get the head block level.
@@ -116,7 +116,7 @@ export const GetChain_id = (): IExpression<ValueAtom.chain_id> => new Expression
  *
  * @returns {IExpression} An expression
  */
-export const GetLevel = (): IExpression<ValueAtom.nat> => new Expression(ExpressionAtom.level);
+export const GetLevel = () => new Expression<MichelsonType.nat>(ExpressionAtom.level);
 
 /**
  * Get the head block timestamp.
@@ -130,7 +130,7 @@ export const GetLevel = (): IExpression<ValueAtom.nat> => new Expression(Express
  *
  * @returns {IExpression} An expression
  */
-export const GetTimestamp = (): IExpression<ValueAtom.timestamp> => new Expression(ExpressionAtom.now);
+export const GetTimestamp = (): IExpression => new Expression<MichelsonType.timestamp>(ExpressionAtom.now);
 
 /**
  * Get total voting power.
@@ -144,7 +144,7 @@ export const GetTimestamp = (): IExpression<ValueAtom.timestamp> => new Expressi
  *
  * @returns {IExpression} An expression
  */
-export const GetTotalVotingPower = (): IExpression<ValueAtom.nat> => new Expression(ExpressionAtom.total_voting_power);
+export const GetTotalVotingPower = () => new Expression<MichelsonType.nat>(ExpressionAtom.total_voting_power);
 
 /**
  * Get the voting power of a given implicit account.
@@ -161,7 +161,5 @@ export const GetTotalVotingPower = (): IExpression<ValueAtom.nat> => new Express
  *
  * @returns {IExpression} An expression
  */
-export const GetVotingPower = (
-    key_hash: ILiteral<ValueAtom.key_hash>,
-    line = new LineInfo(),
-): IExpression<ValueAtom.nat> => new Expression(ExpressionAtom.voting_power, `${key_hash}`, line);
+export const GetVotingPower = (key_hash: ILiteral<MichelsonType.key_hash>, line = new LineInfo()) =>
+    new Expression<MichelsonType.nat>(ExpressionAtom.voting_power, `${key_hash}`, line);
diff --git a/src/expression/bls12_381.ts b/src/expression/bls12_381.ts
@@ -2,7 +2,7 @@ import { LineInfo } from '../misc/utils';
 import { IExpression } from '../typings/expression';
 import { Expression } from '../core/expression';
 import ExpressionAtom from '../core/enums/expression';
-import ValueAtom from '../core/enums/literal';
+import { MichelsonType } from '../core/enums/type';
 
 /**
  * Check a BLS12-381 pairing.
@@ -27,5 +27,5 @@ import ValueAtom from '../core/enums/literal';
  *
  * @returns {IExpression} An expression of types `TBool()`.
  */
-export const PairingCheck = (pairs: IExpression<ValueAtom.list>, line = new LineInfo()) =>
-    new Expression<ValueAtom.bool>(ExpressionAtom.pairing_check, pairs, line);
+export const PairingCheck = (pairs: IExpression<MichelsonType.list>, line = new LineInfo()) =>
+    new Expression<MichelsonType.bool>(ExpressionAtom.pairing_check, pairs, line);
diff --git a/src/expression/comparison.ts b/src/expression/comparison.ts
@@ -2,6 +2,7 @@ import { LineInfo } from '../misc/utils';
 import { IExpression } from '../typings/expression';
 import { Expression } from '../core/expression';
 import ExpressionAtom from '../core/enums/expression';
+import { MichelsonType } from '../core/enums/type';
 
 /**
  * Check if a value is less than another value.
@@ -19,7 +20,7 @@ import ExpressionAtom from '../core/enums/expression';
  * @returns {IExpression} An expression
  */
 export const LessThan = (left: IExpression, right: IExpression, line = new LineInfo()) =>
-    new Expression(ExpressionAtom.lt, left, right, line);
+    new Expression<MichelsonType.bool>(ExpressionAtom.lt, left, right, line);
 
 /**
  * Check if a value is greater than another value.
@@ -37,7 +38,7 @@ export const LessThan = (left: IExpression, right: IExpression, line = new LineI
  * @returns {IExpression} An expression
  */
 export const GreaterThan = (left: IExpression, right: IExpression, line = new LineInfo()) =>
-    new Expression(ExpressionAtom.gt, left, right, line);
+    new Expression<MichelsonType.bool>(ExpressionAtom.gt, left, right, line);
 
 /**
  * Check if a value is less than or equal another value.
@@ -55,7 +56,7 @@ export const GreaterThan = (left: IExpression, right: IExpression, line = new Li
  * @returns {IExpression} An expression
  */
 export const LessThanOrEqual = (left: IExpression, right: IExpression, line = new LineInfo()) =>
-    new Expression(ExpressionAtom.le, left, right, line);
+    new Expression<MichelsonType.bool>(ExpressionAtom.le, left, right, line);
 
 /**
  * Check if a value is greater than or equal another value.
@@ -73,7 +74,7 @@ export const LessThanOrEqual = (left: IExpression, right: IExpression, line = ne
  * @returns {IExpression} An expression
  */
 export const GreaterThanOrEqual = (left: IExpression, right: IExpression, line = new LineInfo()) =>
-    new Expression(ExpressionAtom.ge, left, right, line);
+    new Expression<MichelsonType.bool>(ExpressionAtom.ge, left, right, line);
 
 export const Comparison = {
     LessThan,