From e02bb5410999d3f71e1eec0c608428b106176189 Mon Sep 17 00:00:00 2001 From: Roy Crihfield Date: Wed, 18 Oct 2023 00:16:37 -0500 Subject: [PATCH] normalize logger --- x/registry/keeper/keeper.go | 6 ++++++ x/registry/keeper/naming_keeper.go | 8 ++++---- x/registry/keeper/record_keeper.go | 10 +++++----- 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/x/registry/keeper/keeper.go b/x/registry/keeper/keeper.go index 36d09a77..a8bfa0df 100644 --- a/x/registry/keeper/keeper.go +++ b/x/registry/keeper/keeper.go @@ -20,6 +20,7 @@ import ( auth "github.com/cosmos/cosmos-sdk/x/auth/keeper" bank "github.com/cosmos/cosmos-sdk/x/bank/keeper" paramtypes "github.com/cosmos/cosmos-sdk/x/params/types" + "github.com/tendermint/tendermint/libs/log" ) var ( @@ -96,6 +97,11 @@ func NewKeeper(cdc codec.BinaryCodec, accountKeeper auth.AccountKeeper, bankKeep } } +// logger returns a module-specific logger. +func logger(ctx sdk.Context) log.Logger { + return ctx.Logger().With("module", types.ModuleName) +} + // GetRecordIndexKey Generates Bond ID -> Bond index key. func GetRecordIndexKey(id string) []byte { return append(PrefixCIDToRecordIndex, []byte(id)...) diff --git a/x/registry/keeper/naming_keeper.go b/x/registry/keeper/naming_keeper.go index e67a0b80..017bbd20 100644 --- a/x/registry/keeper/naming_keeper.go +++ b/x/registry/keeper/naming_keeper.go @@ -611,7 +611,7 @@ func (k Keeper) ProcessAuthorityExpiryQueue(ctx sdk.Context) { k.SetNameAuthority(ctx, name, &authority) k.DeleteAuthorityExpiryQueue(ctx, name, authority) - ctx.Logger().Info(fmt.Sprintf("Marking authority expired as no bond present: %s", name)) + logger(ctx).Info(fmt.Sprintf("Marking authority expired as no bond present: %s", name)) return } @@ -672,7 +672,7 @@ func (k Keeper) AuthorityExpiryQueueIterator(ctx sdk.Context, endTime time.Time) // TryTakeAuthorityRent tries to take rent from the authority bond. func (k Keeper) TryTakeAuthorityRent(ctx sdk.Context, name string, authority types.NameAuthority) { - ctx.Logger().Info(fmt.Sprintf("Trying to take rent for authority: %s", name)) + logger(ctx).Info(fmt.Sprintf("Trying to take rent for authority: %s", name)) params := k.GetParams(ctx) rent := params.AuthorityRent @@ -684,7 +684,7 @@ func (k Keeper) TryTakeAuthorityRent(ctx sdk.Context, name string, authority typ k.SetNameAuthority(ctx, name, &authority) k.DeleteAuthorityExpiryQueue(ctx, name, authority) - ctx.Logger().Info(fmt.Sprintf("Insufficient funds in owner account to pay authority rent, marking as expired: %s", name)) + logger(ctx).Info(fmt.Sprintf("Insufficient funds in owner account to pay authority rent, marking as expired: %s", name)) return } @@ -699,7 +699,7 @@ func (k Keeper) TryTakeAuthorityRent(ctx sdk.Context, name string, authority typ k.SetNameAuthority(ctx, name, &authority) k.AddBondToAuthorityIndexEntry(ctx, authority.BondId, name) - ctx.Logger().Info(fmt.Sprintf("Authority rent paid successfully: %s", name)) + logger(ctx).Info(fmt.Sprintf("Authority rent paid successfully: %s", name)) } // ListNameAuthorityRecords - get all name authority records. diff --git a/x/registry/keeper/record_keeper.go b/x/registry/keeper/record_keeper.go index cea1be7d..cdbd802a 100644 --- a/x/registry/keeper/record_keeper.go +++ b/x/registry/keeper/record_keeper.go @@ -39,14 +39,14 @@ func (k RecordKeeper) OnAuctionWinnerSelected(ctx sdk.Context, auctionID string) name := k.GetAuctionToAuthorityMapping(ctx, auctionID) if name == "" { // We don't know about this auction, ignore. - ctx.Logger().Info(fmt.Sprintf("Ignoring auction notification, name mapping not found: %s", auctionID)) + logger(ctx).Info(fmt.Sprintf("Ignoring auction notification, name mapping not found: %s", auctionID)) return } store := ctx.KVStore(k.storeKey) if !HasNameAuthority(store, name) { // We don't know about this authority, ignore. - ctx.Logger().Info(fmt.Sprintf("Ignoring auction notification, authority not found: %s", auctionID)) + logger(ctx).Info(fmt.Sprintf("Ignoring auction notification, authority not found: %s", auctionID)) return } @@ -71,12 +71,12 @@ func (k RecordKeeper) OnAuctionWinnerSelected(ctx sdk.Context, auctionID string) // Can be used to check if names are older than the authority itself (stale names). authority.Height = uint64(ctx.BlockHeight()) - ctx.Logger().Info(fmt.Sprintf("Winner selected, marking authority as active: %s", name)) + logger(ctx).Info(fmt.Sprintf("Winner selected, marking authority as active: %s", name)) } else { // Mark as expired. authority.Status = types.AuthorityExpired - ctx.Logger().Info(fmt.Sprintf("No winner, marking authority as expired: %s", name)) + logger(ctx).Info(fmt.Sprintf("No winner, marking authority as expired: %s", name)) } authority.AuctionId = "" @@ -85,7 +85,7 @@ func (k RecordKeeper) OnAuctionWinnerSelected(ctx sdk.Context, auctionID string) // Forget about this auction now, we no longer need it. removeAuctionToAuthorityMapping(store, auctionID) } else { - ctx.Logger().Info(fmt.Sprintf("Ignoring auction notification, status: %s", auctionObj.Status)) + logger(ctx).Info(fmt.Sprintf("Ignoring auction notification, status: %s", auctionObj.Status)) } }