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

Add missing natspec comments on Smart Contracts functions #217

Merged
28 commits merged into from
Sep 8, 2022

Conversation

gusjavaz
Copy link
Contributor

Scope

This PR adds missing comments on the functions of the following contracts:
1- ATokenBurner
2- ATokenMinter
6- Foundation
7- Proxy
8- Snapshot
9- StakingDescriptor
Also minor changes to parameter names to better reflect their specific functionality.

Why?

To have better knowledge of contracts functionality

@gusjavaz gusjavaz requested a review from a team as a code owner August 25, 2022 12:56
@github-actions github-actions bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code solidity labels Aug 25, 2022
@gusjavaz gusjavaz changed the title Add missing natspec comments on the functions of Smart Contracts Add missing natspec comments on Smart Contracts functions Aug 25, 2022
@codecov
Copy link

codecov bot commented Aug 25, 2022

Codecov Report

Merging #217 (1f2e9d5) into main (4639288) will decrease coverage by 1.70%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #217      +/-   ##
==========================================
- Coverage   53.39%   51.69%   -1.71%     
==========================================
  Files         343      283      -60     
  Lines       43527    41182    -2345     
  Branches      369        0     -369     
==========================================
- Hits        23240    21287    -1953     
+ Misses      17874    17478     -396     
- Partials     2413     2417       +4     
Impacted Files Coverage Δ
badgerTrie/smt_merkle_proof.go 65.62% <0.00%> (-3.91%) ⬇️
peering/active.go 83.01% <0.00%> (-0.95%) ⬇️
bridge/contracts/ATokenBurner.sol
bridge/contracts/ATokenMinter.sol
bridge/contracts/Foundation.sol
bridge/contracts/Proxy.sol
bridge/contracts/Snapshots.sol
...contracts/libraries/metadata/StakingDescriptor.sol
bridge/contracts/utils/ImmutableAuth.sol
bridge/contracts/utils/ETHDKGUtils.sol
... and 52 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@gusjavaz gusjavaz marked this pull request as draft August 25, 2022 13:58
@github-actions github-actions bot removed javascript Pull requests that update Javascript code dependencies Pull requests that update a dependency file labels Aug 25, 2022
@gusjavaz gusjavaz marked this pull request as ready for review August 25, 2022 17:52
bridge/contracts/Foundation.sol Outdated Show resolved Hide resolved
bridge/contracts/Foundation.sol Outdated Show resolved Hide resolved
bridge/contracts/Snapshots.sol Outdated Show resolved Hide resolved
bridge/contracts/Snapshots.sol Outdated Show resolved Hide resolved
bridge/contracts/Snapshots.sol Outdated Show resolved Hide resolved
bridge/contracts/Snapshots.sol Outdated Show resolved Hide resolved
bridge/contracts/Snapshots.sol Outdated Show resolved Hide resolved
bridge/contracts/Snapshots.sol Outdated Show resolved Hide resolved
bridge/contracts/Snapshots.sol Show resolved Hide resolved
Gustavo Vázquez Amado and others added 6 commits September 2, 2022 12:03
Co-authored-by: Leonardo Viana <38760502+vtleonardo@users.noreply.github.com>
Co-authored-by: Leonardo Viana <38760502+vtleonardo@users.noreply.github.com>
Co-authored-by: Leonardo Viana <38760502+vtleonardo@users.noreply.github.com>
Co-authored-by: Leonardo Viana <38760502+vtleonardo@users.noreply.github.com>
Copy link
Contributor

@vtleonardo vtleonardo left a comment

Choose a reason for hiding this comment

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

LGTM!

@ghost ghost merged commit bd13207 into alicenet:main Sep 8, 2022
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants