diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d33878e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,134 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations + diff --git a/LICENSE b/LICENSE index 261eeb9..e6e9d38 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright 2022 Archway Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/NOTICE b/NOTICE index 03e8b8e..3b7301b 100644 --- a/NOTICE +++ b/NOTICE @@ -1,4 +1,4 @@ -Copyright 2022 Archway Network +Copyright 2022 Archway Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index e878bb1..73c4d85 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,36 @@ -# Archway Bindings +# arch3.rs -CosmWasm bindings to interact with Archway's modules. +[![Build Status][build-image]][build-link] +[![Codacy Badge][codacy-image]][codacy-link] +[![Apache 2.0 Licensed][license-image]][license-link] +![MSRV][rustc-image] -## Usage +Rust SDK for Archway. -Please refer to the [example contract](https://github.com/archway-network/archway-bindings/tree/main/contracts/increment) for a full usage example. +## Packages + +| Package | Version | Docs | Description | +|-------------------------------------------|:---------------------------------------------:|:-----------------------------------------------------:|:------------------------------------------------------| +| [`archway-bindings`](./packages/bindings) | [![crates.io][bindings-image]][bindings-link] | [![docs.rs][bindings-docs-image]][bindings-docs-link] | CosmWasm bindings to interact with Archway's modules. | +| [`archway-proto`](./packages/proto) | [![crates.io][proto-image]][proto-link] | [![docs.rs][proto-docs-image]][proto-docs-link] | Rust build of Archway's ProtoBuf definitions. | + +## License + +This project is licensed under the Apache-2.0 License - see the [LICENSE][license-link] file for details. + +[//]: # "badges" +[build-image]: https://github.com/archway-network/arch3.rs/actions/workflows/check.yml/badge.svg +[build-link]: https://github.com/archway-network/arch3.rs/actions/workflows/check.yml +[codacy-image]: https://app.codacy.com/project/badge/Grade/6fedce8e3af541718dba59bde1f38375 +[codacy-link]: https://app.codacy.com/gh/archway-network/arch3.rs/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade +[license-image]: https://img.shields.io/github/license/archway-network/arch3.rs?label=License&logo=opensourceinitiative&logoColor=white +[license-link]: https://github.com/archway-network/arch3.rs/blob/main/LICENSE +[rustc-image]: https://img.shields.io/badge/rustc-1.70+-red.svg?logo=rust +[bindings-image]: https://img.shields.io/crates/v/archway-bindings.svg +[bindings-link]: https://crates.io/crates/archway-bindings +[bindings-docs-image]: https://docs.rs/archway-bindings/badge.svg +[bindings-docs-link]: https://docs.rs/archway-bindings/ +[proto-image]: https://img.shields.io/crates/v/archway-proto.svg +[proto-link]: https://crates.io/crates/archway-proto +[proto-docs-image]: https://docs.rs/archway-proto/badge.svg +[proto-docs-link]: https://docs.rs/archway-proto/ diff --git a/packages/bindings/Cargo.toml b/packages/bindings/Cargo.toml index 9be1655..198071e 100644 --- a/packages/bindings/Cargo.toml +++ b/packages/bindings/Cargo.toml @@ -8,6 +8,7 @@ license.workspace = true repository.workspace = true homepage.workspace = true readme = "README.md" +license-file = "LICENSE" categories = [ "cryptography", diff --git a/packages/bindings/README.md b/packages/bindings/README.md index e878bb1..10f453c 100644 --- a/packages/bindings/README.md +++ b/packages/bindings/README.md @@ -1,7 +1,33 @@ # Archway Bindings +[![Crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Apache 2.0 Licensed][license-image]][license-link] +![MSRV][rustc-image] + CosmWasm bindings to interact with Archway's modules. ## Usage -Please refer to the [example contract](https://github.com/archway-network/archway-bindings/tree/main/contracts/increment) for a full usage example. +Please refer to the [example contract] for a full usage example. + +## Specs + +The bindings follow the [specs] defined by the Archway Protocol. + +## License + +This project is licensed under the Apache-2.0 License - see the [LICENSE][license-link] file for details. + +[//]: # "badges" +[crate-image]: https://buildstats.info/crate/archway-bindings +[crate-link]: https://crates.io/crates/archway-bindings +[docs-image]: https://docs.rs/archway-bindings/badge.svg +[docs-link]: https://docs.rs/archway-bindings/ +[license-image]: https://img.shields.io/github/license/archway-network/arch3.rs?label=License&logo=opensourceinitiative&logoColor=white&color=informational +[license-link]: https://github.com/archway-network/arch3.rs/blob/main/LICENSE +[rustc-image]: https://img.shields.io/badge/rustc-1.70+-blue.svg?logo=rust&logoColor=white&color=informational + +[//]: # "general links" +[example contract]: https://github.com/archway-network/arch3.rs/tree/main/contracts/increment +[specs]: https://github.com/archway-network/archway/blob/main/x/rewards/spec/08_wasm_bindings.md diff --git a/packages/proto/Cargo.toml b/packages/proto/Cargo.toml index ace9ac2..fa5c040 100644 --- a/packages/proto/Cargo.toml +++ b/packages/proto/Cargo.toml @@ -8,6 +8,7 @@ license.workspace = true repository.workspace = true homepage.workspace = true readme = "README.md" +license-file = "LICENSE" categories = [ "cryptography", diff --git a/packages/proto/README.md b/packages/proto/README.md index 10107fd..bc6a9db 100644 --- a/packages/proto/README.md +++ b/packages/proto/README.md @@ -1,9 +1,14 @@ # Archway Proto +[![Crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +[![Apache 2.0 Licensed][license-image]][license-link] +![MSRV][rustc-image] + Rust build of Archway's ProtoBuf definitions. This package can be used both in CosmWasm smart contracts and gRPC clients. -It is based on the [`cosmos-sdk-proto v0.18.0`](https://github.com/cosmos/cosmos-rust) +It is based on the [`cosmos-sdk-proto v0.18.0`][cosmos-rust] crate to provide the Cosmos SDK `v0.45.x` messages and follows the same feature definitions, with the `tonic` gRPC clients enabled by default. @@ -20,3 +25,19 @@ archway-proto = { version = "0.1.0", default-features = false, features = ["cosm ```toml archway-proto = "0.1.0" ``` + +## License + +This project is licensed under the Apache-2.0 License - see the [LICENSE][license-link] file for details. + +[//]: # "badges" +[crate-image]: https://buildstats.info/crate/archway-proto +[crate-link]: https://crates.io/crates/archway-proto +[docs-image]: https://docs.rs/archway-proto/badge.svg +[docs-link]: https://docs.rs/archway-proto/ +[license-image]: https://img.shields.io/github/license/archway-network/arch3.rs?label=License&logo=opensourceinitiative&logoColor=white&color=informational +[license-link]: https://github.com/archway-network/arch3.rs/blob/main/LICENSE +[rustc-image]: https://img.shields.io/badge/rustc-1.70+-blue.svg?logo=rust&logoColor=white&color=informational + +[//]: # "links" +[cosmos-rust]: https://github.com/cosmos/cosmos-rust