skittles 0.1.6 → 0.1.9

package/lib/abi/get-abi.d.ts

@@ -0,0 +1,4 @@
+import { Abi } from "../types/abi-types";
+import SkittlesClass from "../types/skittles-class";
+declare const getAbi: (skittlesClass: SkittlesClass) => Abi;
+export default getAbi;

package/lib/ast/get-ast.d.ts

@@ -0,0 +1,3 @@
+import { SourceFile } from "typescript";
+declare const getAst: (file: string) => SourceFile;
+export default getAst;

package/lib/bytecode/get-bytecode.d.ts

@@ -0,0 +1,2 @@
+declare const getBytecode: (className: string, content: string) => any;
+export default getBytecode;

package/lib/data/yul-template.d.ts

@@ -0,0 +1,11 @@
+export declare enum YulSection {
+    Constructor = "constructor",
+    Dispatchers = "dispatchers",
+    Functions = "functions",
+    StorageLayout = "storage layout",
+    ConstructorStorageLayout = "constructor storage layout",
+    StorageAccess = "storage access",
+    ConstructorStorageAccess = "constructor storage access"
+}
+declare const yulTemplate: string[];
+export default yulTemplate;

package/lib/helpers/ast-helper.d.ts

@@ -0,0 +1,13 @@
+import { BinaryExpression, ClassDeclaration, Node, PropertyDeclaration } from "typescript";
+export declare const getClassNode: (node: Node) => ClassDeclaration;
+export declare const getNodeName: (node: Node) => string;
+export declare const isPlusEquals: (expression: BinaryExpression) => boolean;
+export declare const isEquals: (expression: BinaryExpression) => boolean;
+export declare const isMinusEquals: (expression: BinaryExpression) => boolean;
+export declare const isTrueKeyword: (node: Node) => boolean;
+export declare const isFalseKeyword: (node: Node) => boolean;
+export declare const isNodePrivate: (node: Node) => boolean;
+export declare const isNodeImmutable: (node: Node) => boolean;
+export declare const isPropertyArrowFunction: (node: PropertyDeclaration) => boolean;
+export declare const isVariable: (property: PropertyDeclaration) => boolean;
+export declare const isExpression: (node: Node) => boolean;

package/lib/helpers/file-helper.d.ts

@@ -0,0 +1,2 @@
+export declare const getAllContractFiles: () => string[];
+export declare const writeFile: (type: string, fileName: string, content: string) => void;

package/lib/helpers/selector-helper.d.ts

@@ -0,0 +1,2 @@
+declare const getSelector: (abi: any[], func: string) => string;
+export default getSelector;

package/lib/helpers/string-helper.d.ts

@@ -0,0 +1,2 @@
+export declare const subStringCount: (str: string, subString: string) => number;
+export declare const getVariables: (n: number) => string;

package/lib/helpers/yul-helper.d.ts

@@ -0,0 +1,3 @@
+import { YulSection } from "../data/yul-template";
+export declare const addToSection: (yul: string[], section: YulSection, lines: string[]) => string[];
+export declare const getBaseYul: (name: string) => string[];

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { address, self, block, chain, msg, tx } from "./types/core-types";
+export { address, self, block, chain, msg, tx };

package/lib/index.js

@@ -13,6 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.tx = exports.msg = exports.chain = exports.block = exports.self = void 0;
 // import chalk from "chalk";
 // import clear from "clear";
 // import figlet from "figlet";
@@ -23,6 +24,26 @@ const get_bytecode_1 = __importDefault(require("./bytecode/get-bytecode"));
 const file_helper_1 = require("./helpers/file-helper");
 const get_skittles_class_1 = __importDefault(require("./skittles-class/get-skittles-class"));
 const get_yul_1 = __importDefault(require("./yul/get-yul"));
+const core_types_1 = require("./types/core-types");
+Object.defineProperty(exports, "self", { enumerable: true, get: function () { return core_types_1.self; } });
+Object.defineProperty(exports, "block", { enumerable: true, get: function () { return core_types_1.block; } });
+Object.defineProperty(exports, "chain", { enumerable: true, get: function () { return core_types_1.chain; } });
+Object.defineProperty(exports, "msg", { enumerable: true, get: function () { return core_types_1.msg; } });
+Object.defineProperty(exports, "tx", { enumerable: true, get: function () { return core_types_1.tx; } });
+const skittlesCompile = () => __awaiter(void 0, void 0, void 0, function* () {
+    const files = (0, file_helper_1.getAllContractFiles)();
+    const promises = files.map((file) => __awaiter(void 0, void 0, void 0, function* () {
+        const skittlesClass = (0, get_skittles_class_1.default)(file);
+        const abi = (0, get_abi_1.default)(skittlesClass);
+        const { name } = skittlesClass;
+        (0, file_helper_1.writeFile)("abi", name, JSON.stringify(abi, null, 2));
+        const yul = (0, get_yul_1.default)(skittlesClass, abi);
+        (0, file_helper_1.writeFile)("yul", name, yul);
+        const bytecode = (0, get_bytecode_1.default)(name, yul);
+        (0, file_helper_1.writeFile)("bytecode", name, bytecode);
+    }));
+    yield Promise.all(promises);
+});
 // clear();
 // console.log(
 //   chalk.red(figlet.textSync("skittles-cli", { horizontalLayout: "full" }))
@@ -45,17 +66,3 @@ commander_1.program
     yield skittlesCompile();
 }));
 commander_1.program.parse();
-const skittlesCompile = () => __awaiter(void 0, void 0, void 0, function* () {
-    const files = (0, file_helper_1.getAllContractFiles)();
-    const promises = files.map((file) => __awaiter(void 0, void 0, void 0, function* () {
-        const skittlesClass = (0, get_skittles_class_1.default)(file);
-        const abi = (0, get_abi_1.default)(skittlesClass);
-        const { name } = skittlesClass;
-        (0, file_helper_1.writeFile)("abi", name, JSON.stringify(abi, null, 2));
-        const yul = (0, get_yul_1.default)(skittlesClass, abi);
-        (0, file_helper_1.writeFile)("yul", name, yul);
-        const bytecode = (0, get_bytecode_1.default)(name, yul);
-        (0, file_helper_1.writeFile)("bytecode", name, bytecode);
-    }));
-    yield Promise.all(promises);
-});

package/lib/skittles-class/get-skittles-class.d.ts

@@ -0,0 +1,3 @@
+import SkittlesClass from "../types/skittles-class";
+declare const getSkittlesClass: (file: string) => SkittlesClass;
+export default getSkittlesClass;

package/lib/skittles-class/get-skittles-constructor.d.ts

@@ -0,0 +1,4 @@
+import { ConstructorDeclaration } from "typescript";
+import { SkittlesConstructor } from "../types/skittles-class";
+declare const getSkittlesConstructor: (astConstructor: ConstructorDeclaration) => SkittlesConstructor;
+export default getSkittlesConstructor;

package/lib/skittles-class/get-skittles-expression.d.ts

@@ -0,0 +1,4 @@
+import { Expression } from "typescript";
+import { SkittlesExpression } from "../types/skittles-class";
+declare const getSkittlesExpression: (expression: Expression) => SkittlesExpression;
+export default getSkittlesExpression;

package/lib/skittles-class/get-skittles-method.d.ts

@@ -0,0 +1,4 @@
+import { MethodDeclaration, PropertyDeclaration } from "typescript";
+import { SkittlesMethod } from "../types/skittles-class";
+declare const getSkittlesMethod: (astMethod: MethodDeclaration | PropertyDeclaration) => SkittlesMethod;
+export default getSkittlesMethod;

package/lib/skittles-class/get-skittles-operator.d.ts

@@ -0,0 +1,4 @@
+import { SyntaxKind } from "typescript";
+import { SkittlesOperator } from "../types/skittles-class";
+declare const getSkittlesOperator: (syntaxKind: SyntaxKind) => SkittlesOperator;
+export default getSkittlesOperator;

package/lib/skittles-class/get-skittles-property.d.ts

@@ -0,0 +1,4 @@
+import { PropertyDeclaration } from "typescript";
+import { SkittlesVariable } from "../types/skittles-class";
+declare const getSkittlesProperty: (astProperty: PropertyDeclaration) => SkittlesVariable;
+export default getSkittlesProperty;

package/lib/skittles-class/get-skittles-state-mutability.d.ts

@@ -0,0 +1,3 @@
+import SkittlesClass from "../types/skittles-class";
+declare const getStateMutability: (skittlesClass: SkittlesClass) => SkittlesClass;
+export default getStateMutability;

package/lib/skittles-class/get-skittles-statements.d.ts

@@ -0,0 +1,4 @@
+import { Statement } from "typescript";
+import { SkittlesStatement } from "../types/skittles-class";
+declare const getSkittlesStatements: (block: Statement | undefined, returnType: string) => SkittlesStatement[];
+export default getSkittlesStatements;

package/lib/skittles-class/get-skittles-type.d.ts

@@ -0,0 +1,3 @@
+import { Node } from "typescript";
+declare const getSkittlesType: (type: Node | undefined, value?: any) => string;
+export default getSkittlesType;

package/lib/types/abi-types.d.ts

@@ -0,0 +1,12 @@
+export interface AbiParameter {
+    name: string;
+    type: string;
+}
+export interface AbiFunction {
+    type: "function" | "constructor" | "receive" | "fallback";
+    name?: string;
+    inputs: AbiParameter[];
+    outputs?: AbiParameter[];
+    stateMutability: "view" | "payable" | "nonpayable" | "pure";
+}
+export declare type Abi = AbiFunction[];

package/lib/types/core-types.d.ts

@@ -0,0 +1,21 @@
+export declare type address = string;
+export declare const self: address;
+export declare class block {
+    static get coinbase(): address;
+    static get difficulty(): number;
+    static get block(): number;
+    static get prevhash(): number;
+    static get timestamp(): number;
+}
+export declare class chain {
+    static get id(): number;
+}
+export declare class msg {
+    static get data(): string;
+    static get sender(): address;
+    static get value(): number;
+}
+export declare class tx {
+    static get gasPrice(): number;
+    static get origin(): address;
+}

package/lib/types/skittles-class.d.ts

@@ -0,0 +1,135 @@
+export declare enum SkittlesExpressionType {
+    Not = "Not",
+    Binary = "Binary",
+    Value = "Value",
+    Storage = "Storage",
+    Variable = "Variable",
+    Mapping = "Mapping",
+    EvmDialect = "Evm Dialect"
+}
+export interface SkittlesBaseExpression {
+    expressionType: SkittlesExpressionType;
+}
+export declare enum SkittlesOperator {
+    Plus = 0,
+    Minus = 1,
+    Multiply = 2,
+    Divide = 3,
+    Modulo = 4,
+    Equals = 5,
+    NotEquals = 6,
+    GreaterThan = 7,
+    LessThan = 8,
+    GreaterThanOrEqual = 9,
+    LessThanOrEqual = 10,
+    And = 11,
+    Or = 12,
+    Not = 13
+}
+export interface SkittlesNotExpression extends SkittlesBaseExpression {
+    expressionType: SkittlesExpressionType.Not;
+    value: SkittlesExpression;
+}
+export interface SkittlesEvmDialectExpression extends SkittlesBaseExpression {
+    expressionType: SkittlesExpressionType.EvmDialect;
+    environment: string;
+    variable: string;
+}
+export interface SkittlesMappingExpression extends SkittlesBaseExpression {
+    expressionType: SkittlesExpressionType.Mapping;
+    variable: string;
+    items: SkittlesExpression[];
+}
+export interface SkittlesBinaryExpression extends SkittlesBaseExpression {
+    expressionType: SkittlesExpressionType.Binary;
+    left: SkittlesExpression;
+    right: SkittlesExpression;
+    operator: SkittlesOperator;
+}
+export interface SkittlesVariableExpression extends SkittlesBaseExpression {
+    expressionType: SkittlesExpressionType.Variable;
+    value: any;
+}
+export interface SkittlesValueExpression extends SkittlesBaseExpression {
+    expressionType: SkittlesExpressionType.Value;
+    type: string;
+    value: any;
+}
+export interface SkittlesStorageExpression extends SkittlesBaseExpression {
+    expressionType: SkittlesExpressionType.Storage;
+    variable: string;
+}
+export declare type SkittlesExpression = SkittlesNotExpression | SkittlesEvmDialectExpression | SkittlesMappingExpression | SkittlesBinaryExpression | SkittlesVariableExpression | SkittlesValueExpression | SkittlesStorageExpression;
+export declare enum SkittlesStatementType {
+    StorageUpdate = "Storage Update",
+    Return = "Return",
+    MappingUpdate = "Mapping Update",
+    Call = "Call",
+    If = "If",
+    Throw = "Throw"
+}
+export interface SkittlesBaseStatement {
+    statementType: SkittlesStatementType;
+}
+export interface SkittlesThrowStatement extends SkittlesBaseStatement {
+    statementType: SkittlesStatementType.Throw;
+    error: SkittlesExpression;
+}
+export interface SkittlesIfStatement extends SkittlesBaseStatement {
+    statementType: SkittlesStatementType.If;
+    condition: SkittlesExpression;
+    then: SkittlesStatement[];
+    else: SkittlesStatement[];
+}
+export interface SkittlesCallStatement extends SkittlesBaseStatement {
+    statementType: SkittlesStatementType.Call;
+    target: string;
+    parameters: SkittlesExpression[];
+}
+export interface SkittlesMappingUpdateStatement extends SkittlesBaseStatement {
+    statementType: SkittlesStatementType.MappingUpdate;
+    variable: string;
+    items: SkittlesExpression[];
+    value: SkittlesExpression;
+}
+export interface SkittlesStorageUpdateStatement extends SkittlesBaseStatement {
+    statementType: SkittlesStatementType.StorageUpdate;
+    variable: string;
+    value: SkittlesExpression;
+}
+export interface SkittlesReturnStatement extends SkittlesBaseStatement {
+    statementType: SkittlesStatementType.Return;
+    type: string;
+    value: SkittlesExpression;
+}
+export declare type SkittlesStatement = SkittlesThrowStatement | SkittlesIfStatement | SkittlesCallStatement | SkittlesMappingUpdateStatement | SkittlesStorageUpdateStatement | SkittlesReturnStatement;
+export interface SkittlesVariable {
+    name: string;
+    type: string;
+    value?: SkittlesExpression;
+    private: boolean;
+    immutable: boolean;
+}
+export interface SkittlesParameter {
+    name: string;
+    type: string;
+}
+export interface SkittlesMethod {
+    name: string;
+    returns: string;
+    private: boolean;
+    view: boolean;
+    parameters: SkittlesParameter[];
+    statements: SkittlesStatement[];
+}
+export interface SkittlesConstructor {
+    parameters: SkittlesParameter[];
+    statements: SkittlesStatement[];
+}
+interface SkittlesClass {
+    name: string;
+    constructor?: SkittlesConstructor;
+    variables: SkittlesVariable[];
+    methods: SkittlesMethod[];
+}
+export default SkittlesClass;

package/lib/yul/add-yul-constructor.d.ts

@@ -0,0 +1,3 @@
+import SkittlesClass from "../types/skittles-class";
+declare const addConstructor: (yul: string[], skittlesClass: SkittlesClass) => string[];
+export default addConstructor;

package/lib/yul/add-yul-method-dispatcher.d.ts

@@ -0,0 +1,3 @@
+import { SkittlesMethod } from "../types/skittles-class";
+declare const addMethodDispatcher: (yul: string[], abi: any[], method: SkittlesMethod) => string[];
+export default addMethodDispatcher;

package/lib/yul/add-yul-method-function.d.ts

@@ -0,0 +1,3 @@
+import { SkittlesMethod } from "../types/skittles-class";
+declare const addMethodFunction: (yul: string[], method: SkittlesMethod) => string[];
+export default addMethodFunction;

package/lib/yul/add-yul-property-dispatcher.d.ts

@@ -0,0 +1,3 @@
+import { SkittlesVariable } from "../types/skittles-class";
+declare const addPropertyDispatcher: (yul: string[], abi: any[], property: SkittlesVariable) => string[];
+export default addPropertyDispatcher;

package/lib/yul/add-yul-storage-access.d.ts

@@ -0,0 +1,3 @@
+import SkittlesClass, { SkittlesVariable } from "../types/skittles-class";
+declare const addStorageAccess: (yul: string[], property: SkittlesVariable, skittlesClass: SkittlesClass, isConstructor?: boolean) => string[];
+export default addStorageAccess;

package/lib/yul/add-yul-storage-layout.d.ts

@@ -0,0 +1,3 @@
+import { SkittlesVariable } from "../types/skittles-class";
+declare const addStorageLayout: (yul: string[], property: SkittlesVariable, index: number, constructor?: boolean) => string[];
+export default addStorageLayout;

package/lib/yul/add-yul-value-initialzations.d.ts

@@ -0,0 +1,3 @@
+import { SkittlesVariable } from "../types/skittles-class";
+declare const addValueInitializations: (yul: string[], property: SkittlesVariable, index: number) => string[];
+export default addValueInitializations;

package/lib/yul/format-yul.d.ts

@@ -0,0 +1,2 @@
+declare const formatYul: (yul: string[]) => string;
+export default formatYul;

package/lib/yul/get-block-yul.d.ts

@@ -0,0 +1,3 @@
+import { SkittlesStatement } from "../types/skittles-class";
+declare const getBlockYul: (statements: SkittlesStatement[]) => string[];
+export default getBlockYul;

package/lib/yul/get-expression-yul.d.ts

@@ -0,0 +1,3 @@
+import { SkittlesExpression } from "../types/skittles-class";
+declare const getExpressionYul: (expression: SkittlesExpression) => string;
+export default getExpressionYul;

package/lib/yul/get-statement-yul.d.ts

@@ -0,0 +1,3 @@
+import { SkittlesStatement } from "../types/skittles-class";
+declare const getStatementYul: (statement: SkittlesStatement) => string[];
+export default getStatementYul;

package/lib/yul/get-yul.d.ts

@@ -0,0 +1,4 @@
+import SkittlesClass from "../types/skittles-class";
+import { Abi } from "../types/abi-types";
+declare const getYul: (skittlesClass: SkittlesClass, abi: Abi) => string;
+export default getYul;

package/lib/yul/yul-constants.d.ts

@@ -0,0 +1,3 @@
+export declare const decoderFunctions: Record<string, string>;
+export declare const returnFunctions: Record<string, string>;
+export declare const evmDialects: Record<string, Record<string, string>>;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "skittles",
-  "version": "0.1.6",
+  "version": "0.1.9",
   "description": "TypeScript Smart Contract Language for the EVM",
   "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "bin": {
     "skittles": "./lib/index.js"
   },
@@ -14,7 +15,7 @@
     "refresh": "rm -rf ./node_modules ./package-lock.json && yarn",
     "local": "sudo yarn global add && skittles",
     "test": "hardhat test",
-    "prepublishOnly": "yarn run build && yarn run test"
+    "prepublishOnly": "yarn run build && yarn run test && node ./lib/index.js compile"
   },
   "repository": {
     "type": "git",

package/TODO.md

@@ -1,21 +0,0 @@
-===== Peer Review ====
-
-- add init function
-- wrap all hardhat functions
-- add readme
-- add normal repo things
-- Consider making types default exports (like `string` and `number` are)
-
-==== Beta ready ====
-
-- Add support for `else` conditions for `if` statements (need to use switches)
-- Add support for events
-- Add immutable (readonly) setting for evaluated values using `setimmutable`
-- Consider how we handle large numbers (BigNumber or something?)
-- automatic mapping views
-- Add config for things like running optimizer
-
-==== FORMATTED ====
-
-- Remove redundant stores for `readonly` values in the constructor
-- Change to getting function signatures with this: https://github.com/FuelLabs/yulp/blob/620d04acb060a7a817e2cfc6da4c9b4d9c7fcef0/src/yulplus.ne#L40

package/build/abi/ERC20.abi

@@ -1,165 +0,0 @@
-[
-  {
-    "type": "constructor",
-    "inputs": [
-      {
-        "name": "mintAmount_",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "nonpayable"
-  },
-  {
-    "type": "function",
-    "name": "decimals",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "symbol",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "string"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "name",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "string"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "totalSupply",
-    "inputs": [],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "balanceOf",
-    "inputs": [
-      {
-        "name": "address",
-        "type": "address"
-      }
-    ],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "allowance",
-    "inputs": [
-      {
-        "name": "owner",
-        "type": "address"
-      },
-      {
-        "name": "spender",
-        "type": "address"
-      }
-    ],
-    "outputs": [
-      {
-        "name": "",
-        "type": "uint256"
-      }
-    ],
-    "stateMutability": "view"
-  },
-  {
-    "type": "function",
-    "name": "approve",
-    "inputs": [
-      {
-        "name": "spender",
-        "type": "address"
-      },
-      {
-        "name": "amount",
-        "type": "uint256"
-      }
-    ],
-    "outputs": [
-      {
-        "name": "",
-        "type": "bool"
-      }
-    ],
-    "stateMutability": "payable"
-  },
-  {
-    "type": "function",
-    "name": "transfer",
-    "inputs": [
-      {
-        "name": "to",
-        "type": "address"
-      },
-      {
-        "name": "amount",
-        "type": "uint256"
-      }
-    ],
-    "outputs": [
-      {
-        "name": "",
-        "type": "bool"
-      }
-    ],
-    "stateMutability": "payable"
-  },
-  {
-    "type": "function",
-    "name": "transferFrom",
-    "inputs": [
-      {
-        "name": "from",
-        "type": "address"
-      },
-      {
-        "name": "to",
-        "type": "address"
-      },
-      {
-        "name": "amount",
-        "type": "uint256"
-      }
-    ],
-    "outputs": [
-      {
-        "name": "",
-        "type": "bool"
-      }
-    ],
-    "stateMutability": "payable"
-  }
-]