Removed support for btc-rpc-proxy

takinbo · takinbo · commit 6589786bb0b6 · 2025-02-19T07:43:27.000Z
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
+.vscode
+docker-images
 electrs.s9pk
 image.tar
 scripts/embassy.js
-.vscode
-docker-images
diff --git a/Makefile b/Makefile
@@ -15,6 +15,7 @@ install: $(PKG_ID).s9pk
 	start-cli package install $(PKG_ID).s9pk
 
 clean:
+	docker run --rm -it -v "$(shell pwd)"/configurator:/home/rust/src messense/rust-musl-cross:x86_64-musl cargo clean -q
 	rm -rf docker-images
 	rm -rf image.tar
 	rm -f $(PKG_ID).s9pk
@@ -28,7 +29,7 @@ arm: docker-images/aarch64.tar scripts/embassy.js
 x86: docker-images/x86_64.tar scripts/embassy.js
 	start-sdk pack
 
-$(PKG_ID).s9pk: manifest.yaml instructions.md scripts/embassy.js electrs/LICENSE docker-images/aarch64.tar docker-images/x86_64.tar
+$(PKG_ID).s9pk: manifest.yaml instructions.md scripts/embassy.js electrs/LICENSE docker-images/x86_64.tar docker-images/aarch64.tar
 	start-sdk pack
 
 docker-images/aarch64.tar: Dockerfile docker_entrypoint.sh check-synced.sh check-electrum.sh configurator/target/aarch64-unknown-linux-musl/release/configurator $(ELECTRS_SRC)
diff --git a/check-synced.sh b/check-synced.sh
@@ -14,11 +14,6 @@ if [ "$b_type" == "bitcoind-testnet" ]; then
   b_rpc_port=48332
   e_monitoring_port=44224
   e_db_path=/data/db/testnet4
-elif [ "$b_type" == "bitcoind-proxy" ]; then
-  b_host="btc-rpc-proxy.embassy"
-  b_rpc_port=8332
-  e_monitoring_port=4224
-  e_db_path=/data/db/bitcoin
 else
   b_host="bitcoind.embassy"
   b_rpc_port=8332
@@ -28,7 +23,7 @@ fi
 
  b_username=$(yq '.bitcoind.username' /data/start9/config.yaml)
  b_password=$(yq '.bitcoind.password' /data/start9/config.yaml)
- 
+
  #Get blockchain info from the bitcoin rpc
  b_gbc_result=$(curl -sS --user $b_username:$b_password --data-binary '{"jsonrpc": "1.0", "id": "sync-hck", "method": "getblockchaininfo", "params": []}' -H 'content-type: text/plain;' http://$b_host:$b_rpc_port/ 2>&1)
  error_code=$?
@@ -58,18 +53,18 @@ fi
     #Gather keys/values from prometheus rpc:
     curl_res=$(curl -sS localhost:$e_monitoring_port 2>/dev/null)
     error_code=$?
-    
+
     if [[ $error_code -ne 0 ]]; then
         echo "Error contacting the electrs Prometheus RPC" >&2
         exit 61
     fi
-    
+
     #Determine whether we are actively doing a database compaction:
     #compaction_res=$(echo -e "$features_res" | grep num-running-compactions | sed "s/\s$//g" | grep " [^0]$"|awk '{print $NF}'|head -1)
     #^The prometheus RPC's num-running-compactions key doesn't seem to correspond to actual
     # compaction events, so we'll determine compaction by another, dumber but accurate method:
     chk_numlines=100000 #Look through the last 100,000 lines of the db LOG
-    log_file="/data/db/bitcoin/LOG"
+    log_file="$e_db_path/LOG"
     tail_log="ionice -c3 tail -$chk_numlines $log_file"
     compaction_job=$($tail_log|nice -n19 grep EVENT_LOG|nice -n19 grep "ManualCompaction"|nice -n19 tail -1|nice -n19 cut -d" " -f7)
     if [ -n "$compaction_job" ] ; then
diff --git a/configurator/src/main.rs b/configurator/src/main.rs
@@ -22,11 +22,6 @@ enum BitcoinCoreConfig {
         username: String,
         password: String,
     },
-    #[serde(rename = "bitcoind-proxy")]
-    BitcoindProxy {
-        username: String,
-        password: String,
-    },
     #[serde(rename = "bitcoind-testnet")]
     BitcoindTestnet {
         username: String,
@@ -47,12 +42,6 @@ fn main() -> Result<(), anyhow::Error> {
                     let network = format!("{}", "bitcoin");
                     (username, password, hostname.clone(), 8332, hostname.clone(), 8333, network.clone())
                 }
-                BitcoinCoreConfig::BitcoindProxy { username, password } => {
-                    let hostname = format!("{}", "btc-rpc-proxy.embassy");
-                    let p2p_hostname = format!("{}", "bitcoind.embassy");
-                    let network = format!("{}", "bitcoin");
-                    (username, password, hostname.clone(), 8332, p2p_hostname.clone(), 8333, network.clone())
-                }
                 BitcoinCoreConfig::BitcoindTestnet { username, password } => {
                     let hostname = format!("{}", "bitcoind-testnet.embassy");
                     let network = format!("{}", "testnet4");
diff --git a/manifest.yaml b/manifest.yaml
@@ -101,17 +101,6 @@ dependencies:
       auto-configure:
         type: script
     requires-runtime-config: true
-  btc-rpc-proxy:
-    version: '>=0.3.2.1 <0.5.0'
-    requirement:
-      type: 'opt-in'
-      how: Set "Bitcoin Core" to "Bitcoin Core"
-    description: Provides bitcoin rpc interface needed for info about fees, blockchain, mempool, network, and transactions. Can also use bitcoind for rpc interface, or an external node for both.
-    config:
-      check:
-        type: script
-      auto-configure:
-        type: script
 backup:
   create:
     type: script
diff --git a/scripts/services/dependencies.ts b/scripts/services/dependencies.ts
@@ -1,101 +1,12 @@
 import { types as T, matches } from "../deps.ts";
 
-const { shape, arrayOf, number, boolean, string } = matches;
+const { shape, number, boolean, string } = matches;
 
-const matchProxyConfig = shape({
-  users: arrayOf(
-    shape(
-      {
-        name: string,
-        'allowed-calls': arrayOf(string),
-        password: string,
-        'fetch-blocks': boolean,
-      },
-      ['fetch-blocks'],
-    ),
-  ),
-})
-
-function times<T>(fn: (i: number) => T, amount: number): T[] {
-  const answer = new Array(amount)
-  for (let i = 0; i < amount; i++) {
-    answer[i] = fn(i)
-  }
-  return answer
-}
-
-function randomItemString(input: string) {
-  return input[Math.floor(Math.random() * input.length)]
-}
-
-const serviceName = 'electrs'
-const fullChars =
-  'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
 type Check = {
   currentError(config: T.Config): string | void
   fix(config: T.Config): void
 }
 
-const proxyChecks: Array<Check> = [
-  {
-    currentError(config) {
-      if (!matchProxyConfig.test(config)) {
-        return 'Config is not the correct shape'
-      }
-      if (config.users.some((x) => x.name === serviceName)) {
-        return
-      }
-      return `Must have an RPC user named "${serviceName}"`
-    },
-    fix(config) {
-      if (!matchProxyConfig.test(config)) {
-        return
-      }
-      config.users.push({
-        name: serviceName,
-        'allowed-calls': [],
-        password: times(() => randomItemString(fullChars), 22).join(''),
-      })
-    },
-  },
-  ...[
-    'estimatesmartfee',
-    'getblockchaininfo',
-    'getblockcount',
-    'getmempoolentry',
-    'getnetworkinfo',
-    'getrawmempool',
-    'getrawtransaction',
-  ].map(
-    (operator): Check => ({
-      currentError(config) {
-        if (!matchProxyConfig.test(config)) {
-          return 'Config is not the correct shape'
-        }
-        if (
-          config.users
-            .find((x) => x.name === serviceName)
-            ?.['allowed-calls']?.some((x) => x === operator) ??
-          false
-        ) {
-          return
-        }
-        return `RPC user "${serviceName}" must have "${operator}" enabled`
-      },
-      fix(config) {
-        if (!matchProxyConfig.test(config)) {
-          throw new Error('Config is not the correct shape')
-        }
-        const found = config.users.find((x) => x.name === serviceName)
-        if (!found) {
-          throw new Error(`No user ${serviceName} found`)
-        }
-        found['allowed-calls'] = [...(found['allowed-calls'] ?? []), operator]
-      },
-    }),
-  ),
-]
-
 const matchBitcoindConfig = shape({
   rpc: shape({
     enable: boolean,
@@ -168,31 +79,6 @@ const bitcoindChecks: Array<Check> = [
 ]
 
 export const dependencies: T.ExpectedExports.dependencies = {
-  'btc-rpc-proxy': {
-    // deno-lint-ignore require-await
-    async check(effects, configInput) {
-      effects.info('check btc-rpc-proxy')
-      for (const checker of proxyChecks) {
-        const error = checker.currentError(configInput)
-        if (error) {
-          effects.error(`throwing error: ${error}`)
-          return { error }
-        }
-      }
-      return { result: null }
-    },
-    // deno-lint-ignore require-await
-    async autoConfigure(effects, configInput) {
-      effects.info('autoconfigure btc-rpc-proxy')
-      for (const checker of proxyChecks) {
-        const error = checker.currentError(configInput)
-        if (error) {
-          checker.fix(configInput)
-        }
-      }
-      return { result: configInput }
-    },
-  },
   bitcoind: {
     // deno-lint-ignore require-await
     async check(effects, configInput) {
diff --git a/scripts/services/getConfig.ts b/scripts/services/getConfig.ts
@@ -19,7 +19,6 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
       "name": "Select Bitcoin Node",
       "variant-names": {
         "bitcoind": "Bitcoin Core",
-        "bitcoind-proxy": "Bitcoin Core (proxy)",
         "bitcoind-testnet": "Bitcoin Core (testnet4)",
       },
       "description": "The Bitcoin node type you would like to use for electrs",
@@ -48,28 +47,6 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
           "selector": "$.rpc.password",
         },
       },
-      "bitcoind-proxy": {
-        "username": {
-          "type": "pointer",
-          "name": "RPC Username",
-          "description": "The username for the RPC user allocated to electrs",
-          "subtype": "package",
-          "package-id": "btc-rpc-proxy",
-          "target": "config",
-          "multi": false,
-          "selector": "$.users[?(@.name == \"electrs\")].name",
-        },
-        "password": {
-          "type": "pointer",
-          "name": "RPC Password",
-          "description": "The password for the RPC user allocated to electrs",
-          "subtype": "package",
-          "package-id": "btc-rpc-proxy",
-          "target": "config",
-          "multi": false,
-          "selector": "$.users[?(@.name == \"electrs\")].password",
-        },
-      },
       "bitcoind-testnet": {
         "username": {
           "type": "pointer",
diff --git a/scripts/services/migrations.ts b/scripts/services/migrations.ts
@@ -37,22 +37,15 @@ export const migration: T.ExpectedExports.migration =
       "0.10.8.1": {
         up: compat.migrations.updateConfig(
           (config: any) => {
-            switch (config.type) {
-              case "internal-proxy":
-                config.type = "bitcoind-proxy";
-                break;
-              default:
-                config.type = "bitcoind";
-                break;
-            }
             config.bitcoind = {
-              type: config.type,
+              type: "bitcoind",
               username: config.user,
               password: config.password,
             };
 
             delete config.user;
             delete config.password;
+            delete config.type;
 
             return config;
           },
@@ -61,14 +54,7 @@ export const migration: T.ExpectedExports.migration =
         ),
         down: compat.migrations.updateConfig(
           (config: any) => {
-            switch (config.bitcoind.type) {
-              case "bitcoind-proxy":
-                config.type = "internal-proxy";
-                break;
-              default:
-                config.type = "internal";
-                break;
-            }
+            config.type = config.bitcoind.type;
             config.user = config.bitcoind.username;
             config.password = config.bitcoind.password;
 
