Wrap error from remote and 3rd party libraries with stacktrace

Author: dyng

cmd/root.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"os"
 
+	"github.com/dyng/ramen/internal/common"
 	conf "github.com/dyng/ramen/internal/config"
 	"github.com/dyng/ramen/internal/view"
 	"github.com/ethereum/go-ethereum/log"
@@ -95,7 +96,7 @@ func initLogger() {
 		log.Crit("Failed to create log file", "error", err)
 	}
 
-	handler := log.StreamHandler(file, log.TerminalFormat(false))
+	handler := common.ErrorStackHandler(log.StreamHandler(file, log.TerminalFormat(false)))
 	if config.DebugMode {
 		handler = log.LvlFilterHandler(log.LvlDebug, handler)
 	} else {

go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/asaskevich/EventBus v0.0.0-20200907212545-49d423059eef
 	github.com/ethereum/go-ethereum v1.10.26
 	github.com/gdamore/tcell/v2 v2.5.4
+	github.com/pkg/errors v0.9.1
 	github.com/rivo/tview v0.0.0-20230104153304-892d1a2eb0da
 	github.com/shopspring/decimal v1.3.1
 	github.com/spf13/cobra v1.6.1

go.sum

@@ -56,6 +56,7 @@ github.com/mitchellh/mapstructure v1.4.1 h1:CpVNEelQCZBooIPDn+AR3NpivK/TIKU8bDxd
 github.com/mitchellh/pointerstructure v1.2.0 h1:O+i9nHnXS3l/9Wu7r4NrEdwA2VFTicjUEN1uBnDo34A=
 github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/prometheus/tsdb v0.7.1 h1:YZcsG11NqnK4czYLrWd9mpEuAJIHVQLwdrleYfszMAA=

internal/common/conv/argument.go

@@ -1,12 +1,12 @@
 package conv
 
 import (
-	"fmt"
 	"math/big"
 	"strconv"
 
 	"github.com/ethereum/go-ethereum/accounts/abi"
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/pkg/errors"
 )
 
 // UnpackArgument converts string format of a value into the Go type corresponding to given argument type.
@@ -23,7 +23,7 @@ func UnpackArgument(t abi.Type, s string) (any, error) {
 	case abi.HashTy:
 		return common.HexToHash(s), nil
 	default:
-		return nil, fmt.Errorf("unsupported argument type %v", t.T)
+		return nil, errors.Errorf("unsupported argument type %v", t.T)
 	}
 }
 
@@ -35,7 +35,7 @@ func parseInteger(t abi.Type, s string) (any, error) {
 		default:
 			i, ok := new(big.Int).SetString(s, 10)
 			if !ok {
-				return nil, fmt.Errorf("cannot parse %s as type %v", s, t.T)
+				return nil, errors.Errorf("cannot parse %s as type %v", s, t.T)
 			} else {
 				return i, nil
 			}
@@ -47,7 +47,7 @@ func parseInteger(t abi.Type, s string) (any, error) {
 		default:
 			i, ok := new(big.Int).SetString(s, 10)
 			if !ok {
-				return nil, fmt.Errorf("cannot parse %s as type %v", s, t.T)
+				return nil, errors.Errorf("cannot parse %s as type %v", s, t.T)
 			} else {
 				return i, nil
 			}

internal/common/log.go

@@ -0,0 +1,20 @@
+package common
+
+import (
+	"fmt"
+
+	"github.com/ethereum/go-ethereum/log"
+)
+
+func ErrorStackHandler(h log.Handler) log.Handler {
+	return log.FuncHandler(func(r *log.Record) error {
+		i := len(r.Ctx) - 1
+		if i > 0 {
+			e := r.Ctx[i]
+			if err, ok := e.(error); ok {
+				r.Ctx[i] = fmt.Sprintf("%+v", err)
+			}
+		}
+		return h.Log(r)
+	})
+}

internal/config/config.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/dyng/ramen/internal/view/style"
+	"github.com/pkg/errors"
 )
 
 var (
@@ -55,15 +56,15 @@ func ParseConfig(config *Config) error {
 		if os.IsNotExist(err) {
 			return nil
 		} else {
-			return err
+			return errors.WithStack(err)
 		}
 	}
 
 	// read and parse config file
 	configJson := new(configJSON)
 	err = json.Unmarshal(bytes, &configJson)
 	if err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	// overwrite configurations only when the default value is used

internal/provider/alchemy.go

@@ -1,5 +1,7 @@
 package provider
 
+import "github.com/pkg/errors"
+
 type (
 	GetAssetTransfersParams struct {
 		FromBlock         string   `json:"fromBlock,omitempty"`
@@ -47,7 +49,7 @@ func (p *Provider) GetAssetTransfers(params GetAssetTransfersParams) (*GetAssetT
 	var result *GetAssetTransfersResult
 	err := p.rpcClient.CallContext(ctx, &result, "alchemy_getAssetTransfers", params)
 	if err != nil {
-		return nil, err
+		return nil, errors.WithStack(err)
 	}
 	return result, nil
 }

internal/provider/ethereum.go

@@ -3,7 +3,6 @@ package provider
 import (
 	"context"
 	"encoding/json"
-	"errors"
 	"math/big"
 	"time"
 
@@ -16,6 +15,7 @@ import (
 	"github.com/ethereum/go-ethereum/ethclient"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/rpc"
+	"github.com/pkg/errors"
 )
 
 var (
@@ -47,7 +47,7 @@ type txExtraInfo struct {
 
 func (tx *rpcTransaction) UnmarshalJSON(msg []byte) error {
 	if err := json.Unmarshal(msg, &tx.tx); err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 	return json.Unmarshal(msg, &tx.txExtraInfo)
 }
@@ -77,7 +77,7 @@ func NewProvider(url string, providerType string) *Provider {
 
 	rpcClient, err := rpc.Dial(url)
 	if err != nil {
-		log.Crit("Cannot connect to rpc server", "url", url, "error", err)
+		log.Crit("Cannot connect to rpc server", "url", url, "error", errors.WithStack(err))
 	}
 
 	p.rpcClient = rpcClient
@@ -97,7 +97,7 @@ func (p *Provider) GetNetwork() (common.BigInt, error) {
 	if p.chainId == nil {
 		chainId, err := p.client.NetworkID(ctx)
 		if err != nil {
-			return nil, err
+			return nil, errors.WithStack(err)
 		}
 		p.chainId = chainId
 		p.signer = types.NewLondonSigner(chainId)
@@ -108,7 +108,8 @@ func (p *Provider) GetNetwork() (common.BigInt, error) {
 func (p *Provider) GetGasPrice() (common.BigInt, error) {
 	ctx, cancel := p.createContext()
 	defer cancel()
-	return p.client.SuggestGasPrice(ctx)
+	gasPrice, err := p.client.SuggestGasPrice(ctx)
+	return gasPrice, errors.WithStack(err)
 }
 
 func (p *Provider) GetSigner() (types.Signer, error) {
@@ -122,31 +123,36 @@ func (p *Provider) GetSigner() (types.Signer, error) {
 func (p *Provider) GetCode(addr common.Address) ([]byte, error) {
 	ctx, cancel := p.createContext()
 	defer cancel()
-	return p.client.CodeAt(ctx, addr, nil)
+	code, err := p.client.CodeAt(ctx, addr, nil)
+	return code, errors.WithStack(err)
 }
 
 func (p *Provider) GetBalance(addr common.Address) (common.BigInt, error) {
 	ctx, cancel := p.createContext()
 	defer cancel()
-	return p.client.BalanceAt(ctx, addr, nil)
+	balance, err := p.client.BalanceAt(ctx, addr, nil)
+	return balance, errors.WithStack(err)
 }
 
 func (p *Provider) GetBlockHeight() (uint64, error) {
 	ctx, cancel := p.createContext()
 	defer cancel()
-	return p.client.BlockNumber(ctx)
+	height, err := p.client.BlockNumber(ctx)
+	return height, errors.WithStack(err)
 }
 
 func (p *Provider) GetBlockByHash(hash common.Hash) (*common.Block, error) {
 	ctx, cancel := p.createContext()
 	defer cancel()
-	return p.client.BlockByHash(ctx, hash)
+	block, err := p.client.BlockByHash(ctx, hash)
+	return block, errors.WithStack(err)
 }
 
 func (p *Provider) GetBlockByNumber(number common.BigInt) (*common.Block, error) {
 	ctx, cancel := p.createContext()
 	defer cancel()
-	return p.client.BlockByNumber(ctx, number)
+	block, err := p.client.BlockByNumber(ctx, number)
+	return block, errors.WithStack(err)
 }
 
 func (p *Provider) BatchTransactionByHash(hashList []common.Hash) (common.Transactions, error) {
@@ -166,7 +172,7 @@ func (p *Provider) BatchTransactionByHash(hashList []common.Hash) (common.Transa
 
 	err := p.rpcClient.BatchCallContext(ctx, reqs)
 	if err != nil {
-		return nil, err
+		return nil, errors.WithStack(err)
 	}
 
 	result := make(common.Transactions, size)
@@ -191,7 +197,7 @@ func (p *Provider) EstimateGas(address common.Address, from common.Address, inpu
 
 	gasLimit, err := p.client.EstimateGas(ctx, msg)
 	if err != nil {
-		return 0, err
+		return 0, errors.WithStack(err)
 	}
 
 	return gasLimit, nil
@@ -201,7 +207,7 @@ func (p *Provider) CallContract(address common.Address, abi *abi.ABI, method str
 	// encode calldata
 	input, err := abi.Pack(method, args...)
 	if err != nil {
-		return nil, err
+		return nil, errors.WithStack(err)
 	}
 
 	// build call message
@@ -215,12 +221,12 @@ func (p *Provider) CallContract(address common.Address, abi *abi.ABI, method str
 
 	data, err := p.client.CallContract(ctx, msg, nil)
 	if err != nil {
-		return nil, err
+		return nil, errors.WithStack(err)
 	}
 
 	vals, err := abi.Unpack(method, data)
 	if err != nil {
-		return nil, err
+		return nil, errors.WithStack(err)
 	}
 
 	return vals, nil
@@ -236,7 +242,7 @@ func (p *Provider) SendTransaction(txnReq *common.TxnRequest) (common.Hash, erro
 	// fetch the next nonce
 	nonce, err := p.client.PendingNonceAt(ctx, from)
 	if err != nil {
-		return common.Hash{}, err
+		return common.Hash{}, errors.WithStack(err)
 	}
 
 	txn := types.NewTx(&types.LegacyTx{
@@ -255,17 +261,18 @@ func (p *Provider) SendTransaction(txnReq *common.TxnRequest) (common.Hash, erro
 
 	signedTx, err := types.SignTx(txn, signer, key)
 	if err != nil {
-		return common.Hash{}, err
+		return common.Hash{}, errors.WithStack(err)
 	}
 
 	err = p.client.SendTransaction(ctx, signedTx)
-	return signedTx.Hash(), err
+	return signedTx.Hash(), errors.WithStack(err)
 }
 
 func (p *Provider) SubscribeNewHead(ch chan<- *common.Header) (ethereum.Subscription, error) {
 	ctx, cancel := p.createContext()
 	defer cancel()
-	return p.client.SubscribeNewHead(ctx, ch)
+	sub, err := p.client.SubscribeNewHead(ctx, ch)
+	return sub, errors.WithStack(err)
 }
 
 func (p *Provider) createContext() (context.Context, context.CancelFunc) {