refactor: create common library for predicated connectors

.changeset/mean-yaks-decide.md

@@ -0,0 +1,8 @@
+---
+"@fuel-connectors/walletconnect-connector": minor
+"@fuel-connectors/solana-connector": minor
+"@fuel-connectors/evm-connector": minor
+"@fuel-connectors/common": minor
+---
+
+Added a new package with helper classes/functions for predicated connectors since they share a fair ammount of core logic.

.gitignore

@@ -18,3 +18,6 @@ yarn-error.log*
 # Misc
 .DS_Store
 .zed
+
+# Sway
+**/out/release

.npmrc

@@ -1 +1,2 @@
 save-exact = true
+enable-pre-post-scripts = true

biome.json

@@ -43,6 +43,7 @@
       "**/.turbo",
       "**/build",
       "**/contracts",
+      "**/examples/react-next/.next",
       "pnpm-lock.yaml",
       "**/examples/react-app/src/types",
       "**/examples/react-next/.next",

package.json

@@ -25,13 +25,13 @@
     "@changesets/cli": "2.27.1",
     "@fuels/ts-config": "0.20.0",
     "@fuels/tsup-config": "0.20.0",
-    "@vitest/coverage-v8": "1.6.0",
+    "@vitest/coverage-v8": "2.0.2",
     "compare-versions": "6.1.0",
     "husky": "9.0.11",
     "lint-staged": "15.2.2",
     "tsx": "^4.16.2",
-    "turbo": "1.13.3",
-    "vitest": "1.6.0"
+    "turbo": "2.0.11",
+    "vitest": "2.0.2"
   },
   "engines": {
     "node": ">=18",
@@ -45,5 +45,6 @@
       "ws@>=6.0.0 <6.2.3": ">=6.2.3",
       "fast-xml-parser@<4.4.1": ">=4.4.1"
     }
-  }
+  },
+  "packageManager": "[email protected]"
 }

packages/burner-wallet-connector/package.json

@@ -24,6 +24,6 @@
     "typescript": "5.4.5",
     "vite": "5.2.11",
     "vite-plugin-dts": "3.9.1",
-    "vitest": "1.6.0"
+    "vitest": "2.0.2"
   }
 }

packages/common/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@fuel-connectors/common",
+  "version": "0.0.1",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    },
+    "./scripts": {
+      "require": "./dist/scripts/index.js",
+      "import": "./dist/scripts/index.mjs",
+      "types": "./dist/scripts/index.d.ts"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsup --dts",
+    "ts:check": "tsc --noEmit",
+    "test": "vitest"
+  },
+  "peerDependencies": {
+    "fuels": ">=0.93.0"
+  },
+  "dependencies": {
+    "@ethersproject/bytes": "5.7.0",
+    "@solana/web3.js": "1.93.2",
+    "bs58": "6.0.0",
+    "memoizee": "0.4.15",
+    "tweetnacl": "1.0.3",
+    "viem": "2.19.1"
+  },
+  "devDependencies": {
+    "@types/memoizee": "0.4.11",
+    "fuels": "0.93.0",
+    "terser": "5.31.0",
+    "tsup": "8.0.2",
+    "typescript": "5.4.5",
+    "vitest": "2.0.2"
+  }
+}

packages/common/scripts/index.ts

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

packages/common/scripts/versions.ts

@@ -0,0 +1,105 @@
+import fs from 'node:fs';
+import { getPredicateRoot } from 'fuels';
+
+// When running pnpm fuels:build, the build script creates files
+// differently than when running pnpm fuels:typegen
+export const checkForcBuild = async (__dirname: string) => {
+  const predicatePath = `${__dirname}/factories`;
+  if (!fs.existsSync(predicatePath)) {
+    console.info('No new predicate found. Ignoring...');
+    return;
+  }
+
+  console.info('New predicate found. Moving to new folder...');
+  const rightPath = `${__dirname}/new`;
+  if (fs.existsSync(rightPath)) await addPredicate(__dirname);
+
+  fs.mkdirSync(rightPath);
+  fs.renameSync(predicatePath, `${rightPath}/factories`);
+  fs.writeFileSync(
+    `${rightPath}/index.ts`,
+    `export { VerificationPredicateAbi__factory } from './factories/VerificationPredicateAbi__factory';`,
+  );
+  console.info('Predicate moved to new folder.');
+};
+
+export const addPredicate = async (__dirname: string) => {
+  const predicatePath = `${__dirname}/new`;
+  if (!fs.existsSync(predicatePath)) {
+    console.info('No new predicate found. Ignoring...');
+    return;
+  }
+
+  const { VerificationPredicateAbi__factory: predicate } = await import(
+    predicatePath
+  );
+  const version = getPredicateRoot(predicate.bin);
+  const newPath = `${__dirname}/${version}`;
+  if (fs.existsSync(newPath)) {
+    console.warn(`Predicate already exists: ${version}`);
+    console.warn('Removing new folder..');
+    fs.rmSync(predicatePath, { recursive: true, force: true });
+    return;
+  }
+
+  fs.mkdirSync(newPath);
+
+  const date = new Date();
+  const code = [
+    '/* Autogenerated file. Do not edit manually. */',
+    '',
+    `export const generationDate = ${date.getTime().toString()};`,
+    '// biome-ignore lint: Autogenerated file',
+    `export const abi = ${JSON.stringify(predicate.abi)};`,
+    `export const bin = '${predicate.bin}';`,
+  ];
+
+  fs.appendFileSync(`${newPath}/index.ts`, code.join('\n'));
+  fs.rmSync(predicatePath, { recursive: true, force: true });
+  console.info(`Predicate added: ${version}`);
+};
+
+export const syncPredicate = async (__dirname: string) => {
+  const dictPath = `${__dirname}/index.ts`;
+  const header =
+    "/* Autogenerated file. Do not edit manually. */\n\nimport type { PredicateVersion } from '@fuel-connectors/common';\n";
+  fs.writeFileSync(dictPath, header);
+
+  const versions = await Promise.all(
+    fs
+      .readdirSync(__dirname)
+      .filter((f) => !f.includes('.ts'))
+      .map(async (f) => {
+        const { generationDate, abi, bin } = await import(
+          `${__dirname}/${f}/index.ts`
+        );
+        return { abi, bin, date: generationDate, version: f };
+      }),
+  );
+  if (versions.length === 0) {
+    console.warn('No predicates found.');
+    return;
+  }
+
+  const headers = versions.map(
+    (v) =>
+      `import { abi as abi${v.date}, bin as bin${v.date}, generationDate as generationDate${v.date}} from './${v.version}';`,
+  );
+
+  const code = `\n\nexport const PREDICATE_VERSIONS = {\n${versions
+    .map(
+      (v) =>
+        `\t'${v.version}':{ predicate: {abi: abi${v.date}, bin: bin${v.date}}, generatedAt: generationDate${v.date} }`,
+    )
+    .join(',\n')}
+} as Record<string, PredicateVersion>;\n`;
+  fs.appendFileSync(dictPath, `${headers.join('\n')}${code}`);
+  console.info('Dictionary updated.');
+};
+
+export const generateVersions = async (__dirname: string) => {
+  await checkForcBuild(__dirname);
+  await addPredicate(__dirname);
+  await syncPredicate(__dirname);
+  console.info('Done.');
+};

packages/common/src/FakeAccount.ts

@@ -0,0 +1,68 @@
+import { Keypair } from '@solana/web3.js';
+import nacl from 'tweetnacl';
+import { type PrivateKeyAccount, privateKeyToAccount } from 'viem/accounts';
+import type { Hash, Option } from './types';
+
+export interface FakeAccount {
+  generate: () => void;
+  getAddress: () => Option<string, Hash>;
+  getRawAddress: () => Uint8Array;
+  signMessage: (
+    message: Option<string, Uint8Array, Hash>,
+  ) => Promise<Option<string, Uint8Array, Hash>>;
+}
+
+export class EthereumFakeAccount implements FakeAccount {
+  private account!: PrivateKeyAccount;
+  constructor() {
+    this.generate();
+  }
+
+  generate = (): void => {
+    this.account = privateKeyToAccount(
+      '0x0000000000000000000000000000000000000000000000000000000000000001',
+    );
+  };
+
+  getAddress = (): Option<string, Hash> => this.account.address;
+  getRawAddress = (): Uint8Array =>
+    Buffer.from(this.account.address.slice(2), 'hex');
+
+  signMessage = (
+    message: Option<string, Uint8Array, Hash>,
+  ): Promise<Option<string, Uint8Array, Hash>> => {
+    return this.account.signMessage({
+      message: message as string,
+    });
+  };
+}
+
+export class SolanaFakeAccount implements FakeAccount {
+  private keypair!: Keypair;
+  constructor() {
+    this.generate();
+  }
+
+  generate = (): void => {
+    this.keypair = Keypair.generate();
+  };
+
+  getAddress = (): Option<string, Hash> => this.keypair.publicKey.toString();
+  getRawAddress = (): Uint8Array => this.keypair.publicKey.toBytes();
+
+  private getSmallTxId = (
+    message: Option<string, Uint8Array, Hash>,
+  ): Uint8Array => {
+    const txIdNo0x = message.slice(2);
+    const idBytes = `${txIdNo0x.slice(0, 16)}${txIdNo0x.slice(-16)}`;
+    return new TextEncoder().encode(idBytes);
+  };
+
+  signMessage = (
+    message: Option<string, Uint8Array, Hash>,
+  ): Promise<Option<string, Uint8Array, Hash>> => {
+    return Promise.resolve(
+      nacl.sign.detached(this.getSmallTxId(message), this.keypair.secretKey),
+    );
+  };
+}