@0xobelisk/sui-common 0.4.9

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@0xobelisk/sui-common",
+  "version": "0.4.9",
+  "description": "Common low level logic shared between packages",
+  "keywords": [
+    "sui",
+    "obelisk labs",
+    "move",
+    "blockchain"
+  ],
+  "type": "module",
+  "author": "team@obelisk.build",
+  "homepage": "https://github.com/0xobelisk/obelisk-engine/tree/main/packages/sui-common#readme",
+  "bugs": "https://github.com/0xobelisk/obelisk-engine/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/0xobelisk/obelisk-engine.git"
+  },
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "typesVersions": {
+    "*": {
+      "index": [
+        "./src/index.ts"
+      ]
+    }
+  },
+  "types": "src/index.ts",
+  "dependencies": {
+    "@mysten/sui.js": "^0.41.0",
+    "chalk": "^5.0.1",
+    "dotenv": "^16.0.3",
+    "ejs": "^3.1.8",
+    "execa": "^7.0.0",
+    "find-up": "^6.3.0",
+    "glob": "^8.0.3",
+    "path": "^0.12.7",
+    "prettier": "^2.8.4",
+    "prettier-plugin-rust": "^0.1.9",
+    "prettier-plugin-solidity": "^1.1.2",
+    "typescript": "5.1.6",
+    "yargs": "^17.7.1",
+    "zod": "^3.22.3",
+    "zod-validation-error": "^1.3.0",
+    "esbuild": "^0.17.15"
+  },
+  "devDependencies": {
+    "@types/ejs": "^3.1.1",
+    "@types/glob": "^7.2.0",
+    "@types/node": "^18.15.11",
+    "@types/yargs": "^17.0.10",
+    "tsup": "^6.7.0",
+    "tsx": "^3.12.6"
+  },
+  "scripts": {
+    "build": "pnpm run build:js",
+    "build:js": "tsup && chmod +x ./dist/index.js",
+    "clean": "pnpm run clean:js",
+    "clean:js": "rimraf dist",
+    "dev": "tsup --watch",
+    "lint": "eslint . --ext .ts"
+  }
+}

package/src/codegen/index.ts

@@ -0,0 +1,3 @@
+// import "./modules.d";
+export * from "./utils";
+export * from "./types";

package/src/codegen/modules.d.ts

@@ -0,0 +1 @@
+declare module "prettier-plugin-rust";

package/src/codegen/types/index.ts

@@ -0,0 +1,82 @@
+export type BaseType =
+  | "string"
+  | "vector<string>"
+  | "address"
+  | "bool"
+  | "u8"
+  | "u64"
+  | "u128"
+  | "vector<address>"
+  | "vector<bool>"
+  | "vector<u8>"
+  | "vector<vector<u8>>"
+  | "vector<u64>"
+  | "vector<u128>";
+
+type Address = string;
+type Bool = boolean;
+type U8 = number;
+type U64 = number;
+type U128 = number;
+type Vector<T> = T[];
+
+export type BaseValueType =
+  | String
+  | Address
+  | Bool
+  | U8
+  | U64
+  | U128
+  | Vector<Address>
+  | Vector<Bool>
+  | Vector<U8>
+  | Vector<Vector<U8>>
+  | Vector<U64>
+  | Vector<U128>;
+
+export interface ValueType {
+  valueType: BaseType | Record<string, BaseType>;
+  ephemeral?: boolean;
+  defaultValue?: BaseValueType | Record<string, BaseValueType>;
+}
+
+export type SchemaMapType = BaseType | ValueType;
+
+export type ObeliskConfig = {
+  name: string;
+  description: string;
+  systems: string[];
+  schemas: Record<string, SchemaMapType>;
+};
+
+export type MoveType =
+  | "string"
+  | "vector<string>"
+  | "String"
+  | "vector<String>"
+  | "address"
+  | "bool"
+  | "u8"
+  | "u64"
+  | "u128"
+  | "vector<address>"
+  | "vector<bool>"
+  | "vector<u8>"
+  | "vector<vector<u8>>"
+  | "vector<u64>"
+  | "vector<u128>";
+
+export interface RenderSchemaOptions {
+  projectName: string;
+  systems: string[];
+  schemaName: string;
+  structName: string;
+  ephemeral: boolean;
+  singleton: boolean;
+  valueType: MoveType | Record<string, MoveType>; // move type
+  realType: BaseType | Record<string, BaseType>; // ts type
+  // structAttrs: string[];
+  // structTypes: string[];
+  defaultValue: BaseValueType | Record<string, BaseValueType> | undefined;
+  needImportString: boolean;
+}

package/src/codegen/utils/config.ts

@@ -0,0 +1,68 @@
+import { findUp } from "find-up";
+import path from "path";
+import esbuild from "esbuild";
+import { NotInsideProjectError } from "./errors";
+import { rmSync } from "fs";
+import { pathToFileURL } from "url";
+import os from "os";
+
+// In order of preference files are checked
+const configFiles = [
+  "obelisk.config.js",
+  "obelisk.config.mjs",
+  "obelisk.config.ts",
+  "obelisk.config.mts",
+];
+const TEMP_CONFIG = "obelisk.config.example.mjs";
+
+export async function loadConfig(configPath?: string): Promise<unknown> {
+  configPath = await resolveConfigPath(configPath);
+  try {
+    await esbuild.build({
+      entryPoints: [configPath],
+      format: "esm",
+      outfile: TEMP_CONFIG,
+      // https://esbuild.github.io/getting-started/#bundling-for-node
+      platform: "node",
+      // bundle local imports (otherwise it may error, js can't import ts)
+      bundle: true,
+      // avoid bundling external imports (it's unnecessary and esbuild can't handle all node features)
+      packages: "external",
+    });
+    configPath = await resolveConfigPath(TEMP_CONFIG, true);
+    // Node.js caches dynamic imports, so without appending a cache breaking
+    // param like `?update={Date.now()}` this import always returns the same config
+    // if called multiple times in a single process, like the `dev-contracts` cli
+    return (await import(configPath + `?update=${Date.now()}`)).obeliskConfig;
+  } finally {
+    rmSync(TEMP_CONFIG, { force: true });
+  }
+}
+
+export async function resolveConfigPath(
+  configPath: string | undefined,
+  toFileURL?: boolean
+) {
+  if (configPath === undefined) {
+    configPath = await getUserConfigPath();
+  } else {
+    if (!path.isAbsolute(configPath)) {
+      configPath = path.join(process.cwd(), configPath);
+      configPath = path.normalize(configPath);
+    }
+  }
+
+  // Add `file:///` for Windows support
+  // (see https://github.com/nodejs/node/issues/31710)
+  return toFileURL && os.platform() === "win32"
+    ? pathToFileURL(configPath).href
+    : configPath;
+}
+
+async function getUserConfigPath() {
+  const tsConfigPath = await findUp(configFiles);
+  if (tsConfigPath === undefined) {
+    throw new NotInsideProjectError();
+  }
+  return tsConfigPath;
+}

package/src/codegen/utils/errors.ts

@@ -0,0 +1,5 @@
+
+export class NotInsideProjectError extends Error {
+name = "NotInsideProjectError";
+message = "You are not inside a Obelisk project";
+}

package/src/codegen/utils/format.ts

@@ -0,0 +1,42 @@
+// import chalk from "chalk";
+import * as prettier from "prettier";
+import * as rustPlugin from "prettier-plugin-rust";
+
+export async function formatMove(
+  content: string,
+  prettierConfigPath?: string
+): Promise<string> {
+  let config;
+  if (prettierConfigPath) {
+    config = await prettier.resolveConfig(prettierConfigPath);
+  }
+  try {
+    return prettier.format(content, {
+      plugins: [rustPlugin],
+      // parser: "rustParse",
+
+      printWidth: 120,
+      semi: true,
+      tabWidth: 2,
+      useTabs: false,
+      bracketSpacing: true,
+
+      ...config,
+    });
+  } catch (error) {
+    let message;
+    if (error instanceof Error) {
+      message = error.message;
+    } else {
+      message = error;
+    }
+    console.log(`Error during output formatting: ${message}`);
+    return content;
+  }
+}
+
+export async function formatTypescript(content: string): Promise<string> {
+  return prettier.format(content, {
+    parser: "typescript",
+  });
+}

package/src/codegen/utils/formatAndWrite.ts

@@ -0,0 +1,31 @@
+import { mkdirSync, writeFileSync } from "fs";
+import { dirname } from "path";
+import { formatMove, formatTypescript } from "./format";
+
+export async function formatAndWriteMove(
+  output: string,
+  fullOutputPath: string,
+  logPrefix?: string
+): Promise<void> {
+  // const formattedOutput = await formatMove(output);
+  // console.log(formattedOutput)
+  mkdirSync(dirname(fullOutputPath), { recursive: true });
+
+  writeFileSync(fullOutputPath, output);
+  if (logPrefix !== undefined) {
+    console.log(`${logPrefix}: ${fullOutputPath}`);
+  }
+}
+
+export async function formatAndWriteTypescript(
+  output: string,
+  fullOutputPath: string,
+  logPrefix: string
+): Promise<void> {
+  const formattedOutput = await formatTypescript(output);
+
+  mkdirSync(dirname(fullOutputPath), { recursive: true });
+
+  writeFileSync(fullOutputPath, formattedOutput);
+  console.log(`${logPrefix}: ${fullOutputPath}`);
+}

package/src/codegen/utils/index.ts

@@ -0,0 +1,6 @@
+export * from "./format";
+export * from "./formatAndWrite";
+export * from "./posixPath";
+export * from "./renderMove/worldgen";
+export * from "./renderMove/generateEps";
+export * from "./config";

package/src/codegen/utils/posixPath.ts

@@ -0,0 +1,8 @@
+/**
+ * Explicitly normalize a given path to a posix path (using `/` as separator).
+ * This should be used for generating Solidity files that will be consumed by solc,
+ * because solc expects `/` as path separator, but path.join produces `\` if the user is on windows.
+ */
+export function posixPath(path: string): string {
+  return path.replace(/\\/g, "/");
+}