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.

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

docs: update outdated events in specs #602

Merged
merged 17 commits into from
Jul 26, 2022
Merged

docs: update outdated events in specs #602

merged 17 commits into from
Jul 26, 2022

Conversation

0Tech
Copy link
Collaborator

@0Tech 0Tech commented Jul 20, 2022

Description

Update outdated documentation about the events.
It also adds common specification about the events.

Checklist:

  • I followed the contributing guidelines and code of conduct.
  • I have added a relevant changelog to CHANGELOG.md
  • I have added tests to cover my changes.
  • I have updated the documentation accordingly.
  • I have updated API documentation client/docs/swagger-ui/swagger.yaml

@0Tech 0Tech added the documentation Improvements or additions to documentation label Jul 20, 2022
@0Tech 0Tech self-assigned this Jul 20, 2022
@0Tech 0Tech marked this pull request as ready for review July 20, 2022 07:18
@0Tech 0Tech requested review from dudong2 and zemyblue July 20, 2022 07:18

# Events of LBM-SDK

Note: the content of this document is based on the actual implementation in version 0.45.6 of the cosmos-sdk. As we do not intend to introduce a new specification, it's a bug of the documentation if you find any differences between this document and the implementation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Current lbm-sdk is based on cosmos-sdk v0.45.1. But we need to bump up

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cosmos-sdk version up issue was added in #575 . Please check it later.

docs/core/event.md Outdated Show resolved Hide resolved
docs/core/event.md Outdated Show resolved Hide resolved
| transfer | amount | {amount} |
| message | module | bank |
| message | action | send |
Copy link

@ByunghyunBang ByunghyunBang Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why message.actions are removed at document?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some modules do not have the event of type `message' in its document. So, I decided to put the event into the common document, and remove it from the individual module's.

@0Tech 0Tech requested a review from ByunghyunBang July 26, 2022 00:14
@0Tech 0Tech merged commit 99ebca8 into Finschia:main Jul 26, 2022
@0Tech 0Tech deleted the docs_event branch July 26, 2022 07:39
dudong2 pushed a commit to dudong2/lbm-sdk that referenced this pull request Aug 1, 2022
* docs: update x/bank events

* docs: update x/crisis events

* docs: update x/distribution events

* docs: update x/evidence events

* docs: update x/feegrant events

* docs: update x/gov events

* docs: update x/slashing events

* docs: update x/staking events

* docs: add x/collection events

* docs: update x/foundation events

* docs: add x/token events

* docs: add common spec of events into docs

* docs: fix typo

* docs: update CHANGELOG.md

* docs: narrow the context

* Update docs/core/event.md

* Update docs/core/event.md
@zemyblue zemyblue mentioned this pull request Oct 27, 2022
5 tasks
@zemyblue zemyblue mentioned this pull request Nov 28, 2022
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants