Merge branch 'main' into modules

Signed-off-by: sudo rm -rf --no-preserve-root / <[email protected]>

.github/workflows/checks.yml

@@ -111,4 +111,4 @@ jobs:
           test/**/*.sol test/**/interfaces/*.sol test/**/mocks/*.sol \
           test/**/scripts/*.js scripts/*.py --allow-dupe --allow-redirect \
           --request-delay 0.4 \
-          --white-list https://www.wagmi.xyz,https://twitter.com,https://github.com/pcaversaccio/snekmate.git@,https://github.com/pcaversaccio/snekmate/releases/tag/v0.0.5,https://github.com/pcaversaccio/snekmate/blob/v0.0.5,https://github.com/pcaversaccio/snekmate/compare/v0.0.4...v0.0.5,https://cs.stackexchange.com
+          --white-list https://www.wagmi.xyz,https://twitter.com,https://github.com/pcaversaccio/snekmate.git@,https://github.com/pcaversaccio/snekmate/releases/tag/v0.1.0,https://github.com/pcaversaccio/snekmate/blob/v0.1.0,https://github.com/pcaversaccio/snekmate/compare/v0.0.5...v0.1.0,https://cs.stackexchange.com

.gitmodules

@@ -1,27 +1,27 @@
+[submodule "lib/murky"]
+	path = lib/murky
+	url = https://github.com/dmfxyz/murky.git
+[submodule "lib/solady"]
+	path = lib/solady
+	url = https://github.com/vectorized/solady.git
+[submodule "lib/solmate"]
+	path = lib/solmate
+	url = https://github.com/transmissions11/solmate.git
+[submodule "lib/prb-test"]
+	path = lib/prb-test
+	url = https://github.com/paulrberg/prb-test.git
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std.git
 [submodule "lib/create-util"]
 	path = lib/create-util
 	url = https://github.com/pcaversaccio/create-util.git
+[submodule "lib/erc4626-tests"]
+	path = lib/erc4626-tests
+	url = https://github.com/a16z/erc4626-tests.git
 [submodule "lib/solidity-bytes-utils"]
 	path = lib/solidity-bytes-utils
 	url = https://github.com/GNSPS/solidity-bytes-utils.git
 [submodule "lib/openzeppelin-contracts"]
 	path = lib/openzeppelin-contracts
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts.git
-[submodule "lib/prb-test"]
-	path = lib/prb-test
-	url = https://github.com/paulrberg/prb-test.git
-[submodule "lib/murky"]
-	path = lib/murky
-	url = https://github.com/dmfxyz/murky.git
-[submodule "lib/erc4626-tests"]
-	path = lib/erc4626-tests
-	url = https://github.com/a16z/erc4626-tests.git
-[submodule "lib/solady"]
-	path = lib/solady
-	url = https://github.com/vectorized/solady.git
-[submodule "lib/solmate"]
-	path = lib/solmate
-	url = https://github.com/transmissions11/solmate.git

.prettierignore

@@ -11,3 +11,4 @@ lib/openzeppelin-contracts
 cache
 out
 dist
+venv

.solhintignore

@@ -11,3 +11,4 @@ lib/openzeppelin-contracts
 cache
 out
 dist
+venv

CHANGELOG.md

@@ -1,6 +1,12 @@
 # 🕓 Changelog
 
-## [`0.0.5`](https://github.com/pcaversaccio/snekmate/releases/tag/v0.0.5) (Unreleased)
+## [`0.1.0`](https://github.com/pcaversaccio/snekmate/releases/tag/v0.0.1) (Unreleased)
+
+### 👀 Full Changelog
+
+- [`v0.0.5...v0.1.0`](https://github.com/pcaversaccio/snekmate/compare/v0.0.5...v0.1.0)
+
+## [`0.0.5`](https://github.com/pcaversaccio/snekmate/releases/tag/v0.0.5) (07-03-2024)
 
 ### 💥 New Features
 

README.md

@@ -9,6 +9,7 @@
 
 **State-of-the-art**, **highly opinionated**, **hyper-optimised**, and **secure** 🐍Vyper smart contract building blocks.
 
+> [!WARNING]
 > This is **experimental software** and is provided on an "as is" and "as available" basis. We **do not give any warranties** and **will not be liable for any losses** incurred through any use of this code base.
 
 ## 📜 Contracts
@@ -60,6 +61,9 @@ src
 
 ## 🎛 Installation
 
+> [!IMPORTANT]  
+> 🐍 snekmate uses a [ZeroVer](https://0ver.org)-based versioning scheme. This means 🐍 snekmate's major version will never exceed the first and most important number in computing: zero.
+
 We offer three convenient ways to install the 🐍 snekmate contracts:
 
 ### 1️⃣ Foundry

foundry.toml

@@ -4,7 +4,6 @@ src = 'src'                                                 # the source directo
 test = 'test'                                               # the test directory
 out = 'out'                                                 # the output directory (for artifacts)
 libs = ['lib']                                              # a list of library directories
-remappings = []                                             # a list of remappings
 cache = true                                                # whether to cache builds or not
 cache_path = 'cache'                                        # where the cache is stored if enabled
 force = false                                               # whether to ignore the cache (clean build)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "snekmate",
-  "version": "0.0.5-rc.3",
+  "version": "0.0.5",
   "description": "State-of-the-art, highly opinionated, hyper-optimised, and secure 🐍Vyper smart contract building blocks.",
   "author": "Pascal Marco Caversaccio <[email protected]>",
   "license": "AGPL-3.0-only",

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "snekmate"
-version = "0.0.5rc3"
+version = "0.0.5"
 description = "State-of-the-art, highly opinionated, hyper-optimised, and secure 🐍Vyper smart contract building blocks."
 readme = {file = "README.md", content-type = "text/markdown"}
 requires-python = ">=3.10"

scripts/compile.py

@@ -1,6 +1,6 @@
 import subprocess, glob
 
-for filename in glob.glob("**/*.vy", recursive=True):
+for filename in glob.glob("src/**/*.vy", recursive=True):
     result = subprocess.run(
         ["vyper", "-f", "userdoc,devdoc", filename], capture_output=True, text=True
     )