Skip to content

Commit

Permalink
Problem: out-of-date content that doesn't align with Cronos context (c…
Browse files Browse the repository at this point in the history
…rypto-org-chain#359)

* update WIP

Signed-off-by: Landan Hu <[email protected]>

* remove typo

Signed-off-by: Landan Hu <[email protected]>

* fix typos

Signed-off-by: Landan Hu <[email protected]>

* fix typo

Signed-off-by: Landan Hu <[email protected]>
  • Loading branch information
landanhu authored Feb 24, 2022
1 parent 996aaeb commit 0123a2f
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 20 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ This version is the same as v0.5.3 with a patched version of ethermint which inc
*September 21, 2021*
## v0.5.3

This version contains several new features, it enables gravity bridge in Cronos and automatic token conversion for bridging tokens to crc20 tokens. It also fix the decimal conversion issues in the CRO tokens from crypto.org chain.
This version contains several new features, it enables gravity bridge in Cronos and automatic token conversion for bridging tokens to crc20 tokens. It also fixes the decimal conversion issues in the CRO tokens from Crypto.org Chain.
In addition to that, it also upgrade ethermint to its latest version (v0.5.0.x) which bring several breaking changes (see [changelog](https://github.com/tharsis/ethermint/blob/1a01c6a992c0fb94d70bb1c7127715874cefd057/CHANGELOG.md)).

### Consensus breaking changes
Expand Down
10 changes: 5 additions & 5 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
## Moderation
These are the policies for upholding our community’s standards of conduct. If you feel that a thread needs moderation, please contact the above mentioned person.

1. Remarks that violate the Crypto.org Chain standards of conduct, including hateful, hurtful, oppressive, or exclusionary remarks, are not allowed. (Cursing is allowed, but never targeting another user, and never in a hateful manner.)
1. Remarks that violate the Cronos standards of conduct, including hateful, hurtful, oppressive, or exclusionary remarks, are not allowed. (Cursing is allowed, but never targeting another user, and never in a hateful manner.)

2. Remarks that moderators find inappropriate, whether listed in the code of conduct or not, are also not allowed.

Expand All @@ -42,10 +42,10 @@ These are the policies for upholding our community’s standards of conduct. If

8. Moderators are held to a higher standard than other community members. If a moderator creates an inappropriate situation, they should expect less leeway than others.

In the Crypto.org Chain developer community we strive to go the extra step to look out for each other. Don’t just aim to be technically unimpeachable, try to be your best self. In particular, avoid flirting with offensive or sensitive issues, particularly if they’re off-topic; this all too often leads to unnecessary fights, hurt feelings, and damaged trust; worse, it can drive people away from the community entirely.
In the Cronos developer community we strive to go the extra step to look out for each other. Don’t just aim to be technically unimpeachable, try to be your best self. In particular, avoid flirting with offensive or sensitive issues, particularly if they’re off-topic; this all too often leads to unnecessary fights, hurt feelings, and damaged trust; worse, it can drive people away from the community entirely.

And if someone takes issue with something you said or did, resist the urge to be defensive. Just stop doing what it was they complained about and apologize. Even if you feel you were misinterpreted or unfairly accused, chances are good there was something you could’ve communicated better — remember that it’s your responsibility to make your fellow Crypto.org Chain developer community members comfortable. Everyone wants to get along and we are all here first and foremost because we want to talk about cool technology. You will find that people will be eager to assume good intent and forgive as long as you earn their trust.
And if someone takes issue with something you said or did, resist the urge to be defensive. Just stop doing what it was they complained about and apologize. Even if you feel you were misinterpreted or unfairly accused, chances are good there was something you could’ve communicated better — remember that it’s your responsibility to make your fellow Cronos developer community members comfortable. Everyone wants to get along and we are all here first and foremost because we want to talk about cool technology. You will find that people will be eager to assume good intent and forgive as long as you earn their trust.

The enforcement policies listed above apply to all official Crypto.org Chain venues. For other projects adopting the Crypto.org Chain Code of Conduct, please contact the maintainers of those projects for enforcement. If you wish to use this code of conduct for your own project, consider explicitly mentioning your moderation policy or making a copy with your own moderation policy so as to avoid confusion.
The enforcement policies listed above apply to all official Cronos venues. For other projects adopting the Cronos Code of Conduct, please contact the maintainers of those projects for enforcement. If you wish to use this code of conduct for your own project, consider explicitly mentioning your moderation policy or making a copy with your own moderation policy so as to avoid confusion.

* Adapted from the the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html), the [Node.js Policy on Trolling](http://blog.izs.me/post/30036893703/policy-on-trolling) as well as the [Contributor Covenant v1.3.0](http://contributor-covenant.org/version/1/3/0/).
* Adapted from the the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html), the [Node.js Policy on Trolling](http://blog.izs.me/post/30036893703/policy-on-trolling) as well as the [Contributor Covenant v1.3.0](http://contributor-covenant.org/version/1/3/0/).
23 changes: 13 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Contributing

Thank you for your interest in contributing to Chain! The goal of the cronos repository is to develop the implementation
of Crypto.org Cronos Chain to best power its network use cases in payments, finance and digital assets. If you have any questions, feel free to ask on [Discord](https://discord.gg/pahqHz26q4).
Thank you for your interest in contributing to Cronos! The goal of this repository is to develop the implementation of Cronos.
Cronos is the first Ethereum-compatible blockchain network built on Cosmos SDK technology. An open-source and permission-less
Layer 1 chain, Cronos aims to massively scale the DeFi, GameFi, and overall Web3 user community by providing builders with the
ability to instantly port apps and crypto assets from other chains while benefiting from low transaction fees, high throughput,
and fast finality. If you have any questions, feel free to ask on [Discord](https://discord.gg/pahqHz26q4).

All work on the code base tries to adhere to the "Development Process" described in [The Collective Code Construction Contract (C4)](https://rfc.zeromq.org/spec/42/#24-development-process).

Expand All @@ -11,11 +14,11 @@ All contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md

## Requests involving no code changes (e.g. conventions, processes or network parameters)

Requests involving no code changes (e.g. conventions, processes or network parameters) should be posted as [Github Discussions](https://github.com/crypto-org-chain/cronos/discussions) threads to allow for early feedback before e.g. being submitted for formal network governance decisions.
Requests involving no code changes (e.g. conventions, processes or network parameters) should be posted as [GitHub Discussions](https://github.com/crypto-org-chain/cronos/discussions) threads to allow for early feedback before e.g. being submitted for formal network governance decisions.

## Feature requests and bug reports

Feature requests and bug reports should be posted as [Github issues](https://github.com/crypto-org-chain/cronos/issues/new/choose).
Feature requests and bug reports should be posted as [GitHub issues](https://github.com/crypto-org-chain/cronos/issues/new/choose).
In an issue, please describe what you did, what you expected, and what happened instead.

If you think that you have identified an issue with Chain that might compromise
Expand All @@ -28,17 +31,17 @@ When the issue is well understood but the solution leads to a consensus-breaking
([ADR](https://github.com/crypto-org-chain/cronos/blob/master/docs/architecture/README.md)). The ADR will help build consensus on an overall strategy to ensure the code base maintains coherence in the larger context. If you are not comfortable with writing an ADR, you can open a less-formal issue and the maintainers will help you turn it into an ADR.

## Working on issues
There are several ways to identify an area where you can contribute to Chain:
There are several ways to identify an area where you can contribute to Cronos:

* You can reach out by sending a message in the developer community communication channel, either with a specific contribution in mind or in general by saying "I want to help!".
* Occasionally, some issues on Github may be labelled with `help wanted` or `good first issue` tags.
* Occasionally, some issues on GitHub may be labelled with `help wanted` or `good first issue` tags.

We use the variation of the "fork and pull" model where contributors push changes to their personal fork and create pull requests to bring those changes into the source repository.
Changes in pull requests should satisfy "Patch Requirements" described in [The Collective Code Construction Contract (C4)](https://rfc.zeromq.org/spec:42/C4/#23-patch-requirements). The code and comments should follow [Effective Go Guide](https://golang.org/doc/effective_go.html) (and [Uber Style Guide](https://github.com/uber-go/guide/blob/master/style.md)). Many of the code style rules are captured by `go fmt`, `golint`, `go vet` and other tools, so we recommend [setting up your editor to do formatting and lint-checking for you](https://github.com/golang/go/wiki/IDEsAndTextEditorPlugins).

Once you identified an issue to work on, this is the summary of your basic steps:

* Fork Chain's repository under your Github account.
* Fork Chain's repository under your GitHub account.

* Clone your fork locally on your machine.

Expand All @@ -50,17 +53,17 @@ Once you identified an issue to work on, this is the summary of your basic steps

* Include tests that cover all non-trivial code.

* Check you are working on the latest version on master in Chain's official repository. If not, please pull Chain's official repository's master (upstream) into your fork's master branch, and rebase your committed changes or replay your stashed changes in your branch over the latest changes in the upstream version.
* Check you are working on the latest version on master in Chain's official repository. If not, please pull Chain's official repository's master (upstream) into your fork's main branch, and rebase your committed changes or replay your stashed changes in your branch over the latest changes in the upstream version.

* Run all tests locally and make sure they pass.

* If your changes are of interest to other developers, please make corresponding changes in the official documentation and the changelog.

* Push your changes to your fork's branch and open the pull request to Chain's repository master branch.
* Push your changes to your fork's branch and open the pull request to Cronos's repository main branch.

* In the pull request, complete its checklist, add a clear description of the problem your changes solve, and add the following statement to confirm that your contribution is your own original work: "I hereby certify that my contribution is in accordance with the Developer Certificate of Origin (https://developercertificate.org/)."

* The reviewer will either accept and merge your pull request, or leave comments requesting changes via the Github PR interface (you should then make changes by pushing directly to your existing PR branch).
* The reviewer will either accept and merge your pull request, or leave comments requesting changes via the GitHub PR interface (you should then make changes by pushing directly to your existing PR branch).

### Changelog

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ pystarport supervisorctl stop all
- [Project Website](http://cronos.org/)
- [Technical Documentation](http://cronos.org/docs)
- Community chatrooms (non-technical): [Discord](https://discord.gg/nsp9JTC) [Telegram](https://t.me/CryptoComOfficial)
- Developer community channel (technical): [![Support Server](https://img.shields.io/discord/783264383978569728.svg?color=7289da&label=Crypto.org Chain =discord =flat-square)](https://discord.gg/pahqHz26q4)
- Developer community channel (technical): [![Support Server](https://img.shields.io/discord/783264383978569728.svg?color=7289da&label=Cronos&logo=discord&style=flat-square)](https://discord.gg/pahqHz26q4)
- [Ethermint](https://github.com/tharsis/ethermint) by Tharsis
- [Cosmos SDK documentation](https://docs.cosmos.network)
- [Cosmos Discord](https://discord.gg/W8trcGV)
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Architecture Decision Records (ADR)

This is a location to record all high-level architecture decisions in the Crypto.org Chain implementation.
This is a location to record all high-level architecture decisions in the Cronos implementation.

You can read more about the ADR concept in this [blog post](https://product.reverb.com/documenting-architecture-decisions-the-reverb-way-a3563bb24bd0#.78xhdix6t).

Expand Down
4 changes: 2 additions & 2 deletions x/cronos/spec/01_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ The Cronos module glues IBC, gravity bridge and ethermint together through hooks

Cronos uses CRO as its gas token.

The CRO assets on the Cronos Chain need to be transferred from the Crypto.org Chain through an IBC channel. The tokens arrive on the Cronos Chain as IBC tokens first, then are automatically converted to the gas token.
The CRO assets on the Cronos Chain need to be transferred from the Crypto.org Chain through an IBC channel. The tokens arrived at the Cronos Chain as IBC tokens first, then are automatically converted to the gas token.

### Decimal Places Conversion

The CRO on the Crypto.org chain has 8 decimals, while the Cronos gas token has 18 decimals (to keep compatibility with Ethereum). So a conversion is done automatically:
The CRO on the Crypto.org Chain has 8 decimals, while the Cronos gas token has 18 decimals (to keep compatibility with Ethereum). So a conversion is done automatically:

- When transferring CRO to Cronos chain, the decimal places of the amount are expanded to 18.
- When transferring CRO from Cronos chain, the amount is truncated to 8 decimals, the remaining part is left in Cronos, so the total value is preserved.
Expand Down

0 comments on commit 0123a2f

Please sign in to comment.