chore: add portal project (#145)

### Tasks

- [x] Change from NodeJS `18.14` to `18.19`
- [x] Remove indexer-related files
- [x] Remove old docker configuration
- [x] Fix/improve tooling configuration (eslint, tsconfig)
- [x] Bring portal project for explorer
    - [x] Adapt `package.json` to run scripts from both projects
    - [x] Rename folder to `app-explorer` and `app-portal`
    - [x] Add `docker/` from portal
    - [x] Add `scripts/` from portal
    - [x] Test if is running properly
- [x] Adjust github-actions to have both projects accordingly
- [x] Adjust `vercel.config` to deploy both project

Author: pedronauck

.eslintignore

@@ -1,25 +1,31 @@
-.changeset
-.eslintrc.js
-.lintstagedrc.js
-node_modules
-**/node_modules/**
+**/**/.*
+**/build/**
 **/coverage/
-dist
 **/dist/**
-build
-**/build/**
-CHANGELOG.md
-*.typegen.ts
-*.html
-.next/*
-generated
+**/fuel-v2-contracts
 **/generated/**
-storybook
+**/node_modules/**
+**/public/storybook/**
+**/public/ui/**
+**/storybook-static
+**/storybook-static/**
 **/storybook/**
+*.html
+*.typegen.ts
+.changeset
+.eslintrc.js
+.lintstagedrc.js
+.next/*
 .turbo
+CHANGELOG.md
+build
+dist
+generated
+generated
+node_modules
+packages/app-portal/public/**
+packages/app-portal/src/types
 pnpm-lock.yaml
-**/**/.*
-.*/
-packages/app/public/**
-contracts/predicate/vitest.config.ts
-./tailwind.config.ts
+scripts/bridge/fuel-bridge
+**/**/tsconfig.json
+**.js

.eslintrc.js

@@ -1,11 +1,4 @@
-const { resolve } = require('path');
-const { dependencies } = require('./packages/app/package.json');
-
-const project = [
-  resolve(__dirname, './tsconfig.json'),
-  resolve(__dirname, './packages/**/tsconfig.json'),
-  resolve(__dirname, './contracts/**/tsconfig.json'),
-];
+const { dependencies } = require('./packages/app-explorer/package.json');
 
 module.exports = {
   root: true,
@@ -16,7 +9,6 @@ module.exports = {
   ],
   parserOptions: {
     tsconfigRootDir: __dirname,
-    project,
   },
   settings: {
     react: {
@@ -29,7 +21,6 @@ module.exports = {
       },
       [require.resolve('eslint-import-resolver-typescript')]: {
         alwaysTryTypes: true,
-        project,
       },
     },
   },
@@ -40,6 +31,7 @@ module.exports = {
       { prefer: 'type-imports', fixStyle: 'separate-type-imports' },
     ],
     'import/consistent-type-specifier-style': ['error', 'prefer-top-level'],
+    'import/namespace': 'off',
     'import/order': [
       'error',
       {

.lintstagedrc.mjs

@@ -1,13 +1,4 @@
-import { getTsconfig } from 'get-tsconfig';
-import { relative } from 'node:path';
-
 export default {
   '**/*.(js|jsx|ts|jsx|md|mdx|json|html|css)': ['prettier --write'],
-  '**/*.ts?(x)': (files) => {
-    const commands = files.flatMap((file) => {
-      const tsConfig = relative(process.cwd(), getTsconfig(file).path);
-      return [`tsc -p ${tsConfig} --noEmit`, `eslint .`];
-    });
-    return Array.from(new Set(commands));
-  },
+  '**/*.ts?(x)': ['eslint'],
 };

.npmrc

@@ -1,4 +1,4 @@
-node-version=18.19.0
+node-version=20.11.0
 
 # Not always possible to be strict, but if it works for you, keep it to true.
 # https://pnpm.io/next/npmrc#strict-peer-dependencies

.nvmrc

@@ -1 +1 @@
-18.19.0
+20.11.0

.prettierignore

@@ -1,25 +1,25 @@
-.changeset
-**/node_modules/
+**/**/.*
+**/build/**
 **/coverage/
-dist
 **/dist/**
-build
-**/build/**
-CHANGELOG.md
-*.typegen.ts
-*.html
-.next/*
-generated
+**/fuel-v2-contracts
 **/generated/**
-storybook
-**/storybook/**
-storybook-static
-**/storybook-static/**
-**/public/ui/**
+**/node_modules/**
 **/public/storybook/**
+**/public/ui/**
+**/storybook-static
+**/storybook-static/**
+**/storybook/**
+*.typegen.ts
+.next/*
 .turbo
-pnpm-lock.yaml
-.next
-graphql.schema.json
+CHANGELOG.md
+build
+dist
+generated
 helm
-packages/graphql/src/schemas/*.graphql
+node_modules
+packages/app-portal/public/**
+packages/app-portal/src/types
+pnpm-lock.yaml
+scripts/bridge/fuel-bridge

.prettierrc

@@ -0,0 +1,17 @@
+const fuelPrettierConfig = require('@fuels/prettier-config');
+
+/** @type {import("prettier").Config} */
+module.exports = {
+  ...fuelPrettierConfig,
+  // trailingComma always adds comma on the end of functions params, that can cause
+  // issues, when a second param can't be undefined.
+  trailingComma: 'es5',
+  overrides: [
+    {
+      files: '*.json',
+      options: {
+        trailingComma: 'none',
+      },
+    },
+  ],
+};

.prettierrc.js

@@ -4,7 +4,6 @@
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
   },
-  "rust-analyzer.linkedProjects": ["./packages/indexer/Cargo.toml"],
   "editor.quickSuggestions": {
     "strings": "on"
   },

.vscode/settings.json

@@ -3,20 +3,40 @@
 
 ## 📗 Table of contents
 
-- [Getting Started](./docs/GETTING_STARTED.md)
-  - [Requirements](./docs/GETTING_STARTED.md#requirements)
-  - [Running Project Locally](./docs/GETTING_STARTED.md#running-project-locally)
-    - [📚 - Getting the Repository](./docs/GETTING_STARTED.md#---getting-the-repository)
-    - [📦 - Install Dependencies](./docs/GETTING_STARTED.md#---install-dependencies)
-    - [📒 - Run Local Node](./docs/GETTING_STARTED.md#---run-local-node)
-    - [💻 - Run Web App](./docs/GETTING_STARTED.md#---run-web-app)
-  - [📗 Project Overview](./docs/GETTING_STARTED.md#-project-overview)
-  - [🧰 Useful Scripts](./docs/GETTING_STARTED.md#-useful-scripts)
-  - [Running Tests](./docs/GETTING_STARTED.md#run-tests)
-    - [Run Tests in Development Mode](./docs/GETTING_STARTED.md#run-tests)
-- [Contribution Guide](./docs/CONTRIBUTING.md)
-  - [Finding Something to Work On](./docs/CONTRIBUTING.md#finding-something-to-work-on)
-  - [Contribution Flow](./docs/CONTRIBUTING.md#contribution-flow)
+### Explorer
+
+- [Getting Started](./docs/explorer/GETTING_STARTED.md)
+  - [Requirements](./docs/explorer/GETTING_STARTED.md#requirements)
+  - [Running Project Locally](./docs/explorer/GETTING_STARTED.md#running-project-locally)
+    - [📚 - Getting the Repository](./docs/explorer/GETTING_STARTED.md#---getting-the-repository)
+    - [📦 - Install Dependencies](./docs/explorer/GETTING_STARTED.md#---install-dependencies)
+    - [📒 - Run Local Node](./docs/explorer/GETTING_STARTED.md#---run-local-node)
+    - [💻 - Run Web App](./docs/explorer/GETTING_STARTED.md#---run-web-app)
+  - [📗 Project Overview](./docs/explorer/GETTING_STARTED.md#-project-overview)
+  - [🧰 Useful Scripts](./docs/explorer/GETTING_STARTED.md#-useful-scripts)
+  - [Running Tests](./docs/explorer/GETTING_STARTED.md#run-tests)
+    - [Run Tests in Development Mode](./docs/explorer/GETTING_STARTED.md#run-tests)
+- [Contribution Guide](./docs/explorer/CONTRIBUTING.md)
+  - [Finding Something to Work On](./docs/explorer/CONTRIBUTING.md#finding-something-to-work-on)
+  - [Contribution Flow](./docs/explorer/CONTRIBUTING.md#contribution-flow)
+- [License](#license)
+
+### Portal
+
+- [Getting Started](./docs/portal/GETTING_STARTED.md)
+  - [Requirements](./docs/portal/GETTING_STARTED.md#requirements)
+  - [Running Project Locally](./docs/portal/GETTING_STARTED.md#running-project-locally)
+    - [📚 - Getting the Repository](./docs/portal/GETTING_STARTED.md#---getting-the-repository)
+    - [📦 - Install Dependencies](./docs/portal/GETTING_STARTED.md#---install-dependencies)
+    - [📒 - Run Local Node](./docs/portal/GETTING_STARTED.md#---run-local-node)
+    - [💻 - Run Web App](./docs/portal/GETTING_STARTED.md#---run-web-app)
+  - [📗 Project Overview](./docs/portal/GETTING_STARTED.md#-project-overview)
+  - [🧰 Useful Scripts](./docs/portal/GETTING_STARTED.md#-useful-scripts)
+  - [Running Tests](./docs/portal/GETTING_STARTED.md#run-tests)
+    - [Run Tests in Development Mode](./docs/portal/GETTING_STARTED.md#run-tests)
+- [Contribution Guide](./docs/portal/CONTRIBUTING.md)
+  - [Finding Something to Work On](./docs/portal/CONTRIBUTING.md#finding-something-to-work-on)
+  - [Contribution Flow](./docs/portal/CONTRIBUTING.md#contribution-flow)
 - [License](#license)
 
 ## License

README.md

@@ -1 +1,3 @@
-FUEL_PROVIDER_URL=https://beta-5.swayswap.io/graphql
+FUEL_PROVIDER_URL=https://beta-4.fuel.network/graphql
+PRIVATE_KEY=
+

contracts/predicate/.env.example

@@ -12,9 +12,9 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "dotenv": "16.3.1",
-    "fuels": "0.71.0",
-    "vitest": "1.1.3",
+    "dotenv": "16.4.1",
+    "fuels": "0.71.1",
+    "vitest": "1.2.1",
     "tsx": "4.7.0"
   }
 }

contracts/predicate/package.json

@@ -2,17 +2,17 @@ import { BaseAssetId, Predicate, Provider, Wallet, bn, hexlify } from 'fuels';
 import { promises as fs } from 'node:fs';
 import { resolve } from 'node:path';
 
-const { FUEL_PROVIDER_BETA5, PRIVATE_KEY } = process.env;
+const { FUEL_PROVIDER_URL, PRIVATE_KEY } = process.env;
 const BIN_PATH = resolve(__dirname, '../out/debug/predicate-app.bin');
 const AMOUNT = 300_000;
 
-if (!FUEL_PROVIDER_BETA5 || !PRIVATE_KEY) {
+if (!FUEL_PROVIDER_URL || !PRIVATE_KEY) {
   throw new Error('Missing some config on your .env file');
 }
 
 async function main() {
   const binHex = hexlify(await fs.readFile(BIN_PATH));
-  const provider = await Provider.create(FUEL_PROVIDER_BETA5!);
+  const provider = await Provider.create(FUEL_PROVIDER_URL!);
   const wallet = Wallet.fromPrivateKey(PRIVATE_KEY!, provider);
   const { minGasPrice: gasPrice } = wallet.provider.getGasConfig();
   const walletAddress = wallet.address.toB256();
@@ -43,7 +43,7 @@ async function main() {
       BaseAssetId,
       {
         gasPrice,
-      },
+      }
     );
     const res2 = await tx2.waitForResult();
     console.log(`→ Transaction Id: ${res2.id}`);

contracts/predicate/scripts/run-predicate.ts

@@ -4,20 +4,20 @@ FROM node:20-slim AS base
 
 # Expose the ENVs to the env of the container
 ENV PORT="${PORT}"
-ENV FUEL_PROVIDER_BETA5="${FUEL_PROVIDER_BETA5}"
+ENV FUEL_PROVIDER_URL="${FUEL_PROVIDER_URL}"
 ENV PNPM_HOME="/pnpm"
 ENV PATH="$PNPM_HOME:$PATH"
 
 # Enable pnpm using corepack form node.js
 RUN corepack enable
 
-COPY . /app
-WORKDIR /app
+COPY . /app-explorer
+WORKDIR /app-explorer
 
 RUN pnpm install --frozen-lockfile
 
 EXPOSE 4444
 
-WORKDIR /app/packages/graphql
+WORKDIR /app-explorer/packages/graphql
 
 CMD ["pnpm", "start"]

deployment/Dockerfile

@@ -1,17 +1,15 @@
-start:
-	# sh ./scripts/start.sh
-	# docker compose up
-	echo "Docker env is temporary disabled on this project";
-	echo "Run pnpm dev for development";
+build:
+	docker compose --env-file ./envs/ports.env build
 
-down:
-	docker compose down
+start:
+	docker compose --env-file ./envs/ports.env up -d --build
 
-restart:
-	docker compose restart
+stop:
+	docker compose stop
 
 clean:
-	docker compose down --rmi local -v --remove-orphans
+	docker compose down --rmi local -v
 
 logs:
 	docker compose logs -f
+