TransactionSubmissionError
Defined in: errors.ts:594
Thrown by a write method (splits.deposit, splits.requestWithdrawal,
eoa.deposit, eoa.requestWithdrawal, incentives.claimIncentives) when
it fails after at least one of its transactions was broadcast.
txHashes holds the transactions of the call that were mined.
pendingTxHash is the one that was broadcast but not confirmed (for a
contract wallet, the wallet's own transaction hash), and pendingStatus
says why: reverted (mined and reverted, so it moved nothing and a retry is
safe) or unconfirmed (no receipt was obtained; it may still be mined). The
original error is in cause.
To fix: look these transactions up before retrying, so nothing is sent twice.
Extends​
Properties​
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
code | readonly | string | Stable identifier of the failed check. | ObolSdkError.code | errors.ts:331 |
hint? | public | string | Short, actionable suggestion for the caller. | ObolSdkError.hint | errors.ts:333 |
txHashes | readonly | string[] | Hashes of the transactions of this call that were mined. | - | errors.ts:597 |
pendingTxHash? | readonly | string | Hash of the broadcast transaction that was not confirmed, if any. | - | errors.ts:599 |
pendingStatus? | readonly | "reverted" | "unconfirmed" | Why pendingTxHash is not confirmed; set with pendingTxHash. | - | errors.ts:601 |
cause | readonly | unknown | The error that stopped the call. | - | errors.ts:603 |
stackTraceLimit | static | number | The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)). The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. | ObolSdkError.stackTraceLimit | node_modules/@types/node/globals.d.ts:68 |
Methods​
captureStackTrace()​
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
Parameters​
| Parameter | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns​
void
Inherited from​
ObolSdkError.captureStackTrace
prepareStackTrace()​
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/@types/node/globals.d.ts:56
Parameters​
| Parameter | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns​
any
See​
https://v8.dev/docs/stack-trace-api#customizing-stack-traces