From 7ab00f21ac99dbb52ed1b67490fb69cd07c1851f Mon Sep 17 00:00:00 2001 From: aljo242 Date: Tue, 21 Feb 2023 07:58:03 -0500 Subject: [PATCH 1/8] fix spec --- x/airdrop/spec/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/x/airdrop/spec/README.md b/x/airdrop/spec/README.md index 4fb078d10..7fd8972ab 100644 --- a/x/airdrop/spec/README.md +++ b/x/airdrop/spec/README.md @@ -154,7 +154,9 @@ var Status_value = map[string]int32{ ### ZoneDrop ```go +var ( KeyPrefixZoneDrop = []byte{0x01} +) func GetKeyZoneDrop(chainID string) []byte { return append(KeyPrefixZoneDrop, []byte(chainID)...) From 1d74ec02f1c1eebaaf9272232ef18faa91d94d60 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Tue, 21 Feb 2023 08:03:14 -0500 Subject: [PATCH 2/8] fix spec --- x/airdrop/spec/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/x/airdrop/spec/README.md b/x/airdrop/spec/README.md index 7fd8972ab..cae9a7ac7 100644 --- a/x/airdrop/spec/README.md +++ b/x/airdrop/spec/README.md @@ -177,7 +177,9 @@ type ZoneDrop struct { ### ClaimRecord ```go +var ( KeyPrefixClaimRecord = []byte{0x02} +) func GetKeyClaimRecord(chainID string, addr sdk.AccAddress) []byte { return append(append(KeyPrefixClaimRecord, []byte(chainID)...), addr...) From 640ee668fa2549c451c5f1aabf07d302f0c6bb0d Mon Sep 17 00:00:00 2001 From: aljo242 Date: Tue, 21 Feb 2023 08:11:40 -0500 Subject: [PATCH 3/8] format spec --- x/airdrop/spec/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/x/airdrop/spec/README.md b/x/airdrop/spec/README.md index cae9a7ac7..8c98b0f48 100644 --- a/x/airdrop/spec/README.md +++ b/x/airdrop/spec/README.md @@ -155,7 +155,7 @@ var Status_value = map[string]int32{ ```go var ( -KeyPrefixZoneDrop = []byte{0x01} + KeyPrefixZoneDrop = []byte{0x01} ) func GetKeyZoneDrop(chainID string) []byte { @@ -178,7 +178,7 @@ type ZoneDrop struct { ```go var ( -KeyPrefixClaimRecord = []byte{0x02} + KeyPrefixClaimRecord = []byte{0x02} ) func GetKeyClaimRecord(chainID string, addr sdk.AccAddress) []byte { From 8d55e375a374eb578de8cd6f674f032fd28fe3db Mon Sep 17 00:00:00 2001 From: aljo242 Date: Tue, 21 Feb 2023 08:18:21 -0500 Subject: [PATCH 4/8] format more --- x/claimsmanager/spec/README.md | 6 ++++-- x/epochs/spec/04_keeper.md | 20 ++++++++++---------- x/epochs/spec/05_hooks.md | 13 +++++++++---- x/mint/spec/02_state.md | 18 +++++++++--------- x/mint/spec/03_end_epoch.md | 6 +++--- 5 files changed, 35 insertions(+), 28 deletions(-) diff --git a/x/claimsmanager/spec/README.md b/x/claimsmanager/spec/README.md index beb67f150..660ed805a 100644 --- a/x/claimsmanager/spec/README.md +++ b/x/claimsmanager/spec/README.md @@ -58,8 +58,10 @@ var ClaimType_value = map[string]int32{ ### Claim ```go -KeyPrefixClaim = []byte{0x00} -KeyPrefixLastEpochClaim = []byte{0x01} +var ( + KeyPrefixClaim = []byte{0x00} + KeyPrefixLastEpochClaim = []byte{0x01} +) // ClaimKey returns the key for storing a given claim. func GetGenericKeyClaim(key []byte, chainID string, address string, module ClaimType, srcChainID string) []byte { diff --git a/x/epochs/spec/04_keeper.md b/x/epochs/spec/04_keeper.md index 5b3973a8e..aa89c34fd 100644 --- a/x/epochs/spec/04_keeper.md +++ b/x/epochs/spec/04_keeper.md @@ -11,15 +11,15 @@ Epochs keeper module provides utility functions to manage epochs. ```go // Keeper is the interface for lockup module keeper type Keeper interface { - // GetEpochInfo returns epoch info by identifier - GetEpochInfo(ctx sdk.Context, identifier string) types.EpochInfo - // SetEpochInfo set epoch info - SetEpochInfo(ctx sdk.Context, epoch types.EpochInfo) - // DeleteEpochInfo delete epoch info - DeleteEpochInfo(ctx sdk.Context, identifier string) - // IterateEpochInfo iterate through epochs - IterateEpochInfo(ctx sdk.Context, fn func(index int64, epochInfo types.EpochInfo) (stop bool)) - // Get all epoch infos - AllEpochInfos(ctx sdk.Context) []types.EpochInfo + // GetEpochInfo returns epoch info by identifier + GetEpochInfo(ctx sdk.Context, identifier string) types.EpochInfo + // SetEpochInfo set epoch info + SetEpochInfo(ctx sdk.Context, epoch types.EpochInfo) + // DeleteEpochInfo delete epoch info + DeleteEpochInfo(ctx sdk.Context, identifier string) + // IterateEpochInfo iterate through epochs + IterateEpochInfo(ctx sdk.Context, fn func(index int64, epochInfo types.EpochInfo) (stop bool)) + // Get all epoch infos + AllEpochInfos(ctx sdk.Context) []types.EpochInfo } ``` \ No newline at end of file diff --git a/x/epochs/spec/05_hooks.md b/x/epochs/spec/05_hooks.md index e98d8c132..701c5f593 100644 --- a/x/epochs/spec/05_hooks.md +++ b/x/epochs/spec/05_hooks.md @@ -6,10 +6,15 @@ order: 5 ## Hooks ```go - // the first block whose timestamp is after the duration is counted as the end of the epoch - AfterEpochEnd(ctx sdk.Context, epochIdentifier string, epochNumber int64) - // new epoch is next block of epoch end block - BeforeEpochStart(ctx sdk.Context, epochIdentifier string, epochNumber int64) + // the first block whose timestamp is after the duration is counted as the end of the epoch + func AfterEpochEnd(ctx sdk.Context, epochIdentifier string, epochNumber int64) { + // ... + } + + // new epoch is next block of epoch end block + func BeforeEpochStart(ctx sdk.Context, epochIdentifier string, epochNumber int64) { + // ... + } ``` ## How modules receive hooks diff --git a/x/mint/spec/02_state.md b/x/mint/spec/02_state.md index a8ea239a0..121ff6482 100644 --- a/x/mint/spec/02_state.md +++ b/x/mint/spec/02_state.md @@ -10,7 +10,7 @@ The minter is a space for holding current rewards information. ```go type Minter struct { - EpochProvisions sdk.Dec // Rewards for the current epoch + EpochProvisions sdk.Dec // Rewards for the current epoch } ``` @@ -20,14 +20,14 @@ Minting params are held in the global params store. ```go type Params struct { - MintDenom string // type of coin to mint - GenesisEpochProvisions sdk.Dec // initial epoch provisions at genesis - EpochIdentifier string // identifier of epoch - ReductionPeriodInEpochs int64 // number of epochs between reward reductions - ReductionFactor sdk.Dec // reduction multiplier to execute on each period - DistributionProportions DistributionProportions // distribution_proportions defines the proportion of the minted denom - WeightedDeveloperRewardsReceivers []WeightedAddress // address to receive developer rewards - MintingRewardsDistributionStartEpoch int64 // start epoch to distribute minting rewards + MintDenom string // type of coin to mint + GenesisEpochProvisions sdk.Dec // initial epoch provisions at genesis + EpochIdentifier string // identifier of epoch + ReductionPeriodInEpochs int64 // number of epochs between reward reductions + ReductionFactor sdk.Dec // reduction multiplier to execute on each period + DistributionProportions DistributionProportions // distribution_proportions defines the proportion of the minted denom + WeightedDeveloperRewardsReceivers []WeightedAddress // address to receive developer rewards + MintingRewardsDistributionStartEpoch int64 // start epoch to distribute minting rewards } ``` diff --git a/x/mint/spec/03_end_epoch.md b/x/mint/spec/03_end_epoch.md index ede4ce63a..dd8b7e39e 100644 --- a/x/mint/spec/03_end_epoch.md +++ b/x/mint/spec/03_end_epoch.md @@ -16,7 +16,7 @@ will be lowered by `1 - reduction factor`. ```go func (m Minter) NextEpochProvisions(params Params) sdk.Dec { - return m.EpochProvisions.Mul(params.ReductionFactor) + return m.EpochProvisions.Mul(params.ReductionFactor) } ``` @@ -26,7 +26,7 @@ Calculate the provisions generated for each epoch based on current epoch provisi ```go func (m Minter) EpochProvision(params Params) sdk.Coin { - provisionAmt := m.EpochProvisions.QuoInt(sdk.NewInt(int64(params.EpochsPerYear))) - return sdk.NewCoin(params.MintDenom, provisionAmt.TruncateInt()) + provisionAmt := m.EpochProvisions.QuoInt(sdk.NewInt(int64(params.EpochsPerYear))) + return sdk.NewCoin(params.MintDenom, provisionAmt.TruncateInt()) } ``` From 96f499d486f6627687eb75117c1683e529bd7e51 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Tue, 21 Feb 2023 08:19:33 -0500 Subject: [PATCH 5/8] annotate for proto --- x/tokenfactory/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/x/tokenfactory/README.md b/x/tokenfactory/README.md index 7d6644e45..2c940c349 100644 --- a/x/tokenfactory/README.md +++ b/x/tokenfactory/README.md @@ -24,7 +24,7 @@ created denom. Once a denom is created, the original creator is given Creates a denom of `factory/{creator address}/{subdenom}` given the denom creator address and the subdenom. Subdenoms can contain `[a-zA-Z0-9./]`. -```go +```protobuf message MsgCreateDenom { string sender = 1 [ (gogoproto.moretags) = "yaml:\"sender\"" ]; string subdenom = 2 [ (gogoproto.moretags) = "yaml:\"subdenom\"" ]; @@ -47,7 +47,7 @@ message MsgCreateDenom { Minting of a specific denom is only allowed for the current admin. Note, the current admin is defaulted to the creator of the denom. -```go +```protobuf message MsgMint { string sender = 1 [ (gogoproto.moretags) = "yaml:\"sender\"" ]; cosmos.base.v1beta1.Coin amount = 2 [ @@ -69,7 +69,7 @@ message MsgMint { Burning of a specific denom is only allowed for the current admin. Note, the current admin is defaulted to the creator of the denom. -```go +```protobuf message MsgBurn { string sender = 1 [ (gogoproto.moretags) = "yaml:\"sender\"" ]; cosmos.base.v1beta1.Coin amount = 2 [ @@ -90,7 +90,7 @@ message MsgBurn { Change the admin of a denom. Note, this is only allowed to be called by the current admin of the denom. -```go +```protobuf message MsgChangeAdmin { string sender = 1 [ (gogoproto.moretags) = "yaml:\"sender\"" ]; string denom = 2 [ (gogoproto.moretags) = "yaml:\"denom\"" ]; @@ -103,7 +103,7 @@ message MsgChangeAdmin { Setting of metadata for a specific denom is only allowed for the admin of the denom. It allows the overwriting of the denom metadata in the bank module. -```go +```protobuf message MsgChangeAdmin { string sender = 1 [ (gogoproto.moretags) = "yaml:\"sender\"" ]; cosmos.bank.v1beta1.Metadata metadata = 2 [ (gogoproto.moretags) = "yaml:\"metadata\"", (gogoproto.nullable) = false ]; From bc6aac7d35620286c8dc681fdb74b62b8e3560ac Mon Sep 17 00:00:00 2001 From: aljo242 Date: Tue, 21 Feb 2023 08:24:19 -0500 Subject: [PATCH 6/8] mdlint targets --- .markdownlint.yml | 22 ++++++++++++++++++++++ Makefile | 7 +++++++ 2 files changed, 29 insertions(+) create mode 100644 .markdownlint.yml diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 000000000..0ee34e50a --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,22 @@ +# Default state for all rules +default: false +MD003: + # Heading style + style: 'atx' +MD001: true +MD018: true +MD026: true +MD034: true +MD040: true +MD042: true +MD048: true +MD051: true +# MD004: false +# MD009: false +# MD010: +# code_blocks: false +# MD013: false +# MD024: false +# MD029: false +# MD033: false +# MD037: false # breaks on latex \ No newline at end of file diff --git a/Makefile b/Makefile index 0a550b161..b00572ee4 100755 --- a/Makefile +++ b/Makefile @@ -405,6 +405,13 @@ format: find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/docs/statik/statik.go" -not -name '*.pb.go' | xargs goimports -w -local github.com/ingenuity-build/quicksilver .PHONY: format +mdlint: + @echo "--> Running markdown linter" + @docker run -v $(PWD):/workdir ghcr.io/igorshubovych/markdownlint-cli:latest "**/*.md" + +mdlint-fix: + @docker run -v $(PWD):/workdir ghcr.io/igorshubovych/markdownlint-cli:latest "**/*.md" --fix + ############################################################################### ### Protobuf ### ############################################################################### From 35f6c64d90bb114445da796efdaa2bbf8a85e651 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Tue, 21 Feb 2023 08:24:46 -0500 Subject: [PATCH 7/8] mdlint fix pt1 --- README.md | 10 +++---- SECURITY.md | 2 +- x/airdrop/spec/README.md | 26 ++++++++--------- x/claimsmanager/spec/README.md | 24 ++++++++-------- x/interchainquery/spec/README.md | 24 ++++++++-------- x/interchainstaking/spec/README.md | 40 +++++++++++++-------------- x/module/spec/README.md | 22 +++++++-------- x/participationrewards/spec/README.md | 30 ++++++++++---------- 8 files changed, 89 insertions(+), 89 deletions(-) diff --git a/README.md b/README.md index 60f207841..6523aa2fc 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,10 @@ This system spec has been found to be optimal: 4. 100Mbps bidirectional Internet connection ## Software Dependencies -1. The Go programming language - https://go.dev/ -2. Git distributed version control - https://git-scm.com/ -3. Docker - https://www.docker.com/get-started/ -4. GNU Make - https://www.gnu.org/software/make/ +1. The Go programming language - +2. Git distributed version control - +3. Docker - +4. GNU Make - Make sure that the above software is installed on your system. Follow the instructions for your particular platform or use your preferred platform package manager; @@ -60,7 +60,7 @@ For subsequent tests run the following if you want to start with fresh state: Quicksilver utilises code and logic that originated from other projects; as an open-source project ourselves, we believe that appropriate attribution is neccessary, in order to combat plagarism. -The following modules were lifted and reused in almost entirety from Osmosis (https://github.com/osmosis-labs/osmosis), under the terms of the Apache 2.0 License, and we are grateful for their contribution: +The following modules were lifted and reused in almost entirety from Osmosis (), under the terms of the Apache 2.0 License, and we are grateful for their contribution: ``` x/mint diff --git a/SECURITY.md b/SECURITY.md index 4a7b230cd..ce95cdb24 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -5,7 +5,7 @@ ## Reporting Please report to our security mailing list at [security@ingenuity.build](mailto:security@ingenuity.build) and we shall respond to you within 72 hours. -## Packages in scope: +## Packages in scope * [x/airdrop](/x/airdrop) * [x/interchainstaking](/x/interchainstaking) * [x/mint](/x/mint) diff --git a/x/airdrop/spec/README.md b/x/airdrop/spec/README.md index 8c98b0f48..b40a31055 100644 --- a/x/airdrop/spec/README.md +++ b/x/airdrop/spec/README.md @@ -13,18 +13,18 @@ The purpose of this module is to distribute QCK airdrops to users for engaging i ## Contents -1. [Concepts](#Concepts) -1. [State](#State) -1. [Messages](#Messages) -1. [Transactions](#Transactions) -1. [Events](#Events) -1. [Hooks](#Hooks) -1. [Queries](#Queries) -1. [Keepers](#Keepers) -1. [Parameters](#Parameters) -1. [Proposals](#Proposals) -1. [Begin Block](#Begin-Block) -1. [End Block](#End-Block) +1. [Concepts](#concepts) +1. [State](#state) +1. [Messages](#messages) +1. [Transactions](#transactions) +1. [Events](#events) +1. [Hooks](#hooks) +1. [Queries](#queries) +1. [Keepers](#keepers) +1. [Parameters](#parameters) +1. [Proposals](#proposals) +1. [Begin Block](#begin-block) +1. [End Block](#end-block) ## Concepts @@ -426,7 +426,7 @@ type QueryClaimRecordResponse struct { ## Keepers -https://pkg.go.dev/github.com/ingenuity-build/quicksilver/x/airdrop/keeper + ## Parameters diff --git a/x/claimsmanager/spec/README.md b/x/claimsmanager/spec/README.md index 660ed805a..8e3bb259c 100644 --- a/x/claimsmanager/spec/README.md +++ b/x/claimsmanager/spec/README.md @@ -7,17 +7,17 @@ based claims utilized in other modules. ## Contents -1. [Concepts](#Concepts) -1. [State](#State) -1. [Messages](#Messages) -1. [Transactions](#Transactions) -1. [Events](#Events) -1. [Hooks](#Hooks) -1. [Queries](#Queries) -1. [Keepers](#Keepers) -1. [Parameters](#Parameters) -1. [Begin Block](#Begin-Block) -1. [End Block](#End-Block) +1. [Concepts](#concepts) +1. [State](#state) +1. [Messages](#messages) +1. [Transactions](#transactions) +1. [Events](#events) +1. [Hooks](#hooks) +1. [Queries](#queries) +1. [Keepers](#keepers) +1. [Parameters](#parameters) +1. [Begin Block](#begin-block) +1. [End Block](#end-block) ## Concepts @@ -197,7 +197,7 @@ type QueryClaimsResponse struct { ## Keepers -https://pkg.go.dev/github.com/ingenuity-build/quicksilver/x/claimsmanager/keeper + ## Parameters diff --git a/x/interchainquery/spec/README.md b/x/interchainquery/spec/README.md index 53df9a0d7..a65cd6dda 100644 --- a/x/interchainquery/spec/README.md +++ b/x/interchainquery/spec/README.md @@ -7,17 +7,17 @@ facilitate provable cross-chain queries. ## Contents -1. [Concepts](#Concepts) -1. [State](#State) -1. [Messages](#Messages) -1. [Transactions](#Transactions) -1. [Events](#Events) -1. [Hooks](#Hooks) -1. [Queries](#Queries) -1. [Keepers](#Keepers) -1. [Parameters](#Parameters) -1. [Begin Block](#Begin-Block) -1. [End Block](#End-Block) +1. [Concepts](#concepts) +1. [State](#state) +1. [Messages](#messages) +1. [Transactions](#transactions) +1. [Events](#events) +1. [Hooks](#hooks) +1. [Queries](#queries) +1. [Keepers](#keepers) +1. [Parameters](#parameters) +1. [Begin Block](#begin-block) +1. [End Block](#end-block) ## Concepts @@ -152,7 +152,7 @@ type QueryRequestsResponse struct { ## Keepers -https://pkg.go.dev/github.com/ingenuity-build/quicksilver/x/interchainquery/keeper + ## Parameters diff --git a/x/interchainstaking/spec/README.md b/x/interchainstaking/spec/README.md index d450aa53b..6ff4dc16d 100644 --- a/x/interchainstaking/spec/README.md +++ b/x/interchainstaking/spec/README.md @@ -7,19 +7,19 @@ protocol. ## Contents -1. [Concepts](#Concepts) -1. [State](#State) -1. [Messages](#Messages) -1. [Transactions](#Transactions) -1. [Proposals](#Proposals) -1. [Events](#Events) -1. [Hooks](#Hooks) -1. [Queries](#Queries) -1. [Keepers](#Keepers) -1. [Parameters](#Parameters) -1. [Begin Block](#Begin-Block) -1. [After Epoch End](#After-Epoch-End) -1. [IBC](#IBC) +1. [Concepts](#concepts) +1. [State](#state) +1. [Messages](#messages) +1. [Transactions](#transactions) +1. [Proposals](#proposals) +1. [Events](#events) +1. [Hooks](#hooks) +1. [Queries](#queries) +1. [Keepers](#keepers) +1. [Parameters](#parameters) +1. [Begin Block](#begin-block) +1. [After Epoch End](#after-epoch-end) +1. [IBC](#ibc) ## Concepts @@ -673,7 +673,7 @@ Query deposit account address for a given chain. ## Keepers -https://pkg.go.dev/github.com/ingenuity-build/quicksilver/x/interchainstaking/keeper + ## Parameters @@ -755,7 +755,7 @@ updated. Triggered by `RequestRedemption` when a user redeems qAssets. Withdrawal records are set or updated accordingly. -See [MsgRequestRedemption](#MsgRequestRedemption). +See [MsgRequestRedemption](#msgrequestredemption). - **Endpoint:** `/cosmos.staking.v1beta1.MsgTokenizeShares` - **Handler:** `HandleTokenizedShares` @@ -779,7 +779,7 @@ Triggered at the end of every epoch during `Rebalance`. #### MsgSend Triggered by `TransferToDelegate` during `HandleReceiptTransaction`. -See [Deposit Interval](#Deposit-Interval). +See [Deposit Interval](#deposit-interval). - **Endpoint:** `/cosmos.bank.v1beta1.MsgSend` - **Handler:** `HandleCompleteSend` @@ -811,7 +811,7 @@ latency and different zone block times, etc). Triggered by `DistributeRewardsFromWithdrawAccount` to distribute rewards across the zone delegation accounts and collect fees to the module fee account. The `RedemptionRate` is updated accordingly. -See [WithdrawalAddress Balances](#WithdrawalAddress-Balances). +See [WithdrawalAddress Balances](#withdrawaladdress-balances). - **Endpoint:** `/ibc.applications.transfer.v1.MsgTransfer` - **Handler:** `HandleMsgTransfer` @@ -833,7 +833,7 @@ update the individual account balances `AccountBalanceCallback`, trigger the #### Delegator Delegations Query delegator delegations for each zone and update delegation records. -See [After Epoch End](#After-Epoch-End). +See [After Epoch End](#after-epoch-end). - **Query:** `cosmos.staking.v1beta1.Query/DelegatorDelegations` - **Callback:** `DelegationsCallback` @@ -841,7 +841,7 @@ See [After Epoch End](#After-Epoch-End). #### Delegate Total Rewards Withdraw delegation rewards for each zone and distribute. -See [After Epoch End](#After-Epoch-End). +See [After Epoch End](#after-epoch-end). - **Query:** `cosmos.distribution.v1beta1.Query/DelegationTotalRewards` - **Callback:** `RewardsCallback` @@ -849,7 +849,7 @@ See [After Epoch End](#After-Epoch-End). #### WithdrawalAddress Balances Triggered by `HandleWithdrawRewards`. -See [MsgWithdrawDelegatorReward](#MsgWithdrawDelegatorReward). +See [MsgWithdrawDelegatorReward](#msgwithdrawdelegatorreward). - **Query:** `cosmos.bank.v1beta1.Query/AllBalances` - **Callback:** `DistributeRewardsFromWithdrawAccount` diff --git a/x/module/spec/README.md b/x/module/spec/README.md index 76ae2a404..c4720f20b 100644 --- a/x/module/spec/README.md +++ b/x/module/spec/README.md @@ -6,17 +6,17 @@ A brief module overview; ## Contents -1. [Concepts](#Concepts) -1. [State](#State) -1. [Messages](#Messages) -1. [Transactions](#Transactions) -1. [Events](#Events) -1. [Hooks](#Hooks) -1. [Queries](#Queries) -1. [Keepers](#Keepers) -1. [Parameters](#Parameters) -1. [Begin Block](#Begin-Block) -1. [End Block](#End-Block) +1. [Concepts](#concepts) +1. [State](#state) +1. [Messages](#messages) +1. [Transactions](#transactions) +1. [Events](#events) +1. [Hooks](#hooks) +1. [Queries](#queries) +1. [Keepers](#keepers) +1. [Parameters](#parameters) +1. [Begin Block](#begin-block) +1. [End Block](#end-block) ## Concepts diff --git a/x/participationrewards/spec/README.md b/x/participationrewards/spec/README.md index 42edb4b73..a898d69ee 100644 --- a/x/participationrewards/spec/README.md +++ b/x/participationrewards/spec/README.md @@ -7,19 +7,19 @@ allocate and distribute protocol participation rewards to users. ## Contents -1. [Concepts](#Concepts) -1. [State](#State) -1. [Messages](#Messages) -1. [Transactions](#Transactions) -1. [Proposals](#Proposals) -1. [Events](#Events) -1. [Hooks](#Hooks) -1. [Queries](#Queries) -1. [Keepers](#Keepers) -1. [Parameters](#Parameters) -1. [Begin Block](#Begin-Block) -1. [End Block](#End-Block) -1. [After Epoch End](#After-Epoch-End) +1. [Concepts](#concepts) +1. [State](#state) +1. [Messages](#messages) +1. [Transactions](#transactions) +1. [Proposals](#proposals) +1. [Events](#events) +1. [Hooks](#hooks) +1. [Queries](#queries) +1. [Keepers](#keepers) +1. [Parameters](#parameters) +1. [Begin Block](#begin-block) +1. [End Block](#end-block) +1. [After Epoch End](#after-epoch-end) ## Concepts @@ -32,7 +32,7 @@ Specifically, we want to reward users for: 3. Holdings of off-chain assets (qAssets); The total inflation allocation for participation rewards is divided -proportionally for each of the above according to the module [parameters](#Parameters). +proportionally for each of the above according to the module [parameters](#parameters). ### 1. Lockup Rewards @@ -341,7 +341,7 @@ type QueryProtocolDataResponse struct { ## Keepers -https://pkg.go.dev/github.com/ingenuity-build/quicksilver/x/participationrewards/keeper + ## Parameters From 7da6be1d8889cf881fe9c0ff4b7e0bfe78ac8e43 Mon Sep 17 00:00:00 2001 From: aljo242 Date: Tue, 21 Feb 2023 08:28:30 -0500 Subject: [PATCH 8/8] add ignore and fix --- .markdownlintignore | 2 ++ README.md | 10 ++++------ x/epochs/spec/02_state.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) create mode 100644 .markdownlintignore diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 000000000..e491f7370 --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1,2 @@ +CHANGELOG.md +docs/api/proto-docs.md \ No newline at end of file diff --git a/README.md b/README.md index 6523aa2fc..4b2cac4c3 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ This system spec has been found to be optimal: Make sure that the above software is installed on your system. Follow the instructions for your particular platform or use your preferred platform package manager; -In addition install `jq` (a command line JSON processor): +In addition, install `jq` (a command line JSON processor): - Debian based systems: `apt-get install jq` @@ -62,11 +62,9 @@ Quicksilver utilises code and logic that originated from other projects; as an o The following modules were lifted and reused in almost entirety from Osmosis (), under the terms of the Apache 2.0 License, and we are grateful for their contribution: -``` -x/mint -x/epochs -x/tokenfactory -``` + x/mint + x/epochs + x/tokenfactory We're also using CosmWasm, developed over the course of years with lead from Confio and support from the whole of Cosmos. diff --git a/x/epochs/spec/02_state.md b/x/epochs/spec/02_state.md index 24d77aaaa..56db792bc 100644 --- a/x/epochs/spec/02_state.md +++ b/x/epochs/spec/02_state.md @@ -7,7 +7,7 @@ order: 2 Epochs module keeps `EpochInfo` objects and modify the information as epochs info changes. Epochs are initialized as part of genesis initialization, and modified on begin blockers or end blockers. -### Epoch information type +## Epoch information type ```protobuf message EpochInfo {