Skip to content

Commit 59c0a60

Browse files
author
Yongwoo Lee
authored
chore: reformat proto files and restore proto docs (#212)
1 parent ade0ff1 commit 59c0a60

File tree

12 files changed

+10174
-27
lines changed

12 files changed

+10174
-27
lines changed

‎docs/core/proto-docs.md

+10,043
Large diffs are not rendered by default.

‎docs/protodoc-markdown.tmpl

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
<!-- This file is auto-generated. Please do not modify it yourself. -->
2+
# Protobuf Documentation
3+
<a name="top"></a>
4+
5+
## Table of Contents
6+
{{range .Files}}
7+
{{$file_name := .Name}}- [{{.Name}}](#{{.Name}})
8+
{{- if .Messages }}
9+
{{range .Messages}} - [{{.LongName}}](#{{.FullName}})
10+
{{end}}
11+
{{- end -}}
12+
{{- if .Enums }}
13+
{{range .Enums}} - [{{.LongName}}](#{{.FullName}})
14+
{{end}}
15+
{{- end -}}
16+
{{- if .Extensions }}
17+
{{range .Extensions}} - [File-level Extensions](#{{$file_name}}-extensions)
18+
{{end}}
19+
{{- end -}}
20+
{{- if .Services }}
21+
{{range .Services}} - [{{.Name}}](#{{.FullName}})
22+
{{end}}
23+
{{- end -}}
24+
{{end}}
25+
- [Scalar Value Types](#scalar-value-types)
26+
27+
{{range .Files}}
28+
{{$file_name := .Name}}
29+
<a name="{{.Name}}"></a>
30+
<p align="right"><a href="#top">Top</a></p>
31+
32+
## {{.Name}}
33+
{{.Description}}
34+
35+
{{range .Messages}}
36+
<a name="{{.FullName}}"></a>
37+
38+
### {{.LongName}}
39+
{{.Description}}
40+
41+
{{if .HasFields}}
42+
| Field | Type | Label | Description |
43+
| ----- | ---- | ----- | ----------- |
44+
{{range .Fields -}}
45+
| `{{.Name}}` | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
46+
{{end}}
47+
{{end}}
48+
49+
{{if .HasExtensions}}
50+
| Extension | Type | Base | Number | Description |
51+
| --------- | ---- | ---- | ------ | ----------- |
52+
{{range .Extensions -}}
53+
| `{{.Name}}` | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
54+
{{end}}
55+
{{end}}
56+
57+
{{end}} <!-- end messages -->
58+
59+
{{range .Enums}}
60+
<a name="{{.FullName}}"></a>
61+
62+
### {{.LongName}}
63+
{{.Description}}
64+
65+
| Name | Number | Description |
66+
| ---- | ------ | ----------- |
67+
{{range .Values -}}
68+
| {{.Name}} | {{.Number}} | {{nobr .Description}} |
69+
{{end}}
70+
71+
{{end}} <!-- end enums -->
72+
73+
{{if .HasExtensions}}
74+
<a name="{{$file_name}}-extensions"></a>
75+
76+
### File-level Extensions
77+
| Extension | Type | Base | Number | Description |
78+
| --------- | ---- | ---- | ------ | ----------- |
79+
{{range .Extensions -}}
80+
| `{{.Name}}` | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
81+
{{end}}
82+
{{end}} <!-- end HasExtensions -->
83+
84+
{{range .Services}}
85+
<a name="{{.FullName}}"></a>
86+
87+
### {{.Name}}
88+
{{.Description}}
89+
90+
| Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint |
91+
| ----------- | ------------ | ------------- | ------------| ------- | -------- |
92+
{{range .Methods -}}
93+
| `{{.Name}}` | [{{.RequestLongType}}](#{{.RequestFullType}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} | {{with (index .Options "google.api.http")}}{{range .Rules}}{{.Method}}|{{.Pattern}}{{end}}{{end}}|
94+
{{end}}
95+
{{end}} <!-- end services -->
96+
97+
{{end}}
98+
99+
## Scalar Value Types
100+
101+
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
102+
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
103+
{{range .Scalars -}}
104+
| <a name="{{.ProtoType}}" /> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} |
105+
{{end}}

‎proto/lbm/bank/v1beta1/bank.proto

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ message Input {
2828
option (gogoproto.equal) = false;
2929
option (gogoproto.goproto_getters) = false;
3030

31-
string address = 1;
31+
string address = 1;
3232
repeated lbm.base.v1beta1.Coin coins = 2
3333
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/line/lbm-sdk/v2/types.Coins"];
3434
}
@@ -38,7 +38,7 @@ message Output {
3838
option (gogoproto.equal) = false;
3939
option (gogoproto.goproto_getters) = false;
4040

41-
string address = 1;
41+
string address = 1;
4242
repeated lbm.base.v1beta1.Coin coins = 2
4343
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/line/lbm-sdk/v2/types.Coins"];
4444
}

‎proto/lbm/bank/v1beta1/tx.proto

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ message MsgSend {
2121
option (gogoproto.equal) = false;
2222
option (gogoproto.goproto_getters) = false;
2323

24-
string from_address = 1 [(gogoproto.moretags) = "yaml:\"from_address\""];
25-
string to_address = 2 [(gogoproto.moretags) = "yaml:\"to_address\""];
24+
string from_address = 1 [(gogoproto.moretags) = "yaml:\"from_address\""];
25+
string to_address = 2 [(gogoproto.moretags) = "yaml:\"to_address\""];
2626
repeated lbm.base.v1beta1.Coin amount = 3
2727
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/line/lbm-sdk/v2/types.Coins"];
2828
}

‎proto/lbm/crisis/v1beta1/genesis.proto

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,5 @@ import "lbm/base/v1beta1/coin.proto";
1010
message GenesisState {
1111
// constant_fee is the fee used to verify the invariant in the crisis
1212
// module.
13-
lbm.base.v1beta1.Coin constant_fee = 3
14-
[(gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"constant_fee\""];
13+
lbm.base.v1beta1.Coin constant_fee = 3 [(gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"constant_fee\""];
1514
}

‎proto/lbm/distribution/v1beta1/distribution.proto

+3-3
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ message CommunityPoolSpendProposal {
108108
option (gogoproto.goproto_getters) = false;
109109
option (gogoproto.goproto_stringer) = false;
110110

111-
string title = 1;
112-
string description = 2;
113-
string recipient = 3;
111+
string title = 1;
112+
string description = 2;
113+
string recipient = 3;
114114
repeated lbm.base.v1beta1.Coin amount = 4
115115
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/line/lbm-sdk/v2/types.Coins"];
116116
}

‎proto/lbm/gov/v1beta1/gov.proto

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ message Deposit {
4646
option (gogoproto.goproto_getters) = false;
4747
option (gogoproto.equal) = false;
4848

49-
uint64 proposal_id = 1 [(gogoproto.moretags) = "yaml:\"proposal_id\""];
50-
string depositor = 2;
49+
uint64 proposal_id = 1 [(gogoproto.moretags) = "yaml:\"proposal_id\""];
50+
string depositor = 2;
5151
repeated lbm.base.v1beta1.Coin amount = 3
5252
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/line/lbm-sdk/v2/types.Coins"];
5353
}

‎proto/lbm/gov/v1beta1/tx.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ message MsgSubmitProposal {
2929
option (gogoproto.stringer) = false;
3030
option (gogoproto.goproto_getters) = false;
3131

32-
google.protobuf.Any content = 1 [(cosmos_proto.accepts_interface) = "Content"];
32+
google.protobuf.Any content = 1 [(cosmos_proto.accepts_interface) = "Content"];
3333
repeated lbm.base.v1beta1.Coin initial_deposit = 2 [
3434
(gogoproto.nullable) = false,
3535
(gogoproto.castrepeated) = "github.com/line/lbm-sdk/v2/types.Coins",

‎proto/lbm/staking/v1beta1/tx.proto

+10-10
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ message MsgCreateValidator {
4444
(gogoproto.moretags) = "yaml:\"min_self_delegation\"",
4545
(gogoproto.nullable) = false
4646
];
47-
string delegator_address = 4 [(gogoproto.moretags) = "yaml:\"delegator_address\""];
48-
string validator_address = 5 [(gogoproto.moretags) = "yaml:\"validator_address\""];
49-
google.protobuf.Any pubkey = 6 [(cosmos_proto.accepts_interface) = "lbm.crypto.PubKey"];
47+
string delegator_address = 4 [(gogoproto.moretags) = "yaml:\"delegator_address\""];
48+
string validator_address = 5 [(gogoproto.moretags) = "yaml:\"validator_address\""];
49+
google.protobuf.Any pubkey = 6 [(cosmos_proto.accepts_interface) = "lbm.crypto.PubKey"];
5050
lbm.base.v1beta1.Coin value = 7 [(gogoproto.nullable) = false];
5151
}
5252

@@ -84,8 +84,8 @@ message MsgDelegate {
8484
option (gogoproto.equal) = false;
8585
option (gogoproto.goproto_getters) = false;
8686

87-
string delegator_address = 1 [(gogoproto.moretags) = "yaml:\"delegator_address\""];
88-
string validator_address = 2 [(gogoproto.moretags) = "yaml:\"validator_address\""];
87+
string delegator_address = 1 [(gogoproto.moretags) = "yaml:\"delegator_address\""];
88+
string validator_address = 2 [(gogoproto.moretags) = "yaml:\"validator_address\""];
8989
lbm.base.v1beta1.Coin amount = 3 [(gogoproto.nullable) = false];
9090
}
9191

@@ -98,9 +98,9 @@ message MsgBeginRedelegate {
9898
option (gogoproto.equal) = false;
9999
option (gogoproto.goproto_getters) = false;
100100

101-
string delegator_address = 1 [(gogoproto.moretags) = "yaml:\"delegator_address\""];
102-
string validator_src_address = 2 [(gogoproto.moretags) = "yaml:\"validator_src_address\""];
103-
string validator_dst_address = 3 [(gogoproto.moretags) = "yaml:\"validator_dst_address\""];
101+
string delegator_address = 1 [(gogoproto.moretags) = "yaml:\"delegator_address\""];
102+
string validator_src_address = 2 [(gogoproto.moretags) = "yaml:\"validator_src_address\""];
103+
string validator_dst_address = 3 [(gogoproto.moretags) = "yaml:\"validator_dst_address\""];
104104
lbm.base.v1beta1.Coin amount = 4 [(gogoproto.nullable) = false];
105105
}
106106

@@ -115,8 +115,8 @@ message MsgUndelegate {
115115
option (gogoproto.equal) = false;
116116
option (gogoproto.goproto_getters) = false;
117117

118-
string delegator_address = 1 [(gogoproto.moretags) = "yaml:\"delegator_address\""];
119-
string validator_address = 2 [(gogoproto.moretags) = "yaml:\"validator_address\""];
118+
string delegator_address = 1 [(gogoproto.moretags) = "yaml:\"delegator_address\""];
119+
string validator_address = 2 [(gogoproto.moretags) = "yaml:\"validator_address\""];
120120
lbm.base.v1beta1.Coin amount = 3 [(gogoproto.nullable) = false];
121121
}
122122

‎proto/lbm/vesting/v1beta1/tx.proto

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ service Msg {
1818
message MsgCreateVestingAccount {
1919
option (gogoproto.equal) = true;
2020

21-
string from_address = 1 [(gogoproto.moretags) = "yaml:\"from_address\""];
22-
string to_address = 2 [(gogoproto.moretags) = "yaml:\"to_address\""];
21+
string from_address = 1 [(gogoproto.moretags) = "yaml:\"from_address\""];
22+
string to_address = 2 [(gogoproto.moretags) = "yaml:\"to_address\""];
2323
repeated lbm.base.v1beta1.Coin amount = 3
2424
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/line/lbm-sdk/v2/types.Coins"];
2525

‎proto/lbm/vesting/v1beta1/vesting.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ message DelayedVestingAccount {
5656
message Period {
5757
option (gogoproto.goproto_stringer) = false;
5858

59-
int64 length = 1;
59+
int64 length = 1;
6060
repeated lbm.base.v1beta1.Coin amount = 2
6161
[(gogoproto.nullable) = false, (gogoproto.castrepeated) = "github.com/line/lbm-sdk/v2/types.Coins"];
6262
}

‎testutil/testdata/unknonwnproto.proto

+2-2
Original file line numberDiff line numberDiff line change
@@ -299,8 +299,8 @@ message TestUpdatedTxBody {
299299
message TestUpdatedAuthInfo {
300300
repeated lbm.tx.v1beta1.SignerInfo signer_infos = 1;
301301
lbm.tx.v1beta1.Fee fee = 2;
302-
bytes new_field_3 = 3;
303-
bytes new_field_1024 = 1024;
302+
bytes new_field_3 = 3;
303+
bytes new_field_1024 = 1024;
304304
}
305305

306306
message TestRepeatedUints {

0 commit comments

Comments
 (0)