Release/1.0

.env.example

@@ -2,10 +2,30 @@ MNEMONIC="caught sniff chuckle survey divert happy crop brick obscure prevent in
 PK="{INSERT_STRING}"
 
 INFURA_API_KEY="{INSERT_STRING}"
+ALCHEMY_KEY="{INSERT_STRING}"
 ETHERSCAN_API_KEY="{INSERT_STRING}"
 GASPRICE_API_ENDPOINT="(INSERT_STRING)"
 COINMARKETCAP_API_KEY="{INSERT_STRING}"
 
-ERC20_TOKEN="mock"
 REPORT_GAS="true"
 GEN_DOCS="false"
+
+#  Deploy settings
+UNISWAP_ROUTER="0x0"
+# ERC20_TOKEN="0xECabAE592Eb56D96115FcF4c7F772ADB7BF573d0"
+# ERC20_TOKEN=mock
+ERC20_TOKEN=0x0038dD433c3D98D7d18E0345dF043c442D3b3D88
+RECIPIENT=0xe1fe7A4DBF33e6dA8c9e2628d102c67FB9E94549
+UNISWAP_ROUTER=mock
+
+# Factory
+feeCreateCollection=1
+feeCreateSplitter=1
+feeCreateCollectionErc20=0.0003
+feeCreateSplitterErc20=0.0003
+
+# Router
+feeBurn=1
+feeMint=1
+feeBurnErc20=0.0003
+feeMintErc20=0.0003

.github/workflows/forge.yml

@@ -0,0 +1,41 @@
+on: [push, pull_request]
+
+# on:
+#   push:
+#     branches:
+#       - main
+#   pull_request:
+    # Optionally configure to run only for changes in specific files. For example:
+    # paths:
+    # - src/**
+    # - test/**
+    # - foundry.toml
+    # - remappings.txt
+    # - .github/workflows/foundry-gas-diff.yml
+
+name: Forge Tests
+
+# https://github.com/Rubilmax/foundry-gas-diff
+env:
+  # make fuzzing semi-deterministic to avoid noisy gas cost estimation
+  # due to non-deterministic fuzzing (but still use pseudo-random fuzzing seeds)
+  FOUNDRY_FUZZ_SEED: 0x${{ github.event.pull_request.base.sha || github.sha }}
+
+
+jobs:
+  check:
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Run tests
+        run: forge test -vvv --gas-report
+
+      - name: Run snapshot
+        run: forge snapshot

.gitignore

@@ -1,4 +1,10 @@
 # directories
+abi2json/
+flat/
+test/Flattened/
+ignition/
+flat.sol
+
 .yarn/*
 !.yarn/patches
 !.yarn/releases
@@ -25,3 +31,270 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 soljson-v0.8.4+commit.c7e474f2.js
+
+# Allow a dummy project in this directory for testing purposes
+myproject
+
+/node_modules
+/.idea
+*.tsbuildinfo
+
+# VS Code workspace config
+workspace.code-workspace
+
+.DS_Store
+
+# Below is Github's node gitignore template,
+# ignoring the node_modules part, as it'd ignore every node_modules, and we have some for testing
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+#node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+
+docs/.env.example
+
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# VSCode settings
+.vscode/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+# lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+venv*/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+
+/auditFiles/contracts
+
+# FOUNDRY
+
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Dotenv file
+.env
+
+forge-cache/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/lib/forge-std"]
+	path = test/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

.prettierrc.yaml

@@ -14,3 +14,4 @@ overrides:
   - files: "*.sol"
     options:
       tabWidth: 4
+      printWidth: 120