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

fix: op-rs rename #883

Merged
merged 3 commits into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ edition = "2021"
license = "MIT"
rust-version = "1.81"
authors = ["clabby", "refcell"]
homepage = "https://github.com/anton-rs/kona"
repository = "https://github.com/anton-rs/kona"
homepage = "https://github.com/op-rs/kona"
repository = "https://github.com/op-rs/kona"
keywords = ["ethereum", "optimism", "crypto"]
categories = ["cryptography", "cryptography::cryptocurrencies"]
exclude = ["**/target"]
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@
</h4>

<p align="center">
<a href="https://github.com/anton-rs/kona/actions/workflows/rust_ci.yaml"><img src="https://github.com/anton-rs/kona/actions/workflows/rust_ci.yaml/badge.svg?label=ci" alt="CI"></a>
<a href="https://github.com/anton-rs/kona/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
<a href="https://anton-rs.github.io/kona"><img src="https://img.shields.io/badge/Contributor%20Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
<a href="https://github.com/op-rs/kona/actions/workflows/rust_ci.yaml"><img src="https://github.com/op-rs/kona/actions/workflows/rust_ci.yaml/badge.svg?label=ci" alt="CI"></a>
<a href="https://github.com/op-rs/kona/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
<a href="https://op-rs.github.io/kona"><img src="https://img.shields.io/badge/Contributor%20Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
<a href="https://github.com/ethereum-optimism/monorepo"><img src="https://img.shields.io/badge/OP%20Stack-monorepo-red?labelColor=2a2f35" alt="OP Stack"></a>
<a href="https://img.shields.io/codecov/c/github/anton-rs/kona"><img src="https://img.shields.io/codecov/c/github/anton-rs/kona" alt="Codecov"></a>
<a href="https://img.shields.io/codecov/c/github/op-rs/kona"><img src="https://img.shields.io/codecov/c/github/op-rs/kona" alt="Codecov"></a>
</p>

<p align="center">
<a href="#whats-kona">What's Kona?</a> •
<a href="#overview">Overview</a> •
<a href="https://anton-rs.github.io/kona/CONTRIBUTING.html">Contributing</a> •
<a href="https://op-rs.github.io/kona/CONTRIBUTING.html">Contributing</a> •
<a href="#credits">Credits</a>
</p>

Expand All @@ -37,7 +37,7 @@ program! Kona is also used by:
- [`op-succinct`][op-succinct]

To build your own backend for kona, or build a new application on top of its libraries,
see the [SDK section of the book](https://anton-rs.github.io/kona/sdk/intro.html).
see the [SDK section of the book](https://op-rs.github.io/kona/sdk/intro.html).

### Development Status

Expand Down Expand Up @@ -83,11 +83,11 @@ getting started with building your own programs, and a reference for the librari
[op-stack]: https://github.com/ethereum-optimism/optimism
[op-program]: https://github.com/ethereum-optimism/optimism/tree/develop/op-program
[cannon]: https://github.com/ethereum-optimism/optimism/tree/develop/cannon
[cannon-rs]: https://github.com/anton-rs/cannon-rs
[cannon-rs]: https://github.com/op-rs/cannon-rs
[badboi-cannon-rs]: https://github.com/BadBoiLabs/cannon-rs
[asterisc]: https://github.com/etheruem-optimism/asterisc
[fpp-specs]: https://specs.optimism.io/experimental/fault-proof/index.html
[book]: https://anton-rs.github.io/kona/
[book]: https://op-rs.github.io/kona/
[op-succinct]: https://github.com/succinctlabs/op-succinct
[op-labs]: https://github.com/ethereum-optimism
[bad-boi-labs]: https://github.com/BadBoiLabs
Expand Down
2 changes: 1 addition & 1 deletion book/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `kona-book`

This repository contains the source code for the Kona book, which is available at [anton-rs.github.io/kona](https://anton-rs.github.io/kona/).
This repository contains the source code for the Kona book, which is available at [op-rs.github.io/kona](https://op-rs.github.io/kona/).

## Contributing

Expand Down
4 changes: 2 additions & 2 deletions book/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ command = "mdbook-mermaid"
[output.html]
default-theme = "ferra"
preferred-dark-theme = "ferra"
git-repository-url = "https://github.com/anton-rs/kona"
edit-url-template = "https://github.com/anton-rs/kona/edit/main/book/{path}"
git-repository-url = "https://github.com/op-rs/kona"
edit-url-template = "https://github.com/op-rs/kona/edit/main/book/{path}"
additional-css = ["custom.css"]
additional-js = ["mermaid.min.js", "mermaid-init.js"]
2 changes: 1 addition & 1 deletion book/src/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before working with this repository locally, you'll need to install several depe

## Pull Request Process

1. Before anything, [create an issue](https://github.com/anton-rs/kona/issues/new) to discuss the change you're
1. Before anything, [create an issue](https://github.com/op-rs/kona/issues/new) to discuss the change you're
wanting to make, if it is significant or changes functionality. Feel free to skip this step for trivial changes.
1. Once your change is implemented, ensure that all checks are passing before creating a PR. The full CI pipeline can
be run locally via the `justfile`s in the repository.
Expand Down
2 changes: 1 addition & 1 deletion book/src/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

_Documentation for the Kona project._

<a href="https://github.com/anton-rs/kona"><img src="https://img.shields.io/badge/GitHub%20Repo-kona-green?logo=github"></a>
<a href="https://github.com/op-rs/kona"><img src="https://img.shields.io/badge/GitHub%20Repo-kona-green?logo=github"></a>

> 📖 `kona` is in active development, and is not yet ready for use in production. During development, this book will evolve quickly and may contain inaccuracies.
>
Expand Down
12 changes: 6 additions & 6 deletions book/src/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[op-stack]: https://github.com/ethereum-optimism/optimism
[op-program]: https://github.com/ethereum-optimism/optimism/tree/develop/op-program
[cannon]: https://github.com/ethereum-optimism/optimism/tree/develop/cannon
[cannon-rs]: https://github.com/anton-rs/cannon-rs
[cannon-rs]: https://github.com/op-rs/cannon-rs
[asterisc]: https://github.com/ethereum-optimism/asterisc
[fp-specs]: https://specs.optimism.io/experimental/fault-proof/index.html
[fpp-specs]: https://specs.optimism.io/experimental/fault-proof/index.html#fault-proof-program
Expand All @@ -15,11 +15,11 @@

<!-- Kona links -->

[kona]: https://github.com/anton-rs/kona
[book]: https://anton-rs.github.io/kona/
[issues]: https://github.com/anton-rs/kona/issues
[new-issue]: https://github.com/anton-rs/kona/issues/new
[contributing]: https://github.com/anton-rs/kona/tree/main/CONTRIBUTING.md
[kona]: https://github.com/op-rs/kona
[book]: https://op-rs.github.io/kona/
[issues]: https://github.com/op-rs/kona/issues
[new-issue]: https://github.com/op-rs/kona/issues/new
[contributing]: https://github.com/op-rs/kona/tree/main/CONTRIBUTING.md

<!-- People -->

Expand Down
4 changes: 2 additions & 2 deletions book/src/sdk/custom-backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ let pipeline = PipelineBuilder::new()
```

From here, a custom derivation driver is needed to produce the desired execution payload(s). An example of this for
`kona-client` can be found in the [DerivationDriver](https://github.com/anton-rs/kona/blob/main/bin/client/src/l1/driver.rs#L77).
`kona-client` can be found in the [DerivationDriver](https://github.com/op-rs/kona/blob/main/bin/client/src/l1/driver.rs#L77).

### `kona-mpt` / `kona-executor` sources

Expand Down Expand Up @@ -113,7 +113,7 @@ let header = executor.execute_payload(...).expect("Failed execution");
### Bringing it Together

Once your custom backend traits for both `kona-derive` and `kona-executor` have been implemented,
your final binary may look something like [that of `kona-client`'s](https://github.com/anton-rs/kona/blob/main/bin/client/src/kona.rs).
your final binary may look something like [that of `kona-client`'s](https://github.com/op-rs/kona/blob/main/bin/client/src/kona.rs).
Alternatively, if you're looking to prove a wider range of blocks, [`op-succinct`'s `range` program](https://github.com/succinctlabs/op-succinct/tree/main/programs/range)
offers a good example of running the pipeline and executor across a string of contiguous blocks.

Expand Down
2 changes: 1 addition & 1 deletion book/src/sdk/fpvm-backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Finally, in `kona-proof`, implementations of data source traits from `kona-deriv
to pull in untyped data from the host by `PreimageKey`. These data source traits are covered in more detail within
the [Custom Backend](./custom-backend.md) section, but we'll quickly gloss over them here to build intuition.

Let's take, for example, [`OracleL1ChainProvider`](https://github.com/anton-rs/kona/blob/40a8d7ec3def4a1eeb26492a1e4338d8b032e428/bin/client/src/l1/chain_provider.rs#L16-L23).
Let's take, for example, [`OracleL1ChainProvider`](https://github.com/op-rs/kona/blob/40a8d7ec3def4a1eeb26492a1e4338d8b032e428/bin/client/src/l1/chain_provider.rs#L16-L23).
The [`ChainProvider`](https://docs.rs/kona-derive/latest/kona_derive/traits/trait.ChainProvider.html) trait in `kona-derive`
defines a simple interface for fetching information about the L1 chain. In the `OracleL1ChainProvider`, this information
is pulled in over the [PreimageOracle ABI][preimage-specs]. There are many other examples of these data source traits,
Expand Down
4 changes: 2 additions & 2 deletions book/src/sdk/pipeline/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,12 +285,12 @@ So, [@clabby][clabby] and [@refcell][refcell] stood up [kona][kona] in a few mon

<!-- Links -->

[driver]: https://github.com/anton-rs/kona/blob/main/bin/client/src/l1/driver.rs#L74
[driver]: https://github.com/op-rs/kona/blob/main/bin/client/src/l1/driver.rs#L74
[next]: https://doc.rust-lang.org/nightly/core/iter/trait.Iterator.html#tymethod.next
[builder]: https://docs.rs/kona-derive/latest/kona_derive/pipeline/struct.PipelineBuilder.html
[alloy]: https://github.com/alloy-rs/alloy
[ethers-rs]: https://github.com/gakonst/ethers-rs
[kona]: https://github.com/anton-rs/kona
[kona]: https://github.com/op-rs/kona
[clabby]: https://github.com/clabby
[refcell]: https://github.com/refcell
[go]: https://go.dev/
Expand Down
4 changes: 2 additions & 2 deletions build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ docker run \
--platform linux/amd64 \
-v `pwd`/:/workdir \
-w="/workdir" \
ghcr.io/anton-rs/kona/cannon-builder:main cargo build --release -Zbuild-std=core,alloc
ghcr.io/op-rs/kona/cannon-builder:main cargo build --release -Zbuild-std=core,alloc
```

**asterisc**
Expand All @@ -29,5 +29,5 @@ docker run \
--platform linux/amd64 \
-v `pwd`/:/workdir \
-w="/workdir" \
ghcr.io/anton-rs/kona/asterisc-builder:main cargo build --release -Zbuild-std=core,alloc
ghcr.io/op-rs/kona/asterisc-builder:main cargo build --release -Zbuild-std=core,alloc
```
2 changes: 1 addition & 1 deletion build/asterisc/asterisc-repro.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ RUN git clone https://github.com/ethereum-optimism/asterisc && \
# Build kona-client @ `CLIENT_TAG` #
################################################################

FROM ghcr.io/anton-rs/kona/asterisc-builder@sha256:56c57453ebe09875e96df527d3734d781e987dbdc1e0ce9e813e1e88590036bd AS client-build
FROM ghcr.io/op-rs/kona/asterisc-builder@sha256:56c57453ebe09875e96df527d3734d781e987dbdc1e0ce9e813e1e88590036bd AS client-build
SHELL ["/bin/bash", "-c"]

ARG CLIENT_TAG
Expand Down
Loading
Loading