Class ContractDispatchError<ContractApi>

Represents an error that occurred during the execution of a smart contract call due to a dispatch error. This class extends ContractExecutionError and includes a DispatchError property.

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

cause? dispatchError message name raw stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new ContractDispatchError<ContractApi>(err, raw): ContractDispatchError<ContractApi>

  • Constructs a new ContractDispatchError instance.

    Type Parameters

    Parameters

    • err:
          | {
              type: "CannotLookup";
          }
          | {
              type: "Other";
          }
          | {
              type: "BadOrigin";
          }
          | {
              type: "Module";
              value: {
                  error: `0x${string}`;
                  index: number;
              };
          }
          | {
              type: "ConsumerRemaining";
          }
          | {
              type: "NoProviders";
          }
          | {
              type: "TooManyConsumers";
          }
          | {
              type: "Token";
              value:
                  | "FundsUnavailable"
                  | "OnlyProvider"
                  | "BelowMinimum"
                  | "CannotCreate"
                  | "UnknownAsset"
                  | "Frozen"
                  | "Unsupported"
                  | "CannotCreateHold"
                  | "NotExpendable"
                  | "Blocked";
          }
          | {
              type: "Arithmetic";
              value: "Underflow" | "Overflow" | "DivisionByZero";
          }
          | {
              type: "Transactional";
              value: "LimitReached" | "NoLayer";
          }
          | {
              type: "Exhausted";
          }
          | {
              type: "Corruption";
          }
          | {
              type: "Unavailable";
          }
          | {
              type: "RootNotAllowed";
          }

      The DispatchError that occurred during the dispatch phase.

    • raw: ContractCallResult<ContractApi["types"]["ChainApi"]>

      The raw result of the contract call.

    Returns ContractDispatchError<ContractApi>

Properties

Optionalcause

cause?: unknown

dispatchError

dispatchError:
    | {
        type: "CannotLookup";
    }
    | {
        type: "Other";
    }
    | {
        type: "BadOrigin";
    }
    | {
        type: "Module";
        value: {
            error: `0x${string}`;
            index: number;
        };
    }
    | {
        type: "ConsumerRemaining";
    }
    | {
        type: "NoProviders";
    }
    | {
        type: "TooManyConsumers";
    }
    | {
        type: "Token";
        value:
            | "FundsUnavailable"
            | "OnlyProvider"
            | "BelowMinimum"
            | "CannotCreate"
            | "UnknownAsset"
            | "Frozen"
            | "Unsupported"
            | "CannotCreateHold"
            | "NotExpendable"
            | "Blocked";
    }
    | {
        type: "Arithmetic";
        value: "Underflow" | "Overflow" | "DivisionByZero";
    }
    | {
        type: "Transactional";
        value: "LimitReached" | "NoLayer";
    }
    | {
        type: "Exhausted";
    }
    | {
        type: "Corruption";
    }
    | {
        type: "Unavailable";
    }
    | {
        type: "RootNotAllowed";
    }

The error that occurred during the dispatch phase.

message

message: string

name

name: string = 'ContractDispatchError'

raw

raw: Awaited<ReturnType<ContractApi["types"]["ChainApi"]["call"]["contractsApi"]["call"]>>

The raw result of the contract call.

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

On This Page

Constructors
Properties
Methods