Add typed error classes for transaction lifecycle with error classification - #49
Conversation
|
@marshacb must be a member of the Provable team on Vercel to deploy. Learn more about collaboration on Vercel and other options here. |
…, timeout, finalize, and duplicate errors
44fc34c to
37d41df
Compare
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
iamalwaysuncomfortable
left a comment
There was a problem hiding this comment.
A few things worth tightening before merge.
1. waitForConfirmation swallows polling errors silently
packages/provable/src/index.ts:379-385 — the bare catch (e) discards every non-FinalizeRevertError exception (network failure, RPC down, malformed response) and keeps polling. After the timeout the caller sees TransactionTimeoutError with no hint that the actual problem was the network.
Capture the last error and attach as cause:
let lastError: unknown
while (Date.now() - startTime < timeout) {
try {
const confirmed = await pollingClient.getConfirmedTransaction(txId)
if (confirmed) {
if (confirmed.status === 'rejected') throw new FinalizeRevertError(txId)
return confirmed.transaction
}
} catch (e) {
if (e instanceof FinalizeRevertError) throw e
lastError = e
}
await new Promise((r) => setTimeout(r, 5_000))
}
throw new TransactionTimeoutError(txId, timeout, { cause: lastError as Error | undefined })Requires extending TransactionTimeoutError's constructor at errors.ts:134 to accept an options?: ErrorOptions arg.
2. Constructor signatures are inconsistent
errors.ts mixes (message, options?), (transactionId?, options?), (transactionId, timeoutMs, options?), and (message, statusCode?, options?) across the eight classes. Callers have to remember which class takes what in which order.
Viem's pattern — a single options bag ({ shortMessage, metaMessages, cause }) with all fields named — is what most modern SDK error hierarchies converge to. Worth adopting before public-API commitment; renaming constructor signatures after release is a breaking change.
3. (error as any)?.status casts in the classifiers
errors.ts:204 and errors.ts:239. Works because SnarkOS attaches .status on broadcast errors, but the assumption is undocumented. Replace with:
function getStatus(e: unknown): number | undefined {
return typeof e === 'object' && e !== null && 'status' in e && typeof e.status === 'number'
? e.status
: undefined
}Reads cleaner, removes the cast, no behavior change.
4. RecordAlreadyUsedError conflates two distinct cases
errors.ts:108. The classifier regex matches both "duplicate output id" (collision in a newly-created record — basically a bug, never user-recoverable) and "duplicate serial number" (double-spend — user tried to spend the same record twice). The message says "Record already consumed," which is wrong for the output-id case.
Either broaden the message to cover both, or split into RecordSpentError (serial number) and OutputIdCollisionError (output id) since the recovery paths differ.
5. ProvingError is overloaded
provable/src/index.ts:389 ('Delegated execution requires proverUrl') and provable/src/index.ts:417 ('DPS response did not contain a transaction ID') throw ProvingError, but neither is a proof failure — the first is user config error (no proving attempted), the second is a DPS protocol violation. Suggest:
ConfigurationError(orMissingConfigError) for the proverUrl case.DelegatedProvingErrorfor the DPS protocol case (or keepProvingErrorbut add akind: 'protocol' | 'computation'discriminant).
6. Integration tests against a real devnet
The classifiers (errors.ts:199, errors.ts:235) match SnarkOS internal error message strings. The 25 unit tests assert against the strings the classifier expects — they pass even if SnarkOS has rephrased any of them. A SnarkOS upgrade that turns "duplicate output id" into "output identifier conflict" silently degrades RecordAlreadyUsedError to BroadcastError, and instanceof RecordAlreadyUsedError checks start returning false without warning.
Worth a separate integration harness: submit known-bad transactions to a local snarkOS devnet (or replay captured broadcast responses) and assert each typed error class fires. Pure-string unit tests can't catch error-vocabulary drift; only a real devnet (or a periodically-refreshed fixture pulled from one) can.
|
The other options for |
…s, ConfigurationError, lastError tracking, getStatus helper
All six addressed, pushed:
|
* init types/tests * adding storage variable parsing from aleo ABI * remove extra loop for vec storage var checking * Add contract runtime layer: record serialization, execution actions, and RecordFieldValue.type (#39) * Add contract runtime utilities: parseRecordPlaintext, toPlaintext, encodeInputs, simulateContract, executeContract, and RecordFieldValue.type for round-trip serialization * Add contract runtime layer: record serialization, input encoding, simulateContract, executeTransaction, and RecordFieldValue.type for round-trip support * Rename toPlaintext to toString, scope ExecuteResult.outputs to top-level function * Add program and recordName to RecordValue, rename toPlaintext to toString, scope ExecuteResult.outputs to top-level function * Add ABI-aware helpers (getRecordDef, getInputTypes, ABI overloads), Leo compiler format normalization in parseAbi, and serializeRecord alias * Implement execute lifecycle: local proving, delegated DPS, and fee handling (#46) * Implement execute lifecycle: local proving + delegated DPS, fee conversion, confirmation polling, and end-to-end integration tests * Use TransactionJSON from SDK instead of inline type for transaction output extraction * Add @veil/codegen: typed contract factories with named params, typed returns, and simulate/execute proxies (#45) * Add @veil/codegen package: generate TypeScript types, record mappers, and function I/O types from Aleo program ABIs * Add typed contract factory generation to codegen (createXContract with embedded ABI) * Add typed contract interface with autocomplete for function and mapping names * Wire auto-encode inputs and auto-parse outputs into getContract proxies, accept ABI type, add comprehensive proxy tests * Update codegen to use InputValue/ParsedOutput types matching getContract proxy signatures * Handle unrecognized values gracefully in parseRecordPlaintextLoose * Generate named params and typed returns in contract factory (closes Ethereum UX gap for inputs and outputs) * Fix result.outputs reference bug and add _record support for record re-consumption in codegen * Fix generated type errors: cast plaintext outputs through unknown, narrow abi to ABI * Clean up generated code: remove unused imports, replace as any with indexed access types, add client validation, fix unused result in void wrappers * Use structs for ABI detection, remove references in comments * Re-implement simulate/execute in loadNetwork architecture, update integration tests for dynamic SDK pattern * Add loyalty-node example app (#43) * Add loyalty-node example app using @veil/core + @veil/provable with simulate support * Simplify loyalty-node app to use ABI-aware utilities (no manual loadAbi, getInputTypes, or recordToString) * Use generated contract factories with simulate proxies, add codegen dependency and generate script * Use auto-encode/auto-parse contract proxies with native values and RecordValue inputs * Use codegen named params and typed returns, remove manual helpers and output casts * Add read_state demo to showcase mapping reads and complete namespace coverage * Restructure demos around simulate/execute/read namespaces, add ALEO_PRIVATE_KEY env support * Fix toCredits precision, use funded SDK account, simplify execute demo to single on-chain step * Adapt loyalty-node to loadNetwork pattern, fix duplicate Input/Output exports * Add type-level ABI inference for getContract (#48) * Add type-level ABI inference for getContract: function/mapping name narrowing and typed namespaces * Map future/dynamicFuture to FutureValue in codegen instead of void * Add optional dynamicId to record types for RecordWithDynamicID and ExternalRecordWithDynamicID support * Add typed error classes for transaction lifecycle with error classification (#49) * Add typed error classes for transaction lifecycle: broadcast, proving, timeout, finalize, and duplicate errors * Address review feedback: options bag constructors, split record errors, ConfigurationError, lastError tracking, getStatus helper * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: mia <93600681+miazn@users.noreply.github.com> * Add per-transition output parsing to execute lifecycle (#54) * Add per-transition output parsing: structured transitions from execute with program/function metadata * Handle record_with_dynamic_id outputs in transition parser * Add dynamicId record output test for per-transition parsing * Align executeContract behavior across account types (#55) - RPC path now polls for confirmation and walks transitions itself, returning the same {transactionId, transitions, outputs} shape as the local path. The SDK does not ask the wallet to decrypt — record outputs surface as raw record1... ciphertexts on the RPC path. - executeTransaction aliased to writeContract everywhere (matches the Aleo wallet adapter spec); the full-lifecycle action lives as executeContract. - outputs is the called function's transition only on both paths; inner cross-program transitions are surfaced via transitions[]. - Extract waitForConfirmation and extractTransitions to shared core utilities. Position-based top-level identification replaces name matching. * Align codegen and inference integer types to bigint for all bit widths --------- Co-authored-by: Mike Turner <mike@provable.com> * Remove NetworkRecordProvider, use RecordScanner as sole scanning path (#56) * Return per-transition outputs from simulateContract (#57) * Return per-transition outputs from simulateContract - SimulateContractReturnType (and RawSimulateResult) now carries transitions[] alongside outputs, matching ExecuteContractReturnType's shape. outputs is the called function's transition only; inner cross-program transitions are surfaced via transitions[]. - Contract proxy's simulate.fn() now returns { transitions, outputs } with the same per-transition parsing as execute.fn() — same-program transitions parsed with the local ABI, foreign loose-parsed. - Provable's simulate uses programManager.buildAuthorization instead of programManager.run. The Authorization carries the transition list with outputs (same structure a confirmed Transaction has, minus the proof) and doesn't run a full circuit, so it's faster. Outputs flow through the shared extractTransitions with the local-account view-key decryptor. * Add cross-program Authorization integration test Surfaces a real wire-format gap: after `decryptTransition(tvk)`, `outputs(true)` returns JS-native values (`10`) instead of Aleo-typed strings (`'10u32'`). `transition.toString()` emits the same wire-format JSON the chain returns from `/transaction/confirmed/{id}`, so the simulate path now JSON.parses that for each transition before handing it to extractTransitions — outputs are consistent with the execute path. Test vectors (multiply_test.aleo / double_test.aleo) taken from the @provablehq/sdk JSDoc examples. --------- Signed-off-by: mia <93600681+miazn@users.noreply.github.com> Co-authored-by: marshacb <cameron.marshall12@gmail.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Mike Turner <mike@provable.com>
Summary
Adds typed error classes for the execute lifecycle so users can programmatically distinguish between broadcast failures, proving errors, confirmation timeouts, finalize reverts, and duplicate transactions. Replaces generic
Errorthrows throughout the execute path.Addresses #19 and PR #9 review comments 13, 14, 15.
New error classes (all extend BaseError)
InvalidTransactionErrorDuplicateTransactionErrorRecordAlreadyUsedErrorBroadcastErrorTransactionTimeoutErrorFinalizeRevertErrorstatus: "rejected"(finalize reverted, fee consumed)ProvingErrorSimulateNotSupportedErrorsimulateContractcalled on RPC (wallet) accountError classifiers
Two functions that parse raw SDK errors into typed Veil errors:
classifyBroadcastError(error, txId?)- regex-based classification forsubmitTransactionerrors (SDK doesn't preserve HTTP status)classifyProvingError(error)- delegates broadcast-like messages, wraps rest asProvingErrorExecute lifecycle changes
waitForConfirmationnow usesgetConfirmedTransaction(returns status) instead ofgetTransaction— detects finalize reverts viastatus === "rejected"provingRequest+submitProvingRequestwrapped →classifyProvingErrorbuildExecutionTransaction→ProvingError,submitTransaction→classifyBroadcastErrorBaseErrorinstances to avoid double-wrappingFiles
packages/core/src/errors/errors.ts- 8 error classes + 2 classifier functionspackages/core/src/index.ts- exportspackages/core/src/actions/wallet/simulateContract.ts-SimulateNotSupportedErrorpackages/provable/src/index.ts- execute lifecycle wrapping +getConfirmedTransactionfixpackages/core/test/errors/errors.test.ts- 25 new testsTest plan
.name,instanceof BaseError, domain properties, cause chainSimulateNotSupportedErrorthrown for RPC accounts