Skip to content

Commit

Permalink
Update README.md (#9)
Browse files Browse the repository at this point in the history
Add context on what chapters are, formatting
  • Loading branch information
jenpaff authored Oct 10, 2024
1 parent 151bca8 commit 401de3f
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
# Odyssey Examples

## Overview
This repository provides a step-by-step walk through for builders interested in the developer-preview features available on [Odyssey](https://www.ithaca.xyz/updates/introducing-ithaca), a L2 built for developers to innovate. We are rolling out each Chapter with new features for you to build on.

This repository provides a step-by-step walk through for builders interested in the developer-preview features available on [Odyssey](https://www.ithaca.xyz/updates/introducing-ithaca). Each chapter provides examples of new features added.

## Chapter 1
- [Simple Example for EIP-7702](./chapter1/simple-7702/): Basic example to showcase how EIP-7702 transactions work
- [Delegate Account to p256 key](./chapter1/delegate-p256/): Step-by-step walk-through of how EIP-7702+EIP-7212 provide the ability to sign a message with a P256 key
- [BLS Multisig](./chapter1/bls-multisig/): Examples in Python and Rust to showcase Multisig based on BLS signatures verified through precompiles from EIP-2537
### Chapter 1
- [Simple Example for EIP-7702](./chapter1/simple-7702/): Showcases how EIP-7702 transactions work
- [Delegate an account to a p256 key](./chapter1/delegate-p256/): Describes how EIP-7702+EIP-7212 provide the ability to sign a message with a P256 key
- [BLS Multisig](./chapter1/bls-multisig/): In-depth walk-through how to implement a Multisig based on BLS signatures verified through precompiles from EIP-2537
- [EOF](./chapter1/eof/): Instructions on how to deploy and inspect contracts in the new EOF format

## Build & Run
### Build & Test

Use foundry to build and run smart contracts in the repo
Use [foundry](https://github.com/foundry-rs/foundry) to build and run smart contracts in the repository:

```bash
# Make sure foundry is up to date
foundryup

# Compile contracts and run tests in chapter 1
cd chapter1
cd chapter1/
forge build
forge test
````
````

0 comments on commit 401de3f

Please sign in to comment.