Skip to content

Commit

Permalink
Backport update package descriptions and readme (#682)
Browse files Browse the repository at this point in the history
* exclude system transactions from tip cap calc. (#674)

* exclude system transactions from tip cap calc.

* ci runs on prs to main

* Update package details in cargo.toml files (#678)

* Update package details in cargo.toml files

* Add devnet readme (#681)

---------

Co-authored-by: Ömer Talip Akalın <[email protected]>

---------

Co-authored-by: Esad Yusuf Atik <[email protected]>
Co-authored-by: Ömer Talip Akalın <[email protected]>
  • Loading branch information
3 people authored Jun 7, 2024
1 parent 7270755 commit 6f2b620
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ version = "0.4.0-rc.3"
edition = "2021"
license = "GPL-3.0"
authors = ["Chainway Labs <[email protected]>"]
homepage = "https://chainway.xyz"
homepage = "https://citrea.xyz"
publish = false
repository = "https://github.com/chainwayxyz/citrea"

Expand All @@ -73,7 +73,7 @@ jmt = { git = "https://github.com/penumbra-zone/jmt.git", rev = "1d007e11cb68aa5
async-trait = "0.1.71"
anyhow = { version = "1.0.68", default-features = false }
arbitrary = { version = "1.3.1", features = ["derive"] }
backoff = { version = "0.4.0", features = [ "futures", "tokio" ] }
backoff = { version = "0.4.0", features = ["futures", "tokio"] }
base64 = "0.13"
borsh = { version = "0.10.3", default-features = false }
# TODO: Consider replacing this serialization format
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Citrea

**The first rollup that enhances the capabilities of Bitcoin blockspace with zero-knowledge technology.**
**The first rollup that enhances the capabilities of Bitcoin blockspace with zero-knowledge technology, now [live on Devnet](https://www.blog.citrea.xyz/citrea-public-devnet-live/)! 🎉🍊🍋**

![](assets/banner.png)

> [!WARNING]
> Citrea is still work-in-progress. It has not been audited and should not be used in production under any circumstances. Many key features are under heavy development, and its proper integration with [Bitcoin](https://github.com/bitcoin/bitcoin) and [Clementine](https://github.com/chainwayxyz/clementine) is still ongoing. \
> \
> Please note that Citrea has not been deployed to Bitcoin or any other network yet. \
> Citrea is still work-in-progress as a public devnet. While it's launched as a public devnet (on top of a custom Bitcoin Signet), it has not been audited and many features are under heavy development. Citrea's proper integration with [Bitcoin](https://github.com/bitcoin/bitcoin) and [Clementine](https://github.com/chainwayxyz/clementine) is still ongoing. \
> \
> Follow our [website](https://citrea.xyz) & [social media accounts](https://twitter.com/citrea_xyz) for announcements regarding testnet & mainnet phases of Citrea. \
> \
> Citrea uses **BTC** as its native token. **There's no Citrea token**. Please beware of scams!
> Citrea uses **BTC** as its native token. **There's no Citrea token**. Please beware of scams! \
> \
> Please also note that **BTC** and **cBTC** of Citrea Devnet does not carry any real value.
## What is Citrea?

Expand Down Expand Up @@ -40,4 +40,4 @@ Citrea's vision is to build scalable infrastructure that advances Bitcoin into i
## Acknowledgments

- [Sovereign SDK](https://github.com/Sovereign-Labs/sovereign-sdk): Citrea is built on a forked version of the Sovereign SDK. We're deeply thankful to the development & support of Sovereign Labs through our journey.
- [Reth](https://github.com/paradigmxyz/reth): We use Reth crates in various components in Citrea. We're grateful for their rapid development & contribution to the Rust-Ethereum ecosystem.
- [Reth](https://github.com/paradigmxyz/reth): We use Reth crates in various components in Citrea. We're grateful for their rapid development & contribution to the Rust-Ethereum ecosystem.
2 changes: 1 addition & 1 deletion bin/citrea/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = { workspace = true }
edition = { workspace = true }
authors = { workspace = true }
license = { workspace = true }
homepage = "sovereign.xyz"
homepage = { workspace = true }
publish = false
resolver = "2"
default-run = "citrea"
Expand Down
6 changes: 3 additions & 3 deletions crates/bitcoin-da/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ name = "bitcoin-da"
version = "0.1.0"
edition = "2021"
license = "MIT OR Apache-2.0"
authors = ["Chainway <[email protected]>"]
homepage = "https://www.chainway.xyz"
authors = { workspace = true }
homepage = { workspace = true }
publish = false
repository = "https://github.com/chainway/bitcoin-da"
repository = { workspace = true }
rust-version = "1.66"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
2 changes: 1 addition & 1 deletion crates/citrea-stf/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ edition = { workspace = true }
resolver = "2"
authors = { workspace = true }
license = { workspace = true }
homepage = "sovereign.xyz"
homepage = { workspace = true }
publish = false

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down

0 comments on commit 6f2b620

Please sign in to comment.