From 085d0228aa53c2051b470c32b55af7d470e3749a Mon Sep 17 00:00:00 2001
From: frank <lovefree103@gmail.com>
Date: Thu, 8 Aug 2024 16:35:11 +0800
Subject: [PATCH] chore_: ignore sensitive fields of WalletConfig when logging

---
 params/config.go      | 14 ++++++++++++++
 params/config_test.go | 20 ++++++++++++++++++++
 2 files changed, 34 insertions(+)

diff --git a/params/config.go b/params/config.go
index 6c7f684d6..910d18577 100644
--- a/params/config.go
+++ b/params/config.go
@@ -583,6 +583,20 @@ type WalletConfig struct {
 	EnableCelerBridge             bool              `json:"EnableCelerBridge"`
 }
 
+// MarshalJSON custom marshalling to avoid exposing sensitive data in log,
+// there's a function called `startNode` will log NodeConfig which include WalletConfig
+func (wc WalletConfig) MarshalJSON() ([]byte, error) {
+	return json.Marshal(struct {
+		Enabled            bool `json:"Enabled"`
+		StatusProxyEnabled bool `json:"StatusProxyEnabled"`
+		EnableCelerBridge  bool `json:"EnableCelerBridge"`
+	}{
+		Enabled:            wc.Enabled,
+		StatusProxyEnabled: wc.StatusProxyEnabled,
+		EnableCelerBridge:  wc.EnableCelerBridge,
+	})
+}
+
 // LocalNotificationsConfig extra configuration for localnotifications.Service.
 type LocalNotificationsConfig struct {
 	Enabled bool
diff --git a/params/config_test.go b/params/config_test.go
index cc754d115..c04f96145 100644
--- a/params/config_test.go
+++ b/params/config_test.go
@@ -1,6 +1,7 @@
 package params_test
 
 import (
+	"encoding/json"
 	"fmt"
 	"io/ioutil"
 	"path"
@@ -338,3 +339,22 @@ func TestNodeConfigValidate(t *testing.T) {
 		})
 	}
 }
+
+func TestMarshalWalletConfigJSON(t *testing.T) {
+	walletConfig := params.WalletConfig{
+		OpenseaAPIKey:        "some-key",
+		RaribleMainnetAPIKey: "some-key2",
+	}
+	bytes, err := json.Marshal(walletConfig)
+	require.NoError(t, err)
+	// check if sensitive fields are not present
+	require.NotContains(t, string(bytes), "OpenseaAPIKey")
+	require.Contains(t, string(bytes), "StatusProxyEnabled")
+
+	// check if deserializing are still working with sensitive fields
+	walletConfig = params.WalletConfig{}
+	err = json.Unmarshal([]byte(`{"OpenseaAPIKey":"some-key", "StatusProxyEnabled":true}`), &walletConfig)
+	require.NoError(t, err)
+	require.Equal(t, "some-key", walletConfig.OpenseaAPIKey)
+	require.True(t, walletConfig.StatusProxyEnabled)
+}