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

Auto-enforce code formatting #590

Merged
merged 38 commits into from
Jun 20, 2022
Merged

Auto-enforce code formatting #590

merged 38 commits into from
Jun 20, 2022

Conversation

Garandor
Copy link
Contributor

@Garandor Garandor commented Jun 11, 2022

Merge after #572

Only semi-significant change besides the formatting is in the manta/calamari/dolphin RT where i reordered the CallFilter to lead the match with explicitly disallowed extrinsics for safety on refactor.
=> https://github.com/Manta-Network/Manta/pull/590/files#diff-3c21538b15b471a2e041d55e54f471aca028763b85b77a8c30ed31409dd49a27R185

Use https://github.com/Manta-Network/Manta/pull/590/files?diff=unified&w=1 to see only the functional changes

Description

closes #584
closes #586
closes #310
closes #307


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Linked to Github issue with discussion and accepted design OR have an explanation in the PR that describes this work.
  • Wrote unit tests.
  • Updated relevant documentation in the code.
  • Added one line describing your change in <branch>/CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer.
  • If runtime changes, need to update the version numbers properly:
    • authoring_version: The version of the authorship interface. An authoring node will not attempt to author blocks unless this is equal to its native runtime.
    • spec_version: The version of the runtime specification. A full node will not attempt to use its native runtime in substitute for the on-chain Wasm runtime unless all of spec_name, spec_version, and authoring_version are the same between Wasm and native.
    • impl_version: The version of the implementation of the specification. Nodes are free to ignore this; it serves only as an indication that the code is different; as long as the other two versions are the same then while the actual code may be different, it is nonetheless required to do the same thing. Non-consensus-breaking optimizations are about the only changes that could be made which would result in only the impl_version changing.
    • transaction_version: The version of the extrinsics interface. This number must be updated in the following circumstances: extrinsic parameters (number, order, or types) have been changed; extrinsics or pallets have been removed; or the pallet order in the construct_runtime! macro or extrinsic order in a pallet has been changed. You can run the metadata_diff.yml workflow for help. If this number is updated, then the spec_version must also be updated
  • Verify benchmarks & weights have been updated for any modified runtime logics
  • If importing a new pallet, choose a proper module index for it, and allow it in BaseFilter. Ensure every extrinsic works from front-end. If there's corresponding tool, ensure both work for each other.
  • If needed, update our Javascript/Typescript APIs. These APIs are officially used by exchanges or community developers.
  • If modifying existing runtime storage items, make sure to implement storage migrations for the runtime and test them with try-runtime. This includes migrations inherited from upstream changes, and you can search the diffs for modifications of #[pallet::storage] items to check for any.

Dengjianping and others added 24 commits June 6, 2022 23:02
Signed-off-by: Dengjianping <[email protected]>
Signed-off-by: Dengjianping <[email protected]>
Signed-off-by: Dengjianping <[email protected]>
Signed-off-by: Georgi Zlatarev <[email protected]>
Signed-off-by: Georgi Zlatarev <[email protected]>
Signed-off-by: Georgi Zlatarev <[email protected]>
Signed-off-by: Georgi Zlatarev <[email protected]>
Signed-off-by: Georgi Zlatarev <[email protected]>
Signed-off-by: Georgi Zlatarev <[email protected]>
Signed-off-by: Adam Reif <[email protected]>
Signed-off-by: Adam Reif <[email protected]>
Signed-off-by: Adam Reif <[email protected]>
Signed-off-by: Adam Reif <[email protected]>
Makes sure denies take precedence over allows

Signed-off-by: Adam Reif <[email protected]>
@Garandor Garandor requested review from ghzlatarev and Dengjianping and removed request for ghzlatarev June 11, 2022 02:07
@Garandor Garandor self-assigned this Jun 11, 2022
@Garandor Garandor changed the base branch from release-v3.2.0 to manta June 11, 2022 02:31
@ghzlatarev
Copy link
Contributor

Seems that is the rustfmt default setting. Interestingly, we do have an inconsistency here since taplo formats cargo.toml files with 2 spaces instead. This makes it somewhat more difficult to write correct-from-the-start code since .editorconfig is set to 4 spaces, so default formatting of cargo.toml files will be incorrect. We can add a section for [*.toml] files to indent by 2 instead, so as long as you have a compliant IDE it'll produce correct formatting.

If we wanted to make it consistent, I'd vote for changing cargo.toml's to 4 spaces. I'm voting no-change in indentation and adding a .editorconfig change instead.

@ghzlatarev @Dengjianping need your votes :)

I don't have a strong opinion either way. As long as ctrl-s still formats for me.

@Garandor Garandor marked this pull request as draft June 13, 2022 17:25
@Garandor
Copy link
Contributor Author

The PR is finished, but please don't review yet as the changes from #572 are still listed as changes here.
Marking the PR as draft until it is merged.

When you DO review, use "hide whitespace" mode -> https://github.com/Manta-Network/Manta/pull/590/files?diff=unified&w=1

Adam Reif added 2 commits June 14, 2022 15:16
@Garandor Garandor marked this pull request as ready for review June 14, 2022 20:33
Copy link
Contributor Author

@Garandor Garandor left a comment

Choose a reason for hiding this comment

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

I looked it over, the changeset looks good to me.
Some of the automatic formatting is a bit wonky where it inserted new-lines fairly pointlessly, but that's autoformatting i guess ¯_(ツ)_/¯

@Garandor Garandor requested a review from ghzlatarev June 14, 2022 21:00
Copy link
Contributor Author

@Garandor Garandor left a comment

Choose a reason for hiding this comment

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

gone through again, space indented files look sane

Copy link
Contributor

@Dengjianping Dengjianping left a comment

Choose a reason for hiding this comment

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

LGTM!

@stechu stechu merged commit 65357c5 into manta Jun 20, 2022
@stechu stechu deleted the garandor/reformat branch June 20, 2022 03:05
BoyuanFeng pushed a commit that referenced this pull request Jun 20, 2022
BoyuanFeng pushed a commit that referenced this pull request Jun 20, 2022
@Apokalip Apokalip added the L-added Log: Issues and PRs related to addition label Jul 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
L-added Log: Issues and PRs related to addition P-high Priority: High
Projects
None yet
5 participants