Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/projectopensea/seadrop
Smart contracts for primary drops on EVM chains
https://github.com/projectopensea/seadrop
Last synced: 3 months ago
JSON representation
Smart contracts for primary drops on EVM chains
- Host: GitHub
- URL: https://github.com/projectopensea/seadrop
- Owner: ProjectOpenSea
- License: mit
- Created: 2022-07-28T01:36:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-14T16:10:08.000Z (5 months ago)
- Last Synced: 2024-06-16T00:35:37.680Z (5 months ago)
- Language: Solidity
- Size: 8.38 MB
- Stars: 285
- Watchers: 14
- Forks: 121
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Version][version-badge]][version-link]
[![Test CI][ci-badge]][ci-link]
[![Code Coverage][coverage-badge]][coverage-link]
[![License][license-badge]][license-link]
[![Docs][docs-badge]][docs-link]
[![Discussions][discussions-badge]][discussions-link]
# SeaDrop
SeaDrop is a contract for conducting primary NFT drops on evm-compatible blockchains.
## Table of Contents
- [SeaDrop](#seadrop)
- [Table of Contents](#table-of-contents)
- [Background](#background)
- [Deployments](#deployments)
- [Diagram](#diagram)
- [Docs](#docs)
- [Install](#install)
- [Usage](#usage)
- [Foundry Tests](#foundry-tests)
- [Audits](#audits)
- [Contributing](#contributing)
- [License](#license)
## Background
SeaDrop is a contract to perform primary drops on evm-compatible blockchains. The types of drops supported are public drops, allow list stages, token gated drops, and server-side signed mints. An implementing token contract should contain the methods to interface with `SeaDrop` through an authorized user such as an Owner or Administrator.
Future SeaDrop contracts are envisioned to contain additional functionality like descending dutch auction mechanisms and payment in ERC20 tokens.
## Deployments
Network
SeaDrop 1.0
Ethereum
[0x00005EA00Ac477B1030CE78506496e8C2dE24bf5](https://etherscan.io/address/0x00005EA00Ac477B1030CE78506496e8C2dE24bf5#code)
Sepolia
Polygon
Polygon Mumbai
Arbitrum One
Arbitrum Nova
Arbitrum Sepolia
Avalanche C-Chain
Avalanche Fuji
Optimism
Optimism Sepolia
Base
Base Sepolia
BSC
BSC Testnet
Klaytn
Klaytn Baobab
Gnosis Chain
Zora
Zora Sepolia
To deploy to a new EVM chain, follow the [steps outlined here](docs/SeaDropDeployment.md).
## Diagram
This diagram shows the logic flow in the case that a drop is hosted on OpenSea, with an optional mint hosted elsewhere. Note that a fee recipient is not required to integrate with SeaDrop, and a fee recipient may be any address.
## Docs
- [SeaDrop Deployment](docs/SeaDropDeployment.md)
- [SeaDrop Token Deployment](docs/SeaDropTokenDeployment.md)
- [Bring Your Own Token Contract](docs/BringYourOwnTokenContract.md)
- [Provenance Hash](docs/ProvenanceHash.md)
## Install
To install dependencies and compile contracts:
```bash
git clone --recurse-submodules https://github.com/ProjectOpenSea/seadrop && cd seadrop
yarn install
yarn build
```
## Usage
To run hardhat tests written in javascript:
```bash
yarn test
yarn coverage
```
To profile gas usage:
```bash
yarn profile
```
### Foundry Tests
SeaDrop also includes a suite of fuzzing tests written in solidity with Foundry.
To install Foundry (assuming a Linux or macOS system):
```bash
curl -L https://foundry.paradigm.xyz | bash
```
This will download foundryup. To start Foundry, run:
```bash
foundryup
```
To install dependencies:
```
forge install
```
To run tests:
```
forge test
```
To run gas snapshot:
```
forge snapshot
```
The following modifiers are also available:
- Level 2 (-vv): Logs emitted during tests are also displayed.
- Level 3 (-vvv): Stack traces for failing tests are also displayed.
- Level 4 (-vvvv): Stack traces for all tests are displayed, and setup traces for failing tests are displayed.
- Level 5 (-vvvvv): Stack traces and setup traces are always displayed.
```bash
forge test -vv
```
For more information on foundry testing and use, see [Foundry Book installation instructions](https://book.getfoundry.sh/getting-started/installation).
To run lint checks:
```bash
yarn lint:check
```
Lint checks utilize prettier, prettier-plugin-solidity, and solhint.
```javascript
"prettier": "^2.5.1",
"prettier-plugin-solidity": "^1.0.0-beta.24",
```
## Audits
SeaDrop was audited after development by [Spearbit](https://spearbit.com/), read the report [here](./assets/spearbit-seadrop-audit.pdf).
## Contributing
Contributions to SeaDrop are welcome by anyone interested in writing more tests, improving readability, optimizing for gas efficiency, or extending the protocol with new features.
When making a pull request, ensure that:
- All tests pass.
- Code coverage remains at 100% (coverage tests must currently be written in hardhat).
- All new code adheres to the style guide:
- All lint checks pass.
- Code is thoroughly commented with natspec where relevant.
- If making a change to the contracts:
- Gas snapshots are provided and demonstrate an improvement (or an acceptable deficit given other improvements).
- Reference contracts are modified correspondingly if relevant.
- New tests (ideally via foundry) are included for all new features or code paths.
- If making a modification to third-party dependencies, `yarn audit` passes.
- A descriptive summary of the PR has been provided.
## License
[MIT](LICENSE) Copyright 2022 Ozone Networks, Inc.
[version-badge]: https://img.shields.io/github/package-json/v/ProjectOpenSea/seadrop
[version-link]: https://github.com/ProjectOpenSea/seadrop/blob/main/package.json
[ci-badge]: https://github.com/ProjectOpenSea/seadrop/actions/workflows/test.yml/badge.svg
[ci-link]: https://github.com/ProjectOpenSea/seadrop/actions/workflows/test.yml
[coverage-badge]: https://coveralls.io/repos/github/ProjectOpenSea/seadrop/badge.svg?branch=main
[coverage-link]: https://coveralls.io/github/ProjectOpenSea/seadrop?branch=main
[license-badge]: https://img.shields.io/github/license/ProjectOpenSea/seadrop
[license-link]: https://github.com/ProjectOpenSea/seadrop/blob/main/LICENSE
[docs-badge]: https://img.shields.io/badge/SeaDrop-documentation-informational
[docs-link]: https://github.com/ProjectOpenSea/seadrop/tree/main/docs
[discussions-badge]: https://img.shields.io/badge/SeaDrop-discussions-blueviolet
[discussions-link]: https://github.com/ProjectOpenSea/seadrop/discussions