solidity-sandbox

KO | EN

gitlite — search

#hacktoberfest #react #llm #go #machine-learning #rust #linux #macos #windows #awesome #cli #kubernetes #vue #security

solidity-sandbox

(★ 151)

A forkable template repo for easily writing and testing toy contracts

File Explorer

Download Latest Version (.zip)

- forge-std
- openzeppelin-contracts
- openzeppelin-contracts-upgradeable
- solmate
- 0_Template.t.sol
- 1_Dispatcher.t.sol
.gitignore
.gitmodules
foundry.toml
LICENSE
newTest.sh
README.md
sandbox.png

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Solidity Sandbox

![Picture of a sandbox](https://raw.githubusercontent.com/maurelian/solidity-sandbox/main/sandbox.png)

Just a simple [forge](https://book.getfoundry.sh/forge/) based repo for playing around with and
understanding solidity toy code.

See how other's are using it:
- [maurelian's branch](https://github.com/maurelian/solidity-sandbox/tree/maurelian)
- [devtooligan's fork](https://github.com/devtooligan/solidity-sandbox)

## Conventions

The whole purpose of this repo is to make it fast and easy to test stuff, and then keep the test code for
future reference. Specific test contracts can be chosen for testing.  Replace `<contract name>` with full or partial contract name:

`forge test --match-contract <contract name>` or `forge test --mc <contract name>`

## Creating a new test

I don't want to have to think about avoiding contract naming collision, so each new test file
is prefixed with a number, and all the contract names in that file have that same number as a suffix.

There's now a script to generate a new file with a contract and empty test function. Just run the following replacing `<test_name>` with the name of your test (file naming conventions apply, avoid spaces).  Or omit the test name to invoke _interactive mode_.

```sh
./newTest.sh <test name>
```

## Yul code

Occasionally it's helpful to generate the Yul intermediate representation to understand what's
happening underneath the hood. In that case, I'll just use a command like the following to
put the IR into the `./ir` dir. Using a `.sol` extension gives pretty decent syntax highlighting
for readability.

```
forge inspect Target16 ir >! ir/bytesArgLenCheck16.yul.sol
```

Yul code can be compiled with `solc --strict-assembly`.

## Advanced Installation Tip
You can create a bash function that will change directories and call newTest.
Add it to your `.bashrc` file so you can call `scratch` from anywhere!

```bash
scratch() {
  cd <path to solidity-sandbox>
  bash newTest.sh $1
}
```

solidity-sandbox

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

solidity-sandbox

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README