https://github.com/refcell/seals
Sealed Auctions with Commitment Schemes.
https://github.com/refcell/seals
Last synced: 7 months ago
JSON representation
Sealed Auctions with Commitment Schemes.
- Host: GitHub
- URL: https://github.com/refcell/seals
- Owner: refcell
- License: agpl-3.0
- Created: 2022-02-04T06:56:35.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-23T00:11:59.000Z (almost 4 years ago)
- Last Synced: 2025-07-20T06:58:23.935Z (7 months ago)
- Language: Solidity
- Size: 38.1 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# seals • [](https://github.com/abigger87/seals/actions/workflows/tests.yml) [](https://github.com/abigger87/seals/actions/workflows/lints.yml)  
Sealed Commitment Auctions with Overcollateralized Bid Bands.
```m
.---.
/o o\
__(= " =)__
//\'-=-'/\\
) (_
/ `"=-._
/ \ ``"=.
/ / \ \ `=..--.
___/ / \ \___ _, , `\
`-----' `""""`'-----``"""` \ \_/
`-`
```
## Overview
`Seals` is a ***highly*** modular, unconventially named Protocol to run Sealed Auctions using Commitment Schemes.
Each Sealed Commitment Auction is created using [wighawag](https://twitter.com/wighawag) and [ZeframLou's](https://twitter.com/boredGenius) [Clones With Immutable Args](https://github.com/wighawag/clones-with-immutable-args) factory pattern.
The factory contract is called `Floe` - a floating sheet of ice where Seals are spawned,
`Floe` deploys three contracts per auction:
1. [Bloc](./src/Bloc.sol) - The Sealed Auction Manager Contract.
2. [Nibs](./src/Nibs.sol) - The Project Shares issued once the reveal session ends.
3. [Coffer](./src/Coffer.sol) - A Lockbox Contract that stores auction collaterals.
## Architecture
TODO
## Blueprint
```ml
lib
├─ ds-test — https://github.com/dapphub/ds-test
├─ forge-std — https://github.com/brockelmore/forge-std
├─ solmate — https://github.com/Rari-Capital/solmate
├─ clones-with-immutable-args — https://github.com/wighawag/clones-with-immutable-args
src
├─ tests
│ └─ Seal.t — "Seal Tests"
└─ Seal — "The Seal Coordination Contract"
```
## Glossary
We use Primitive and Maker's approach of Unconvential Naming inspired by [The Dangers of Surprising Code](https://samczsun.com/the-dangers-of-surprising-code/) h/t [Alex](https://twitter.com/alexangelj) [Mistrusting Variable Names](https://twitter.com/alexangelj/status/1491280313162813441?s=20&t=NoFpNkO9orH8OZ34-DIfMQ).
`
## Development
[seals](https://github.com/abigger87/seals) is built with [Foundry](https://github.com/gaskonst/foundry) but remains backwards compatible with [DappTools](https://dapp.tools/).
Set up your environment by following the instructions outlined in [abigger87/foundry-starter](https://github.com/abigger87/foundry-starter#development).
```bash
# Setup
make setup
```
```bash
# Build #
make build
```
```bash
# Testing #
make test
```
#### Configure Foundry
Using [foundry.toml](./foundry.toml), Foundry is easily configurable.
## Install Seals as a Dependency
To install with [DappTools](https://dapp.tools/), run:
```sh
dapp install abigger87/seals
```
To install with [Foundry](https://github.com/gakonst/foundry), run:
```sh
forge install abigger87/seals
```
To install with [Hardhat](https://hardhat.org/), run:
```sh
npm i -D seals
```
## License
[AGPL-3.0-only](https://github.com/abigger87/seals/blob/master/LICENSE)
# Acknowledgements
- [lil Juicebox](https://github.com/m1guelpf/lil-web3/blob/main/src/LilJuicebox.sol) created by [Miguel Piedrafita](https://twitter.com/m1guelpf)
- [Soulbound](https://github.com/primitivefinance/soulbound)
- [NFT Call Options](https://github.com/verumlotus/NFT-Call-Option) built by [verumlotus](https://twitter.com/verumlotus)
- [foundry](https://github.com/gakonst/foundry)
- [solmate](https://github.com/Rari-Capital/solmate)
- [forge-std](https://github.com/brockelmore/forge-std)
- [clones-with-immutable-args](https://github.com/wighawag/clones-with-immutable-args).
- [foundry-toolchain](https://github.com/onbjerg/foundry-toolchain) by [onbjerg](https://github.com/onbjerg).
- [forge-template](https://github.com/FrankieIsLost/forge-template) by [FrankieIsLost](https://github.com/FrankieIsLost).
- [Georgios Konstantopoulos](https://github.com/gakonst) for [forge-template](https://github.com/gakonst/forge-template) resource.
## Disclaimer
_These smart contracts are being provided as is. No guarantee, representation or warranty is being made, express or implied, as to the safety or correctness of the user interface or the smart contracts. They have not been audited and as such there can be no assurance they will work as intended, and users may experience delays, failures, errors, omissions, loss of transmitted information or loss of funds. The creators are not liable for any of the foregoing. Users should proceed with caution and use at their own risk._