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: add x/supply spec #836

Merged
merged 8 commits into from
May 16, 2022
Merged

docs: add x/supply spec #836

merged 8 commits into from
May 16, 2022

Conversation

RiccardoM
Copy link
Contributor

@RiccardoM RiccardoM commented Apr 22, 2022

Description

This PR adds the spec folder inside the x/supply module, containing the whole specification.

Depends-On: #835


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Signed-off-by: Riccardo Montagnin <riccardo.montagnin@gmail.com>
Signed-off-by: Riccardo Montagnin <riccardo.montagnin@gmail.com>
```
/supply/total/{denom}
```

Copy link
Contributor

Choose a reason for hiding this comment

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

It is missing example here, it should be like:

Example:

curl localhost:1317/supply/total/{denom}

Example Output:

1000040727987145688


```
/supply/circulating/{denom}
```
Copy link
Contributor

Choose a reason for hiding this comment

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

As above.

x/supply/spec/02_client.md Outdated Show resolved Hide resolved
x/supply/spec/02_client.md Outdated Show resolved Hide resolved
RiccardoM and others added 3 commits April 26, 2022 08:24
Co-authored-by: Paul <p22626262@gmail.com>
Co-authored-by: Paul <p22626262@gmail.com>
Signed-off-by: Riccardo Montagnin <riccardo.montagnin@gmail.com>
@RiccardoM RiccardoM requested a review from dadamu April 26, 2022 06:48
@RiccardoM RiccardoM added the docs/new Add a new documentation page, subsection of a page, or multimedia item label Apr 27, 2022
```

#### total
The `total` command allows users to query the total supply of a token given a denomination.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The `total` command allows users to query the total supply of a token given a denomination.
The `total` command allows users to query the total supply of a token given a denomination and an optional divider exponent. Based on the divider exponent, the total supply is displayed differently.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Instead of putting this here, since the divider exponent thing is related to all queries, I've put a note right inside the Query section

x/supply/spec/02_client.md Outdated Show resolved Hide resolved
```

#### circulating
The `circulating` command allows users to query the circulating supply of a token given a denomination.
Copy link
Contributor

Choose a reason for hiding this comment

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

as above

RiccardoM and others added 2 commits May 6, 2022 08:24
Co-authored-by: Leonardo Bragagnolo <leo.braga95@gmail.com>
Signed-off-by: Riccardo Montagnin <riccardo.montagnin@gmail.com>
@RiccardoM RiccardoM requested a review from leobragaz May 6, 2022 06:38
@RiccardoM RiccardoM added the automerge Automatically merge PR once all prerequisites pass label May 16, 2022
@mergify mergify bot merged commit a90411d into master May 16, 2022
@mergify mergify bot deleted the riccardo/supply-spec branch May 16, 2022 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Automatically merge PR once all prerequisites pass docs/new Add a new documentation page, subsection of a page, or multimedia item
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants