feat: new infra for code snippets

.changeset/config.json

@@ -17,6 +17,7 @@
     "demo-node-esm",
     "demo-typegen",
     "@fuel-ts/docs-snippets",
+    "@fuel-ts/docs-snippets2",
     "template-nextjs",
     "create-fuels-counter-guide",
     "demo-wallet-sdk-react"

.changeset/lemon-cars-shop.md

@@ -0,0 +1,4 @@
+---
+---
+
+feat: new infra for code snippets

.eslintignore

@@ -12,6 +12,8 @@ apps/demo-nextjs
 apps/demo-react-cra
 apps/demo-react-vite
 apps/create-fuels-counter-guide
+apps/docs-snippets2/src/typegend
+apps/docs-snippets2/src/**/*.wrapped.ts
 
 packages/fuels/test/fixtures/project
 packages/account/src/providers/__generated__

.knip.json

@@ -5,6 +5,7 @@
     "/apps/docs/*",
     "/packages/abi-typegen/test/**",
     "templates/**",
+    "/apps/docs-snippets2/**/*.test.ts",
     "apps/create-fuels-counter-guide/**"
   ],
   "ignoreDependencies": [

apps/docs-snippets2/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: ['../../.eslintrc.js'],
+  rules: {
+    'no-console': 'off',
+  },
+};

apps/docs-snippets2/.gitignore

@@ -0,0 +1,2 @@
+src/typegend
+*.wrapped.ts

apps/docs-snippets2/fuels.config.ts

@@ -0,0 +1,9 @@
+import { createConfig } from 'fuels';
+
+export default createConfig({
+  workspace: './sway',
+  output: './src/typegend',
+  forcBuildFlags: ['--release'],
+  forcPath: 'fuels-forc',
+  fuelCorePath: 'fuels-core',
+});

apps/docs-snippets2/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@fuel-ts/docs-snippets2",
+  "version": "0.67.0",
+  "description": "",
+  "private": true,
+  "scripts": {
+    "build": "run-s wrap:snippets build:forc",
+    "build:forc": "pnpm fuels build",
+    "wrap:snippets": "tsx scripts/wrap-snippets.ts",
+    "pretest": "pnpm build",
+    "test": "cd ../.. && pnpm run test:filter apps/docs-snippets2"
+  },
+  "dependencies": {
+    "fuels": "workspace:*"
+  },
+  "devDependencies": {
+    "glob": "^10.2.6"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

apps/docs-snippets2/scripts/launcher.ts

@@ -0,0 +1,16 @@
+import { launchTestNode } from 'fuels/test-utils';
+
+using node = await launchTestNode({ walletsConfig: { count: 3 } });
+
+export const LOCAL_NETWORK_URL = node.provider.url;
+
+const [w0, w2, w3] = node.wallets;
+
+export const WALLET_ADDRESS = w0.address;
+export const WALLET_PVT_KEY = w0.privateKey;
+
+export const WALLET_ADDRESS_2 = w2.address;
+export const WALLET_PVT_KEY_2 = w2.privateKey;
+
+export const WALLET_ADDRESS_3 = w3.address;
+export const WALLET_PVT_KEY_3 = w3.privateKey;

apps/docs-snippets2/scripts/wrap-snippets.ts

@@ -0,0 +1,88 @@
+import { readFileSync, writeFileSync } from 'fs';
+import { globSync } from 'glob';
+import { join } from 'path';
+
+const wrapperFnFilepath = join(__dirname, 'wrapper-fn.ts');
+const wrapperFnContents = readFileSync(wrapperFnFilepath, 'utf-8');
+
+/**
+ * Wrap snippet for testing
+ * @param filepath - Snippet filepath
+ */
+export const wrapSnippet = (filepath: string) => {
+  const snippetContents = readFileSync(filepath, 'utf8');
+
+  /*
+    Filter all imports from file.
+  */
+  const importsReg = /^[\s\S]+from.+['"];/gm;
+  let imports = snippetContents.match(importsReg)?.toString() ?? '';
+  const snippetsNoImports = imports.length ? snippetContents.split(imports)[1] : snippetContents;
+
+  /*
+    Removes .env file import
+  */
+  const envImportReg = /import.+\{.+([\s\S]+).+\}.+from.+'\.\.\/env';/gm;
+  if (envImportReg.test(imports)) {
+    const allImports = imports.match(envImportReg)?.[0];
+    const envImport = `import ${allImports?.split('import ').pop()}`;
+    imports = imports.replace(envImport, '');
+  }
+
+  /*
+    Inject node launcher & friends
+  */
+  let nodeLauncher = '';
+  const localNetworkReg = /,?\s+LOCAL_NETWORK_URL(\s*,)?/;
+  if (localNetworkReg.test(imports)) {
+    /*
+      Removes `LOCAL_NETWORK_URL` from `fuels` import members
+    */
+    imports = imports.replace(localNetworkReg, '$1');
+
+    /*
+     Adds launchNode import
+   */
+    imports += `\nimport { launchTestNode } from 'fuels/test-utils'`;
+
+    /*
+      Injects launched node and env constants
+    */
+    nodeLauncher = readFileSync(join(__dirname, 'launcher.ts'), 'utf-8')
+      .replace(/import.*$/gm, '') // ignore file imports
+      .replace(/export /g, '') // remove export keywords
+      .trim() // zip
+      .replace(/\n/g, '\n  '); // indent chunk
+  }
+
+  /*
+    Format indentation
+  */
+  const indented = snippetsNoImports.replace(/^/gm, '    ').trim();
+  const formatted = wrapperFnContents
+    .replace('// %SNIPPET%', indented)
+    .replace('// %NODE_LAUNCHER%', nodeLauncher);
+
+  /*
+    Write wrapped snippet to disk
+  */
+  const wrappedPath = filepath.replace('.ts', '.wrapped.ts');
+  const wrappedSnippet = [imports, '\n', formatted].join('');
+
+  writeFileSync(wrappedPath, wrappedSnippet);
+};
+
+/*
+  Wrap all snippets inside `src` dir
+*/
+const dir = 'src/**';
+const src = `${dir}/*.ts`;
+const ignore = [
+  `src/typegend/**`,
+  `src/env.ts`,
+  `src/transactions/new-api.ts`,
+  `${dir}/*.test.ts`,
+  `${dir}/*.wrapped.ts`,
+];
+
+globSync(src, { ignore }).forEach(wrapSnippet);

apps/docs-snippets2/scripts/wrapper-fn.ts

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+// eslint-disable-next-line @typescript-eslint/require-await
+export const main = async (passLogsThrough: boolean = false): Promise<any | any[]> => {
+  const logs: any[] = [];
+  const bkpConsole = console;
+
+  // eslint-disable-next-line no-global-assign
+  console = {
+    ...console,
+    log: (...args: any[]) => {
+      if (passLogsThrough) {
+        bkpConsole.log.apply(null, args);
+      }
+      logs.push(args);
+    },
+  };
+
+  // TEST NODE LAUNCHER ———>>>
+  // %NODE_LAUNCHER%
+  // <<<——— TEST NODE LAUNCHER
+
+  try {
+    // SNIPPET ———>>>
+    // %SNIPPET%
+    // <<<——— SNIPPET
+  } catch (error) {
+    console.error(error);
+    return { error };
+  }
+
+  // eslint-disable-next-line no-global-assign
+  console = bkpConsole;
+
+  return logs;
+};

apps/docs-snippets2/src/env.ts

@@ -0,0 +1,8 @@
+export const WALLET_ADDRESS = '<overriden-by-wrapper>';
+export const WALLET_PVT_KEY = '<overriden-by-wrapper>';
+
+export const WALLET_ADDRESS_2 = '<overriden-by-wrapper>';
+export const WALLET_PVT_KEY_2 = '<overriden-by-wrapper>';
+
+export const WALLET_ADDRESS_3 = '<overriden-by-wrapper>';
+export const WALLET_PVT_KEY_3 = '<overriden-by-wrapper>';

apps/docs-snippets2/src/introduction/connecting-to-localnode.test.ts

@@ -0,0 +1,9 @@
+import { main } from './connecting-to-localnode.wrapped';
+
+/**
+ * @group node
+ */
+test('it works', async () => {
+  const [[{ balances }]] = await main();
+  expect(balances).toBeInstanceOf(Array);
+});

apps/docs-snippets2/src/introduction/connecting-to-localnode.ts

@@ -0,0 +1,12 @@
+// #region main
+import { Provider, Wallet, LOCAL_NETWORK_URL } from 'fuels';
+
+const ADDRESS = '0x767caf5b08eba21c561078a4d5be09bbd7f16b9eca22699a61f1edd9e456126f';
+
+const provider = await Provider.create(LOCAL_NETWORK_URL);
+const wallet = Wallet.fromAddress(ADDRESS, provider);
+
+const { balances } = await wallet.getBalances();
+
+console.log({ balances });
+// #endregion main

apps/docs-snippets2/src/introduction/connecting-to-testnet.test.ts

@@ -0,0 +1,9 @@
+import { main } from './connecting-to-testnet.wrapped';
+
+/**
+ * @group node
+ */
+test('it works', async () => {
+  const [[{ balances }]] = await main();
+  expect(balances).toBeInstanceOf(Array);
+});

apps/docs-snippets2/src/introduction/connecting-to-testnet.ts

@@ -0,0 +1,12 @@
+// #region main
+import { Provider, Wallet, TESTNET_NETWORK_URL } from 'fuels';
+
+const ADDRESS = '0x767caf5b08eba21c561078a4d5be09bbd7f16b9eca22699a61f1edd9e456126f';
+
+const provider = await Provider.create(TESTNET_NETWORK_URL);
+const wallet = Wallet.fromAddress(ADDRESS, provider);
+
+const { balances } = await wallet.getBalances();
+
+console.log({ balances });
+// #endregion main

apps/docs-snippets2/src/transactions/transaction-parameters.test.ts

@@ -0,0 +1,9 @@
+import { main } from './transaction-parameters.wrapped';
+
+/**
+ * @group node
+ */
+test('it works', async () => {
+  const [[{ isStatusSuccess }]] = await main();
+  expect(isStatusSuccess).toBeTruthy();
+});

apps/docs-snippets2/src/transactions/transaction-parameters.ts

@@ -0,0 +1,61 @@
+// #region full
+import type { TxParams } from 'fuels';
+import { bn, LOCAL_NETWORK_URL, Provider, ScriptTransactionRequest, Wallet } from 'fuels';
+
+import { WALLET_PVT_KEY } from '../env';
+import { CounterAbi__factory } from '../typegend';
+import counterBytecode from '../typegend/contracts/CounterAbi.hex';
+import { ScriptSumAbi__factory } from '../typegend/scripts';
+
+const { storageSlots } = CounterAbi__factory;
+
+const provider = await Provider.create(LOCAL_NETWORK_URL);
+const wallet = Wallet.fromPrivateKey(WALLET_PVT_KEY, provider);
+
+const deploy = await CounterAbi__factory.deployContract(counterBytecode, wallet, {
+  storageSlots,
+});
+
+const { contract } = await deploy.waitForResult();
+
+// #region transaction-parameters-6
+const txParams: TxParams = {
+  // #region transaction-parameters-1
+  gasLimit: bn(69242),
+  // #endregion transaction-parameters-1
+  // #region transaction-parameters-2
+  maxFee: bn(69242),
+  // #endregion transaction-parameters-2
+  // #region transaction-parameters-3
+  tip: bn(100),
+  // #endregion transaction-parameters-3
+  // #region transaction-parameters-4
+  maturity: 1,
+  // #endregion transaction-parameters-4
+  // #region transaction-parameters-5
+  witnessLimit: bn(5000),
+  // #endregion transaction-parameters-5
+};
+// #endregion transaction-parameters-6
+
+// #region transaction-parameters-7
+const transactionRequest = new ScriptTransactionRequest({
+  script: ScriptSumAbi__factory.bin,
+  gasLimit: 100,
+});
+// #endregion transaction-parameters-7
+
+// #region transaction-parameters-8
+const { waitForResult } = await contract.functions
+  .increment_count(15) //
+  .txParams(txParams)
+  .call();
+
+const {
+  value,
+  transactionResult: { isStatusSuccess },
+} = await waitForResult();
+
+console.log({ value, isStatusSuccess, transactionRequest });
+// #endregion transaction-parameters-8
+// #endregion full

apps/docs-snippets2/sway/.gitignore

@@ -0,0 +1,2 @@
+out
+target

apps/docs-snippets2/sway/Forc.toml

@@ -0,0 +1,2 @@
+[workspace]
+members = ["counter", "script-sum"]

apps/docs-snippets2/sway/counter/Forc.toml

@@ -0,0 +1,7 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "counter"
+
+[dependencies]

apps/docs-snippets2/sway/counter/src/main.sw

@@ -0,0 +1,27 @@
+contract;
+
+abi Counter {
+    #[storage(read)]
+    fn get_count() -> u64;
+
+    #[storage(write, read)]
+    fn increment_count(amount: u64) -> u64;
+}
+
+storage {
+    counter: u64 = 0,
+}
+
+impl Counter for Contract {
+    #[storage(read)]
+    fn get_count() -> u64 {
+        storage.counter.read()
+    }
+
+    #[storage(write, read)]
+    fn increment_count(amount: u64) -> u64 {
+        let current = storage.counter.read();
+        storage.counter.write(current + amount);
+        storage.counter.read()
+    }
+}

apps/docs-snippets2/sway/script-sum/Forc.toml

@@ -0,0 +1,7 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "script-sum"
+
+[dependencies]