Skip to content

Commit dceda22

Browse files
committed
chore(docs): sync external documentation
1 parent 9b28076 commit dceda22

70 files changed

Lines changed: 725 additions & 634 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

modules/logic.md

Lines changed: 469 additions & 220 deletions
Large diffs are not rendered by default.

modules/mint.md

Lines changed: 20 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[//]: # (This file is auto-generated. Please do not modify it yourself.)
22

3-
# Protobuf Documentation
3+
# Mint Module
44

55
<a name="top"></a>
66

@@ -20,41 +20,16 @@ The method for determining the inflation rate is outlined in the
2020
Given the annual inflation rate, the Minting Module calculates the exact amount of tokens to be generated for each
2121
block, based on the total number of blocks in a year.
2222

23-
## Table of Contents
24-
25-
- [mint/v1beta1/mint.proto](#mint/v1beta1/mint.proto)
26-
- [Minter](#mint.v1beta1.Minter)
27-
- [Params](#mint.v1beta1.Params)
28-
29-
- [mint/v1beta1/genesis.proto](#mint/v1beta1/genesis.proto)
30-
- [GenesisState](#mint.v1beta1.GenesisState)
31-
32-
- [mint/v1beta1/query.proto](#mint/v1beta1/query.proto)
33-
- [QueryAnnualProvisionsRequest](#mint.v1beta1.QueryAnnualProvisionsRequest)
34-
- [QueryAnnualProvisionsResponse](#mint.v1beta1.QueryAnnualProvisionsResponse)
35-
- [QueryInflationRequest](#mint.v1beta1.QueryInflationRequest)
36-
- [QueryInflationResponse](#mint.v1beta1.QueryInflationResponse)
37-
- [QueryParamsRequest](#mint.v1beta1.QueryParamsRequest)
38-
- [QueryParamsResponse](#mint.v1beta1.QueryParamsResponse)
39-
40-
- [Query](#mint.v1beta1.Query)
41-
42-
- [mint/v1beta1/tx.proto](#mint/v1beta1/tx.proto)
43-
- [MsgUpdateParams](#mint.v1beta1.MsgUpdateParams)
44-
- [MsgUpdateParamsResponse](#mint.v1beta1.MsgUpdateParamsResponse)
45-
46-
- [Msg](#mint.v1beta1.Msg)
47-
48-
- [Scalar Value Types](#scalar-value-types)
23+
## API
4924

5025
<a name="mint/v1beta1/mint.proto"></a>
5126
<p align="right"><a href="#top">Top</a></p>
5227

53-
## mint/v1beta1/mint.proto
28+
### mint/v1beta1/mint.proto
5429

5530
<a name="mint.v1beta1.Minter"></a>
5631

57-
### Minter
32+
#### Minter
5833

5934
Minter holds the state of minting within the blockchain.
6035

@@ -65,7 +40,7 @@ Minter holds the state of minting within the blockchain.
6540

6641
<a name="mint.v1beta1.Params"></a>
6742

68-
### Params
43+
#### Params
6944

7045
Params defines the parameters for the mint module.
7146

@@ -88,11 +63,11 @@ Params defines the parameters for the mint module.
8863
<a name="mint/v1beta1/genesis.proto"></a>
8964
<p align="right"><a href="#top">Top</a></p>
9065

91-
## mint/v1beta1/genesis.proto
66+
### mint/v1beta1/genesis.proto
9267

9368
<a name="mint.v1beta1.GenesisState"></a>
9469

95-
### GenesisState
70+
#### GenesisState
9671

9772
GenesisState defines the mint module's genesis state.
9873

@@ -112,18 +87,18 @@ GenesisState defines the mint module's genesis state.
11287
<a name="mint/v1beta1/query.proto"></a>
11388
<p align="right"><a href="#top">Top</a></p>
11489

115-
## mint/v1beta1/query.proto
90+
### mint/v1beta1/query.proto
11691

11792
<a name="mint.v1beta1.QueryAnnualProvisionsRequest"></a>
11893

119-
### QueryAnnualProvisionsRequest
94+
#### QueryAnnualProvisionsRequest
12095

12196
QueryAnnualProvisionsRequest is the request type for the
12297
Query/AnnualProvisions RPC method.
12398

12499
<a name="mint.v1beta1.QueryAnnualProvisionsResponse"></a>
125100

126-
### QueryAnnualProvisionsResponse
101+
#### QueryAnnualProvisionsResponse
127102

128103
QueryAnnualProvisionsResponse is the response type for the
129104
Query/AnnualProvisions RPC method.
@@ -134,13 +109,13 @@ Query/AnnualProvisions RPC method.
134109

135110
<a name="mint.v1beta1.QueryInflationRequest"></a>
136111

137-
### QueryInflationRequest
112+
#### QueryInflationRequest
138113

139114
QueryInflationRequest is the request type for the Query/Inflation RPC method.
140115

141116
<a name="mint.v1beta1.QueryInflationResponse"></a>
142117

143-
### QueryInflationResponse
118+
#### QueryInflationResponse
144119

145120
QueryInflationResponse is the response type for the Query/Inflation RPC
146121
method.
@@ -151,13 +126,13 @@ method.
151126

152127
<a name="mint.v1beta1.QueryParamsRequest"></a>
153128

154-
### QueryParamsRequest
129+
#### QueryParamsRequest
155130

156131
QueryParamsRequest is the request type for the Query/Params RPC method.
157132

158133
<a name="mint.v1beta1.QueryParamsResponse"></a>
159134

160-
### QueryParamsResponse
135+
#### QueryParamsResponse
161136

162137
QueryParamsResponse is the response type for the Query/Params RPC method.
163138

@@ -173,7 +148,7 @@ QueryParamsResponse is the response type for the Query/Params RPC method.
173148

174149
<a name="mint.v1beta1.Query"></a>
175150

176-
### Query
151+
#### Query
177152

178153
Query provides defines the gRPC querier service.
179154

@@ -188,11 +163,11 @@ Query provides defines the gRPC querier service.
188163
<a name="mint/v1beta1/tx.proto"></a>
189164
<p align="right"><a href="#top">Top</a></p>
190165

191-
## mint/v1beta1/tx.proto
166+
### mint/v1beta1/tx.proto
192167

193168
<a name="mint.v1beta1.MsgUpdateParams"></a>
194169

195-
### MsgUpdateParams
170+
#### MsgUpdateParams
196171

197172
MsgUpdateParams is the Msg/UpdateParams request type.
198173

@@ -207,7 +182,7 @@ NOTE: All parameters must be supplied. |
207182

208183
<a name="mint.v1beta1.MsgUpdateParamsResponse"></a>
209184

210-
### MsgUpdateParamsResponse
185+
#### MsgUpdateParamsResponse
211186

212187
MsgUpdateParamsResponse defines the response structure for executing a
213188
MsgUpdateParams message.
@@ -222,7 +197,7 @@ Since: cosmos-sdk 0.47
222197

223198
<a name="mint.v1beta1.Msg"></a>
224199

225-
### Msg
200+
#### Msg
226201

227202
Msg defines the x/mint Msg service.
228203

@@ -234,7 +209,7 @@ Since: cosmos-sdk 0.47 | | |
234209

235210
[//]: # (end services)
236211

237-
## Scalar Value Types
212+
### Scalar Value Types
238213

239214
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
240215
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |

0 commit comments

Comments
 (0)