Merge pull request #168 from P4-Games/develop

Deploy #20231124

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintignore

@@ -0,0 +1,4 @@
+**/node_modules/*
+**/out/*
+**/.next/*
+**/src/context/abis/*

.eslintrc.json

@@ -0,0 +1,42 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:@next/next/recommended",
+    "next/core-web-vitals",
+    "prettier"
+  ],
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": [
+    "react",
+    "@next/eslint-plugin-next"
+  ],
+  "rules": {
+    "arrow-body-style": 1,
+    "react/prop-types": 1,
+    "react/display-name": 0,
+    "import/no-unresolved": 2,
+    "react/no-children-prop": 0,
+    "react/self-closing-comp": 2,
+    "react/react-in-jsx-scope": 0,
+    "@next/next/no-img-element": 0,
+    "react/no-unescaped-entities": 0,
+    "import/no-useless-path-segments": 1,
+    "no-unused-vars": [
+      1,
+      {
+        "ignoreRestSiblings": false
+      }
+    ]
+  }
+}

.github/workflows/codeql.yml

@@ -0,0 +1,82 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main", "develop" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '34 21 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners
+    # Consider using larger runners for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript-typescript' ]
+        # CodeQL supports [ 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' ]
+        # Use only 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/gcp.yml

@@ -32,7 +32,7 @@ jobs:
       - name: Automatic Tagging of Releases
         id: increment-git-tag
         run: |
-          bash ./scripts/git_update.sh -v patch
+          bash ./github/workflows/scripts/gitTag.sh -v patch
         # the above can be changed to major, minor or patch (e.g 2.1.3 respectively)
 
       - name: Configure Docker Client

.gitignore

@@ -26,7 +26,7 @@ yarn-error.log*
 .pnpm-debug.log*
 
 # local env files
-.env*.local
+.env*
 
 # vercel
 .vercel
@@ -56,3 +56,5 @@ typechain-types
 #Hardhat files
 cache
 
+##debug smart contracts files
+*.dbg.json

.prettierignore

@@ -0,0 +1,9 @@
+node_modules
+.next
+yarn.lock
+package-lock.json
+public
+.github
+.vscode
+**/src/context/abis/*
+

.prettierrc

@@ -0,0 +1,19 @@
+{
+  "arrowParens": "always",
+  "bracketSameLine": false,
+  "bracketSpacing": true,
+  "embeddedLanguageFormatting": "auto",
+  "htmlWhitespaceSensitivity": "css",
+  "insertPragma": false,
+  "jsxSingleQuote": false,
+  "printWidth": 100,
+  "proseWrap": "preserve",
+  "quoteProps": "as-needed",
+  "requirePragma": false,
+  "semi": false,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "none",
+  "useTabs": false,
+  "vueIndentScriptAndStyle": false
+}

README.md

@@ -1,13 +1,129 @@
-# Sample Hardhat Project
+![](https://img.shields.io/badge/NextJs-informational?style=flat&logo=next&logoColor=white&color=6aa6f8)
+![](https://img.shields.io/badge/JavaScript-informational?style=flat&logo=javascript&logoColor=white&color=6aa6f8)
+![](https://img.shields.io/badge/scss-informational?style=flat&logo=scss&logoColor=white&color=6aa6f8)
+![](https://img.shields.io/badge/Solidity-informational?style=flat&logo=solidity&logoColor=white&color=6aa6f8)
+![](https://img.shields.io/badge/Hardhat-informational?style=flat&logo=hardhat&logoColor=white&color=6aa6f8)
 
-This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, and a script that deploys that contract.
 
-Try running some of the following tasks:
+# Number One Fun (NoF)
 
-```shell
-npx hardhat help
-npx hardhat test
-GAS_REPORT=true npx hardhat test
-npx hardhat node
-npx hardhat run scripts/deploy.js
+![nof-landing](./.doc/images/nof.png)
+
+
+# Build With
+
+- [nextJs Framework](https://nextjs.org/)
+
+# Live Demo
+
+- [NoF Live Demo](https://nof.town)
+
+
+# Requirements
+
+## Software
+
+This App requires:
+
+- [nvm](https://github.com/nvm-sh/nvm) (allows you to quickly install and use different versions of node via the command line.)
+- node js & npm (insalled with nvm)
+- [mongo db](https://www.mongodb.com/docs/manual/installation/) (It will be used for endpoints that are consumed from the discord bot)
+- [metamask](https://metamask.io/download/)
+
+
+## Environment variables
+
+Create a .env file running the command in terminal
+
+```sh
+touch .env
+```
+
+The environment variables bellow needs to be set in the .env file when project is running locally:
+
+```sh
+SKIP_PREFLIGHT_CHECK=true
+GENERATE_SOURCEMAP=false
+npm_config_user_agent=yarn
+PORT=3000
+
+# server-side
+MONGODB='mongodb://localhost:27017'
+NODE_ENV='development'
+APP_ENV='development'
+GAMMA_SERVICE_URL='https://gamma-microservice-7bteynlhua-uc.a.run.app'
+GRAPH_URL='https://api.thegraph.com/subgraphs/name/tomasfrancizco/nof_polygon'
+
+# Client-side
+NEXT_PUBLIC_STORAGE_URL_ALPHA='https://storage.googleapis.com/nof-alpha'
+NEXT_PUBLIC_STORAGE_URL_GAMMA='https://storage.googleapis.com/nof-gamma'
+NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID={you project ID from walletconnect.com}
+NEXT_PUBLIC_CHAIN_NAME='mumbai'
+NEXT_PUBLIC_CHAIN_ID='0x13881'
+NEXT_PUBLIC_CHAIN_CURRENCY='MATIC'
+NEXT_PUBLIC_CHAIN_RPC_URL='https://rpc-mumbai.maticvigil.com'
+NEXT_PUBLIC_CHAIN_EXPLORER_URL='https://mumbai.polygonscan.com'
+NEXT_PUBLIC_DAI_ADDRESS='0x59876b33dd6e725Da632B4DB50d90d33ab022dB6'
+NEXT_PUBLIC_ALPHA_ADDRESS='0x1772F33b587B4ed32f59Dc6B09B9e994616C1eCB'
+NEXT_PUBLIC_GAMMA_PACKS_ADDRESS='0xc0a2630f551106190d95C2348e02E400478e711c'
+NEXT_PUBLIC_GAMMA_CARDS_ADDRESS='0xa888449f2CB7AB034D08051Bf1a9D7402DE959ab'
+NEXT_PUBLIC_GAMMA_OFFERS_ADDRESS=''
+NEXT_PUBLIC_ADMIN_ACCOUNTS='0x35dad65F60c1A32c9895BE97f6bcE57D32792E83,0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
+NEXT_PUBLIC_CHAIN_NODE_PROVIDER_URL='https://polygon-mumbai.g.alchemy.com/v2/YOUR_API_KEY'
+
+```
+
+The source code of the smart contracts is located at [https://github.com/P4-Games/NoF-Smart-Contracts](https://github.com/P4-Games/NoF-Smart-Contracts). If you want to run them locally (example: on a hardhat or ganache node), after compiling them locally, change the addresses in the .env and set these options to network:
+
+```sh
+NEXT_PUBLIC_CHAIN_NAME='localhost'
+NEXT_PUBLIC_CHAIN_ID='0x539'
+NEXT_PUBLIC_CHAIN_CURRENCY='ETH'
+NEXT_PUBLIC_CHAIN_RPC_URL='http://localhost:8545'
+```
+
+## Quick commands
+
+### Install dependencies
+
+```sh
+- yarn install # with yarn
+- npm i # with NPM
+```
+
+If you have troubles with dependencies, try this:
+
+```sh
+set http_proxy=
+set https_proxy=
+npm config rm https-proxy
+npm config rm proxy
+npm config set registry "https://registry.npmjs.org"
+yarn cache clean
+yarn config delete proxy
+yarn --network-timeout 100000
+```
+
+### Run App
+
+```sh
+npm run dev / yarn dev
+```
+
+### Use App
+
+```sh
+Open browser in http://localhost:3000/
+```
+
+### Mock Data
+
+You can load mock data from the alpha, gamma collections and have DAIs in your wallet in a local environment, with these commands:
+
+```sh
+# go to the root of the NoF-smart-contracts project and run
+npx hardhat node # to raise the hardhat node
+yarn deploy-mock-data # run the mock data
+
+# Then upload the hardhat addresses to your wallets
 ```