/*
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 .
*/
import { JsonRpcId, JsonRpcIdentifier } from './json_rpc_types.js';
export interface ProviderMessage {
readonly type: string;
readonly data: unknown;
}
export interface QRLSubscription extends ProviderMessage {
readonly type: 'qrl_subscription';
readonly data: {
readonly subscription: string;
readonly result: unknown;
};
}
export interface ProviderRpcError extends Error {
code: number;
data?: unknown;
}
export interface ProviderConnectInfo {
readonly chainId: string;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type Web3APISpec = Record any> | unknown;
export type Web3APIMethod = string & keyof Exclude;
export type Web3APIParams<
API extends Web3APISpec,
Method extends Web3APIMethod,
> = API extends Exclude ? Parameters : unknown;
export interface Web3APIRequest> {
method: Method | string;
params?: Web3APIParams | readonly unknown[] | object;
}
export interface Web3APIPayload>
extends Web3APIRequest {
readonly jsonrpc?: JsonRpcIdentifier;
readonly id?: JsonRpcId;
readonly requestOptions?: unknown;
}
export type Web3APIReturnType<
API extends Web3APISpec,
Method extends Web3APIMethod,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
> = API extends Record any> ? ReturnType : any;