/*
This file is part of web3.js.
web3.js is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
web3.js is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with web3.js. If not, see .
*/
// eslint-disable-next-line max-classes-per-file
import {
JsonRpcError,
JsonRpcPayload,
JsonRpcResponse,
JsonRpcResponseWithError,
} from '@theqrl/web3-types';
import { BaseWeb3Error } from '../web3_error_base.js';
import {
ERR_INVALID_RESPONSE,
ERR_RESPONSE,
ERR_RESPONSE_TOO_LARGE,
} from '../error_codes.js';
// To avoid circular package dependency, copied to code here. If you update this please update same function in `json_rpc.ts`
const isResponseWithError = (
response: JsonRpcResponse,
): response is JsonRpcResponseWithError =>
!Array.isArray(response) &&
response.jsonrpc === '2.0' &&
!!response &&
// eslint-disable-next-line no-null/no-null
(response.result === undefined || response.result === null) &&
// JSON RPC consider "null" as valid response
'error' in response &&
(typeof response.id === 'number' || typeof response.id === 'string');
const buildErrorMessage = (response: JsonRpcResponse): string =>
isResponseWithError(response) ? response.error.message : '';
export class ResponseError extends BaseWeb3Error {
public code = ERR_RESPONSE;
public data?: ErrorType | ErrorType[];
public request?: JsonRpcPayload;
public constructor(
response: JsonRpcResponse,
message?: string,
request?: JsonRpcPayload,
) {
super(
message ??
`Returned error: ${
Array.isArray(response)
? response.map(r => buildErrorMessage(r)).join(',')
: buildErrorMessage(response)
}`,
);
if (!message) {
this.data = Array.isArray(response)
? response.map(r => r.error?.data as ErrorType)
: response?.error?.data;
}
this.request = request;
let errorOrErrors: JsonRpcError | JsonRpcError[] | undefined;
if (`error` in response) {
errorOrErrors = response.error as JsonRpcError;
} else if (response instanceof Array) {
errorOrErrors = response.map(r => r.error) as JsonRpcError[];
}
this.innerError = errorOrErrors as unknown as Error | Error[] | undefined;
}
public toJSON() {
return { ...super.toJSON(), data: this.data, request: this.request };
}
}
/**
* Thrown when a response exceeds the `maxResponseBytes` bound.
*
* This deliberately does not extend {@link ResponseError}: there is no JSON-RPC error
* payload to carry, because the response was refused before (or instead of) being
* parsed. `maxResponseBytes` is the configured limit; `receivedBytes` is the declared
* (`content-length`) or observed decoded size when known.
*/
export class ResponseTooLargeError extends BaseWeb3Error {
public code = ERR_RESPONSE_TOO_LARGE;
public constructor(public maxResponseBytes: number, public receivedBytes?: number) {
super(
`RESPONSE TOO LARGE: response ${
receivedBytes === undefined ? '' : `of ${receivedBytes} bytes `
}exceeds maxResponseBytes (${maxResponseBytes})`,
);
}
public toJSON() {
return {
...super.toJSON(),
maxResponseBytes: this.maxResponseBytes,
receivedBytes: this.receivedBytes,
};
}
}
export class InvalidResponseError extends ResponseError<
ErrorType,
RequestType
> {
public constructor(
result: JsonRpcResponse,
request?: JsonRpcPayload,
) {
super(result, undefined, request);
this.code = ERR_INVALID_RESPONSE;
let errorOrErrors: JsonRpcError | JsonRpcError[] | undefined;
if (`error` in result) {
errorOrErrors = result.error as JsonRpcError;
} else if (result instanceof Array) {
errorOrErrors = result.map(r => r.error) as JsonRpcError[];
}
this.innerError = errorOrErrors as unknown as Error | Error[] | undefined;
}
}