Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starknet-edu/deploy-cairo1-demo
https://github.com/starknet-edu/deploy-cairo1-demo
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/starknet-edu/deploy-cairo1-demo
- Owner: starknet-edu
- Created: 2023-03-22T09:20:25.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-03-30T09:39:49.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:42:38.611Z (4 months ago)
- Language: Cairo
- Size: 3.91 KB
- Stars: 48
- Watchers: 2
- Forks: 23
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-cairo - `deploy-cairo1-demo`
README
# Deploying your first Cairo 1 contract to Starknet
With [version 0.11](https://starkware.medium.com/starknet-alpha-v0-11-0-the-transition-to-cairo-1-0-begins-30442d494515) rolling out on Starknet, you can now deploy your first Cairo 1 contracts on Starknet! Fantastic!... But how ser?
Here is a very rough guide, before we get our doc in order
## The flow
You will need to:
- Clone the Cairo repository (the tool to compile your Cairo 1 contract) at a specific height
- Install the latest version of Cairo-lang (the tool to interact with Starknet)
- Compile your contract from Cairo to Sierra, using cairo
- Declare your Sierra contract, using cairo-lang
- Deploy your contract, using cairo-lang
- Brag to your friends, using Twitter## Clone this repo
```bash
git clone https://github.com/starknet-edu/deploy-cairo1-demo
cd deploy-cairo1-demo
```## Installing the Cairo one compiler
If you're installing Cairo for the first time:
```bash
git clone https://github.com/starkware-libs/cairo/
cd cairo
git checkout 9c190561ce1e8323665857f1a77082925c817b4c
cargo build --all --release
```If you already have Cairo installed:
```bash
cd cairo
git fetch && git pull
git checkout 9c190561ce1e8323665857f1a77082925c817b4c
cargo build --all --release
```At this point you have Cairo installed in this repository.
## Installing Cairo-lang
Go back to the root folder of the repo
```bash
cd ..
```
Set up a python virtual environment
```bash
python3.9 -m venv ~/cairo_venv_v11
source ~/cairo_venv_v11/bin/activate
```
If you had cairo-lang installed previously, uninstall it
```bash
pip3 uninstall cairo-lang
```
Install Cairo lang
```bash
pip3 install ecdsa fastecdsa sympy
pip3 install cairo-lang
```
Check that you have it installed correctly
```bash
starknet --version
```## Compile your contract using Cairo
You can use [this smol demo contract](hello_starknet.cairo) to complete this test. It's a very basic event logger.From your terminal, in the folder you installed Cairo in
```bash
cd cairo
cargo run --bin starknet-compile -- ../hello_starknet.cairo ../hello_starknet.json --replace-ids
```
Congratulations, you have compiled your contracts from Cairo to Sierra!## Declare your contract using Cairo-lang
### Setting environment variables
```bash
export STARKNET_NETWORK=alpha-goerli
export STARKNET_WALLET=starkware.starknet.wallets.open_zeppelin.OpenZeppelinAccount
```### Setting a new account for the tutorial
You need to make sure your starknet CLI is set up with a proper account contract, and funds. For safety, I'll create a new one just for this tutorial.
```bash
starknet new_account --account version_11
```
- You should get your expected contract address
- Send 0.1 ETH to it
- Monitor the transfer transaction. Once it has passed "pending", proceed
```bash
starknet deploy_account --account version_11
```
Monitor the deploy transaction. Once it has passed "pending", proceed### Declaring the contract
Go back to the root folder of the tutorial then try to declare
```bash
cd ..
starknet declare --contract hello_starknet.json --account version_11
```
You should receive your newly declared class hash!### Troubleshooting
Ok so here I had a problem. Using declare sent back:
```bash
Error: OSError: [Errno 8] Exec format error: '~/cairo_venv_11/lib/python3.9/site-packages/starkware/starknet/compiler/v1/bin/starknet-sierra-compile'
```
The reason is that cairo-lang needs to compile your sierra code, and it uses an imported rust binary 'starknet-sierra-compile' for that. But in my case, the imported binary was not built for my achitecture :-(.So, simple: I took the 'starknet-sierra-compile' from the cairo repo, that I built locally, and replaced it in the python package. Here is a command that should work:
```bash
cp cairo/target/release/starknet-sierra-compile ~/cairo_venv_v11/lib/python3.9/site-packages/starkware/starknet/compiler/v1/bin/starknet-sierra-compile
```Then try again declaring. It should work!
## Deploy your contract using Cairo-lang
At this point you are back in the flow you are used to. Using the class hash you received earlier:
```bash
starknet deploy --class_hash --account version_11
```
Monitor your transaction. If it fails because of fee estimation, retry. Once your transaction is accepted_on_l2.... Congratulations! You've deployed your first Cairo 1 contract!## Bragging on Twitter
Don't forget to brag! Post your deployed contract [here](https://twitter.com/henrlihenrli/status/1638468939939282945)And don't forget to add cool functionnalities to your contract.
The Starknet edu team will release soon the Cairo 1 version of [Cairo-101](https://github.com/starknet-edu/starknet-cairo-101). In the meanwhile, you can get ideas of what to do with Cairo 1 with [Starklings-cairo1](https://github.com/shramee/starklings-cairo1)## Do you want to learn more?
If you are interested in
- Learning how to develop cool stuff on Starknet
- How Starknet works
- What Cairo is
- How Stark proofs work
You should join Basecamp, our free 6 weeks training program for aspiring Starknet devs. The next two cohorts start in April and you register [here](https://forms.reform.app/starkware/starknet-basecamp-registration-starting-jan-4th-copy-2/itvk4e) for a cohort in English, and [aqui](https://forms.reform.app/starkware/starknet-basecamp-registration-starting-apr-11th-copy/itvk4e) para una cohort en Español.