Skip to content

Commit

Permalink
Prep for crates io (#1101)
Browse files Browse the repository at this point in the history
* update cargo files

* Adds readmes

* correct readme text

* updates snowbridge versions and adds category tags

* update polkadot-sdk

* update polkadot-sdk

* update polkadot-sdk

---------

Co-authored-by: claravanstaden <Cats 4 life!>
  • Loading branch information
claravanstaden authored Jan 9, 2024
1 parent 011cb7f commit a90f0c9
Show file tree
Hide file tree
Showing 37 changed files with 176 additions and 86 deletions.
26 changes: 13 additions & 13 deletions parachain/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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
9 changes: 5 additions & 4 deletions parachain/pallets/ethereum-beacon-client/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
[package]
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"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
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.
8 changes: 4 additions & 4 deletions parachain/pallets/ethereum-beacon-client/fuzz/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 5 additions & 4 deletions parachain/pallets/inbound-queue/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
[package]
name = "snowbridge-inbound-queue"
description = "Snowbridge Inbound Queue"
version = "0.1.1"
edition = "2021"
authors = ["Snowfork <[email protected]>"]
repository = "https://github.com/Snowfork/snowbridge"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
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.
9 changes: 5 additions & 4 deletions parachain/pallets/outbound-queue/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
[package]
name = "snowbridge-outbound-queue"
description = "Snowbridge Outbound Queue"
version = "0.1.1"
edition = "2021"
authors = ["Snowfork <[email protected]>"]
repository = "https://github.com/Snowfork/snowbridge"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
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.
9 changes: 5 additions & 4 deletions parachain/pallets/outbound-queue/merkle-tree/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
[package]
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"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
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.
9 changes: 5 additions & 4 deletions parachain/pallets/outbound-queue/runtime-api/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
[package]
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"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
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 generate merkle proofs for outbound messages
- calculate delivery fee for delivering messages to Ethereum
9 changes: 5 additions & 4 deletions parachain/pallets/system/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
[package]
name = "snowbridge-system"
description = "Snowbridge System"
version = "0.1.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
repository = "https://github.com/Snowfork/snowbridge"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
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.
9 changes: 5 additions & 4 deletions parachain/pallets/system/runtime-api/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
[package]
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"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
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.
8 changes: 5 additions & 3 deletions parachain/primitives/beacon/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[package]
name = "snowbridge-beacon-primitives"
description = "Snowbridge Beacon Primitives"
version = "0.0.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[dependencies]
serde = { version = "1.0.188", optional = true, features = ["derive"] }
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.
8 changes: 5 additions & 3 deletions parachain/primitives/core/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[package]
name = "snowbridge-core"
description = "Snowbridge Core"
version = "0.1.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[dependencies]
serde = { version = "1.0.188", optional = true, features = ["alloc", "derive"], default-features = false }
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).
8 changes: 5 additions & 3 deletions parachain/primitives/ethereum/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[package]
name = "snowbridge-ethereum"
description = "Snowbridge Ethereum"
version = "0.1.0"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[dependencies]
serde = { version = "1.0.188", optional = true, features = ["derive"] }
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.
8 changes: 5 additions & 3 deletions parachain/primitives/router/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[package]
name = "snowbridge-router-primitives"
description = "Snowbridge Router Primitives"
version = "0.1.1"
authors = ["Snowfork <[email protected]>"]
edition = "2021"
version = "0.9.0"
edition.workspace = true
authors.workspace = true
repository.workspace = true
license = "Apache-2.0"
categories = ["cryptography::cryptocurrencies"]

[dependencies]
serde = { version = "1.0.188", optional = true, features = ["derive"] }
Expand Down
Loading

0 comments on commit a90f0c9

Please sign in to comment.