synd-cli: checkRetryable & undo-alias commands (#917)

Author: calebguy

synd-cli/biome.json

@@ -26,6 +26,6 @@
     }
   },
   "files": {
-    "ignore": ["node_modules", "dist", ".gitignore", ".next"]
+    "ignore": ["node_modules", "dist", ".gitignore", ".next", "src/dev"]
   }
 }

synd-cli/package.json

@@ -7,8 +7,8 @@
     "format": "biome format --write .",
     "lint": "biome lint --write .",
     "typecheck": "tsc --noEmit",
-    "biome:check": "biome check .",
-    "biome:check-write": "biome check --write ."
+    "check": "biome check .",
+    "check-write": "biome check --write ."
   },
   "dependencies": {
     "@arbitrum/orbit-sdk": "^0.23.3",

synd-cli/src/cli/commands/alias.ts

@@ -1,4 +1,4 @@
-import { applyL1ToL2Alias } from "@/utils/alias"
+import { applyL1ToL2Alias, undoL1ToL2Alias } from "@/utils/alias"
 import { print } from "@/utils/print"
 import type { Command } from "@commander-js/extra-typings"
 import { ethAddressSchema, handleSchemaErrors } from "../schema"
@@ -19,4 +19,20 @@ export function aliasCommand(program: Command) {
       }
       print(applyL1ToL2Alias(parsedAddress))
     })
+
+  program
+    .command("undo-alias")
+    .description("Calculate the original address from an aliased L2 address")
+    .argument("<address>", "The aliased address to undo")
+    .action((address: string) => {
+      const {
+        success,
+        data: parsedAddress,
+        error
+      } = ethAddressSchema.safeParse(address)
+      if (!success) {
+        return handleSchemaErrors(error)
+      }
+      print(undoL1ToL2Alias(parsedAddress))
+    })
 }

synd-cli/src/cli/commands/appchain/checkRetryable/checkRetryable.ts

@@ -0,0 +1,70 @@
+import type { CheckRetryable } from "@/types"
+import {
+  publicClientToProvider,
+  registerNetworkInArbSDK
+} from "@/utils/arbitrumSDKHelpers"
+import { print } from "@/utils/print"
+import {
+  ParentToChildMessageStatus,
+  ParentTransactionReceipt
+} from "@arbitrum/sdk"
+import type { JsonRpcProvider } from "@ethersproject/providers"
+
+export async function checkRetryable({
+  hash,
+  settlementPublicClient,
+  appchainPublicClient,
+  rollup
+}: CheckRetryable) {
+  const settlementChainProvider: JsonRpcProvider = publicClientToProvider(
+    settlementPublicClient
+  )
+  const appchainProvider: JsonRpcProvider =
+    publicClientToProvider(appchainPublicClient)
+
+  await registerNetworkInArbSDK(
+    settlementChainProvider,
+    appchainProvider,
+    rollup,
+    appchainPublicClient.chain.testnet ?? false
+  )
+
+  print(`Checking retryable tickets for settlement chain tx: ${hash}`)
+
+  const parentReceipt =
+    await settlementChainProvider.getTransactionReceipt(hash)
+  if (!parentReceipt) {
+    throw new Error(`Transaction receipt not found for hash: ${hash}`)
+  }
+
+  print(`Settlement chain tx found in block ${parentReceipt.blockNumber}`)
+
+  const parentTxReceipt = new ParentTransactionReceipt(parentReceipt)
+
+  const parentToChildMessages =
+    await parentTxReceipt.getParentToChildMessages(appchainProvider)
+
+  print(`Found ${parentToChildMessages.length} retryable ticket(s)`)
+
+  if (parentToChildMessages.length === 0) {
+    print("No retryable tickets found in this transaction")
+    return
+  }
+
+  for (let i = 0; i < parentToChildMessages.length; i++) {
+    const message = parentToChildMessages[i]
+    print(`\n=== Retryable Ticket ${i + 1}/${parentToChildMessages.length} ===`)
+    print(`Retryable creation ID: ${message.retryableCreationId}`)
+
+    const status = await message.status()
+    print(`Status: ${ParentToChildMessageStatus[status]}`)
+
+    if (status === ParentToChildMessageStatus.REDEEMED) {
+      const result = await message.waitForStatus()
+      if ("childTxReceipt" in result) {
+        print(`Appchain tx hash: ${result.childTxReceipt.transactionHash}`)
+        print(`Appchain block: ${result.childTxReceipt.blockNumber}`)
+      }
+    }
+  }
+}

synd-cli/src/cli/commands/appchain/checkRetryable/index.ts

@@ -0,0 +1,49 @@
+import { appchainCheckRetryableOptionsSchema } from "@/cli/schema"
+import { addInitSubcommand } from "@/utils/addInitCommand"
+import {
+  getAppchainClients,
+  getSupportedChainPublicClient
+} from "@/utils/clients"
+import { parseConfigAndOptions } from "@/utils/config"
+import type { Command } from "@commander-js/extra-typings"
+import { checkRetryable } from "./checkRetryable"
+
+export function checkRetryableCommand(program: Command) {
+  const checkCmd = program
+    .command("check-retryable")
+    .description(
+      "Check retryable ticket status from a settlement chain transaction"
+    )
+
+  addInitSubcommand(
+    checkCmd,
+    "check-retryable",
+    appchainCheckRetryableOptionsSchema
+  )
+
+  checkCmd
+    .option("--config <path>", "Path to JSON config file")
+    .option("--settlement-rpc <url>", "RPC URL for the settlement chain")
+    .option("--appchain-rpc <url>", "RPC URL for the appchain")
+    .option("--rollup <address>", "Address of the rollup contract")
+    .option("--hash <hash>", "Settlement chain transaction hash to check")
+    .action(async (options: Record<string, unknown>) => {
+      const validatedOptions = parseConfigAndOptions(
+        options,
+        appchainCheckRetryableOptionsSchema
+      )
+
+      const { settlementRpc, appchainRpc, rollup, hash } = validatedOptions
+
+      const settlementPublicClient =
+        await getSupportedChainPublicClient(settlementRpc)
+      const [appchainPublicClient] = await getAppchainClients(appchainRpc)
+
+      await checkRetryable({
+        hash,
+        settlementPublicClient,
+        appchainPublicClient,
+        rollup
+      })
+    })
+}

synd-cli/src/cli/commands/appchain/checkTokenBridge/checkTokenBridge.ts

@@ -1,14 +1,11 @@
-import type { CheckTokenBridge, PublicClientWithChain } from "@/types"
+import type { CheckTokenBridge } from "@/types"
+import {
+  publicClientToProvider,
+  registerNetworkInArbSDK
+} from "@/utils/arbitrumSDKHelpers"
 import { getTokenBridgeContracts } from "@/utils/getTokenBridgeContracts"
 import { print } from "@/utils/print"
 import { createTokenBridgePrepareTransactionReceipt } from "@arbitrum/orbit-sdk"
-import {
-  type ArbitrumNetwork,
-  getArbitrumNetworkInformationFromRollup,
-  registerCustomArbitrumNetwork
-} from "@arbitrum/sdk"
-import type { JsonRpcProvider } from "@ethersproject/providers"
-import { providers } from "ethers"
 import { stringify } from "viem"
 
 export async function checkTokenBridge({
@@ -17,7 +14,7 @@ export async function checkTokenBridge({
   settlementPublicClient,
   createdAtHash
 }: CheckTokenBridge) {
-  registerNewNetwork(
+  registerNetworkInArbSDK(
     publicClientToProvider(settlementPublicClient),
     publicClientToProvider(appchainPublicClient),
     rollup,
@@ -63,45 +60,3 @@ export async function checkTokenBridge({
   print("TokenBridge contracts fetched")
   print(stringify(tokenBridgeContracts, null, 2))
 }
-
-export const registerNewNetwork = async (
-  parentProvider: JsonRpcProvider,
-  childProvider: JsonRpcProvider,
-  rollupAddress: string,
-  isTestnet: boolean
-): Promise<ArbitrumNetwork> => {
-  const chainId = (await childProvider.getNetwork()).chainId
-  const { parentChainId, ethBridge, confirmPeriodBlocks } =
-    await getArbitrumNetworkInformationFromRollup(rollupAddress, parentProvider)
-
-  const arbitrumNetwork: ArbitrumNetwork = {
-    name: String(`${chainId}-arbitrum-network`),
-    chainId,
-    parentChainId,
-    confirmPeriodBlocks,
-    ethBridge,
-    isCustom: true,
-    isTestnet
-  }
-
-  return registerCustomArbitrumNetwork(arbitrumNetwork)
-}
-
-export function publicClientToProvider(publicClient: PublicClientWithChain) {
-  const { chain } = publicClient
-
-  if (typeof chain === "undefined") {
-    throw new Error(`[publicClientToProvider] "chain" is undefined`)
-  }
-
-  const network = {
-    chainId: chain.id,
-    name: chain.name,
-    ensAddress: chain.contracts?.ensRegistry?.address
-  }
-
-  const transportUrl = publicClient.transport.url as string | undefined
-  const url = transportUrl ?? chain.rpcUrls.default.http[0]
-
-  return new providers.StaticJsonRpcProvider(url, network)
-}