Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openzeppelin/cairo-contracts
OpenZeppelin Contracts written in Cairo for Starknet, a decentralized ZK Rollup
https://github.com/openzeppelin/cairo-contracts
cairo ethereum security smart-contracts starknet
Last synced: 5 days ago
JSON representation
OpenZeppelin Contracts written in Cairo for Starknet, a decentralized ZK Rollup
- Host: GitHub
- URL: https://github.com/openzeppelin/cairo-contracts
- Owner: OpenZeppelin
- License: mit
- Created: 2021-08-18T23:00:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T22:01:44.000Z (9 days ago)
- Last Synced: 2024-12-12T23:17:46.465Z (9 days ago)
- Topics: cairo, ethereum, security, smart-contracts, starknet
- Language: Rust
- Homepage: https://docs.openzeppelin.com/contracts-cairo
- Size: 3.28 MB
- Stars: 833
- Watchers: 20
- Forks: 349
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# OpenZeppelin Contracts for Cairo
[](https://github.com/OpenZeppelin/cairo-contracts/actions/workflows/test.yml)
**A library for secure smart contract development** written in Cairo for [Starknet](https://starkware.co/product/starknet/), a decentralized ZK Rollup.
> **Warning**
> This repo contains highly experimental code.
> It has no code coverage checks.
> It hasn't been audited.
> **Use at your own risk.**
## Usage
> **Warning**
> Expect rapid iteration.
### Prepare the environment
Simply [install Cairo and scarb](https://docs.swmansion.com/scarb/download).
### Set up your project
Create a new project and `cd` into it.
```bash
scarb new my_project && cd my_project
```
The contents of `my_project` should look like this:
```bash
$ ls
Scarb.toml src
```
### Install the library
Edit `scarb.toml` and add:
```toml
[dependencies]
openzeppelin = "0.20.0"
```
The previous example would import the entire library. We can also add each package as a separate dependency to improve the building time by not including modules that won't be used:
```toml
[dependencies]
openzeppelin_token = "0.20.0"
```
Build the project to download it:
```bash
$ scarb build
Updating git repository https://github.com/OpenZeppelin/cairo-contracts
Compiling my_project v0.1.0 (~/my_project/Scarb.toml)
Finished release target(s) in 6 seconds
```
### Using the library
Open `src/lib.cairo` and write your contract.
For example, this is how to write an ERC20-compliant contract:
```cairo
#[starknet::contract]
mod MyToken {
use openzeppelin_token::erc20::{ERC20Component, ERC20HooksEmptyImpl};
use starknet::ContractAddress;
component!(path: ERC20Component, storage: erc20, event: ERC20Event);
// ERC20 Mixin
#[abi(embed_v0)]
impl ERC20MixinImpl = ERC20Component::ERC20MixinImpl;
impl ERC20InternalImpl = ERC20Component::InternalImpl;
#[storage]
struct Storage {
#[substorage(v0)]
erc20: ERC20Component::Storage
}
#[event]
#[derive(Drop, starknet::Event)]
enum Event {
#[flat]
ERC20Event: ERC20Component::Event
}
#[constructor]
fn constructor(
ref self: ContractState,
initial_supply: u256,
recipient: ContractAddress
) {
let name = "MyToken";
let symbol = "MTK";
self.erc20.initializer(name, symbol);
self.erc20.mint(recipient, initial_supply);
}
}
```
## Learn
### Documentation
Check out the [full documentation site](https://docs.openzeppelin.com/contracts-cairo)!
### Cairo
- [Cairo book](https://book.cairo-lang.org/)
- [Cairo language documentation](https://docs.cairo-lang.org/)
- [Starknet documentation](https://docs.starknet.io/)
- [Cairopractice](https://cairopractice.com/)
### Tooling
- [Scarb](https://docs.swmansion.com/scarb)
## Development
> **Note**: You can track our roadmap and future milestones in our [Github Project](https://github.com/orgs/OpenZeppelin/projects/29/).
OpenZeppelin Contracts for Cairo exists thanks to its contributors. There are many ways you can participate and help build high quality software, make sure to check out the [contribution](CONTRIBUTING.md) guide in advance.
### Set up the project
Clone the repository:
```bash
git clone [email protected]:OpenZeppelin/cairo-contracts.git
```
`cd` into it and build:
```bash
cd cairo-contracts
scarb build -w
```
### Run tests
```bash
snforge test -w
```
## Security
> ⚠️ Warning! ⚠️
> This project is still in a very early and experimental phase. It has never been audited nor thoroughly reviewed for security vulnerabilities. Do not use in production.
Refer to [SECURITY.md](SECURITY.md) for more details.
## License
OpenZeppelin Contracts for Cairo is released under the [MIT License](LICENSE).