sui-explorer integration with CLI publish commands

ChainMovers · Jul 21, 2024 · bf6d434 · bf6d434
1 parent 36c530a
commit bf6d434
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 11 deletions.
diff --git a/scripts/common/__publish.sh b/scripts/common/__publish.sh
@@ -139,10 +139,38 @@ publish_all() {
   echo "Package ID also in [~/suibase/workdirs/$WORKDIR_NAME/published-data/$MOVE_TOML_PACKAGE_NAME/most-recent/package-id.json]"
   echo "Created objects in [~/suibase/workdirs/$WORKDIR_NAME/published-data/$MOVE_TOML_PACKAGE_NAME/most-recent/created-objects.json]"
   echo "Complete output in [~/suibase/workdirs/$WORKDIR_NAME/published-data/$_SUB_INSTALL_DIR/publish-output.json]"
-  echo "==================== Explorer Links ======================"
-  echo "Package [https://suiexplorer.com/object/$_ID_PACKAGE_FOR_LINK?network=$_WORKDIR_NAME_FOR_LINK]"
-  if [ -n "$SUI_PUBLISH_TXDIGEST" ]; then
-    echo "TxBlock [https://suiexplorer.com/txblock/$SUI_PUBLISH_TXDIGEST?network=$_WORKDIR_NAME_FOR_LINK]"
+
+  if [ "${CFG_sui_explorer_enabled:?}" = "true" ] && [ "${CFG_sui_explorer_host_ip:?}" != "~" ]; then
+    echo "==================== Explorer Links ======================"
+    # Build the URL using the yaml config. Example of config:
+    #
+    #   sui_explorer_enabled: true
+    #   sui_explorer_scheme: "http://"
+    #   sui_explorer_host_ip: "localhost"
+    #   sui_explorer_port_number: 44380
+    #   sui_explorer_object_path: "/object/{ID}"
+    #   sui_explorer_txn_path: "/txblock/{ID}"
+    #
+    local _URL_BASE
+    if [ -n "${CFG_sui_explorer_scheme}" ] && [ "${CFG_sui_explorer_scheme}" != "~" ]; then
+      _URL_BASE="${CFG_sui_explorer_scheme}${CFG_sui_explorer_host_ip:?}"
+    else
+      _URL_BASE="http://${CFG_sui_explorer_host_ip:?}"
+    fi
+
+    if [ -n "${CFG_sui_explorer_port_number}" ] && [ "${CFG_sui_explorer_port_number}" != "~" ]; then
+      _URL_BASE="${_URL_BASE}:${CFG_sui_explorer_port_number:?}"
+    fi
+
+    if [ -n "${CFG_sui_explorer_package_path:?}" ] && [ -n "$_ID_PACKAGE_FOR_LINK" ]; then
+      local _URL_PATH="${CFG_sui_explorer_package_path//\{ID\}/$_ID_PACKAGE_FOR_LINK}"
+      echo "Package [${_URL_BASE}${_URL_PATH}]"
+    fi
+
+    if [ -n "${CFG_sui_explorer_txn_path}" ] && [ -n "$SUI_PUBLISH_TXDIGEST" ]; then
+      local _URL_PATH="${CFG_sui_explorer_txn_path//\{ID\}/$SUI_PUBLISH_TXDIGEST}"
+      echo "TxBlock [${_URL_BASE}${_URL_PATH}]"
+    fi
   fi
 
   # Push new information to suibase-daemon.

diff --git a/scripts/common/__sui-faucet-process.sh b/scripts/common/__sui-faucet-process.sh
@@ -35,7 +35,6 @@ start_sui_faucet_process() {
       if [ "$_HOST_IP" = "localhost" ]; then
         _HOST_IP="127.0.0.1"
       fi
-      echo "Starting sui-faucet process at http://$_HOST_IP:${CFG_sui_faucet_port:?}"
       env SUI_CONFIG_DIR="$WORKDIRS/$WORKDIR/faucet" "$SUI_BIN_DIR/sui-faucet" \
         --amount "${CFG_sui_faucet_coin_value:?}" \
         --host-ip "$_HOST_IP" \

diff --git a/scripts/defaults/cargobin/suibase.yaml b/scripts/defaults/cargobin/suibase.yaml
@@ -41,9 +41,13 @@ dtp_api_port_number: 44398
 
 suibase_api_port_number: 44399
 
-sui_explorer_enabled: true
-sui_explorer_host_ip: "suiscan.xyz"
-sui_explorer_port_number: 443
+sui_explorer_enabled: false
+sui_explorer_scheme: ~
+sui_explorer_host_ip: ~
+sui_explorer_port_number: ~
+sui_explorer_object_path: ~
+sui_explorer_package_path: ~
+sui_explorer_txn_path: ~
 
 links:
   - alias: "devnet"

diff --git a/scripts/defaults/devnet/suibase.yaml b/scripts/defaults/devnet/suibase.yaml
@@ -40,8 +40,12 @@ dtp_api_port_number: 44398
 suibase_api_port_number: 44399
 
 sui_explorer_enabled: true
+sui_explorer_scheme: "https://"
 sui_explorer_host_ip: "suiscan.xyz"
-sui_explorer_port_number: 443
+sui_explorer_port_number: ~
+sui_explorer_object_path: "/devnet/object/{ID}"
+sui_explorer_package_path: "/devnet/object/{ID}/contracts"
+sui_explorer_txn_path: "/devnet/tx/{ID}"
 
 links:
   - alias: "sui.io"

diff --git a/scripts/defaults/localnet/suibase.yaml b/scripts/defaults/localnet/suibase.yaml
@@ -98,8 +98,12 @@ dtp_api_port_number: 44398
 suibase_api_port_number: 44399
 
 sui_explorer_enabled: true
+sui_explorer_scheme: "http://"
 sui_explorer_host_ip: "localhost"
 sui_explorer_port_number: 44380
+sui_explorer_object_path: "/object/{ID}"
+sui_explorer_package_path: "/object/{ID}"
+sui_explorer_txn_path: "/txblock/{ID}"
 
 links:
   - alias: "localnet"

diff --git a/scripts/defaults/mainnet/suibase.yaml b/scripts/defaults/mainnet/suibase.yaml
@@ -40,8 +40,12 @@ dtp_api_port_number: 44398
 suibase_api_port_number: 44399
 
 sui_explorer_enabled: true
+sui_explorer_scheme: "https://"
 sui_explorer_host_ip: "suiscan.xyz"
-sui_explorer_port_number: 443
+sui_explorer_port_number: ~
+sui_explorer_object_path: "/mainnet/object/{ID}"
+sui_explorer_package_path: "/mainnet/object/{ID}/contracts"
+sui_explorer_txn_path: "/mainnet/tx/{ID}"
 
 links:
   - alias: "sui.io"

diff --git a/scripts/defaults/testnet/suibase.yaml b/scripts/defaults/testnet/suibase.yaml
@@ -40,8 +40,12 @@ dtp_api_port_number: 44398
 suibase_api_port_number: 44399
 
 sui_explorer_enabled: true
+sui_explorer_scheme: "https://"
 sui_explorer_host_ip: "suiscan.xyz"
-sui_explorer_port_number: 443
+sui_explorer_port_number: ~
+sui_explorer_object_path: "/testnet/object/{ID}"
+sui_explorer_package_path: "/testnet/object/{ID}/contracts"
+sui_explorer_txn_path: "/testnet/tx/{ID}"
 
 links:
   - alias: "sui.io"