Block explorer selection #2579

NicolaLS · 2024-02-26T12:57:05Z

Allow users to configure their preferred block explorer (from predefined selection) in the settings.

Block explorers need to be added to the AvailableExplorers struct and whitelisted in the backend. The frontend learns all available options by calling the /available-explorers endpoint. Adding options will only need a change in the backend the frontend will always show all available selections.

notes:

I chose to keep it simple by statically defining the AvailableExplorers of course we could also implement an interface instead that each coin can implement, this would be more elegant but I did not see the need for that.
I really don't like the implementation of the disable/enable "save" button (compare the json configs) see here. I don't know how to do it differently though..
I had to fetch the initialConfig in a different place than the config because it would always update alongside config if they were initialized in the same place loadConfig see here. I don't understand why it behaves like this, I just fetch the config again to initialize initialConfig maybe there is a better way avoiding two get requests...

Right now the frontend uses the /supported-coins endpoint to decide how many/which selection to show in the setting. This requires a keystore to be connected which is weird UX. We can fix this later by introducing a separate check for a multicoin, or bitcoin only user/wallet in the config.

Please let me know if you have suggestions for more block explorers, I just added the most popular. In case they deviate from host.com/tx/xxx (e.g. host.com?tx=xx) there needs to be more refactoring in the backend, maybe then it would make sense to define an interface rather than a static stuct for the AvailableExplorers.

NicolaLS · 2024-02-26T13:15:23Z

frontends/web/src/routes/account/account.tsx

+      if (account) {
+        if (backend[account.coinCode]) {
+          setBlockExplorerTxPrefix(backend[account.coinCode].blockExplorerTxPrefix);
+        } else {


this is redundant as we check blockExplorerTxPrefix undefined on line 337. Should I remove the else branch ?

benma

thanks!

partial review, couldn't finish yet.

benma · 2024-02-26T13:30:41Z

backend/backend.go

-	// Block explorers.
+	// Block explorers (btc).
 	"https://blockstream.info/tx/",
 	"https://blockstream.info/testnet/tx/",
+	"https://mempool.space/tx/",
+	"https://mempool.space/testnet/tx/",
+	// Block explorers (ltc).
 	"https://sochain.com/tx/LTCTEST/",
 	"https://blockchair.com/litecoin/transaction/",
+	// Block explorers (eth).
 	"https://etherscan.io/tx/",
 	"https://goerli.etherscan.io/tx/",
+	"https://sepolia.etherscan.io/tx/",
+	"https://ethplorer.io/tx/",
+	"https://goerli.ethplorer.io/tx/",
+	"https://sepolia.ethplorer.io/tx/",


instead of adding them all here, it's better to add another loop in SystemOpen() that goes through all explorers, so that one only has to modify the list of explorers when making changes (adding or removing explorers).

benma · 2024-02-26T13:33:11Z

backend/config/blockexplorer.go

+// BlockExplorer defines a selectable block explorer.
+type BlockExplorer struct {
+	Name string `json:"name"`
+	Url  string `json:"url"`


document the fields as well. Especially that the Url is a prefix and the txID will be appended.

benma · 2024-02-26T13:37:57Z

backend/config/config.go

 // ethCoinConfig holds configurations for ethereum coins.
 type ethCoinConfig struct {
 	DeprecatedActiveERC20Tokens []string `json:"activeERC20Tokens"`
+	BlockExplorerTxPrefix       string   `json:"blockExplorerTxPrefix"`


i wonder if it's maybe better to add a separate field to the backend config blockExplorers, so it's all concentrated in one location 🤔

also the name should maybe not mention prefix, in case there are (or will be) explorers where the txID is not simply appended

that makes sense.

benma · 2024-02-26T13:41:20Z

frontends/web/src/locales/en/app.json

        "title": "Why is there a network fee?"
      }
    },
+    "settings-block-explorer": {


settingsBlockExplorer, all entries should be camelCase (most are, but there are some misses like right below with settings-electrum 🙈 )

benma · 2024-02-26T13:42:10Z

frontends/web/src/locales/en/app.json

+        "title": "How do I use a block explorer?"
+      },
+      "options": {
+        "text": "The BitBoxApp features a protection mechanism designed to prevent the opening of arbitrary links. This serves as a security measure against malicious links. It cannot be bypassed on an individual basis; rather, its suspension would be required to allow users to configure their own URLs.",


imo this is super confusing to users, especially the last part. i'd stop at the first part

"The BitBoxApp features a protection mechanism designed to prevent the opening of arbitrary links. This serves as a security measure against malicious links."

benma · 2024-02-26T13:43:46Z

frontends/web/src/routes/settings/select-explorer.tsx

+  useEffect(() => {
+    const fetchData = async () => {
+      const coins = await backendAPI.getSupportedCoins();
+      const allExplorerSelection = await apiGet('available-explorers');


make an API call wrapper in api/backend.ts, and a definition of the return type.

backend/config/config.go

NicolaLS · 2024-02-26T16:32:24Z

addressed your comments @benma , please resolve the threads if satisfied. also noticed I can remove GOETH and SEPETH from the config again, will wait for more feedback and do it in the next push.

NicolaLS · 2024-03-07T09:39:39Z

I added another commit that uses accounts instead of supported-coins, but now there will not be any changes/additions anymore.

NicolaLS · 2024-03-27T08:41:37Z

force pushed rebase for clean diff

NicolaLS · 2024-03-27T08:50:17Z

Please let me know if I should add something to the CHANGELOG.md. Everything should be ready, the change requests are addressed but I leave it to @benma to resolve them. @thisconnect could you review the frontend?

Add a setting that lets users configure their preferred block explorer. Only whitelisted block explorers are available options. The frontend decides which selections to show (e.g only BTC or BTC and ETH) based on the accounts that are present.

Add the block explorer prefix url to the configuration that will be used to open the transaction. The available options to select are statically defined and the frontend can learn them by calling the available-explorers endpoint for which a handler was implemented in this commit.

NicolaLS force-pushed the block-explorer-selection branch 2 times, most recently from 07e315a to 9afd818 Compare February 26, 2024 13:13

NicolaLS commented Feb 26, 2024

View reviewed changes

benma reviewed Feb 26, 2024

View reviewed changes

NicolaLS force-pushed the block-explorer-selection branch 3 times, most recently from 563d584 to fc70f0a Compare February 26, 2024 16:09

NicolaLS commented Feb 26, 2024

View reviewed changes

backend/config/config.go Outdated Show resolved Hide resolved

NicolaLS force-pushed the block-explorer-selection branch from fc70f0a to f45d117 Compare February 26, 2024 16:18

NicolaLS force-pushed the block-explorer-selection branch from f45d117 to ad701cd Compare March 7, 2024 09:33

NicolaLS force-pushed the block-explorer-selection branch 2 times, most recently from 516f8f1 to 717687f Compare March 25, 2024 07:43

NicolaLS force-pushed the block-explorer-selection branch from 717687f to 2368734 Compare March 27, 2024 08:41

NicolaLS force-pushed the block-explorer-selection branch from 2368734 to 6e127f7 Compare March 27, 2024 08:44

NicolaLS requested a review from benma March 27, 2024 08:48

NicolaLS force-pushed the block-explorer-selection branch 5 times, most recently from aace6ba to 1302c90 Compare May 29, 2024 14:48

NicolaLS force-pushed the block-explorer-selection branch 3 times, most recently from 4b61268 to 3a0085e Compare June 7, 2024 18:08

NicolaLS force-pushed the block-explorer-selection branch 3 times, most recently from 0beb449 to 982a1a2 Compare June 17, 2024 16:22

NicolaLS force-pushed the block-explorer-selection branch 5 times, most recently from d65c13d to 9cabcd3 Compare July 15, 2024 14:27

NicolaLS force-pushed the block-explorer-selection branch from 9cabcd3 to 239b7fa Compare July 30, 2024 13:24

NicolaLS added 2 commits August 20, 2024 10:07

NicolaLS force-pushed the block-explorer-selection branch from 239b7fa to bedadc8 Compare August 20, 2024 16:21

Uh oh!

Block explorer selection #2579

Are you sure you want to change the base?

Block explorer selection #2579

Uh oh!

Conversation

NicolaLS commented Feb 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

benma left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NicolaLS commented Feb 26, 2024

Uh oh!

NicolaLS commented Mar 7, 2024

Uh oh!

NicolaLS commented Mar 27, 2024

Uh oh!

NicolaLS commented Mar 27, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

NicolaLS commented Feb 26, 2024 •

edited

Loading