Add ClaimSDK transaction-submitted callback by Copilot · Pull Request #63 · GoodDollar/GoodSDKs

Copilot · 2026-08-19T11:16:44Z

Claim consumers need to distinguish wallet signing from the pending-on-chain stage. The claim flow now exposes a reliable post-broadcast callback before receipt confirmation.

Claim API
- Added claim({ onTransactionSubmitted }) for the post-submission / pre-confirmation hook.
- Kept existing positional claim(txConfirm) support.
- Preserved transaction hash aliases via deprecated onTxHash / onTxhash.
Callback behavior
- Invokes the submitted callback once after writeContract succeeds.
- Logs and swallows callback errors so UI handlers cannot fail the claim.
- Applies the same safe callback path to custodial claim submission.
Coverage
- Added focused ClaimSDK tests for callback ordering, single invocation, swallowed errors, aliases, and legacy txConfirm.

await claimSdk.claim({
  txConfirm: async (message) => showWalletPrompt(message),
  onTransactionSubmitted: (hash) => {
    setClaimState("pending-confirmation")
    setTxHash(hash)
  },
})

Fixes ClaimSDK: support optional transaction-submitted callback before confirmation #62

Co-authored-by: sirpy <671095+sirpy@users.noreply.github.com>

sirpy · 2026-08-19T12:22:03Z

+export type ClaimTxConfirmCallback = (message: string) => void | Promise<void>
+
+export type ClaimTransactionSubmittedCallback = (
+  hash: `0x${string}`,
+) => void | Promise<void>
+
+export interface ClaimOptions {
+  /** Called during the balance check step to confirm faucet or retry actions. */
+  txConfirm?: ClaimTxConfirmCallback
+  /** Called once after the claim transaction is broadcast and before receipt confirmation. */
+  onTransactionSubmitted?: ClaimTransactionSubmittedCallback
+  /** @deprecated Use onTransactionSubmitted for the post-broadcast, pre-confirmation stage. */
+  onTxHash?: ClaimTransactionSubmittedCallback
+  /** @deprecated Use onTransactionSubmitted; this alias preserves integrations that used the lowercase-h spelling. */
+  onTxhash?: ClaimTransactionSubmittedCallback
+}
+


not required

sirpy · 2026-08-19T12:28:20Z

@copilot fix review comments

Co-authored-by: sirpy <671095+sirpy@users.noreply.github.com>

Copilot · 2026-08-19T12:44:14Z

@copilot fix review comments

Addressed in 28f5ce9, d75d22c, and 0376129. Automated code review and CodeQL are now clean.

sirpy · 2026-08-31T12:56:05Z

@blueogin

blueogin · 2026-09-02T13:58:35Z


    const hash = await this.walletClient.writeContract(request)
-    onHash?.(hash)
+    await safeInvokeSubmittedCallback(


Awaited callback can hang claim()
The submitted callback is now awaited. A consumer callback that resolves slowly or never (rare cases) blocks the 5s sleep and waitForTransactionReceipt, so claim() hangs even after the tx confirms.
Worth either keeping it fire-and-forget or wrapping it in a timeout.

blueogin · 2026-09-02T13:59:19Z

+    const onClaimSubmitted = vi.fn(() => {
+      events.push("submitted")
+    })
+    vi.spyOn(sdk, "submitAndWait").mockImplementation(


The test mocks out submitAndWait and invokes the callback itself, so the real callback-before-confirmation ordering inside ClaimSDK.submitAndWait is never exercised. A regression there wouldn't fail the suite.

sirpy · 2026-10-12T08:34:51Z

@copilot evaluate the latest review comments by @blueogin
are they valid? if so suggest fixes

sirpy · 2026-10-12T09:05:50Z

@copilot evaluate the latest review comments by @blueogin
are they valid? if so suggest fixes

blueogin · 2026-10-14T14:20:04Z

@sirpy
copilot seems not working

sirpy · 2026-10-20T12:51:28Z

@copilot evaluate the latest review comments by @blueogin
are they valid? if so suggest fixes

Copilot · 2026-10-20T12:51:35Z

@sirpy The model claude-haiku-5.5 is not available for your account. This can happen if the model was disabled by your organization's policy or if your Copilot plan doesn't include access to it.

You can try again without specifying a model (just @copilot) to use the default, or choose a different model from the model picker.