Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare release 2.9.2 #286

Merged
merged 44 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
ade384f
Prepare release 2.8.2 (#257)
julio4 Nov 21, 2024
7229cb7
fix(app): correct sidebar placement
julio4 Nov 21, 2024
5f3513e
fix(app): responsive content centering
julio4 Nov 21, 2024
c6f7e7c
fix(app): responsive content centering
julio4 Nov 21, 2024
75d68e2
Update issue templates, Close #273
julio4 Dec 6, 2024
1aa137b
Feat: add logos (#278)
julio4 Dec 17, 2024
1ea1387
Feat: upgrade to `2.9.2` (#280)
julio4 Dec 17, 2024
319609a
Update verify_cairo_programs.yml
julio4 Dec 17, 2024
904b746
feat: rework index
julio4 Jan 1, 2025
0fe426b
fix: suggest snforge in contributing guide
julio4 Jan 1, 2025
86b240d
fix: update footer date
julio4 Jan 1, 2025
57c35bd
feat: migrate storage to snforge
julio4 Jan 3, 2025
b0cbfff
feat: rework storage
julio4 Jan 3, 2025
23c161b
feat: storage space section
julio4 Jan 3, 2025
9e74dd0
fix: syscall typo
julio4 Jan 3, 2025
4ad870e
feat: migrate constructor to snforge
julio4 Jan 12, 2025
1dd88c7
feat: rework constructor
julio4 Jan 12, 2025
313f75e
feat: improve storage layout example
julio4 Jan 13, 2025
65db4cb
feat: migrate variables to snforge
julio4 Jan 14, 2025
b33bbfd
feat: rework variables
julio4 Jan 14, 2025
9455abf
fix: simplify local variable
julio4 Jan 14, 2025
6c419f5
feat: migrate visibility to snforge
julio4 Jan 16, 2025
bb3e7e0
feat: rework visibility
julio4 Jan 16, 2025
4632562
feat: migrate counter to snforge
julio4 Jan 20, 2025
4d47436
fix: remove pub visibility for counter contract
julio4 Jan 21, 2025
b8120c9
feat: migrate mappings to snforge
julio4 Jan 21, 2025
4d9e928
feat: rework mappings
julio4 Jan 21, 2025
e1908da
remove ByteArray/String chapter
julio4 Jan 21, 2025
e05dc64
feat: migrate errors to snforge
julio4 Jan 21, 2025
41cdc06
feat: rework errors
julio4 Jan 21, 2025
93845ff
Update README.md
julio4 Jan 21, 2025
93ee3fb
feat: migrate events to snforge
julio4 Jan 22, 2025
a4fa6b4
feat: rework events
julio4 Jan 23, 2025
c358932
feat: migrate storing_custom_types to snforge
julio4 Jan 23, 2025
c2c3c29
feat: rework storing_custom_types
julio4 Jan 23, 2025
d13e155
feat: migrate custom_type_entrypoints to snforge
julio4 Jan 24, 2025
b9d0450
feat: rework custom_type_entrypoints
julio4 Jan 24, 2025
24d3d08
feat: update syscalls (close #283)
julio4 Jan 25, 2025
4cbc935
feat: remove interacting/interface chapter
julio4 Jan 26, 2025
dd00697
Update simple_vault.cairo
CountryCousin Jan 26, 2025
48a3667
feat: migrate calling_other_contract to snforge
julio4 Jan 27, 2025
ac41ee5
feat: rework calling_other_contract
julio4 Jan 27, 2025
b78c30c
fix: cairo cheatsheet in sub listing
julio4 Jan 28, 2025
4328222
feat: update CI/CD
julio4 Jan 28, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Checklist:**
- Using the correct tooling versions, from https://github.com/NethermindEth/StarknetByExample/blob/dev/.tool-versions
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Feature request
about: Suggest an idea of example or concept to showcase
title: ''
labels: enhancement
assignees: ''

---

**Describe the concept/idea you would like to see**

**Is it a new example or a modification/extension of a current one**
If you consider editing some content, explain exactly why and what.

**Additional context**
Add any other context or screenshots about the request here.
17 changes: 9 additions & 8 deletions .github/workflows/verify_cairo_programs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,17 @@ name: Verify Cairo programs compilation
on:
pull_request:
branches:
- dev
- main
workflow_dispatch:

jobs:
typos:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: crate-ci/typos@master

compile_and_verify:
runs-on: ubuntu-latest

Expand All @@ -19,21 +26,15 @@ jobs:
- name: Configure upstream repository
run: |
git remote add upstream https://github.com/NethermindEth/StarknetByExample
git fetch upstream main
git fetch upstream

- name: Install scarb
uses: software-mansion/setup-scarb@v1

- name: Install snforge
uses: foundry-rs/setup-snfoundry@v3

- name: Run build script
- name: Verify changes
run: |
chmod +x scripts/cairo_programs_verifier.sh
./scripts/cairo_programs_verifier.sh

typos:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: crate-ci/typos@master
4 changes: 2 additions & 2 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
scarb 2.8.2
starknet-foundry 0.30.0
scarb 2.9.2
starknet-foundry 0.35.0
30 changes: 18 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

When contributing to this repository, please first discuss the change you wish to make via issue or in the telegram channel before making a change.

Join the telegram channel: https://t.me/StarknetByExample
Join the telegram channel: <https://t.me/StarknetByExample>

The release branch is `main`. The development branch is `dev` and is considered stable (but not released yet).
When you want to contribute, please create a new branch from `dev` and open a pull request to merge your changes back into `dev`.
You should never open a pull request to merge your changes directly into `main`.

The `dev` branch is deployed at <https://starknet-by-example-dev.voyager.online/>

Please note we have a code of conduct, please follow it in all your interactions with the project.

Expand Down Expand Up @@ -80,10 +86,10 @@ typos src/
You can add or modify examples in the `listings` directory. Each listing is a scarb project.
You can use `scarb init` to create a new scarb project, but be sure to remove the generated git repository with `rm -rf .git` and follow the instructions below for the correct `Scarb.toml` configuration.

You can choose to use standard cairo with `cairo-test` or Starknet Foundry with `snforge_std`.
We prefer to use Starknet Foundry with `snforge_std`, however you can still use `cairo-test` if desired.
Please use the appropriate `Scarb.toml` configuration. `scarb test` will automatically resolve to `snforge test` if `snforge_std` is in the dependencies.

Here's the required `Scarb.toml` configuration for **cairo-test**:
Here's the required `Scarb.toml` configuration for **Starknet Foundry**:

```toml
[package]
Expand All @@ -103,15 +109,21 @@ starknet.workspace = true
# erc20 = { path = "../../getting-started/erc20" }

[dev-dependencies]
cairo_test.workspace = true
assert_macros.workspace = true
snforge_std.workspace = true

[scripts]
test.workspace = true

[[target.starknet-contract]]
```

Here's the required `Scarb.toml` configuration for **Starknet Foundry**:
You also **NEED** to do the following:

- Remove the generated git repository, `rm -rf .git` (this is important!)
- Double check that the package name is the same as the name of the directory

Here's the required `Scarb.toml` configuration for **cairo-test**:

```toml
[package]
Expand All @@ -131,20 +143,14 @@ starknet.workspace = true
# erc20 = { path = "../../getting-started/erc20" }

[dev-dependencies]
assert_macros.workspace = true
snforge_std.workspace = true
cairo_test.workspace = true

[scripts]
test.workspace = true

[[target.starknet-contract]]
```

You also NEED to do the following:

- Remove the generated git repository, `rm -rf .git` (this is important!)
- Double check that the package name is the same as the name of the directory

### Verification script

The current book has script that verifies the compilation of all Cairo programs in the book.
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Starknet by Example

Dev preview at: https://starknet-by-example-dev.voyager.online/

## Description

Starknet by Example is a collection of examples of how to use the [Cairo](https://github.com/starkware-libs/cairo) programming language to create smart contracts on Starknet.
Expand Down
Loading