-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e3408a9
commit dd366fd
Showing
2 changed files
with
4 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,6 @@ | ||
>[!IMPORTANT] | ||
> *This repo is a work in progress and is not ready for production use.* | ||
> *This project has been moved to a new location. Check out https://github.com/cyfrin/moccasin* | ||
# Gaboon | ||
This project has moved to: | ||
|
||
A fast, pythonic, Vyper smart contract testing and development framework. | ||
|
||
[](https://github.com/astral-sh/uv) | ||
|
||
<!-- <p align="center"> | ||
<br /> | ||
<a href="https://cyfrin.io/"> | ||
<img src="./img/gaboon-logo.png" width="250" alt=""/></a> | ||
<br /> | ||
</p> --> | ||
|
||
Fast to install, test, and run python commands on your smart contracts. | ||
|
||
# Quickstart | ||
|
||
Head over to [the gaboon installation documentation](https://cyfrin.github.io/gaboon/installing-gaboon.html) to for other install methodologies and getting stated. | ||
|
||
|
||
```bash | ||
uv tool install gaboon-cli | ||
``` | ||
|
||
# Documentation | ||
|
||
The documentation roughly attempts to follow [Diátaxis](https://diataxis.fr/). | ||
|
||
# Speed Comparisons | ||
|
||
*The following comparisions were done taking the `user` result from running the bash `time` command followed by the appropriote command on an M3 MacOS* | ||
*Compile command tested with a basic vyper counter contract on version 0.4.0 or 0.3.10 depending on compatibility* | ||
|
||
|
||
| Command | Gaboon | Brownie | Hardhat | Foundry | Ape | | ||
| ------- | ------ | ------- | ------- | ------- | ----- | | ||
| help | 0.03s | 0.37s | 0.30s | 0.01s | 2.55s | | ||
| init | 0.04s | 0.37s | xx | 0.20s | 5.08s | | ||
| compile | 0.49s | 0.42s | xx | 0.17s | 2.00s | | ||
|
||
|
||
# Acknowledgements | ||
|
||
- [brownie](https://github.com/eth-brownie/brownie) | ||
- [vyper](https://github.com/vyperlang/vyper) | ||
- [boa](https://github.com/vyperlang/titanoboa) | ||
|
||
## Background | ||
|
||
> The Gaboon viper (Bitis gabonica), also called the Gaboon adder, is a viper species found in the rainforests and savannas of sub-Saharan Africa. Like all other vipers, it is venomous. It is the largest member of the genus Bitis, and has the longest fangs of any venomous snake – up to 2 inches (5 cm) in length – and the highest venom yield of any snake. No subspecies are recognized. | ||
https://github.com/cyfrin/moccasin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[project] | ||
name = "gaboon-cli" | ||
version = "0.1.1" | ||
version = "0.1.2" | ||
description = "Pythonic smart contract development framework using Titanoboa" | ||
authors = [ | ||
{ name = "PatrickAlphac", email = "[email protected]" }, | ||
|