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

Simulation docs #5033

Merged
merged 12 commits into from
Jan 31, 2020
Merged

Simulation docs #5033

merged 12 commits into from
Jan 31, 2020

Conversation

fedekunze
Copy link
Collaborator

closes #4534

This PR aims to provide a guide to implement the simulation package on each module (module.go), on the application level (app.go) and to create the simulation testing framework (app_test.go).

  • Targeted PR against correct branch (see CONTRIBUTING.md)

  • Linked to github-issue with discussion and accepted design OR link to spec that describes this work.

  • Wrote tests

  • Updated relevant documentation (docs/)

  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md

  • Re-reviewed Files changed in the github PR explorer


For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@fedekunze fedekunze added T:Docs Changes and features related to documentation. WIP labels Sep 11, 2019
@mircea-c
Copy link

Start sim

@gamarin2
Copy link
Contributor

Just a note (not review), there is no concepts/ folder.

/using-the-sdk should be at the root of the docs folder (docs/using-the-sdk)

@stale
Copy link

stale bot commented Oct 12, 2019

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Oct 12, 2019
@stale
Copy link

stale bot commented Nov 11, 2019

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Nov 11, 2019
@fedekunze
Copy link
Collaborator Author

keep open

@fedekunze fedekunze marked this pull request as ready for review January 31, 2020 13:35
@fedekunze fedekunze added R4R and removed WIP labels Jan 31, 2020
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

ACK -- great job @fedekunze. Looks very clean. Feel free to merge whenever.

@codecov
Copy link

codecov bot commented Jan 31, 2020

Codecov Report

Merging #5033 into master will increase coverage by 0.08%.
The diff coverage is 61.93%.

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #5033      +/-   ##
=========================================
+ Coverage   53.31%   53.4%   +0.08%     
=========================================
  Files         319     322       +3     
  Lines       19573   19724     +151     
=========================================
+ Hits        10436   10534      +98     
- Misses       8317    8373      +56     
+ Partials      820     817       -3
Impacted Files Coverage Δ
store/types/store.go 43.75% <ø> (ø) ⬆️
x/genutil/client/cli/migrate.go 71.92% <ø> (ø) ⬆️
x/bank/internal/types/msgs.go 97.22% <ø> (ø) ⬆️
x/auth/exported/exported.go 100% <ø> (ø) ⬆️
x/auth/ante/fee.go 77.77% <ø> (+5.05%) ⬆️
types/coin.go 92.12% <ø> (ø) ⬆️
simapp/genesis_account.go 100% <ø> (ø) ⬆️
types/store.go 18.75% <ø> (ø) ⬆️
x/auth/types/genesis.go 73.52% <ø> (+3.25%) ⬆️
x/staking/keeper/invariants.go 0% <0%> (ø) ⬆️
... and 38 more

@fedekunze fedekunze merged commit c7a6299 into master Jan 31, 2020
@fedekunze fedekunze deleted the fedekunze/4534-simulation-docs branch January 31, 2020 15:06
cwgoes pushed a commit that referenced this pull request Feb 3, 2020
* simulation docs

* update docs with the latest simulation changes

* minor imporvments

* clean up of simulation.md

* expand section on weights

* minor reword

* minor wording fix

Co-authored-by: Marko <[email protected]>
cwgoes added a commit that referenced this pull request Feb 3, 2020
* Simulation docs (#5033)

* simulation docs

* update docs with the latest simulation changes

* minor imporvments

* clean up of simulation.md

* expand section on weights

* minor reword

* minor wording fix

Co-authored-by: Marko <[email protected]>

* Merge PR #5597: Include Amount in Complete Unbonding/Redelegation Events

* Add bank alias for gaia

* Moar bank alias gaia

* Moar bank alias gaia

* Call `TimeoutExecuted`, add wrappers

* Remove unused `MsgRecvPacket`

Co-authored-by: Federico Kunze <[email protected]>
Co-authored-by: Marko <[email protected]>
Co-authored-by: Alexander Bezobchuk <[email protected]>
Co-authored-by: Jack Zampolin <[email protected]>
fedekunze added a commit that referenced this pull request Feb 20, 2020
* Add comments, remove unused code and attempt to point to places where the spec is being implemented

* close channel when transfer fails

* rename packer data transfer to align to spec; refactor table tests

* ICS 20 implementation cleanup work (#5602)

* Simulation docs (#5033)

* simulation docs

* update docs with the latest simulation changes

* minor imporvments

* clean up of simulation.md

* expand section on weights

* minor reword

* minor wording fix

Co-authored-by: Marko <[email protected]>

* Merge PR #5597: Include Amount in Complete Unbonding/Redelegation Events

* Add bank alias for gaia

* Moar bank alias gaia

* Moar bank alias gaia

* Call `TimeoutExecuted`, add wrappers

* Remove unused `MsgRecvPacket`

Co-authored-by: Federico Kunze <[email protected]>
Co-authored-by: Marko <[email protected]>
Co-authored-by: Alexander Bezobchuk <[email protected]>
Co-authored-by: Jack Zampolin <[email protected]>

* Merge PR #5603: Remove acknowledgement interface in favour of []byte

* fixes and cleanup

* spec compliance

* refactor relay prefixes and tests

* Fix test compilation

* cleanup; add notes and additional test case

* Receive transfer test

* Apply suggestions from code review

Co-Authored-By: Bot from GolangCI <[email protected]>

* Fix autolinter application

* Add testcase with incorrect prefix

* golangcibot fixes

* delete extra comment

Co-authored-by: Federico Kunze <[email protected]>
Co-authored-by: Christopher Goes <[email protected]>
Co-authored-by: Marko <[email protected]>
Co-authored-by: Alexander Bezobchuk <[email protected]>
Co-authored-by: Bot from GolangCI <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Standardize and document simulation testing patterns for modules
5 participants