28e7371701
This PR replaces Geth's logger package (a fork of [log15](https://github.com/inconshreveable/log15)) with an implementation using slog, a logging library included as part of the Go standard library as of Go1.21. Main changes are as follows: * removes any log handlers that were unused in the Geth codebase. * Json, logfmt, and terminal formatters are now slog handlers. * Verbosity level constants are changed to match slog constant values. Internal translation is done to make this opaque to the user and backwards compatible with existing `--verbosity` and `--vmodule` options. * `--log.backtraceat` and `--log.debug` are removed. The external-facing API is largely the same as the existing Geth logger. Logger method signatures remain unchanged. A small semantic difference is that a `Handler` can only be set once per `Logger` and not changed dynamically. This just means that a new logger must be instantiated every time the handler of the root logger is changed. ---- For users of the `go-ethereum/log` module. If you were using this module for your own project, you will need to change the initialization. If you previously did ```golang log.Root().SetHandler(log.LvlFilterHandler(log.LvlInfo, log.StreamHandler(os.Stderr, log.TerminalFormat(true)))) ``` You now instead need to do ```golang log.SetDefault(log.NewLogger(log.NewTerminalHandlerWithLevel(os.Stderr, log.LevelInfo, true))) ``` See more about reasoning here: https://github.com/ethereum/go-ethereum/issues/28558#issuecomment-1820606613
128 lines
5.0 KiB
Go
128 lines
5.0 KiB
Go
// Copyright 2018 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package core
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"os"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
"github.com/ethereum/go-ethereum/internal/ethapi"
|
|
"github.com/ethereum/go-ethereum/log"
|
|
"github.com/ethereum/go-ethereum/signer/core/apitypes"
|
|
"golang.org/x/exp/slog"
|
|
)
|
|
|
|
type AuditLogger struct {
|
|
log log.Logger
|
|
api ExternalAPI
|
|
}
|
|
|
|
func (l *AuditLogger) List(ctx context.Context) ([]common.Address, error) {
|
|
l.log.Info("List", "type", "request", "metadata", MetadataFromContext(ctx).String())
|
|
res, e := l.api.List(ctx)
|
|
l.log.Info("List", "type", "response", "data", res)
|
|
|
|
return res, e
|
|
}
|
|
|
|
func (l *AuditLogger) New(ctx context.Context) (common.Address, error) {
|
|
return l.api.New(ctx)
|
|
}
|
|
|
|
func (l *AuditLogger) SignTransaction(ctx context.Context, args apitypes.SendTxArgs, methodSelector *string) (*ethapi.SignTransactionResult, error) {
|
|
sel := "<nil>"
|
|
if methodSelector != nil {
|
|
sel = *methodSelector
|
|
}
|
|
l.log.Info("SignTransaction", "type", "request", "metadata", MetadataFromContext(ctx).String(),
|
|
"tx", args.String(),
|
|
"methodSelector", sel)
|
|
|
|
res, e := l.api.SignTransaction(ctx, args, methodSelector)
|
|
if res != nil {
|
|
l.log.Info("SignTransaction", "type", "response", "data", common.Bytes2Hex(res.Raw), "error", e)
|
|
} else {
|
|
l.log.Info("SignTransaction", "type", "response", "data", res, "error", e)
|
|
}
|
|
return res, e
|
|
}
|
|
|
|
func (l *AuditLogger) SignData(ctx context.Context, contentType string, addr common.MixedcaseAddress, data interface{}) (hexutil.Bytes, error) {
|
|
marshalledData, _ := json.Marshal(data) // can ignore error, marshalling what we just unmarshalled
|
|
l.log.Info("SignData", "type", "request", "metadata", MetadataFromContext(ctx).String(),
|
|
"addr", addr.String(), "data", marshalledData, "content-type", contentType)
|
|
b, e := l.api.SignData(ctx, contentType, addr, data)
|
|
l.log.Info("SignData", "type", "response", "data", common.Bytes2Hex(b), "error", e)
|
|
return b, e
|
|
}
|
|
|
|
func (l *AuditLogger) SignGnosisSafeTx(ctx context.Context, addr common.MixedcaseAddress, gnosisTx GnosisSafeTx, methodSelector *string) (*GnosisSafeTx, error) {
|
|
sel := "<nil>"
|
|
if methodSelector != nil {
|
|
sel = *methodSelector
|
|
}
|
|
data, _ := json.Marshal(gnosisTx) // can ignore error, marshalling what we just unmarshalled
|
|
l.log.Info("SignGnosisSafeTx", "type", "request", "metadata", MetadataFromContext(ctx).String(),
|
|
"addr", addr.String(), "data", string(data), "selector", sel)
|
|
res, e := l.api.SignGnosisSafeTx(ctx, addr, gnosisTx, methodSelector)
|
|
if res != nil {
|
|
data, _ := json.Marshal(res) // can ignore error, marshalling what we just unmarshalled
|
|
l.log.Info("SignGnosisSafeTx", "type", "response", "data", string(data), "error", e)
|
|
} else {
|
|
l.log.Info("SignGnosisSafeTx", "type", "response", "data", res, "error", e)
|
|
}
|
|
return res, e
|
|
}
|
|
|
|
func (l *AuditLogger) SignTypedData(ctx context.Context, addr common.MixedcaseAddress, data apitypes.TypedData) (hexutil.Bytes, error) {
|
|
l.log.Info("SignTypedData", "type", "request", "metadata", MetadataFromContext(ctx).String(),
|
|
"addr", addr.String(), "data", data)
|
|
b, e := l.api.SignTypedData(ctx, addr, data)
|
|
l.log.Info("SignTypedData", "type", "response", "data", common.Bytes2Hex(b), "error", e)
|
|
return b, e
|
|
}
|
|
|
|
func (l *AuditLogger) EcRecover(ctx context.Context, data hexutil.Bytes, sig hexutil.Bytes) (common.Address, error) {
|
|
l.log.Info("EcRecover", "type", "request", "metadata", MetadataFromContext(ctx).String(),
|
|
"data", common.Bytes2Hex(data), "sig", common.Bytes2Hex(sig))
|
|
b, e := l.api.EcRecover(ctx, data, sig)
|
|
l.log.Info("EcRecover", "type", "response", "address", b.String(), "error", e)
|
|
return b, e
|
|
}
|
|
|
|
func (l *AuditLogger) Version(ctx context.Context) (string, error) {
|
|
l.log.Info("Version", "type", "request", "metadata", MetadataFromContext(ctx).String())
|
|
data, err := l.api.Version(ctx)
|
|
l.log.Info("Version", "type", "response", "data", data, "error", err)
|
|
return data, err
|
|
}
|
|
|
|
func NewAuditLogger(path string, api ExternalAPI) (*AuditLogger, error) {
|
|
f, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
handler := slog.NewTextHandler(f, nil)
|
|
l := log.NewLogger(handler).With("api", "signer")
|
|
l.Info("Configured", "audit log", path)
|
|
return &AuditLogger{l, api}, nil
|
|
}
|