keys: define proto type

codec/std/codec.proto

@@ -47,8 +47,9 @@ message Supply {
 // Evidence defines the application-level allowed Evidence to be submitted via a
 // MsgSubmitEvidence message.
 message Evidence {
-  option (gogoproto.equal)             = true;
-  option (cosmos_proto.interface_type) = "github.com/cosmos/cosmos-sdk/x/evidence/exported.Evidence";
+  option (gogoproto.equal) = true;
+  option (cosmos_proto.interface_type) =
+      "github.com/cosmos/cosmos-sdk/x/evidence/exported.Evidence";
 
   // sum defines a set of all acceptable concrete Evidence implementations.
   oneof sum {
@@ -62,8 +63,9 @@ message MsgSubmitEvidence {
   option (gogoproto.equal)           = true;
   option (gogoproto.goproto_getters) = false;
 
-  cosmos_sdk.x.evidence.v1.MsgSubmitEvidenceBase base     = 1 [(gogoproto.nullable) = false, (gogoproto.embed) = true];
-  Evidence                                       evidence = 2;
+  cosmos_sdk.x.evidence.v1.MsgSubmitEvidenceBase base = 1
+      [(gogoproto.nullable) = false, (gogoproto.embed) = true];
+  Evidence evidence = 2;
 }
 
 // MsgSubmitProposal defines the application-level message type for handling
@@ -72,17 +74,19 @@ message MsgSubmitProposal {
   option (gogoproto.equal)           = true;
   option (gogoproto.goproto_getters) = false;
 
-  cosmos_sdk.x.gov.v1.MsgSubmitProposalBase base    = 1 [(gogoproto.nullable) = false, (gogoproto.embed) = true];
-  Content                                   content = 2;
+  cosmos_sdk.x.gov.v1.MsgSubmitProposalBase base = 1
+      [(gogoproto.nullable) = false, (gogoproto.embed) = true];
+  Content content = 2;
 }
 
 // Proposal defines the application-level concrete proposal type used in governance
 // proposals.
 message Proposal {
   option (gogoproto.equal) = true;
 
-  cosmos_sdk.x.gov.v1.ProposalBase base    = 1 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
-  Content                          content = 2 [(gogoproto.nullable) = false];
+  cosmos_sdk.x.gov.v1.ProposalBase base = 1
+      [(gogoproto.embed) = true, (gogoproto.nullable) = false];
+  Content content = 2 [(gogoproto.nullable) = false];
 }
 
 // Content defines the application-level allowed Content to be included in a
@@ -118,23 +122,24 @@ message Message {
 
   // sum defines the set of all allowed valid messages defined in modules.
   oneof sum {
-    cosmos_sdk.x.bank.v1.MsgSend                                msg_send                          = 1;
-    cosmos_sdk.x.bank.v1.MsgMultiSend                           msg_multi_send                    = 2;
-    cosmos_sdk.x.crisis.v1.MsgVerifyInvariant                   msg_verify_invariant              = 3;
-    cosmos_sdk.x.distribution.v1.MsgSetWithdrawAddress          msg_set_withdraw_address          = 4;
-    cosmos_sdk.x.distribution.v1.MsgWithdrawDelegatorReward     msg_withdraw_delegator_reward     = 5;
-    cosmos_sdk.x.distribution.v1.MsgWithdrawValidatorCommission msg_withdraw_validator_commission = 6;
-    cosmos_sdk.x.distribution.v1.MsgFundCommunityPool           msg_fund_community_pool           = 7;
-    MsgSubmitEvidence                                           msg_submit_evidence               = 8;
-    MsgSubmitProposal                                           msg_submit_proposal               = 9;
-    cosmos_sdk.x.gov.v1.MsgVote                                 msg_vote                          = 10;
-    cosmos_sdk.x.gov.v1.MsgDeposit                              msg_deposit                       = 11;
-    cosmos_sdk.x.slashing.v1.MsgUnjail                          msg_unjail                        = 12;
-    cosmos_sdk.x.staking.v1.MsgCreateValidator                  msg_create_validator              = 13;
-    cosmos_sdk.x.staking.v1.MsgEditValidator                    msg_edit_validator                = 14;
-    cosmos_sdk.x.staking.v1.MsgDelegate                         msg_delegate                      = 15;
-    cosmos_sdk.x.staking.v1.MsgBeginRedelegate                  msg_begin_redelegate              = 16;
-    cosmos_sdk.x.staking.v1.MsgUndelegate                       msg_undelegate                    = 17;
+    cosmos_sdk.x.bank.v1.MsgSend                                msg_send                      = 1;
+    cosmos_sdk.x.bank.v1.MsgMultiSend                           msg_multi_send                = 2;
+    cosmos_sdk.x.crisis.v1.MsgVerifyInvariant                   msg_verify_invariant          = 3;
+    cosmos_sdk.x.distribution.v1.MsgSetWithdrawAddress          msg_set_withdraw_address      = 4;
+    cosmos_sdk.x.distribution.v1.MsgWithdrawDelegatorReward     msg_withdraw_delegator_reward = 5;
+    cosmos_sdk.x.distribution.v1.MsgWithdrawValidatorCommission msg_withdraw_validator_commission =
+        6;
+    cosmos_sdk.x.distribution.v1.MsgFundCommunityPool msg_fund_community_pool = 7;
+    MsgSubmitEvidence                                 msg_submit_evidence     = 8;
+    MsgSubmitProposal                                 msg_submit_proposal     = 9;
+    cosmos_sdk.x.gov.v1.MsgVote                       msg_vote                = 10;
+    cosmos_sdk.x.gov.v1.MsgDeposit                    msg_deposit             = 11;
+    cosmos_sdk.x.slashing.v1.MsgUnjail                msg_unjail              = 12;
+    cosmos_sdk.x.staking.v1.MsgCreateValidator        msg_create_validator    = 13;
+    cosmos_sdk.x.staking.v1.MsgEditValidator          msg_edit_validator      = 14;
+    cosmos_sdk.x.staking.v1.MsgDelegate               msg_delegate            = 15;
+    cosmos_sdk.x.staking.v1.MsgBeginRedelegate        msg_begin_redelegate    = 16;
+    cosmos_sdk.x.staking.v1.MsgUndelegate             msg_undelegate          = 17;
   }
 }
 

codec/std/compact_bit_array.go

@@ -0,0 +1,223 @@
+package std
+
+import (
+	"encoding/binary"
+	"fmt"
+	"regexp"
+	"strings"
+)
+
+// NewCompactBitArray returns a new compact bit array.
+// It returns nil if the number of bits is zero.
+func NewCompactBitArray(bits int) *CompactBitArray {
+	if bits <= 0 {
+		return nil
+	}
+	return &CompactBitArray{
+		ExtraBitsStored: []byte{byte(bits % 8)},
+		Elems:           make([]byte, (bits+7)/8),
+	}
+}
+
+// Size returns the number of bits in the bitarray
+func (bA *CompactBitArray) Size() int {
+	if bA == nil {
+		return 0
+	} else if bA.ExtraBitsStored[0] == byte(0) {
+		return len(bA.Elems) * 8
+	}
+	// num_bits = 8*num_full_bytes + overflow_in_last_byte
+	// num_full_bytes = (len(bA.Elems)-1)
+	return (len(bA.Elems)-1)*8 + int(bA.ExtraBitsStored[0])
+}
+
+// GetIndex returns the bit at index i within the bit array.
+// The behavior is undefined if i >= bA.Size()
+func (bA *CompactBitArray) GetIndex(i int) bool {
+	if bA == nil {
+		return false
+	}
+	if i >= bA.Size() {
+		return false
+	}
+	return bA.Elems[i>>3]&(uint8(1)<<uint8(7-(i%8))) > 0
+}
+
+// SetIndex sets the bit at index i within the bit array.
+// The behavior is undefined if i >= bA.Size()
+func (bA *CompactBitArray) SetIndex(i int, v bool) bool {
+	if bA == nil {
+		return false
+	}
+	if i >= bA.Size() {
+		return false
+	}
+	if v {
+		bA.Elems[i>>3] |= (uint8(1) << uint8(7-(i%8)))
+	} else {
+		bA.Elems[i>>3] &= ^(uint8(1) << uint8(7-(i%8)))
+	}
+	return true
+}
+
+// NumTrueBitsBefore returns the number of bits set to true before the
+// given index. e.g. if bA = _XX__XX, NumOfTrueBitsBefore(4) = 2, since
+// there are two bits set to true before index 4.
+func (bA *CompactBitArray) NumTrueBitsBefore(index int) int {
+	numTrueValues := 0
+	for i := 0; i < index; i++ {
+		if bA.GetIndex(i) {
+			numTrueValues++
+		}
+	}
+	return numTrueValues
+}
+
+// Copy returns a copy of the provided bit array.
+func (bA *CompactBitArray) Copy() *CompactBitArray {
+	if bA == nil {
+		return nil
+	}
+	c := make([]byte, len(bA.Elems))
+	copy(c, bA.Elems)
+	return &CompactBitArray{
+		ExtraBitsStored: bA.ExtraBitsStored,
+		Elems:           c,
+	}
+}
+
+// String returns a string representation of CompactBitArray: BA{<bit-string>},
+// where <bit-string> is a sequence of 'x' (1) and '_' (0).
+// The <bit-string> includes spaces and newlines to help people.
+// For a simple sequence of 'x' and '_' characters with no spaces or newlines,
+// see the MarshalJSON() method.
+// Example: "BA{_x_}" or "nil-BitArray" for nil.
+func (bA *CompactBitArray) String() string {
+	return bA.StringIndented("")
+}
+
+// StringIndented returns the same thing as String(), but applies the indent
+// at every 10th bit, and twice at every 50th bit.
+func (bA *CompactBitArray) StringIndented(indent string) string {
+	if bA == nil {
+		return "nil-BitArray"
+	}
+	lines := []string{}
+	bits := ""
+	size := bA.Size()
+	for i := 0; i < size; i++ {
+		if bA.GetIndex(i) {
+			bits += "x"
+		} else {
+			bits += "_"
+		}
+		if i%100 == 99 {
+			lines = append(lines, bits)
+			bits = ""
+		}
+		if i%10 == 9 {
+			bits += indent
+		}
+		if i%50 == 49 {
+			bits += indent
+		}
+	}
+	if len(bits) > 0 {
+		lines = append(lines, bits)
+	}
+	return fmt.Sprintf("BA{%v:%v}", size, strings.Join(lines, indent))
+}
+
+// MarshalJSON implements json.Marshaler interface by marshaling bit array
+// using a custom format: a string of '-' or 'x' where 'x' denotes the 1 bit.
+func (bA *CompactBitArray) MarshalJSON() ([]byte, error) {
+	if bA == nil {
+		return []byte("null"), nil
+	}
+
+	bits := `"`
+	size := bA.Size()
+	for i := 0; i < size; i++ {
+		if bA.GetIndex(i) {
+			bits += `x`
+		} else {
+			bits += `_`
+		}
+	}
+	bits += `"`
+	return []byte(bits), nil
+}
+
+var bitArrayJSONRegexp = regexp.MustCompile(`\A"([_x]*)"\z`)
+
+// UnmarshalJSON implements json.Unmarshaler interface by unmarshaling a custom
+// JSON description.
+func (bA *CompactBitArray) UnmarshalJSON(bz []byte) error {
+	b := string(bz)
+	if b == "null" {
+		// This is required e.g. for encoding/json when decoding
+		// into a pointer with pre-allocated BitArray.
+		bA.ExtraBitsStored = []byte{0}
+		bA.Elems = nil
+		return nil
+	}
+
+	// Validate 'b'.
+	match := bitArrayJSONRegexp.FindStringSubmatch(b)
+	if match == nil {
+		return fmt.Errorf("bitArray in JSON should be a string of format %q but got %s", bitArrayJSONRegexp.String(), b)
+	}
+	bits := match[1]
+
+	// Construct new CompactBitArray and copy over.
+	numBits := len(bits)
+	bA2 := NewCompactBitArray(numBits)
+	for i := 0; i < numBits; i++ {
+		if bits[i] == 'x' {
+			bA2.SetIndex(i, true)
+		}
+	}
+	*bA = *bA2
+	return nil
+}
+
+// // CompactMarshal is a space efficient encoding for CompactBitArray.
+// // It is not amino compatible.
+// func (bA *CompactBitArray) Marshal() []byte {
+// 	size := bA.Size()
+// 	if size <= 0 {
+// 		return []byte("null")
+// 	}
+// 	bz := make([]byte, 0, size/8)
+// 	// length prefix number of bits, not number of bytes. This difference
+// 	// takes 3-4 bits in encoding, as opposed to instead encoding the number of
+// 	// bytes (saving 3-4 bits) and including the offset as a full byte.
+// 	bz = appendUvarint(bz, uint64(size))
+// 	bz = append(bz, bA.Elems...)
+// 	return bz
+// }
+
+// // CompactUnmarshal is a space efficient decoding for CompactBitArray.
+// // It is not amino compatible.
+// func (bA *CompactBitArray) Unmarshal(bz []byte) error {
+// 	if len(bz) < 2 {
+// 		return errors.New("compact bit array: invalid compact unmarshal size")
+// 	} else if bytes.Equal(bz, []byte("null")) {
+// 		return nil
+// 	}
+// 	size, n := binary.Uvarint(bz)
+// 	bz = bz[n:]
+// 	if len(bz) != int(size+7)/8 {
+// 		return errors.New("compact bit array: invalid compact unmarshal size")
+// 	}
+
+// 	bA = NewCompactBitArray(int(size % 8))
+// 	bA.Elems = bz
+// 	return nil
+// }
+
+func appendUvarint(b []byte, x uint64) []byte {
+	var a [binary.MaxVarintLen64]byte
+	n := binary.PutUvarint(a[:], x)
+	return append(b, a[:n]...)
+}