Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
ClementWalter committed Aug 1, 2023
1 parent 2ac9e10 commit c3d4116
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 29 deletions.
8 changes: 8 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"MD033": false,
"MD041": false,
"MD045": false,
"MD013": {
"code_blocks": false
}
}
3 changes: 3 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"proseWrap": "always"
}
68 changes: 44 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@

- [About](#about)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Build](#build)
- [Run](#run)
- [Test](#test)
- [Format](#format)
- [Roadmap](#roadmap)
Expand All @@ -45,24 +43,31 @@

## About

Kakarot is an (zk)-Ethereum Virtual Machine implementation written in Cairo. Kakarot is Ethereum compatible, i.e. all existing smart contracts, developer tools and wallets work out-of-the-box on Kakarot. It's been open source from day one. Soon available on Starknet L2 and L3.
Kakarot is an (zk)-Ethereum Virtual Machine implementation written in Cairo.
Kakarot is Ethereum compatible, i.e. all existing smart contracts, developer
tools and wallets work out-of-the-box on Kakarot. It's been open source from day
one. Soon available on Starknet L2 and L3.

It is a work in progress, and it is not ready for production.
🚧 It is a work in progress, and it is not ready for production.

## Getting Started

This repository is a rewrite of [the first version of Kakarot zkEVM](https://github.com/kkrt-labs/kakarot).

### Prerequisites

- [Cairo](https://github.com/starkware-libs/cairo)
- [Scarb](https://docs.swmansion.com/scarb/download)
This repository is a rewrite of
[the first version of Kakarot zkEVM](https://github.com/kkrt-labs/kakarot).

### Installation

- Install Scarb:
- `curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh`
- [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository and clone your fork (`git clone https://github.com/<YOUR_USERNAME>/kakarot-ssj`)

```bash
curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh
```

- [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the
repository and clone your fork
(`git clone https://github.com/<YOUR_USERNAME>/kakarot-ssj`)

## Usage

### Build

Expand All @@ -84,45 +89,57 @@ scarb fmt

## Roadmap

See the [open issues](https://github.com/sayajin-labs/kakarot-ssj/issues) for a list of proposed features (and known issues).
See the [open issues](https://github.com/sayajin-labs/kakarot-ssj/issues) for a
list of proposed features (and known issues).

- [Top Feature Requests](https://github.com/sayajin-labs/kakarot-ssj/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Top Bugs](https://github.com/sayajin-labs/kakarot-ssj/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Top Feature Requests](https://github.com/sayajin-labs/kakarot-ssj/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
(Add your votes using the 👍 reaction)
- [Top Bugs](https://github.com/sayajin-labs/kakarot-ssj/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
(Add your votes using the 👍 reaction)
- [Newest Bugs](https://github.com/sayajin-labs/kakarot-ssj/issues?q=is%3Aopen+is%3Aissue+label%3Abug)

## Support

Reach out to the maintainer at one of the following places:

- [GitHub Discussions](https://github.com/sayajin-labs/kakarot-ssj/discussions)
- Contact options listed on [this GitHub profile](https://github.com/starknet-exploration)
- [Telegram group](https://t.me/KakarotZkEvm)

## Project assistance

If you want to say **thank you** or/and support active development of Kakarot:

- Add a [GitHub Star](https://github.com/sayajin-labs/kakarot-ssj) to the project.
- Add a [GitHub Star](https://github.com/sayajin-labs/kakarot-ssj) to the
project.
- Tweet about [Kakarot](https://twitter.com/KakarotZkEvm).
- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog.
- Write interesting articles about the project on [Dev.to](https://dev.to/),
[Medium](https://medium.com/), [Mirror](https://mirror.xyz/) or your personal
blog.

Together, we can make Kakarot **better**!

## Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
First off, thanks for taking the time to contribute! Contributions are what make
the open-source community such an amazing place to learn, inspire, and create.
Any contribution you make will benefit everybody else and is **greatly
appreciated**.

Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved!
Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you
for being involved!

## Authors & contributors

For a full list of all authors and contributors, see [the contributors page](https://github.com/sayajin-labs/kakarot-ssj/contributors).
For a full list of all authors and contributors, see
[the contributors page](https://github.com/sayajin-labs/kakarot-ssj/contributors).

## Security

Kakarot follows good practices of security, but 100% security cannot be assured.
Kakarot is provided **"as is"** without any **warranty**. Use at your own risk.

_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._
_For more information and to report security issues, please refer to our
[security documentation](docs/SECURITY.md)._

## License

Expand All @@ -134,7 +151,8 @@ See [LICENSE](LICENSE) for more information.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Thanks goes to these wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -162,7 +180,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!

<p align="center">
<img src="docs/img/kakarot_github_banner_footer.png" height="200">
Expand Down
9 changes: 4 additions & 5 deletions src/tests/test_kakarot.cairo
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
// Core lib imports
use array::ArrayTrait;
use option::OptionTrait;
// Internal imports
use kakarot::context::CallContext;
use kakarot::evm;
use kakarot::stack::StackTrait;
use option::OptionTrait;
use kakarot::context::CallContext;


#[test]
#[available_gas(2000000)]
Expand All @@ -13,6 +12,7 @@ fn nominal_case_empty_pc() {
let bytecode = ArrayTrait::<u8>::new();
let call_data = ArrayTrait::<u8>::new();
let call_value = 0;

// Create a call context.
let call_context = CallContext {
bytecode: bytecode, call_data: call_data, value: call_value,
Expand All @@ -36,4 +36,3 @@ fn stack_should_increment_len_on_push() {

assert(stack_len == 1, 1);
}

0 comments on commit c3d4116

Please sign in to comment.