@tokamak-private-dapps/private-state-cli 0.1.0

package/lib/private-state-cli-shared.mjs

@@ -0,0 +1,94 @@
+import path from "node:path";
+import {
+  ethers,
+  getAddress,
+  keccak256,
+} from "ethers";
+import {
+  deriveL2KeysFromSignature,
+  fromEdwardsToAddress,
+} from "tokamak-l2js";
+
+export const L2_PASSWORD_SIGNING_DOMAIN = "Tokamak private-state L2 password binding";
+export const CHANNEL_BOUND_L2_DERIVATION_MODE = "channel-name-plus-password-v1";
+
+export function slugifyPathComponent(value) {
+  return String(value)
+    .replace(/[^a-zA-Z0-9]+/g, "-")
+    .replace(/^-+|-+$/g, "")
+    .toLowerCase();
+}
+
+export function deriveChannelIdFromName(channelName) {
+  return ethers.toBigInt(keccak256(ethers.toUtf8Bytes(channelName)));
+}
+
+export function buildL2PasswordSigningMessage({ channelName, password }) {
+  if (typeof channelName !== "string" || channelName.length === 0) {
+    throw new Error("Missing channel name for L2 identity derivation.");
+  }
+  return [
+    L2_PASSWORD_SIGNING_DOMAIN,
+    `channel:${channelName}`,
+    `password:${String(password)}`,
+  ].join("\n");
+}
+
+export async function deriveParticipantIdentityFromSigner({ channelName, password, signer }) {
+  const seedSignature = await signer.signMessage(buildL2PasswordSigningMessage({ channelName, password }));
+  const keySet = deriveL2KeysFromSignature(seedSignature);
+  const l2Address = getAddress(fromEdwardsToAddress(keySet.publicKey).toString());
+  return {
+    seedSignature,
+    l2PrivateKey: keySet.privateKey,
+    l2PublicKey: keySet.publicKey,
+    l2Address,
+  };
+}
+
+export function walletNameForChannelAndAddress(channelName, l1Address) {
+  return `${channelName}-${getAddress(l1Address)}`;
+}
+
+export function parseWalletName(walletName) {
+  const match = /^(.*)-(0x[a-fA-F0-9]{40})$/.exec(String(walletName));
+  if (!match || match[1].length === 0) {
+    throw new Error(
+      [
+        `Unable to derive the channel name from wallet ${walletName}.`,
+        "Expected the deterministic <channelName>-<l1Address> format.",
+      ].join(" "),
+    );
+  }
+  return {
+    channelName: match[1],
+    l1Address: getAddress(match[2]),
+  };
+}
+
+export function workspaceNetworkDir(workspaceRoot, networkName) {
+  return path.join(workspaceRoot, slugifyPathComponent(networkName));
+}
+
+export function workspaceDirForName(workspaceRoot, networkName, workspaceName) {
+  return path.join(
+    workspaceNetworkDir(workspaceRoot, networkName),
+    slugifyPathComponent(workspaceName),
+  );
+}
+
+export function workspaceChannelDir(workspaceDir) {
+  return path.join(workspaceDir, "channel");
+}
+
+export function workspaceWalletsDir(workspaceDir) {
+  return path.join(workspaceDir, "wallets");
+}
+
+export function walletDirForName(walletsRoot, walletName) {
+  return path.join(walletsRoot, slugifyPathComponent(walletName));
+}
+
+export function walletMetadataPathForDir(walletDir) {
+  return path.join(walletDir, "wallet.metadata.json");
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@tokamak-private-dapps/private-state-cli",
+  "version": "0.1.0",
+  "description": "Command-line client for the Tokamak private-state DApp.",
+  "license": "MIT OR Apache-2.0",
+  "author": "Tokamak Network",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tokamak-network/Tokamak-zk-EVM-contracts.git",
+    "directory": "packages/apps/private-state/cli"
+  },
+  "homepage": "https://github.com/tokamak-network/Tokamak-zk-EVM-contracts/tree/main/packages/apps/private-state/cli#readme",
+  "bugs": {
+    "url": "https://github.com/tokamak-network/Tokamak-zk-EVM-contracts/issues"
+  },
+  "keywords": [
+    "tokamak",
+    "private-dapps",
+    "private-state",
+    "zk-evm",
+    "cli"
+  ],
+  "type": "module",
+  "bin": {
+    "private-state-cli": "private-state-bridge-cli.mjs"
+  },
+  "files": [
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "private-state-bridge-cli.mjs",
+    "cli-assistant.html",
+    "lib"
+  ],
+  "scripts": {
+    "release:check": "node ../../../../scripts/release-readiness.cjs"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@ethereumjs/util": "^10.1.1",
+    "@noble/curves": "^1.2.0",
+    "@tokamak-private-dapps/common-library": "^0.1.0",
+    "@tokamak-private-dapps/groth16": "^0.1.0",
+    "@tokamak-zk-evm/cli": "^2.0.8",
+    "ethers": "^6.14.1",
+    "tokamak-l2js": "^0.1.3"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}