Skip to content

Commit

Permalink
Merge pull request #3 from TheArchitect108/develop
Browse files Browse the repository at this point in the history
merge from tip
  • Loading branch information
TheArchitect108 authored Sep 5, 2022
2 parents 6f8f297 + 31b64b3 commit 8e80352
Show file tree
Hide file tree
Showing 79 changed files with 3,186 additions and 915 deletions.
4 changes: 2 additions & 2 deletions .github/actions/build-dependencies/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ runs:
shell: bash
run: |
pip3 install solc-select
solc-select install 0.8.9
solc-select use 0.8.9
solc-select install 0.8.16
solc-select use 0.8.16
- name: Install Rust
uses: ./.github/actions/cached-rust
Expand Down
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing

Contributions come in a variety of forms. Developing Serai, helping document it,
using its libraries in another project, using and testing it, and simply sharing
it are all valuable ways of contributing.

This document will specifically focus on contributions to this repository in the
form of code and documentation.

### Rules

- Stable native Rust, nightly wasm and tools.
- `cargo fmt` must be used.
- `cargo clippy` must pass, except for the ignored rules (`type_complexity` and
`dead_code`).
- The CI must pass.

- Only use uppercase variable names when relevant to cryptography.

- Put a space after comment markers.
- Don't use multiple newlines between sections of code.
- Have a newline before EOF.

### Guidelines

- Sort inputs as core, std, third party, and then Serai.
- Comment code reasonably.
- Include tests for new features.
- Sign commits.

### Submission

All submissions should be through GitHub. Contributions to a crate will be
licensed according to the crate's existing license, with the crate's copyright
holders (distinct from authors) having the right to re-license the crate via a
unanimous decision.
106 changes: 42 additions & 64 deletions Cargo.lock

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

4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@ members = [
"crypto/transcript",

"crypto/dalek-ff-group",
"crypto/ed448",

"crypto/multiexp",

"crypto/dleq",
"crypto/frost",

"coins/ethereum",
"coins/monero/generators",
"coins/monero",

"processor",
Expand All @@ -32,6 +35,7 @@ group = { opt-level = 3 }

crypto-bigint = { opt-level = 3 }
dalek-ff-group = { opt-level = 3 }
minimal-ed448 = { opt-level = 3 }

multiexp = { opt-level = 3 }

Expand Down
6 changes: 6 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Serai crates are licensed under one of two licenses, either MIT or AGPL-3.0,
depending on the crate in question. Each crate declares their license in their
`Cargo.toml` and includes a `LICENSE` file detailing its status. Additionally,
a full copy of the AGPL-3.0 License is included in the root of this repository
as a reference text. This copy should be provided with any distribution of a
crate licensed under the AGPL-3.0, as per its terms.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,24 @@ wallet.

### Layout

- `docs` - Documentation on the Serai protocol.
- `docs`: Documentation on the Serai protocol.

- `coins` - Various coin libraries intended for usage in Serai yet also by the
wider community. This means they will always support the functionality Serai
needs, yet won't disadvantage other use cases when possible.

- `crypto` - A series of composable cryptographic libraries built around the
- `crypto`: A series of composable cryptographic libraries built around the
`ff`/`group` APIs achieving a variety of tasks. These range from generic
infrastructure, to our IETF-compliant FROST implementation, to a DLEq proof as
needed for Bitcoin-Monero atomic swaps.

- `processor` - A generic chain processor to process data for Serai and process
- `coins`: Various coin libraries intended for usage in Serai yet also by the
wider community. This means they will always support the functionality Serai
needs, yet won't disadvantage other use cases when possible.

- `processor`: A generic chain processor to process data for Serai and process
events from Serai, executing transactions as expected and needed.

- `contracts`: Smart Contracts implementing Serai's functionality.

- `substrate`: Substrate crates used to instantiate the Serai network.

### Links

- [Twitter](https://twitter.com/SeraiDEX): https://twitter.com/SeraiDEX
Expand Down
2 changes: 1 addition & 1 deletion coins/ethereum/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
AGPL-3.0-only license

Copyright (c) 2022 Luke Parker, Elizabeth Binks
Copyright (c) 2022 Luke Parker

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License Version 3 as
Expand Down
Loading

0 comments on commit 8e80352

Please sign in to comment.