Merge pull request #19 from hyperweb-io/feat/parse

adding parse

Author: pyramation

.github/workflows/run-tests.yml

@@ -32,9 +32,12 @@ jobs:
           yarn build
           yarn symlink
 
-      - name: Test @hyperweb/build 🔍
+      - name: Test @hyperweb/build
         run: cd packages/build && yarn test
+
+      - name: Test @hyperweb/parse
+        run: cd packages/parse && yarn test
 
-      - name: Test @hyperweb/ts-json-schema 🔍
+      - name: Test @hyperweb/ts-json-schema
         run: cd packages/ts-json-schema && yarn test
 

packages/parse/README.md

@@ -0,0 +1,41 @@
+# Hyperweb Parse
+
+<p align="center" width="100%">
+   <img src="https://raw.githubusercontent.com/hyperweb-io/.github/refs/heads/main/assets/logo.svg" alt="hyperweb" width="80"><br />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/hyperweb-io/hyperweb-build/actions/workflows/run-tests.yml">
+    <img height="20" src="https://github.com/hyperweb-io/hyperweb-build/actions/workflows/run-tests.yml/badge.svg" />
+  </a>
+  <br />
+   <a href="https://github.com/hyperweb-io/hyperweb-build/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
+   <a href="https://www.npmjs.com/package/@hyperweb/build"><img height="20" src="https://img.shields.io/github/package-json/v/hyperweb-io/hyperweb-build?filename=packages%2Fbuild%2Fpackage.json"></a>
+</p>
+
+
+## Interchain JavaScript Stack 
+
+A unified toolkit for building applications and smart contracts in the Interchain ecosystem ⚛️
+
+| Category              | Tools                                                                                                                  | Description                                                                                           |
+|----------------------|------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
+| **Chain Information**   | [**Chain Registry**](https://github.com/hyperweb-io/chain-registry), [**Utils**](https://www.npmjs.com/package/@chain-registry/utils), [**Client**](https://www.npmjs.com/package/@chain-registry/client) | Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application. |
+| **Wallet Connectors**| [**Interchain Kit**](https://github.com/hyperweb-io/interchain-kit)<sup>beta</sup>, [**Cosmos Kit**](https://github.com/hyperweb-io/cosmos-kit) | Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. |
+| **Signing Clients**          | [**InterchainJS**](https://github.com/hyperweb-io/interchainjs)<sup>beta</sup>, [**CosmJS**](https://github.com/cosmos/cosmjs) | A single, universal signing interface for any network |
+| **SDK Clients**              | [**Telescope**](https://github.com/hyperweb-io/telescope)                                                          | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |
+| **Starter Kits**     | [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)<sup>beta</sup>, [**Create Cosmos App**](https://github.com/hyperweb-io/create-cosmos-app) | Set up a modern Interchain app by running one command. |
+| **UI Kits**          | [**Interchain UI**](https://github.com/hyperweb-io/interchain-ui)                                                   | The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. |
+| **Testing Frameworks**          | [**Starship**](https://github.com/hyperweb-io/starship)                                                             | Unified Testing and Development for the Interchain. |
+| **TypeScript Smart Contracts** | [**Create Hyperweb App**](https://github.com/hyperweb-io/create-hyperweb-app)                              | Build and deploy full-stack blockchain applications with TypeScript |
+| **CosmWasm Contracts** | [**CosmWasm TS Codegen**](https://github.com/CosmWasm/ts-codegen)                                                   | Convert your CosmWasm smart contracts into dev-friendly TypeScript classes. |
+
+## Credits
+
+🛠 Built by Hyperweb (formerly Cosmology) — if you like our tools, please checkout and contribute to [our github ⚛️](https://github.com/hyperweb-io)
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

packages/parse/__tests__/ContractAnalyzer.test.ts

@@ -0,0 +1,150 @@
+import { ContractAnalyzer } from '../src/ContractAnalyzer';
+
+describe('ContractAnalyzer', () => {
+  let analyzer: ContractAnalyzer;
+
+  beforeEach(() => {
+    analyzer = new ContractAnalyzer();
+  });
+
+  it('should identify query methods', () => {
+    const code = `
+      export default class Contract {
+        state: any;
+        
+        getState() {
+          return this.state;
+        }
+        
+        getValue() {
+          const value = this.state.value;
+          return value;
+        }
+      }
+    `;
+
+    const result = analyzer.analyzeFromCode(code);
+    expect(result.queries).toEqual(['getState', 'getValue']);
+    expect(result.mutations).toEqual([]);
+  });
+
+  it('should identify mutation methods', () => {
+    const code = `
+      export default class Contract {
+        state: any;
+        
+        setState(newState: any) {
+          this.state = newState;
+        }
+        
+        updateValue(value: any) {
+          this.state.value = value;
+        }
+      }
+    `;
+
+    const result = analyzer.analyzeFromCode(code);
+    expect(result.queries).toEqual([]);
+    expect(result.mutations).toEqual(['setState', 'updateValue']);
+  });
+
+  it('should identify both query and mutation methods', () => {
+    const code = `
+      export default class Contract {
+        state: any;
+        
+        getState() {
+          return this.state;
+        }
+        
+        setState(newState: any) {
+          this.state = newState;
+        }
+        
+        updateAndGet() {
+          this.state.value = 42;
+          return this.state.value;
+        }
+      }
+    `;
+
+    const result = analyzer.analyzeFromCode(code);
+    expect(result.queries).toEqual(['getState']);
+    expect(result.mutations).toEqual(['setState', 'updateAndGet']);
+  });
+
+  it('should ignore static methods and constructors', () => {
+    const code = `
+      export default class Contract {
+        state: any;
+        
+        constructor() {
+          this.state = {};
+        }
+        
+        static getStaticState() {
+          return this.state;
+        }
+        
+        getState() {
+          return this.state;
+        }
+      }
+    `;
+
+    const result = analyzer.analyzeFromCode(code);
+    expect(result.queries).toEqual(['getState']);
+    expect(result.mutations).toEqual([]);
+  });
+
+  it('should handle class expression with named export', () => {
+    const code = `
+      var Contract = class {
+        state = {};
+        
+        initialize() {
+          this.state.value = 2.02234;
+        }
+        
+        getState() {
+          return this.state.value;
+        }
+        
+        exp() {
+          this.state.value = this.state.value * this.state.value;
+          return this.state.value;
+        }
+      };
+      
+      export { Contract as default };
+    `;
+
+    const result = analyzer.analyzeFromCode(code);
+    expect(result.queries).toEqual(['getState']);
+    expect(result.mutations).toEqual(['initialize', 'exp']);
+  });
+
+  it('should throw error when no default export is found', () => {
+    const code = `
+      class Contract {
+        state: any;
+        
+        getState() {
+          return this.state;
+        }
+      }
+    `;
+
+    expect(() => analyzer.analyzeFromCode(code)).toThrow('No default exported class found in the code');
+  });
+
+  it('should throw error when default export is not a class', () => {
+    const code = `
+      export default function Contract() {
+        return {};
+      }
+    `;
+
+    expect(() => analyzer.analyzeFromCode(code)).toThrow('No default exported class found in the code');
+  });
+}); 

packages/parse/jest.config.js

@@ -0,0 +1,18 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        babelConfig: false,
+        tsconfig: 'tsconfig.json',
+      },
+    ],
+  },
+  transformIgnorePatterns: [`/node_modules/*`],
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  modulePathIgnorePatterns: ['dist/*']
+};

packages/parse/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@hyperweb/parse",
+  "version": "1.0.1",
+  "author": "Hyperweb <developers@hyperweb.io>",
+  "description": "Parse Hyperweb contracts",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "homepage": "https://github.com/hyperweb-io/hyperweb-build",
+  "license": "SEE LICENSE IN LICENSE",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hyperweb-io/hyperweb-build"
+  },
+  "bugs": {
+    "url": "https://github.com/hyperweb-io/hyperweb-build/issues"
+  },
+  "scripts": {
+    "copy": "copyfiles -f ../../LICENSE README.md package.json dist",
+    "clean": "rimraf dist/**",
+    "prepare": "npm run build",
+    "build": "npm run clean; tsc; tsc -p tsconfig.esm.json; npm run copy",
+    "build:dev": "npm run clean; tsc --declarationMap; tsc -p tsconfig.esm.json; npm run copy",
+    "lint": "eslint . --fix",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "keywords": [],
+  "dependencies": {
+    "@babel/parser": "^7.24.0",
+    "@babel/traverse": "^7.24.0",
+    "@babel/types": "^7.24.0"
+  }
+}

packages/parse/src/ContractAnalyzer.ts

@@ -0,0 +1,153 @@
+// @ts-nocheck
+import * as parser from '@babel/parser';
+import traverse, { NodePath } from '@babel/traverse';
+import * as t from '@babel/types';
+
+export interface AnalysisResult {
+  queries: string[];
+  mutations: string[];
+}
+
+export class ContractAnalyzer {
+  private ast: parser.ParseResult<t.File> | null = null;
+
+  /**
+   * Analyzes a TypeScript contract class to identify query and mutation methods
+   * @param code The TypeScript source code to analyze
+   * @returns An object containing arrays of query and mutation method names
+   */
+  public analyzeFromCode(code: string): AnalysisResult {
+    this.parseCode(code);
+    return this.analyze();
+  }
+
+  /**
+   * Parses the TypeScript code into an AST
+   * @param code The TypeScript source code to parse
+   */
+  private parseCode(code: string): void {
+    this.ast = parser.parse(code, {
+      sourceType: 'module',
+      plugins: ['typescript', 'classProperties', 'decorators-legacy'],
+    });
+  }
+
+  /**
+   * Analyzes the parsed AST to identify query and mutation methods
+   * @returns An object containing arrays of query and mutation method names
+   */
+  private analyze(): AnalysisResult {
+    if (!this.ast) {
+      throw new Error('No code has been parsed. Call analyzeFromCode first.');
+    }
+
+    const queries: string[] = [];
+    const mutations: string[] = [];
+    let foundDefaultExport = false;
+
+    const self = this;
+
+    traverse(this.ast, {
+      // Handle both export default class and export { Contract as default }
+      ExportDefaultDeclaration(path) {
+        const declaration = path.node.declaration;
+        
+        // Check if the default export is a class declaration
+        if (t.isClassDeclaration(declaration)) {
+          foundDefaultExport = true;
+          self.analyzeClassMethods(path, declaration, queries, mutations);
+        }
+      },
+      // Handle named exports with default alias
+      ExportNamedDeclaration(path) {
+        const specifiers = path.node.specifiers;
+        for (const specifier of specifiers) {
+          if (
+            t.isExportSpecifier(specifier) &&
+            specifier.exported.type === 'Identifier' &&
+            specifier.exported.name === 'default'
+          ) {
+            // Find the variable declaration for the exported class
+            const binding = path.scope.getBinding(specifier.local.name);
+            if (binding) {
+              const declaration = binding.path.node;
+              if (
+                t.isVariableDeclarator(declaration) &&
+                t.isClassExpression(declaration.init)
+              ) {
+                foundDefaultExport = true;
+                self.analyzeClassMethods(binding.path, declaration.init, queries, mutations);
+              }
+            }
+          }
+        }
+      },
+    });
+
+    if (!foundDefaultExport) {
+      throw new Error('No default exported class found in the code');
+    }
+
+    return { queries, mutations };
+  }
+
+  /**
+   * Analyzes methods within a class declaration or expression
+   */
+  private analyzeClassMethods(
+    parentPath: NodePath,
+    classNode: t.ClassDeclaration | t.ClassExpression,
+    queries: string[],
+    mutations: string[]
+  ): void {
+    parentPath.traverse({
+      ClassMethod(methodPath: NodePath<t.ClassMethod>) {
+        // Skip static methods and constructors
+        if (methodPath.node.static || methodPath.node.kind === 'constructor') {
+          return;
+        }
+
+        const methodName = methodPath.node.key.type === 'Identifier' ? methodPath.node.key.name : '';
+        if (!methodName) return;
+
+        let readsState = false;
+        let writesState = false;
+
+        // Check for state access
+        methodPath.traverse({
+          MemberExpression(memberPath: NodePath<t.MemberExpression>) {
+            const object = memberPath.node.object;
+            const property = memberPath.node.property;
+
+            // Check if this is a this.state access
+            if (
+              t.isThisExpression(object) &&
+              t.isIdentifier(property) &&
+              property.name === 'state'
+            ) {
+              // Check if this is part of an assignment
+              const parent = memberPath.parentPath;
+              if (
+                t.isAssignmentExpression(parent.node) ||
+                (t.isMemberExpression(parent.node) && 
+                 t.isAssignmentExpression(parent.parentPath.node))
+              ) {
+                writesState = true;
+              } else {
+                readsState = true;
+              }
+            }
+          },
+        });
+
+        // If a method writes to state, it's a mutation
+        // If it only reads from state, it's a query
+        if (writesState) {
+          mutations.push(methodName);
+        } else if (readsState) {
+          queries.push(methodName);
+        }
+      },
+    });
+  }
+} 

packages/parse/src/index.ts

@@ -0,0 +1 @@
+export * from './ContractAnalyzer';

packages/parse/tsconfig.esm.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist/esm",
+    "module": "es2022",
+    "rootDir": "src/",
+    "declaration": false
+  }
+}

packages/parse/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src/"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist", "node_modules", "**/*.spec.*", "**/*.test.*"]
+}