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

Prep for crates io #1101

Merged
merged 7 commits into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
5 changes: 5 additions & 0 deletions parachain/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[workspace.package]
authors = ["Snowfork <[email protected]>"]
edition = "2021"
repository = "https://github.com/snowfork/snowbridge.git"

[workspace]
resolver = "2"
members = [
Expand Down
6 changes: 3 additions & 3 deletions parachain/pallets/ethereum-beacon-client/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name = "snowbridge-ethereum-beacon-client"
description = "Snowbridge Beacon Client Pallet"
version = "0.0.1"
edition = "2021"
authors = ["Snowfork <[email protected]>"]
repository = "https://github.com/Snowfork/snowbridge"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[package.metadata.docs.rs]
Expand Down
3 changes: 3 additions & 0 deletions parachain/pallets/ethereum-beacon-client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum Beacon Client

The Ethereum Beacon Client is an on-chain light client that tracks Ethereum consensus using the beacon chain.
6 changes: 3 additions & 3 deletions parachain/pallets/inbound-queue/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name = "snowbridge-inbound-queue"
description = "Snowbridge Inbound Queue"
version = "0.1.1"
edition = "2021"
authors = ["Snowfork <[email protected]>"]
repository = "https://github.com/Snowfork/snowbridge"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[package.metadata.docs.rs]
Expand Down
3 changes: 3 additions & 0 deletions parachain/pallets/inbound-queue/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum Inbound Queue

Reads messages from Ethereum and sends it to intended destination on Polkadot, using XCM.
6 changes: 3 additions & 3 deletions parachain/pallets/outbound-queue/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name = "snowbridge-outbound-queue"
description = "Snowbridge Outbound Queue"
version = "0.1.1"
edition = "2021"
authors = ["Snowfork <[email protected]>"]
repository = "https://github.com/Snowfork/snowbridge"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[package.metadata.docs.rs]
Expand Down
3 changes: 3 additions & 0 deletions parachain/pallets/outbound-queue/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum Outbound Queue

Sends messages from an origin in the Polkadot ecosystem to Ethereum.
6 changes: 3 additions & 3 deletions parachain/pallets/outbound-queue/merkle-tree/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name = "snowbridge-outbound-queue-merkle-tree"
description = "Snowbridge Outbound Queue Merkle Tree"
version = "0.1.1"
edition = "2021"
authors = ["Snowfork <[email protected]>"]
repository = "https://github.com/Snowfork/snowbridge"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[package.metadata.docs.rs]
Expand Down
4 changes: 4 additions & 0 deletions parachain/pallets/outbound-queue/merkle-tree/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Snowbridge Outbound Queue Merkle Tree

This crate implements a simple binary Merkle Tree utilities required for inter-op with Ethereum
bridge & Solidity contract.
6 changes: 3 additions & 3 deletions parachain/pallets/outbound-queue/runtime-api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name = "snowbridge-outbound-queue-runtime-api"
description = "Snowbridge Outbound Queue Runtime API"
version = "0.1.0"
edition = "2021"
authors = ["Snowfork <[email protected]>"]
repository = "https://github.com/Snowfork/snowbridge"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[package.metadata.docs.rs]
Expand Down
6 changes: 6 additions & 0 deletions parachain/pallets/outbound-queue/runtime-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Ethereum Outbound Queue Runtime API

Provides an API:

- to prove BEEFY messages
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To generate merkle proofs for outbound messages.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😅 Dankie! 5afeb2d

- calculate delivery fee for delivering messages to Ethereum
6 changes: 3 additions & 3 deletions parachain/pallets/system/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name = "snowbridge-system"
description = "Snowbridge System"
version = "0.1.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
repository = "https://github.com/Snowfork/snowbridge"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[package.metadata.docs.rs]
Expand Down
4 changes: 3 additions & 1 deletion parachain/pallets/system/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
License: MIT-0
# Ethereum System

Contains management functions to manage functions on Ethereum. For example, creating agents and channels.
6 changes: 3 additions & 3 deletions parachain/pallets/system/runtime-api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name = "snowbridge-system-runtime-api"
description = "Snowbridge System Runtime API"
version = "0.1.0"
edition = "2021"
authors = ["Snowfork <[email protected]>"]
repository = "https://github.com/Snowfork/snowbridge"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[package.metadata.docs.rs]
Expand Down
3 changes: 3 additions & 0 deletions parachain/pallets/system/runtime-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Ethereum System Runtime API

Provides an API for looking up an agent ID on Ethereum.
5 changes: 3 additions & 2 deletions parachain/primitives/beacon/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name = "snowbridge-beacon-primitives"
description = "Snowbridge Beacon Primitives"
version = "0.0.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[dependencies]
Expand Down
10 changes: 10 additions & 0 deletions parachain/primitives/beacon/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Beacon Primitives

Crate with low-level supporting functions for the beacon client, including:

- bls12-381 signature handling to verify signatures on the beacon chain
- merkle proofs
- receipt verification
- ssz types

The code in this crate relates to the Ethereum consensus chain, commonly referred to as the beacon chain.
5 changes: 3 additions & 2 deletions parachain/primitives/core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name = "snowbridge-core"
description = "Snowbridge Core"
version = "0.1.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[dependencies]
Expand Down
4 changes: 4 additions & 0 deletions parachain/primitives/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Core Primitives

Contains common code core to Snowbridge, such as inbound and outbound queue types, pricing structs, ringbuffer data
types (used in the beacon client).
5 changes: 3 additions & 2 deletions parachain/primitives/ethereum/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name = "snowbridge-ethereum"
description = "Snowbridge Ethereum"
version = "0.1.0"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[dependencies]
Expand Down
4 changes: 4 additions & 0 deletions parachain/primitives/ethereum/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Ethereum Primitives

Contains code necessary to decode RLP encoded data (like the Ethereum log), structs for Ethereum execution headers. The
code in this crate relates to the Ethereum execution chain.
5 changes: 3 additions & 2 deletions parachain/primitives/router/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name = "snowbridge-router-primitives"
description = "Snowbridge Router Primitives"
version = "0.1.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[dependencies]
Expand Down
4 changes: 4 additions & 0 deletions parachain/primitives/router/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Router Primitives

Inbound and outbound router logic. Does XCM conversion to a lowered, simpler format the Ethereum contracts can
understand.
5 changes: 3 additions & 2 deletions parachain/runtime/kusama-common/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name = "snowbridge-kusama-common"
description = "Snowbridge Kusama Common"
version = "0.0.1"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we can also bump the version to "0.9.0" now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 06b88e3.

authors = ["Snowfork <[email protected]>"]
edition = "2021"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For completeness, can we add this field to all the manifests:

categories = ["cryptography::cryptocurrencies"]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 06b88e3.


[dependencies]
Expand Down
3 changes: 3 additions & 0 deletions parachain/runtime/kusama-common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Snowbridge Kusama Common

Common crate to contain Snowbridge Kusama runtime config.
5 changes: 3 additions & 2 deletions parachain/runtime/polkadot-common/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name = "snowbridge-polkadot-common"
description = "Snowbridge Polkadot Common"
version = "0.0.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[dependencies]
Expand Down
3 changes: 3 additions & 0 deletions parachain/runtime/polkadot-common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Snowbridge Polkadot Common

Common crate to contain Snowbridge Polkadot runtime config.
5 changes: 3 additions & 2 deletions parachain/runtime/rococo-common/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name = "snowbridge-rococo-common"
description = "Snowbridge Rococo Common"
version = "0.0.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[dependencies]
Expand Down
3 changes: 3 additions & 0 deletions parachain/runtime/rococo-common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Snowbridge Rococo Common

Common crate to contain Snowbridge Rococo runtime config.
5 changes: 3 additions & 2 deletions parachain/runtime/runtime-common/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
name = "snowbridge-runtime-common"
description = "Snowbridge Runtime Common"
version = "0.1.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"

[dependencies]
Expand Down
3 changes: 3 additions & 0 deletions parachain/runtime/runtime-common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Snowbridge Runtime Common

Common crate to contain runtime related structs and implementations for Snowbridge.
3 changes: 3 additions & 0 deletions parachain/runtime/tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Runtime Tests

Tests runtime config and bridge functionality in the boundaries of a runtime.
Loading