|
1 | | -# :crab: RUST PROJECT TEMPLATE - TODO(template) PUT PROJECT NAME HERE |
2 | | -<!--`TODO(template) update each badge with your username and repository name.`--> |
3 | | -[](https://github.com/NethermindEth/rust-template/actions/workflows/docs.yml) |
4 | | -[](https://github.com/NethermindEth/rust-template/actions/workflows/linter.yml) |
5 | | -[](https://github.com/NethermindEth/rust-template/actions/workflows/build-and-test.yml) |
6 | | -[](https://github.com/NethermindEth/rust-template/actions/workflows/dependency-audit.yml) |
7 | | -[](https://github.com/NethermindEth/rust-template/actions/workflows/ub-detection.yml) |
8 | | -[](https://github.com/NethermindEth/rust-template/actions/workflows/coverage.yml) |
9 | | -<!-- You can replace them with a single badge if you create a main CI file that calls the other workflows |
10 | | -[](https://github.com/{{USERNAME}}/{{REPOSITORY}}/actions) |
11 | | ---> |
12 | | -<!--`TODO(template) update with your rust version` |
13 | | -If you want to change from stable to Minimum Supported Rust Version (MSRV), replace the badge with: |
14 | | - TODO(template) update specific version |
15 | | ---> |
| 1 | +# crypto-primitives |
| 2 | + |
| 3 | +[](https://github.com/NethermindEth/crypto-primitives/actions/workflows/docs.yml) |
| 4 | +[](https://github.com/NethermindEth/crypto-primitives/actions/workflows/linter.yml) |
| 5 | +[](https://github.com/NethermindEth/crypto-primitives/actions/workflows/build-and-test.yml) |
| 6 | +[](https://github.com/NethermindEth/crypto-primitives/actions/workflows/dependency-audit.yml) |
| 7 | +[](https://github.com/NethermindEth/crypto-primitives/actions/workflows/ub-detection.yml) |
| 8 | +[](https://github.com/NethermindEth/crypto-primitives/actions/workflows/coverage.yml) |
16 | 9 |  |
17 | | -<!--`TODO(template) update license version if needed. Check LICENSE first`--> |
18 | 10 | [](https://opensource.org/licenses/Apache-2.0) |
19 | | -<!--`TODO(template) update with your crate information. Remove if not needed.`--> |
20 | | -[](https://crates.io/crates/{{CRATE_NAME}}) |
21 | | -[](https://docs.rs/{{CRATE_NAME}}) |
| 11 | +<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> |
| 12 | +[](#contributors-) |
| 13 | +<!-- ALL-CONTRIBUTORS-BADGE:END --> |
22 | 14 |
|
23 | | -TODO(template) describe the project |
24 | | - |
25 | | -## TODO(template) - rust template usage (remove this section after setup) |
26 | | - |
27 | | -This is a rust template from ZKE team :rocket: (a focus on cryptographic libs in sync Rust). |
28 | | - |
29 | | -:bike: To use it - find `TODO(template)` over the repository and set appropriate values. |
30 | | - |
31 | | -- [ ] Settings -> Collaborators and teams - add your team group as admins for the repo (e.g. [zk-engineering](https://github.com/orgs/NethermindEth/teams/zk-engineering)) |
32 | | -- [ ] Settings -> General -> Pull Requests - allow only `Allow squash merging`, also tick `Automatically delete head branches` |
33 | | -- [ ] Settings -> Pages -> Build and deployment -> Source Github Actions |
34 | | -- [ ] Update the description of the repo at the repo's page, add tag topics |
35 | | -- [ ] Introduce necessary sections at the repo's page (releases, deployments etc) |
36 | | -- [ ] Add a website url (if applicable) or a docs page (see [docs](./.github/workflows/docs.yml) flow for public repos) |
37 | | -- [ ] Add [all contributors](https://allcontributors.org/docs/en/cli/installation) |
38 | | -- [ ] Import protection rulesets (see below) in the repo settings (Settings -> Rules -> Rulesets -> Import a ruleset) |
39 | | -- [ ] For binary crates with specific requirements to Rust features consider also [pinning](https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file) the rust toolchain version |
40 | | - |
41 | | -Main branch protection |
42 | | - |
43 | | -```json |
44 | | -{ |
45 | | - "id": 4981961, |
46 | | - "name": "Main protection", |
47 | | - "target": "branch", |
48 | | - "source_type": "Repository", |
49 | | - "source": "NethermindEth/rust-template", |
50 | | - "enforcement": "active", |
51 | | - "conditions": { |
52 | | - "ref_name": { |
53 | | - "exclude": [], |
54 | | - "include": [ |
55 | | - "~DEFAULT_BRANCH" |
56 | | - ] |
57 | | - } |
58 | | - }, |
59 | | - "rules": [ |
60 | | - { |
61 | | - "type": "deletion" |
62 | | - }, |
63 | | - { |
64 | | - "type": "non_fast_forward" |
65 | | - }, |
66 | | - { |
67 | | - "type": "required_deployments", |
68 | | - "parameters": { |
69 | | - "required_deployment_environments": [] |
70 | | - } |
71 | | - }, |
72 | | - { |
73 | | - "type": "required_signatures" |
74 | | - }, |
75 | | - { |
76 | | - "type": "pull_request", |
77 | | - "parameters": { |
78 | | - "required_approving_review_count": 1, |
79 | | - "dismiss_stale_reviews_on_push": false, |
80 | | - "require_code_owner_review": false, |
81 | | - "require_last_push_approval": false, |
82 | | - "required_review_thread_resolution": true, |
83 | | - "automatic_copilot_code_review_enabled": false, |
84 | | - "allowed_merge_methods": [ |
85 | | - "merge", |
86 | | - "squash", |
87 | | - "rebase" |
88 | | - ] |
89 | | - } |
90 | | - } |
91 | | - ], |
92 | | - "bypass_actors": [] |
93 | | -} |
94 | | -``` |
95 | | - |
96 | | -Signed commits |
97 | | - |
98 | | -```json |
99 | | -{ |
100 | | - "id": 4982030, |
101 | | - "name": "Signed commits", |
102 | | - "target": "branch", |
103 | | - "source_type": "Repository", |
104 | | - "source": "NethermindEth/rust-template", |
105 | | - "enforcement": "active", |
106 | | - "conditions": { |
107 | | - "ref_name": { |
108 | | - "exclude": [], |
109 | | - "include": [ |
110 | | - "~ALL" |
111 | | - ] |
112 | | - } |
113 | | - }, |
114 | | - "rules": [ |
115 | | - { |
116 | | - "type": "required_signatures" |
117 | | - } |
118 | | - ], |
119 | | - "bypass_actors": [] |
120 | | -} |
121 | | -``` |
122 | | - |
123 | | -## How to use |
124 | | - |
125 | | -To generate a new project from this template, you need to install [cargo-generate](https://github.com/cargo-generate/cargo-generate) and run: |
126 | | - |
127 | | -```sh |
128 | | -cargo install cargo-generate |
129 | | - |
130 | | -cargo generate --git https://github.com/NethermindEth/rust-template |
131 | | -``` |
132 | | - |
133 | | -## Examples |
134 | | - |
135 | | -See [examples](./examples/). |
| 15 | +Nethermind Crypto Primitives, a WIP endeavor to provide a set of primitives useful for cryptographic applications that can be mixed and matched together. |
| 16 | +Contains traits and their adapters for existing libraries as optional modules. |
| 17 | +Toolkit is fully modular, so you can use only the parts you need. |
136 | 18 |
|
137 | 19 | ## License |
138 | 20 |
|
139 | | -TODO(template) - update [license](https://www.notion.so/nethermind/Open-Source-Software-Usage-and-Licensing-Policy-1c3360fc38d080fd9e61c29b35d1d5af) if needed. |
140 | | -For commercial licenses it is required to get an approve from Legal. |
141 | | - |
142 | 21 | Apache 2.0 |
143 | 22 |
|
144 | 23 | ## Would like to contribute? |
145 | 24 |
|
146 | 25 | see [Contributing](./CONTRIBUTING.md). |
| 26 | + |
| 27 | +## Contributors ✨ |
| 28 | + |
| 29 | +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): |
| 30 | + |
| 31 | +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
| 32 | +<!-- prettier-ignore-start --> |
| 33 | +<!-- markdownlint-disable --> |
| 34 | +<table> |
| 35 | + <tbody> |
| 36 | + <tr> |
| 37 | + <td align="center" valign="top" width="14.28%"><a href="https://github.com/frozenspider"><img src="https://avatars.githubusercontent.com/u/2077017?v=4?s=100" width="100px;" alt="Alex Abdugafarov"/><br /><sub><b>Alex Abdugafarov</b></sub></a><br /><a href="https://github.com/NethermindEth/crypto-primitives/commits?author=frozenspider" title="Code">💻</a></td> |
| 38 | + <td align="center" valign="top" width="14.28%"><a href="https://github.com/cupicmarko"><img src="https://avatars.githubusercontent.com/u/71461781?v=4?s=100" width="100px;" alt="Marko Cupic"/><br /><sub><b>Marko Cupic</b></sub></a><br /><a href="https://github.com/NethermindEth/crypto-primitives/pulls?q=is%3Apr+reviewed-by%3Acupicmarko" title="Reviewed Pull Requests">👀</a></td> |
| 39 | + <td align="center" valign="top" width="14.28%"><a href="https://github.com/NiDimi"><img src="https://avatars.githubusercontent.com/u/81875532?v=4?s=100" width="100px;" alt="Nick Dimitriou"/><br /><sub><b>Nick Dimitriou</b></sub></a><br /><a href="https://github.com/NethermindEth/crypto-primitives/pulls?q=is%3Apr+reviewed-by%3ANiDimi" title="Reviewed Pull Requests">👀</a></td> |
| 40 | + <td align="center" valign="top" width="14.28%"><a href="https://maksimryndin.github.io/"><img src="https://avatars.githubusercontent.com/u/16288656?v=4?s=100" width="100px;" alt="maksimryndin"/><br /><sub><b>maksimryndin</b></sub></a><br /><a href="https://github.com/NethermindEth/crypto-primitives/pulls?q=is%3Apr+reviewed-by%3Amaksimryndin" title="Reviewed Pull Requests">👀</a> <a href="#projectManagement-maksimryndin" title="Project Management">📆</a></td> |
| 41 | + </tr> |
| 42 | + </tbody> |
| 43 | + <tfoot> |
| 44 | + <tr> |
| 45 | + <td align="center" size="13px" colspan="7"> |
| 46 | + <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg"> |
| 47 | + <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a> |
| 48 | + </img> |
| 49 | + </td> |
| 50 | + </tr> |
| 51 | + </tfoot> |
| 52 | +</table> |
| 53 | + |
| 54 | +<!-- markdownlint-restore --> |
| 55 | +<!-- prettier-ignore-end --> |
| 56 | + |
| 57 | +<!-- ALL-CONTRIBUTORS-LIST:END --> |
| 58 | + |
| 59 | +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |
0 commit comments