Skip to content

Commit

Permalink
Improve Katana and Torii
Browse files Browse the repository at this point in the history
  • Loading branch information
tarrencev committed Nov 7, 2023
1 parent a2c016b commit 7219241
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 9 deletions.
13 changes: 10 additions & 3 deletions src/toolchain/katana/overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
## Katana

`katana` is a _blazingly fast_ local Starknet node, designed to support local development with Dojo.
Katana is a _blazingly fast_ sequencer, designed to support both local development as well as production deployments.

In development mode, Katana provides the tool necessary for rapid iteration, including custom development RPCs for manipulating the execution context.

In produciton mode, Katana provides a high performance sequencer optimized for gaming workloads, with support for settlment and cross layer communication.

### Features

- [Starknet JSON-RPC v0.3.0](https://github.com/starkware-libs/starknet-specs/tree/v0.3.0) support
- Custom methods for manipulating the blockchain states
- [Starknet JSON-RPC v0.3.0](https://github.com/starkware-libs/starknet-specs/tree/v0.3.0) support
- Cross layer communication (L1 <> L2, LN <> LN+1)
- Custom methods for manipulating the blockchain states

## Installation

Expand Down Expand Up @@ -57,6 +62,8 @@ ACCOUNTS SEED

```

To enable development features, run using the `--dev` flag.

> 📚 **Reference**
>
> See the [`katana` Reference](./reference.md) for an in depth reference and documentation on Katana.
13 changes: 7 additions & 6 deletions src/toolchain/torii/overview.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
## Torii - Networking & Indexing

Torii is an automatic indexer for dojo worlds. Built in rust to be blazingly fast and exceptionally scalable.
Torii is an automatic indexer for dojo worlds. Built in rust to be blazingly fast and exceptionally scalable. Torii provides a fully typed, dynamically generated GraphqQL interface and a high performance gRPC api for binding clients to the world state.

### Dojo indexer
### Usage

Torii indexes your dojo worlds and exposes a GraphQL API to query them. Simply run:
Torii leverages world introspection to bootstrap directly from an onchain deployment. Simply run:

```sh
torii
torii --world <World Address>
```
and you'll have a GraphQL API running on `http://localhost:8080`!

You'll have a GraphQL API running at `http://localhost:8080/graphql` and a gRPC api at `http://localhost:8080/grpc`

## Installation

Expand All @@ -27,4 +28,4 @@ This will install Torii and the required dependencies on your local system.

> 📚 **Reference**
>
> See the [`torii` Reference](./reference.md) for a complete reference.
> See the [`torii` Reference](./reference.md) for a complete reference.

0 comments on commit 7219241

Please sign in to comment.