From a4f976553e83afa9178d5a3ca888760e8a91d47a Mon Sep 17 00:00:00 2001 From: Daniel Date: Tue, 25 Oct 2022 19:09:07 +0100 Subject: [PATCH] Get,Del,Iter method renames --- x/ccv/provider/keeper/genesis.go | 2 +- x/ccv/provider/keeper/keymap.go | 32 ++++++++++++---------------- x/ccv/provider/keeper/keymap_test.go | 4 ++-- 3 files changed, 17 insertions(+), 21 deletions(-) diff --git a/x/ccv/provider/keeper/genesis.go b/x/ccv/provider/keeper/genesis.go index 7dca652d9e..bfe2364dad 100644 --- a/x/ccv/provider/keeper/genesis.go +++ b/x/ccv/provider/keeper/genesis.go @@ -142,7 +142,7 @@ func (k Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState { km.CkToPk = append(km.CkToPk, ccv.KeyToKey{From: &ck, To: &pk}) return false }) - k.KeyMap(ctx, chainID).Store.IterateCkToMemo(func(ck ConsumerConsAddr, m ccv.LastUpdateMemo) bool { + k.KeyMap(ctx, chainID).Store.IterateCcaToLastUpdateMemo(func(ck ConsumerConsAddr, m ccv.LastUpdateMemo) bool { km.CcaToLastUpdateMemo = append(km.CcaToLastUpdateMemo, ccv.ConsAddrToLastUpdateMemo{ConsAddr: ck, LastUpdateMemo: &m}) return false }) diff --git a/x/ccv/provider/keeper/keymap.go b/x/ccv/provider/keeper/keymap.go index e8b516cabd..3ba2da2b58 100644 --- a/x/ccv/provider/keeper/keymap.go +++ b/x/ccv/provider/keeper/keymap.go @@ -100,13 +100,13 @@ type Store interface { SetCcaToLastUpdateMemo(ConsumerConsAddr, ccvtypes.LastUpdateMemo) GetPkToCk(ProviderPubKey) (ConsumerPubKey, bool) GetCkToPk(ConsumerPubKey) (ProviderPubKey, bool) - GetCkToMemo(ConsumerConsAddr) (ccvtypes.LastUpdateMemo, bool) + GetCcaToLastUpdateMemo(ConsumerConsAddr) (ccvtypes.LastUpdateMemo, bool) DelPkToCk(ProviderPubKey) DelCkToPk(ConsumerPubKey) - DelCkToMemo(ConsumerConsAddr) + DelCcaToLastUpdateMemo(ConsumerConsAddr) IteratePkToCk(func(ProviderPubKey, ConsumerPubKey) bool) IterateCkToPk(func(ConsumerPubKey, ProviderPubKey) bool) - IterateCkToMemo(func(ConsumerConsAddr, ccvtypes.LastUpdateMemo) bool) + IterateCcaToLastUpdateMemo(func(ConsumerConsAddr, ccvtypes.LastUpdateMemo) bool) } type KeyMap struct { @@ -123,7 +123,7 @@ func (e *KeyMap) SetProviderPubKeyToConsumerPubKey(pk ProviderPubKey, ck Consume if _, ok := e.Store.GetCkToPk(ck); ok { return errors.New(`cannot reuse key which is in use or was recently in use`) } - if _, ok := e.Store.GetCkToMemo(ConsumerPubKeyToConsumerConsAddr(ck)); ok { + if _, ok := e.Store.GetCcaToLastUpdateMemo(ConsumerPubKeyToConsumerConsAddr(ck)); ok { return errors.New(`cannot reuse key which is in use or was recently in use`) } if oldCk, ok := e.Store.GetPkToCk(pk); ok { @@ -143,7 +143,7 @@ func (e *KeyMap) GetProviderPubKeyFromConsumerPubKey(ck ConsumerPubKey) (pk Prov } func (e *KeyMap) GetProviderPubKeyFromConsumerConsAddress(cca sdk.ConsAddress) (pk ProviderPubKey, found bool) { - if memo, found := e.Store.GetCkToMemo(cca); found { + if memo, found := e.Store.GetCcaToLastUpdateMemo(cca); found { return *memo.Pk, true } return pk, false @@ -151,14 +151,14 @@ func (e *KeyMap) GetProviderPubKeyFromConsumerConsAddress(cca sdk.ConsAddress) ( func (e *KeyMap) PruneUnusedKeys(latestVscid VSCID) { toDel := []ConsumerConsAddr{} - e.Store.IterateCkToMemo(func(cca ConsumerConsAddr, m ccvtypes.LastUpdateMemo) bool { + e.Store.IterateCcaToLastUpdateMemo(func(cca ConsumerConsAddr, m ccvtypes.LastUpdateMemo) bool { if m.Power == 0 && m.Vscid <= latestVscid { toDel = append(toDel, cca) } return false }) for _, cca := range toDel { - e.Store.DelCkToMemo(cca) + e.Store.DelCcaToLastUpdateMemo(cca) } } @@ -190,7 +190,7 @@ func (e *KeyMap) inner(vscid VSCID, providerUpdates map[ProviderPubKey]int64) ma // Grab provider keys where the last update had positive power // and where the assigned consumer key has changed - e.Store.IterateCkToMemo(func(cca ConsumerConsAddr, m ccvtypes.LastUpdateMemo) bool { + e.Store.IterateCcaToLastUpdateMemo(func(cca ConsumerConsAddr, m ccvtypes.LastUpdateMemo) bool { oldCk := m.Ck if newCk, ok := e.Store.GetPkToCk(*m.Pk); ok { // TODO: do away with ok, should always be ok // TODO: is !seen[str] needed? @@ -214,7 +214,7 @@ func (e *KeyMap) inner(vscid VSCID, providerUpdates map[ProviderPubKey]int64) ma canonicalKey := map[string]ConsumerPubKey{} ret := map[ConsumerPubKey]int64{} - e.Store.IterateCkToMemo(func(_ ConsumerConsAddr, m ccvtypes.LastUpdateMemo) bool { + e.Store.IterateCcaToLastUpdateMemo(func(_ ConsumerConsAddr, m ccvtypes.LastUpdateMemo) bool { str := DeterministicStringify(*m.Pk) if 0 < m.Power { if _, found := keyInProviderKeysToSendUpdateFor[str]; found { @@ -327,7 +327,7 @@ func (e *KeyMap) InternalInvariants() bool { // mapping. // (Ensures lookups are correct) e.Store.IterateCkToPk(func(ck ConsumerPubKey, pk ProviderPubKey) bool { - if m, ok := e.Store.GetCkToMemo(ConsumerPubKeyToConsumerConsAddr(ck)); ok { + if m, ok := e.Store.GetCcaToLastUpdateMemo(ConsumerPubKeyToConsumerConsAddr(ck)); ok { if !pk.Equal(m.Pk) { good = false } @@ -339,7 +339,7 @@ func (e *KeyMap) InternalInvariants() bool { { // All entries in ckToMemo have a consumer consensus // address which is the address held inside - e.Store.IterateCkToMemo(func(cca ConsumerConsAddr, m ccvtypes.LastUpdateMemo) bool { + e.Store.IterateCcaToLastUpdateMemo(func(cca ConsumerConsAddr, m ccvtypes.LastUpdateMemo) bool { cons := ConsumerPubKeyToConsumerConsAddr(*m.Ck) if len(cca) != len(cons) { good = false @@ -395,7 +395,6 @@ func (s *KeyMapStore) SetCcaToLastUpdateMemo(k ConsumerConsAddr, v ccvtypes.Last } s.Store.Set(types.KeyMapCkToMemoKey(s.ChainID, kbz), vbz) } - func (s *KeyMapStore) GetPkToCk(k ProviderPubKey) (v ConsumerPubKey, found bool) { kbz, err := k.Marshal() if err != nil { @@ -424,7 +423,7 @@ func (s *KeyMapStore) GetCkToPk(k ConsumerPubKey) (v ProviderPubKey, found bool) } return v, false } -func (s *KeyMapStore) GetCkToMemo(k ConsumerConsAddr) (v ccvtypes.LastUpdateMemo, found bool) { +func (s *KeyMapStore) GetCcaToLastUpdateMemo(k ConsumerConsAddr) (v ccvtypes.LastUpdateMemo, found bool) { kbz, err := k.Marshal() if err != nil { panic(err) @@ -439,7 +438,6 @@ func (s *KeyMapStore) GetCkToMemo(k ConsumerConsAddr) (v ccvtypes.LastUpdateMemo } return v, false } - func (s *KeyMapStore) DelPkToCk(k ProviderPubKey) { kbz, err := k.Marshal() if err != nil { @@ -454,14 +452,13 @@ func (s *KeyMapStore) DelCkToPk(k ConsumerPubKey) { } s.Store.Delete(types.KeyMapCkToPkKey(s.ChainID, kbz)) } -func (s *KeyMapStore) DelCkToMemo(k ConsumerConsAddr) { +func (s *KeyMapStore) DelCcaToLastUpdateMemo(k ConsumerConsAddr) { kbz, err := k.Marshal() if err != nil { panic(err) } s.Store.Delete(types.KeyMapCkToMemoKey(s.ChainID, kbz)) } - func (s *KeyMapStore) IteratePkToCk(cb func(ProviderPubKey, ConsumerPubKey) bool) { prefix := types.KeyMapPkToCkChainPrefix(s.ChainID) iterator := sdk.KVStorePrefixIterator(s.Store, prefix) @@ -502,12 +499,11 @@ func (s *KeyMapStore) IterateCkToPk(cb func(ConsumerPubKey, ProviderPubKey) bool } } } -func (s *KeyMapStore) IterateCkToMemo(cb func(ConsumerConsAddr, ccvtypes.LastUpdateMemo) bool) { +func (s *KeyMapStore) IterateCcaToLastUpdateMemo(cb func(ConsumerConsAddr, ccvtypes.LastUpdateMemo) bool) { prefix := types.KeyMapCkToMemoChainPrefix(s.ChainID) iterator := sdk.KVStorePrefixIterator(s.Store, prefix) defer iterator.Close() for ; iterator.Valid(); iterator.Next() { - // k := ConsumerPubKey{} k := ConsumerConsAddr{} err := k.Unmarshal(iterator.Key()[len(prefix):]) if err != nil { diff --git a/x/ccv/provider/keeper/keymap_test.go b/x/ccv/provider/keeper/keymap_test.go index f694bf19f3..97e7a7458e 100644 --- a/x/ccv/provider/keeper/keymap_test.go +++ b/x/ccv/provider/keeper/keymap_test.go @@ -726,7 +726,7 @@ func compareForEquality(t *testing.T, require.Equal(t, len(ckToPk), cnt) cnt = 0 - km.Store.IterateCkToMemo(func(_ keeper.ConsumerConsAddr, _ ccvtypes.LastUpdateMemo) bool { + km.Store.IterateCcaToLastUpdateMemo(func(_ keeper.ConsumerConsAddr, _ ccvtypes.LastUpdateMemo) bool { cnt += 1 return false }) @@ -744,7 +744,7 @@ func compareForEquality(t *testing.T, } for k, vExpect := range ckToMemo { k := sdk.ConsAddress(k) - m, found := km.Store.GetCkToMemo(k) + m, found := km.Store.GetCcaToLastUpdateMemo(k) require.True(t, found) require.Equal(t, vExpect.Pk, m.Pk) require.Equal(t, vExpect.Ck, m.Ck)