InvalidArgsError
Represents an error that occurs when arguments provided to a contract or script call are invalid.
This error is typically encountered when the arguments provided do not match the expected types or structure required by the contract or script.
Example
try { // Some operation that can throw an InvalidArgsError} catch (error) { if (error instanceof InvalidArgsError) { console.error(error.message); // Handle the invalid arguments error }}
Param
A human-readable error message.
Param
Additional parameters for the InvalidParamsError.
Extends
Constructors
new InvalidArgsError()
new InvalidArgsError(
message
,args
?,tag
?):InvalidArgsError
Constructs an InvalidArgsError.
Parameters
• message: string
Human-readable error message.
• args?: InvalidArgsErrorParameters
Additional parameters for the InvalidParamsError.
• tag?: string
The tag for the error.
Returns
Overrides
InvalidParamsError
.constructor
Defined in
packages/errors/src/input/InvalidArgsError.js:48
Properties
_tag
_tag:
string
Same as name, used internally.
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:81
cause
cause:
any
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:113
code
code:
number
Error code, analogous to the code in JSON RPC error.
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:111
details
details:
string
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:90
docsPath
docsPath:
undefined
|string
Path to the documentation for this error.
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:95
message
message:
string
Human-readable error message.
Inherited from
Defined in
node_modules/.pnpm/typescript@5.5.2/node_modules/typescript/lib/lib.es5.d.ts:1077
metaMessages
metaMessages:
undefined
|string
[]
Additional meta messages for more context.
Inherited from
InvalidParamsError
.metaMessages
Defined in
packages/errors/src/ethereum/BaseError.js:99
name
name:
string
The name of the error, used to discriminate errors.
Inherited from
Defined in
node_modules/.pnpm/typescript@5.5.2/node_modules/typescript/lib/lib.es5.d.ts:1076
shortMessage
shortMessage:
string
Inherited from
InvalidParamsError
.shortMessage
Defined in
packages/errors/src/ethereum/BaseError.js:103
stack?
optional
stack:string
Inherited from
Defined in
node_modules/.pnpm/typescript@5.5.2/node_modules/typescript/lib/lib.es5.d.ts:1078
version
version:
string
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:107
prepareStackTrace()?
static
optional
prepareStackTrace: (err
,stackTraces
) =>any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
• err: Error
• stackTraces: CallSite
[]
Returns
any
Inherited from
InvalidParamsError
.prepareStackTrace
Defined in
node_modules/.pnpm/@types+node@20.14.8/node_modules/@types/node/globals.d.ts:28
stackTraceLimit
static
stackTraceLimit:number
Inherited from
InvalidParamsError
.stackTraceLimit
Defined in
node_modules/.pnpm/@types+node@20.14.8/node_modules/@types/node/globals.d.ts:30
Methods
walk()
walk(
fn
?):unknown
Walks through the error chain.
Parameters
• fn?: Function
A function to execute on each error in the chain.
Returns
unknown
The first error that matches the function, or the original error.
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:136
captureStackTrace()
captureStackTrace(targetObject, constructorOpt)
static
captureStackTrace(targetObject
,constructorOpt
?):void
Create .stack property on a target object
Parameters
• targetObject: object
• constructorOpt?: Function
Returns
void
Inherited from
InvalidParamsError
.captureStackTrace
Defined in
node_modules/.pnpm/@types+node@20.14.8/node_modules/@types/node/globals.d.ts:21
captureStackTrace(targetObject, constructorOpt)
static
captureStackTrace(targetObject
,constructorOpt
?):void
Create .stack property on a target object
Parameters
• targetObject: object
• constructorOpt?: Function
Returns
void
Inherited from
InvalidParamsError
.captureStackTrace
Defined in
node_modules/.pnpm/@types+node@22.1.0/node_modules/@types/node/globals.d.ts:22
captureStackTrace(targetObject, constructorOpt)
static
captureStackTrace(targetObject
,constructorOpt
?):void
Create .stack property on a target object
Parameters
• targetObject: object
• constructorOpt?: Function
Returns
void
Inherited from
InvalidParamsError
.captureStackTrace
Defined in
node_modules/.pnpm/bun-types@1.1.18/node_modules/bun-types/globals.d.ts:1613
captureStackTrace(targetObject, constructorOpt)
static
captureStackTrace(targetObject
,constructorOpt
?):void
Create .stack property on a target object
Parameters
• targetObject: object
• constructorOpt?: Function
Returns
void
Inherited from
InvalidParamsError
.captureStackTrace
Defined in
node_modules/.pnpm/@types+node@20.12.14/node_modules/@types/node/globals.d.ts:21