Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Problem: missing high-level docs for x/cronos #64

Closed
tomtau opened this issue Sep 9, 2021 · 1 comment · Fixed by #183
Closed

Problem: missing high-level docs for x/cronos #64

tomtau opened this issue Sep 9, 2021 · 1 comment · Fixed by #183
Assignees
@yihuang @thomas-nguy

Comments

@tomtau
Copy link
Contributor

tomtau commented Sep 9, 2021

Right now, it's a bit ambiguous what problems the "x/cronos" module is aimed to solve and why it solves them in that way -- for future reference as well as new and external developers, it'll be good to add:

  1. records for any high level architectural decisions: https://github.com/crypto-org-chain/cronos/tree/main/docs/architecture that were made
  2. basic module specs to cover basic logic and types similar to what has for SDK modules, e.g. https://github.com/cosmos/cosmos-sdk/tree/master/x/bank/spec
@tomtau tomtau mentioned this issue Sep 9, 2021
Merged
14 tasks
@tomtau tomtau mentioned this issue Oct 6, 2021
Closed
@yihuang
Copy link
Collaborator

yihuang commented Oct 21, 2021

work on it now.

yihuang added a commit to yihuang/cronos that referenced this issue Oct 21, 2021
@yihuang
Problem: missing high-level docs for x/cronos
87a5a7d 
Closes: crypto-org-chain#64

Solution:
- write cronos module spec
@yihuang yihuang mentioned this issue Oct 21, 2021
Merged
13 tasks
yihuang added a commit to yihuang/cronos that referenced this issue Oct 25, 2021
@yihuang
Problem: missing high-level docs for x/cronos
741cd0a 
Closes: crypto-org-chain#64

Solution:
- write cronos module spec

fix wordings

add state transition

update title

highlight token mapping deletion

Apply suggestions from code review

Co-authored-by: aw126 <78806365+aw126@users.noreply.github.com>

apply suggestions

tmp

Apply suggestions from code review

Co-authored-by: Tomas Tauber <2410580+tomtau@users.noreply.github.com>

remove Key prefix

review suggstions

Revert "remove Key prefix"

This reverts commit 9fa8583a425f4cc7669fb2cb0c1ce29dcb484ea6.

remove Key prefix

review suggestions
yihuang added a commit that referenced this issue Oct 26, 2021
@yihuang
Problem: missing high-level docs for x/cronos (#183)
f4dec0d 
* Problem: missing high-level docs for x/cronos

Closes: #64

Solution:
- write cronos module spec

fix wordings

add state transition

update title

highlight token mapping deletion

Apply suggestions from code review

Co-authored-by: aw126 <78806365+aw126@users.noreply.github.com>

apply suggestions

tmp

Apply suggestions from code review

Co-authored-by: Tomas Tauber <2410580+tomtau@users.noreply.github.com>

remove Key prefix

review suggstions

Revert "remove Key prefix"

This reverts commit 9fa8583a425f4cc7669fb2cb0c1ce29dcb484ea6.

remove Key prefix

review suggestions

* token withdraw won't be disabled

* contract remap is not allowed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yihuang yihuang

@thomas-nguy thomas-nguy

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Problem: missing high-level docs for x/cronos yihuang/cronos
3 participants
@yihuang @tomtau @thomas-nguy