update proto files

cosmos · Jul 13, 2021 · 8652e00 · 8652e00
1 parent 7beebb2
commit 8652e00
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 51 deletions.
diff --git a/crypto/hd/hd.pb.go b/crypto/hd/hd.pb.go
diff --git a/crypto/keyring/types.pb.go b/crypto/keyring/types.pb.go
diff --git a/docs/core/proto-docs.md b/docs/core/proto-docs.md
@@ -3441,16 +3441,16 @@ then you must create a new proto message and follow ADR-28 for Address construct
 <a name="cosmos.crypto.hd.BIP44Params"></a>
 
 ### BIP44Params
-
+BIP44Params is used as path field in ledger item in Record.
 
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `purpose` | [uint32](#uint32) |  |  |
-| `coinType` | [uint32](#uint32) |  |  |
+| `coin_type` | [uint32](#uint32) |  |  |
 | `account` | [uint32](#uint32) |  |  |
 | `change` | [bool](#bool) |  |  |
-| `addressIndex` | [uint32](#uint32) |  |  |
+| `address_index` | [uint32](#uint32) |  |  |
 
 
 
@@ -3476,7 +3476,7 @@ then you must create a new proto message and follow ADR-28 for Address construct
 <a name="cosmos.crypto.keyring.v1.Record"></a>
 
 ### Record
-
+Record is used for keyring migration from legacyInfo to proto.
 
 
 | Field | Type | Label | Description |
@@ -3495,7 +3495,7 @@ then you must create a new proto message and follow ADR-28 for Address construct
 <a name="cosmos.crypto.keyring.v1.Record.Empty"></a>
 
 ### Record.Empty
-
+Empty item
 
 
 
@@ -3505,7 +3505,7 @@ then you must create a new proto message and follow ADR-28 for Address construct
 <a name="cosmos.crypto.keyring.v1.Record.Ledger"></a>
 
 ### Record.Ledger
-
+Ledger item
 
 
 | Field | Type | Label | Description |
@@ -3526,7 +3526,7 @@ Item is a keyring item stored in a keyring backend.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `priv_key` | [google.protobuf.Any](#google.protobuf.Any) |  |  |
-| `privKeyType` | [string](#string) |  |  |
+| `priv_key_type` | [string](#string) |  |  |
 
 
 

diff --git a/proto/cosmos/crypto/hd/hd.proto b/proto/cosmos/crypto/hd/hd.proto
@@ -6,12 +6,13 @@ import "gogoproto/gogo.proto";
 option go_package = "github.com/cosmos/cosmos-sdk/crypto/hd";
 option (gogoproto.goproto_getters_all) = false;
 
+// BIP44Params is used as path field in ledger item in Record.
 message BIP44Params  {
 	option (gogoproto.goproto_stringer) = false;
 
 	uint32 purpose = 1;
-	uint32 coinType = 2;
+	uint32 coin_type = 2;
 	uint32 account = 3;
 	bool   change = 4;
-	uint32 addressIndex = 5;
+	uint32 address_index = 5;
 }
diff --git a/proto/cosmos/crypto/keyring/types.proto b/proto/cosmos/crypto/keyring/types.proto
@@ -8,10 +8,12 @@ import "cosmos/crypto/hd/hd.proto";
 option go_package = "github.com/cosmos/cosmos-sdk/crypto/keyring";
 option (gogoproto.goproto_getters_all) = false;
 
+// Record is used for keyring migration from legacyInfo to proto.
 message Record {
   string name = 1;
   google.protobuf.Any pub_key = 2;
 
+  // Record contains one of the following items
   oneof item {
     Local local = 3;
     Ledger ledger  = 4;
@@ -21,10 +23,14 @@ message Record {
   // Item is a keyring item stored in a keyring backend.
   message Local {
     google.protobuf.Any priv_key = 1; 
-    string privKeyType = 2;
+    string priv_key_type = 2;
   }
+
+  // Ledger item 
   message Ledger {
     hd.BIP44Params path = 1;
   }
+
+  // Empty item
   message Empty {}
 }