From 6f2b6207fc10bce64f9a643835cce262d828535c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erce=20Can=20Bekt=C3=BCre?= <47954181+ercecan@users.noreply.github.com> Date: Fri, 7 Jun 2024 15:47:44 +0300 Subject: [PATCH] Backport update package descriptions and readme (#682) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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 <56600661+otaliptus@users.noreply.github.com> --------- Co-authored-by: Esad Yusuf Atik Co-authored-by: Ömer Talip Akalın <56600661+otaliptus@users.noreply.github.com> --- Cargo.toml | 4 ++-- README.md | 12 ++++++------ bin/citrea/Cargo.toml | 2 +- crates/bitcoin-da/Cargo.toml | 6 +++--- crates/citrea-stf/Cargo.toml | 2 +- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 7ee1afb92..9d62a4331 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -61,7 +61,7 @@ version = "0.4.0-rc.3" edition = "2021" license = "GPL-3.0" authors = ["Chainway Labs "] -homepage = "https://chainway.xyz" +homepage = "https://citrea.xyz" publish = false repository = "https://github.com/chainwayxyz/citrea" @@ -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 diff --git a/README.md b/README.md index daf39b3a2..cacbef1a0 100644 --- a/README.md +++ b/README.md @@ -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? @@ -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. \ No newline at end of file diff --git a/bin/citrea/Cargo.toml b/bin/citrea/Cargo.toml index a07b30e3e..579f8d6ab 100644 --- a/bin/citrea/Cargo.toml +++ b/bin/citrea/Cargo.toml @@ -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" diff --git a/crates/bitcoin-da/Cargo.toml b/crates/bitcoin-da/Cargo.toml index de00bc2e9..9d54017e5 100644 --- a/crates/bitcoin-da/Cargo.toml +++ b/crates/bitcoin-da/Cargo.toml @@ -3,10 +3,10 @@ name = "bitcoin-da" version = "0.1.0" edition = "2021" license = "MIT OR Apache-2.0" -authors = ["Chainway "] -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 diff --git a/crates/citrea-stf/Cargo.toml b/crates/citrea-stf/Cargo.toml index ab3f1024b..336295ab2 100644 --- a/crates/citrea-stf/Cargo.toml +++ b/crates/citrea-stf/Cargo.toml @@ -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