@towns-labs/generated 2.0.1

package/dev/typings/wallet-link/index.ts

@@ -0,0 +1,4 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+export type { IWalletLink } from "./IWalletLink";

package/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "@towns-labs/generated",
+    "version": "2.0.1",
+    "type": "module",
+    "scripts": {
+        "build": "bun ./scripts/prepare.js",
+        "build-types": "bash scripts/build-contract-types.sh",
+        "make-config": "bun ./scripts/make-config.js"
+    },
+    "dependencies": {
+        "@ethersproject/abi": "^5.8.0",
+        "@ethersproject/providers": "^5.8.0",
+        "ethers": "^5.8.0"
+    },
+    "devDependencies": {
+        "@towns-labs/contracts": "^2.0.0",
+        "@typechain/ethers-v5": "^11.1.2",
+        "typechain": "^8.3.2"
+    },
+    "files": [
+        "config/**/*",
+        "deployments/**/*",
+        "dev/**/*",
+        "scripts/**/*",
+        "v3/**/*",
+        "README.md"
+    ],
+    "imports": {
+        "#/dev/*": "./dev/*",
+        "#/v3/*": "./v3/*",
+        "#/deployments/*": "./deployments/*",
+        "#/config/*": "./config/*"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}

package/scripts/build-contract-types.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+set -ueo pipefail
+cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")"
+cd ..
+
+# Contracts package is a sibling directory
+CONTRACTS_DIR="../contracts"
+ABI_DIR="./dev/abis"
+TYPINGS_DIR="./dev/typings"
+
+# Run forge build in contracts directory (needs foundry.toml)
+(cd "$CONTRACTS_DIR" && forge build)
+
+CONTRACT_INTERFACES="(IDiamond|IDiamondCut|IArchitect|Architect|ILegacyArchitect|MockLegacyArchitect|IProxyManager|IPausable|IEntitlementsManager|EntitlementsManager|IChannel|Channels|IRoles|Roles|IMulticall|IRuleEntitlement|IRuleEntitlementV2|IWalletLink|WalletLink|INodeRegistry|NodeRegistry|IOperatorRegistry|OperatorRegistry|IStreamRegistry|StreamRegistry|OwnableFacet|TokenPausableFacet|UserEntitlement|SpaceOwner|MockERC721A|MembershipFacet|IMembershipMetadata|Member|IBanning|IPricingModules|ICrossChainEntitlement|MockEntitlementGated|IERC721AQueryable|IEntitlementDataQueryable|PlatformRequirementsFacet|IERC721A|INodeOperator|ISpaceDelegation|IEntitlementChecker|IERC5267|ICreateSpace|IDropFacet|DropFacet|ITownsPoints|ITipping|IReview|ITreasury|ISwapRouter|ISwapFacet|IAppRegistry|IAppAccount|ISimpleApp|ITownsApp|Towns|RewardsDistributionV2|MainnetDelegation|GuardianFacet|SubscriptionModuleFacet|IAppInstaller|IAppFactory|IIdentityRegistry|IReputationRegistry)"
+
+# Clean typings to avoid stale factories/interfaces lingering between runs
+rm -rf "$TYPINGS_DIR"
+bun run typechain --target=ethers-v5 "$CONTRACTS_DIR/out/**/?${CONTRACT_INTERFACES}.json" --out-dir "$TYPINGS_DIR"
+
+# Clean abis to avoid stale abi files lingering between runs
+rm -rf "$ABI_DIR"
+mkdir -p "$ABI_DIR"
+cp -a $CONTRACTS_DIR/out/{Diamond,DiamondCutFacet,Architect,MockLegacyArchitect,ProxyManager,IPausable,EntitlementsManager,Channels,Roles,IMulticall,OwnableFacet,WalletLink,MockWalletLink,NodeRegistry,OperatorRegistry,StreamRegistry,TokenPausableFacet,IRuleEntitlement,UserEntitlement,SpaceOwner,MockERC721A,MembershipFacet,IMembershipMetadata,Member,MockRiverRegistry,IBanning,IPricingModules,ICrossChainEntitlement,MockCrossChainEntitlement,MockEntitlementGated,IERC721AQueryable,IEntitlementDataQueryable,PlatformRequirementsFacet,IERC721A,INodeOperator,ISpaceDelegation,IEntitlementChecker,IEntitlementGated,IERC5267,ICreateSpace,DropFacet,ITownsPoints,ITipping,IReview,ITreasury,ISwapRouter,ISwapFacet,IAppRegistry,IAppAccount,ISimpleApp,ITownsApp,Towns,RewardsDistributionV2,MainnetDelegation,GuardianFacet,SubscriptionModuleFacet,IAppInstaller,IAppFactory,IIdentityRegistry,IReputationRegistry}.sol/*.abi.json "$ABI_DIR"
+
+# Copy the json abis to TS files for type inference
+for file in $ABI_DIR/*.abi.json; do
+  filename=$(basename "$file" .json)
+  echo "export default $(cat $file) as const" > $ABI_DIR/$filename.ts
+done
+
+# Generate contract hash for this artifact build
+echo "Generating contract hash..."
+SRC_HASH=$(git rev-parse HEAD:$CONTRACTS_DIR/src 2>/dev/null || echo "")
+BUILD_SCRIPT_HASH=$(git rev-parse HEAD:./scripts/build-contract-types.sh 2>/dev/null || echo "")
+
+if [ -n "$SRC_HASH" ] && [ -n "$BUILD_SCRIPT_HASH" ]; then
+  CONTRACTS_HASH="$SRC_HASH:$BUILD_SCRIPT_HASH"
+  echo "$CONTRACTS_HASH" > "./dev/.contracts-hash"
+  echo "Contract hash: $CONTRACTS_HASH"
+else
+  echo "Warning: Failed to generate contract hash (not in git repo or src not found)"
+fi

package/scripts/copy-addresses.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -euo pipefail
+cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")"
+cd ..
+
+rm -rf deployments
+rsync -av --exclude='*/addresses/facets' ../contracts/deployments/ deployments/
+
+# regenerate the config
+./scripts/make-config.sh

package/scripts/make-config.js

@@ -0,0 +1,95 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+const deploymentsOutputFile = 'config/deployments.json';
+const deploymentsSourceDir = 'deployments';
+
+// parse deployment folder jsons into a single json object
+function combineJson(dir) {
+  const outputData = {};
+  const files = fs.readdirSync(dir).filter(file => file.endsWith('.json'));
+  const subdirs = fs.readdirSync(dir).filter(subdir => fs.statSync(path.join(dir, subdir)).isDirectory());
+
+  const dirName = path.basename(dir);
+  // console.log(`Processing ${dirName} of ${dir}`);
+  
+  for (const file of files) {
+    if (!file.endsWith('.json')) {
+      continue;
+    }
+    const filePath = path.join(dir, file);
+    // console.log(`Reading ${filePath}`);
+    const fileData = JSON.parse(fs.readFileSync(filePath, 'utf8'));
+    const fileName = path.basename(file, '.json');
+    // if the file only has one property, just use that property
+    if (Object.keys(fileData).length === 1) {
+      outputData[fileName] = fileData[Object.keys(fileData)[0]];
+    } else {
+      outputData[fileName] = fileData;
+    }
+  }
+
+  for (const subdir of subdirs) {
+    const subdirPath = path.join(dir, subdir);
+    outputData[subdir] = combineJson(subdirPath); 
+  }
+  return outputData;
+}
+
+// helper for env var readability
+function keyToEnvKey(key) {
+  // convert camelCase to snake_case, handling acronyms properly
+  return key
+    .replace(/([a-z])([A-Z])/g, '$1_$2')  // insert _ between lowercase and uppercase
+    .replace(/([A-Z])([A-Z][a-z])/g, '$1_$2')  // insert _ between acronym and next word
+    .toUpperCase();
+}
+
+// convert a json object to a .env file content string
+function convertToEnv(data, prefix = '') {
+  // recursively walk nested objects, convert all keys to UPPER SNAKE CASE  and values set equal to value,
+  let envContent = ''
+  for (const key of Object.keys(data)) {
+    const value = data[key];
+    const envKey = `${prefix}${keyToEnvKey(key)}`;
+    if (typeof value === 'object') {
+      envContent += convertToEnv(value, `${envKey}_`);
+    } else {
+      envContent += `${envKey}=${String(value)}\n`;
+    }
+  }
+  return envContent;
+}
+
+function makeEnvFile(key, outputData, fileName, keyPrefix = '') {
+  const envFile = path.join(deploymentsSourceDir, key, fileName);
+  const data = outputData[key];
+  const envData = convertToEnv(data, keyPrefix);
+  fs.writeFileSync(envFile, `${keyPrefix}RIVER_ENV=${key}\n${envData}`);
+  return envFile;
+}
+
+const outputData = combineJson(deploymentsSourceDir);
+
+
+// for each top level key in outputData, write a .env file in the deployments/<key> folder
+// with all keys in the json converted to UPPER SNAKE CASE
+for (const key of Object.keys(outputData)) {
+  const files = [
+    makeEnvFile(key, outputData, '.env', ''), 
+    makeEnvFile(key, outputData, '.env.vite', 'VITE_')
+  ];
+  console.log(`Wrote "${key}" env files at ${files.join(', ')}`);
+}
+
+// delete the local_ environments from the outputData
+for (const key of Object.keys(outputData)) {
+  if (key.startsWith('local')) {
+    delete outputData[key];
+  }
+}
+
+// write a config.json file
+fs.mkdirSync(path.dirname(deploymentsOutputFile), { recursive: true });
+fs.writeFileSync(deploymentsOutputFile, JSON.stringify(outputData, null, 2));
+console.log(`Combined deployments for [${Object.keys(outputData).join(', ')}] JSON written to ${deploymentsOutputFile}`);

package/scripts/make-config.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -euo pipefail
+cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")"
+cd ..
+
+node ./scripts/make-config.js

package/scripts/prepare.js

@@ -0,0 +1,176 @@
+#!/usr/bin/env node
+
+/**
+ * CONTRACT ARTIFACT MANAGEMENT
+ *
+ * Strategy: Use checked-in artifacts, fallback to npm download or local generation.
+ *
+ * 1. Artifacts exist in dev/ → use them (checked into repo)
+ * 2. No artifacts → try npm download
+ * 3. npm fails → try local generation (requires contracts package)
+ */
+
+import { execSync } from 'child_process';
+import { existsSync, mkdirSync } from 'fs';
+import { resolve, dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { createRequire } from 'module';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const packageRoot = resolve(__dirname, '..');
+const contractsDir = resolve(packageRoot, '../contracts');
+const devDir = resolve(packageRoot, 'dev');
+const foundryPath = `${process.env.HOME}/.foundry/bin`;
+
+// Get current package version
+function getCurrentVersion() {
+  const require = createRequire(import.meta.url);
+  const packageJson = require('../package.json');
+  return packageJson.version;
+}
+
+// Check if generated files already exist
+function generatedFilesExist() {
+  return existsSync(resolve(devDir, 'abis')) && existsSync(resolve(devDir, 'typings'));
+}
+
+// Download artifacts from npm
+async function downloadArtifactsFromNpm() {
+  const currentVersion = getCurrentVersion();
+  if (!currentVersion) return false;
+
+  console.log(`Attempting npm download for version ${currentVersion}...`);
+
+  const tempDir = resolve(packageRoot, '.temp-download');
+
+  try {
+    if (existsSync(tempDir)) execSync(`rm -rf "${tempDir}"`, { stdio: 'pipe' });
+    mkdirSync(tempDir, { recursive: true });
+
+    execSync(`npm pack @towns-labs/generated@${currentVersion}`, {
+      cwd: tempDir, stdio: 'pipe'
+    });
+
+    const files = execSync('ls *.tgz', { cwd: tempDir, encoding: 'utf8' }).trim().split('\n');
+    execSync(`tar -xzf "${files[0]}" -C "${tempDir}"`, {
+      cwd: tempDir,
+      stdio: 'pipe'
+    });
+
+    const extractedDevDir = resolve(tempDir, 'package/dev');
+    if (!existsSync(extractedDevDir)) {
+      console.log('Downloaded package missing dev/ directory');
+      return false;
+    }
+
+    if (!existsSync(devDir)) mkdirSync(devDir, { recursive: true });
+    execSync(`cp -r "${extractedDevDir}/." "${devDir}/"`, { stdio: 'pipe' });
+
+    console.log('Successfully downloaded artifacts from npm');
+    return true;
+  } catch (error) {
+    console.log('npm download failed:', error.message);
+    return false;
+  } finally {
+    if (existsSync(tempDir)) execSync(`rm -rf "${tempDir}"`, { stdio: 'pipe' });
+  }
+}
+
+// Check if Foundry is installed
+function isFoundryInstalled() {
+  try {
+    execSync('forge --version', { stdio: 'pipe' });
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+// Install Foundry if not present
+function installFoundry() {
+  console.log('Installing Foundry...');
+  try {
+    execSync('curl -L https://foundry.paradigm.xyz | bash', { stdio: 'inherit' });
+    execSync(`${foundryPath}/foundryup`, { stdio: 'inherit' });
+    console.log('Foundry installation completed');
+    return true;
+  } catch (error) {
+    console.log('Foundry installation failed:', error.message);
+    return false;
+  }
+}
+
+// Check if forge build artifacts exist
+function forgeArtifactsExist() {
+  const outDir = resolve(contractsDir, 'out');
+  if (!existsSync(outDir)) return false;
+
+  try {
+    const result = execSync(`find "${outDir}" -name "*.json" -type f | head -1`, {
+      encoding: 'utf8',
+      stdio: 'pipe'
+    }).trim();
+    return result.length > 0;
+  } catch {
+    return false;
+  }
+}
+
+// Generate contract artifacts (last resort fallback)
+function generateArtifacts() {
+  if (!existsSync(contractsDir)) {
+    throw new Error('Cannot generate artifacts: contracts package not available and npm download failed');
+  }
+
+  if (!forgeArtifactsExist()) {
+    throw new Error('Cannot generate artifacts: no forge build output in contracts/out/');
+  }
+
+  if (!isFoundryInstalled()) {
+    console.log('Foundry not found, attempting installation...');
+    if (!installFoundry()) {
+      throw new Error('Failed to install Foundry - cannot generate contract artifacts');
+    }
+  }
+
+  const buildScript = resolve(packageRoot, 'scripts/build-contract-types.sh');
+  if (!existsSync(buildScript)) {
+    throw new Error(`Build script not found at ${buildScript}`);
+  }
+
+  const envWithFoundry = {
+    ...process.env,
+    PATH: `${foundryPath}:${process.env.PATH}`
+  };
+
+  execSync(`bash ${buildScript}`, {
+    cwd: packageRoot,
+    stdio: 'inherit',
+    env: envWithFoundry
+  });
+}
+
+// Main logic
+async function main() {
+  // If generated files exist (checked into repo), use them as-is
+  if (generatedFilesExist()) {
+    console.log('Using checked-in artifacts from dev/');
+    return;
+  }
+
+  // No artifacts found - try npm download
+  console.log('No artifacts found, trying npm download...');
+  if (await downloadArtifactsFromNpm()) {
+    console.log('Using artifacts from npm');
+    return;
+  }
+
+  // npm download failed - try local generation as last resort
+  console.log('NPM download failed, attempting local generation...');
+  generateArtifacts();
+}
+
+main().catch(error => {
+  console.error('Preparation failed:', error.message);
+  process.exit(1);
+});

package/v3/abis/IERC5267.abi.json

@@ -0,0 +1,51 @@
+[
+  {
+    "type": "function",
+    "name": "eip712Domain",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "fields",
+        "type": "bytes1",
+        "internalType": "bytes1"
+      },
+      {
+        "name": "name",
+        "type": "string",
+        "internalType": "string"
+      },
+      {
+        "name": "version",
+        "type": "string",
+        "internalType": "string"
+      },
+      {
+        "name": "chainId",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "verifyingContract",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "salt",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "extensions",
+        "type": "uint256[]",
+        "internalType": "uint256[]"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "event",
+    "name": "EIP712DomainChanged",
+    "inputs": [],
+    "anonymous": false
+  }
+]

package/v3/abis/IERC5267.abi.ts

@@ -0,0 +1,51 @@
+export default [
+  {
+    "type": "function",
+    "name": "eip712Domain",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "fields",
+        "type": "bytes1",
+        "internalType": "bytes1"
+      },
+      {
+        "name": "name",
+        "type": "string",
+        "internalType": "string"
+      },
+      {
+        "name": "version",
+        "type": "string",
+        "internalType": "string"
+      },
+      {
+        "name": "chainId",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "verifyingContract",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "salt",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "extensions",
+        "type": "uint256[]",
+        "internalType": "uint256[]"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "event",
+    "name": "EIP712DomainChanged",
+    "inputs": [],
+    "anonymous": false
+  }
+] as const