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(perp): Specification for client and concepts. #425

Merged
merged 18 commits into from
Jun 10, 2022
Merged

Conversation

Unique-Divine
Copy link
Member

@Unique-Divine Unique-Divine commented May 16, 2022

Summary

  • docs: MVP of the concepts.md
  • docs: CLI command syntax and argument descriptions
  • removed: unnecessary CalcPerpTxFee function (blank and unused) in x/vpool

Related

@Unique-Divine Unique-Divine added type: docs Improvements or additions to documentation x/perp labels May 16, 2022
@Unique-Divine Unique-Divine added this to the alpha milestone May 16, 2022
@@ -134,15 +134,15 @@ Returns:
toll (sdk.Int): Amount of tokens transferred to the the fee pool.
spread (sdk.Int): Amount of tokens transferred to the PerpEF.
*/
func (k Keeper) CalcPerpTxFee(ctx sdk.Context, quoteAmt sdk.Dec) (toll sdk.Int, spread sdk.Int, err error) {
func (k Keeper) CalcPerpTxFee(ctx sdk.Context, quoteAmt sdk.Dec) (toll sdk.Int, spread sdk.Int) {
Copy link
Member Author

Choose a reason for hiding this comment

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

This error value was unused.

@@ -231,8 +231,6 @@ type VpoolKeeper interface {
pair common.AssetPair,
) (price sdk.Dec, err error)

CalcPerpTxFee(ctx sdk.Context, pair common.AssetPair, quoteAmt sdk.Int,
Copy link
Member Author

Choose a reason for hiding this comment

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

This function is not part of the VpoolKeeper. It's part of the PerpKeeper.

@@ -28,21 +28,6 @@ type Keeper struct {
pricefeedKeeper types.PricefeedKeeper
}

//CalcPerpTxFee calculates the total tx fee for exchanging 'quoteAmt' of tokens on
Copy link
Member Author

Choose a reason for hiding this comment

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

This function is unimplemented and unused.

@Unique-Divine Unique-Divine changed the title docs (perp): Specification for client, messages, and concepts. docs (perp): Specification for client and concepts. Jun 10, 2022
@Unique-Divine Unique-Divine marked this pull request as ready for review June 10, 2022 05:27
@Unique-Divine Unique-Divine requested a review from a team as a code owner June 10, 2022 05:27
@Unique-Divine Unique-Divine changed the title docs (perp): Specification for client and concepts. docs(perp): Specification for client and concepts. Jun 10, 2022
@Unique-Divine Unique-Divine merged commit 1bf0941 into master Jun 10, 2022
@Unique-Divine Unique-Divine deleted the realu/docs branch June 10, 2022 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants