Skip to content

Commit

Permalink
chore: copy README files
Browse files Browse the repository at this point in the history
  • Loading branch information
dafnamatsry committed Jul 18, 2024
1 parent e39878c commit d925f54
Show file tree
Hide file tree
Showing 5 changed files with 522 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Starknet-Node
# Sequencer
66 changes: 66 additions & 0 deletions docs/blockifier/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
<div align="center">
<h1>Blockifier</h1>
<br />
<a href="https://github.com/starkware-libs/blockifier/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a>
·
<a href="https://github.com/starkware-libs/blockifier/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a>
·
<a href="https://github.com/starkware-libs/blockifier/discussions/new?category=q-a">Ask a Question</a>
</div>

<div align="center">
<br />

[![GitHub Workflow Status](https://github.com/starkware-libs/blockifier/actions/workflows/post-merge.yml/badge.svg)](https://github.com/starkware-libs/blockifier/actions/workflows/post-merge.yml)
[![codecov](https://codecov.io/gh/starkware-libs/blockifier/branch/main/graph/badge.svg?token=Z5MXY45MR5)](https://codecov.io/gh/starkware-libs/blockifier)

</div>

<details open="open">
<summary>Table of Contents</summary>

- [About](#about)
- [Roadmap](#roadmap)
- [Support](#support)
- [Security](#security)
- [License](#license)

</details>

---

## About

Blockifier is a Rust implementation of the component in the Starknet sequencer that executes transactions, and is in charge of creating state diffs and blocks.

## Roadmap

The Blockifier is a step towards a decentralized sequencer client for Starknet, allowing anyone to run one.
We'll add more milestones to this table once we finish the first one, where we blockify transactions sequentially, including all existing functionality.

| name | status |
| -------------------------------------------------------------------------------------------------------------------------------------- | :----: |
| Add the ability to execute a block and output a state diff. ||
| Integrate with the existing Starknet Sequencer by replacing its current transaction-blockifying component, which is written in Python. ||
| Implement optimistic concurrency of transaction execution. | |
| Extend the Blockifier into a full Starknet sequencer, written in Rust, replacing the one currently in use. | |

## Support

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

- [GitHub Discussions](https://github.com/starkware-libs/blockifier/discussions)
- Contact options listed on [this GitHub profile](https://github.com/starkware-libs)

## Security

Blockifier follows good security practices, but 100% security cannot be assured.
Blockifier 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)._

## License

This project is licensed under the **Apache 2.0 license**.

See [LICENSE](LICENSE) for more information.
17 changes: 17 additions & 0 deletions docs/mempool/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<div align="center">
<h1>Mempool</h1>
<br />
<a href="https://github.com/starkware-libs/mempool/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a>
·
<a href="https://github.com/starkware-libs/mempool/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a>
·
<a href="https://github.com/starkware-libs/mempool/discussions/new?category=q-a">Ask a Question</a>
</div>

<div align="center">
<br />

[![GitHub Workflow Status](https://github.com/starkware-libs/mempool/actions/workflows/post-merge.yml/badge.svg)](https://github.com/starkware-libs/mempool/actions/workflows/post-merge.yml)
[![codecov](https://codecov.io/gh/starkware-libs/mempool/branch/main/graph/badge.svg?token=Z5MXY45MR5)](https://codecov.io/gh/starkware-libs/mempool)

</div>
Loading

0 comments on commit d925f54

Please sign in to comment.