eip-1193 0.0.1

package/index.d.ts

@@ -0,0 +1,506 @@
+// ------------------------------------------------------------------------------------------------
+// TYPES
+// ------------------------------------------------------------------------------------------------
+export type EIP1193Transaction = {
+	blockHash: DATA;
+	blockNumber: QUANTITY | null;
+	from: EIP1193Account;
+	gas: QUANTITY;
+	gasPrice: QUANTITY;
+	hash: DATA;
+	input: DATA;
+	nonce: QUANTITY;
+	to: EIP1193Account;
+	transactionIndex: QUANTITY | null;
+	value: QUANTITY;
+	v: QUANTITY;
+	r: QUANTITY;
+	s: QUANTITY;
+};
+
+export type EIP1193SyncingStatus = {
+	startingBlock: QUANTITY;
+	currentBlock: QUANTITY;
+	highestBlock: QUANTITY;
+};
+
+export type EIP1193Block = {
+	number: QUANTITY;
+	hash: DATA;
+	parentHash: DATA;
+	nonce: DATA;
+	sha3Uncles: DATA;
+	logsBloom: DATA;
+	transactionsRoot: DATA;
+	stateRoot: DATA;
+	receiptsRoot: DATA;
+	miner: EIP1193Account;
+	difficulty: QUANTITY;
+	totalDifficulty: QUANTITY;
+	extraData: DATA;
+	size: QUANTITY;
+	gasLimit: QUANTITY;
+	gasUsed: QUANTITY;
+	timestamp: QUANTITY;
+	uncles: DATA[];
+};
+
+export type EIP1193Log = {
+	removed: boolean;
+	logIndex: QUANTITY | null;
+	transactionIndex: QUANTITY | null;
+	transactionHash: DATA | null;
+	blockHash: DATA | null;
+	blockNumber: QUANTITY | null;
+	address: EIP1193Account;
+	data: DATA;
+	topics: DATA[];
+};
+
+export type EIP1193TransactionReceipt = {
+	transactionHash: DATA;
+	transactionIndex: QUANTITY;
+	blockHash: DATA;
+	blockNumber: QUANTITY;
+	from: EIP1193Account;
+	to: EIP1193Account;
+	cumulativeGasUsed: QUANTITY;
+	effectiveGasPrice: QUANTITY;
+	gasUsed: QUANTITY;
+	contractAddress: EIP1193Account;
+	logs: EIP1193Log[];
+	logsBloom: DATA;
+	type: DATA;
+	root: DATA;
+	status: QUANTITY;
+};
+
+export type EIP1193PendingBlock = EIP1193Block & {
+	number: null;
+	hash: null;
+	nonce: null;
+	logsBloom: null;
+};
+
+export type EIP1193BlockWithTransactions = EIP1193Block & {
+	transactions: EIP1193Transaction[];
+};
+
+export type EIP1193PendingBlockWithTransactions = EIP1193PendingBlock & {
+	transactions: EIP1193Transaction[];
+};
+
+type EIP1193BaseTransactionData = {
+	gas?: QUANTITY;
+	gasPrice?: QUANTITY;
+	value?: QUANTITY;
+	data?: DATA;
+	nonce?: QUANTITY;
+};
+export type EIP1193NormalTransactionData = EIP1193BaseTransactionData & {
+	from: EIP1193Account;
+	to: EIP1193Account;
+};
+
+export type EIP1193TransactionContractCreationData =
+	EIP1193BaseTransactionData & {
+		from: EIP1193Account;
+		data: DATA;
+	};
+
+export type EIP1193TransactionData =
+	| EIP1193NormalTransactionData
+	| EIP1193TransactionContractCreationData;
+
+export type EIP1193CallParam = {
+	from?: EIP1193Account;
+	to: EIP1193Account;
+	gas?: QUANTITY;
+	gasPrice?: QUANTITY;
+	value?: QUANTITY;
+	data?: `0x${string}`;
+};
+
+export type EIP1193AddChainParam = {
+	chainId: ChainId;
+	rpcUrls?: string[];
+	blockExplorerUrls?: string[];
+	chainName?: string;
+	iconUrls?: string[];
+	nativeCurrency?: {
+		name: string;
+		symbol: string;
+		decimals: number;
+	};
+};
+
+export type EIP1193LogsParam = {
+	fromBlock?: BlockTag;
+	toBlock?: BlockTag;
+	address?: EIP1193Account | EIP1193Accounts;
+	topics?: DATA[];
+	blockhash?: DATA;
+};
+
+export type EIP1193TypedSignatureParam = { [field: string]: any }; // TODO
+// ------------------------------------------------------------------------------------------------
+// REQUEST TYPES
+// ------------------------------------------------------------------------------------------------
+
+export type EIP1193Web3ClientVersionRequest = {
+	readonly method: "web3_clientVersion";
+};
+
+export type EIP1193Web3SHARequest = {
+	readonly method: "web3_sha";
+	readonly params: [DATA];
+};
+
+export type EIP1193NetVersionRequest = {
+	readonly method: "net_version";
+};
+
+export type EIP1193NetListeningRequest = {
+	readonly method: "net_listening";
+};
+
+export type EIP1193NetPeerCountRequest = {
+	readonly method: "net_peerCount";
+};
+
+export type EIP1193ProtocolVersionRequest = {
+	readonly method: "eth_protocolVersion";
+};
+
+export type EIP1193SyncingRequest = {
+	readonly method: "eth_syncing";
+};
+
+export type EIP1193CoinbaseRequest = {
+	readonly method: "eth_coinbase";
+};
+
+export type EIP1193MiningRequest = {
+	readonly method: "eth_mining";
+};
+
+export type EIP1193HashrateRequest = {
+	readonly method: "eth_hashrate";
+};
+
+export type EIP1193GasPriceRequest = {
+	readonly method: "eth_gasPrice";
+};
+
+export type EIP1193AccountsRequest = {
+	readonly method: "eth_accounts";
+};
+
+export type EIP1193BlockNumberRequest = {
+	readonly method: "eth_blockNumber";
+};
+
+export type EIP1193GetBalanceRequest = {
+	readonly method: "eth_getBalance";
+	readonly params: [EIP1193Account] | [EIP1193Account, BlockTag];
+};
+
+export type EIP1193GetStorageAtRequest = {
+	readonly method: "eth_getStorageAt";
+	readonly params:
+		| [EIP1193Account, QUANTITY]
+		| [EIP1193Account, QUANTITY, BlockTag];
+};
+
+export type EIP1193GetTransactionCountRequest = {
+	readonly method: "eth_getTransactionCount";
+	readonly params: [EIP1193Account] | [EIP1193Account, BlockTag];
+};
+
+export type EIP1193GetTransactionCountByHashRequest = {
+	readonly method: "eth_getBlockTransactionCountByHash";
+	readonly params: [DATA];
+};
+
+export type EIP1193GetTransactionCountByNumberRequest = {
+	readonly method: "eth_getBlockTransactionCountByNumber";
+	readonly params: [BlockTag];
+};
+
+export type EIP1193GetUncleCountByBlockHashRequest = {
+	readonly method: "eth_getUncleCountByBlockHash";
+	readonly params: [DATA];
+};
+
+export type EIP1193GetUncleCountByBlockNumberRequest = {
+	readonly method: "eth_getUncleCountByBlockNumber";
+	readonly params: [BlockTag];
+};
+
+export type EIP1193GetCodeRequest = {
+	readonly method: "eth_getCode";
+	readonly params: [EIP1193Account] | [EIP1193Account, BlockTag];
+};
+
+export type EIP1193LegacySignRequest = {
+	readonly method: "eth_sign";
+	readonly params: [EIP1193Account, DATA];
+};
+
+export type EIP1193SignTransactionRequest = {
+	readonly method: "eth_signTransaction";
+	readonly params: [EIP1193TransactionData];
+};
+
+export type EIP1193SendTransactionRequest = {
+	readonly method: "eth_sendTransaction";
+	readonly params: [EIP1193TransactionData];
+};
+
+export type EIP1193SendRawTransactionRequest = {
+	readonly method: "eth_sendRawTransaction";
+	readonly params: [DATA];
+};
+
+export type EIP119CallRequest = {
+	readonly method: "eth_call";
+	readonly params: [EIP1193CallParam] | [EIP1193CallParam, BlockTag];
+};
+
+export type EIP119EstimateGasRequest = {
+	readonly method: "eth_estimateGas";
+	readonly params: [EIP1193CallParam] | [EIP1193CallParam, BlockTag];
+};
+
+export type EIP119GetBlockByHashRequest<T = false> = {
+	readonly method: "eth_getBlockByHash";
+	readonly params: [DATA, T];
+};
+
+export type EIP119GetBlockByNumberRequest<T = false> = {
+	readonly method: "eth_getBlockByNumber";
+	readonly params: [BlockTag, T];
+};
+
+export type EIP119GetTransactionByHashRequest = {
+	readonly method: "eth_getTransactionByHash";
+	readonly params: [DATA];
+};
+
+export type EIP119GetTransactionByBlockHashAndIndexRequest = {
+	readonly method: "eth_getTransactionByBlockHashAndIndex";
+	readonly params: [DATA, QUANTITY];
+};
+
+export type EIP119GetTransactionByBlockNumberAndIndexRequest = {
+	readonly method: "eth_getTransactionByBlockNumberAndIndex";
+	readonly params: [BlockTag, QUANTITY];
+};
+
+export type EIP119GetTransactionReceiptRequest = {
+	readonly method: "eth_getTransactionReceipt";
+	readonly params: [DATA];
+};
+
+export type EIP119GetUncleByBlockHashAndIndexRequest = {
+	readonly method: "eth_getUncleByBlockHashAndIndex";
+	readonly params: [DATA, QUANTITY];
+};
+
+export type EIP119GetUncleByBlockNumberAndIndexRequest = {
+	readonly method: "eth_getUncleByBlockNumberAndIndex";
+	readonly params: [BlockTag, QUANTITY];
+};
+
+export type EIP119GetLogsRequest = {
+	readonly method: "eth_getLogs";
+	readonly params: [EIP1193LogsParam];
+};
+
+// ------------------------------------------------------------------------------------------------
+// MORE REQUEST TYPES
+// ------------------------------------------------------------------------------------------------
+
+export type EIP1193PersonalSignRequest = {
+	readonly method: "personal_sign";
+	readonly params: [DATA, EIP1193Account];
+};
+
+export type EIP1193PTypedSignv4Request = {
+	readonly method: "eth_signTypedData_v4";
+	readonly params: [EIP1193Account, EIP1193TypedSignatureParam];
+};
+
+export type EIP1193PTypedSignRequest = {
+	readonly method: "eth_signTypedData";
+	readonly params: [EIP1193Account, EIP1193TypedSignatureParam];
+};
+
+export type EIP1193ChainIdRequest = {
+	readonly method: "eth_chainId";
+};
+
+export type EIP1193RequestAccountsRequest = {
+	readonly method: "eth_requestAccounts";
+};
+
+export type ERIP1193SwitchChainRequest = {
+	readonly method: "wallet_switchEthereumChain";
+	readonly params: [
+		{
+			chainId: string; // TODO `0x${string}`
+		}
+	];
+};
+export type ERIP1193AddChainRequest = {
+	readonly method: "wallet_addEthereumChain";
+	readonly params: [EIP1193AddChainParam];
+};
+
+// ------------------------------------------------------------------------------------------------
+
+export type EIP1193GenericRequest = {
+	readonly method: string;
+	readonly params?: readonly unknown[];
+};
+
+export interface EIP1193ProviderRpcError extends Error {
+	message: string;
+	code: number;
+	data?: unknown;
+}
+
+export interface EIP1193ProviderMessage {
+	readonly type: string;
+	readonly data: unknown;
+}
+
+export interface EIP1193EthSubscription extends EIP1193ProviderMessage {
+	readonly type: "eth_subscription";
+	readonly data: {
+		readonly subscription: string;
+		readonly result: unknown;
+	};
+}
+
+export interface EIP1193ProviderConnectInfo {
+	readonly chainId: string;
+}
+
+export type EIP1193AddChainError = {
+	// TODO
+};
+
+export type EIP1193SwitchChainError = {
+	// TODO
+};
+
+/*
+// TODO
+4001	User Rejected Request	The user rejected the request.
+4100	Unauthorized	The requested method and/or account has not been authorized by the user.
+4200	Unsupported Method	The Provider does not support the requested method.
+4900	Disconnected	The Provider is disconnected from all chains.
+4901	Chain Disconnected	The Provider is not connected to the requested chain.
+*/
+
+type Listener<Message> = (message: Message) => unknown | Promise<unknown>;
+
+export interface EIP1193Provider {
+	on(
+		eventName: "message" | "disconnect",
+		listener: Listener<EIP1193ProviderMessage | EIP1193EthSubscription>
+	): EIP1193Provider;
+	on(
+		eventName: "accountsChanged",
+		listener: Listener<string[]>
+	): EIP1193Provider;
+	on(eventName: "chainChanged", listener: Listener<string>): EIP1193Provider;
+	on(
+		eventName: "connect",
+		listener: Listener<EIP1193ProviderConnectInfo>
+	): EIP1193Provider;
+	removeListener(
+		eventName: string | symbol,
+		listener:
+			| Listener<string>
+			| Listener<string[]>
+			| Listener<
+					| EIP1193ProviderMessage
+					| EIP1193EthSubscription
+					| EIP1193ProviderConnectInfo
+			  >
+	): EIP1193Provider;
+
+	request(args: EIP1193Web3ClientVersionRequest): Promise<string>;
+	request(args: EIP1193Web3SHARequest): Promise<DATA>;
+	request(args: EIP1193NetVersionRequest): Promise<ChainId>;
+	request(args: EIP1193NetListeningRequest): Promise<boolean>;
+	request(args: EIP1193NetPeerCountRequest): Promise<QUANTITY>;
+	request(args: EIP1193ProtocolVersionRequest): Promise<string>;
+	request(args: EIP1193SyncingRequest): Promise<EIP1193SyncingStatus | false>;
+	request(args: EIP1193CoinbaseRequest): Promise<EIP1193Account>;
+	request(args: EIP1193MiningRequest): Promise<boolean>;
+	request(args: EIP1193HashrateRequest): Promise<QUANTITY>;
+	request(args: EIP1193GasPriceRequest): Promise<QUANTITY>;
+	request(args: EIP1193AccountsRequest): Promise<EIP1193Accounts>;
+	request(args: EIP1193BlockNumberRequest): Promise<QUANTITY>;
+	request(args: EIP1193GetBalanceRequest): Promise<QUANTITY>;
+	request(args: EIP1193GetStorageAtRequest): Promise<DATA>;
+	request(args: EIP1193GetTransactionCountRequest): Promise<QUANTITY>;
+	request(args: EIP1193GetTransactionCountByHashRequest): Promise<QUANTITY>;
+	request(args: EIP1193GetTransactionCountByNumberRequest): Promise<QUANTITY>;
+
+	request(args: EIP1193GetUncleCountByBlockHashRequest): Promise<QUANTITY>;
+	request(args: EIP1193GetUncleCountByBlockNumberRequest): Promise<QUANTITY>;
+	request(args: EIP1193GetCodeRequest): Promise<DATA>;
+	request(args: EIP1193LegacySignRequest): Promise<DATA>;
+	request(args: EIP1193SignTransactionRequest): Promise<DATA>;
+	request(args: EIP1193SendTransactionRequest): Promise<DATA>;
+	request(args: EIP1193SendRawTransactionRequest): Promise<DATA>;
+	request(args: EIP119CallRequest): Promise<DATA>;
+	request(args: EIP119EstimateGasRequest): Promise<QUANTITY>;
+	request(args: EIP119GetBlockByHashRequest): Promise<EIP1193Block>;
+	request(args: EIP119GetBlockByNumberRequest): Promise<EIP1193Block>;
+	request(
+		args: EIP119GetBlockByHashRequest<true>
+	): Promise<EIP1193BlockWithTransactions>;
+	request(
+		args: EIP119GetBlockByNumberRequest<true>
+	): Promise<EIP1193BlockWithTransactions>;
+	request(args: EIP119GetTransactionByHashRequest): Promise<EIP1193Transaction>;
+	request(
+		args: EIP119GetTransactionByBlockHashAndIndexRequest
+	): Promise<EIP1193Transaction>;
+	request(
+		args: EIP119GetTransactionByBlockNumberAndIndexRequest
+	): Promise<EIP1193Transaction>;
+	request(
+		args: EIP119GetTransactionReceiptRequest
+	): Promise<EIP1193TransactionReceipt>;
+	request(
+		args: EIP119GetUncleByBlockHashAndIndexRequest
+	): Promise<EIP1193Block>;
+	request(
+		args: EIP119GetUncleByBlockNumberAndIndexRequest
+	): Promise<EIP1193Block>;
+	request(args: EIP119GetLogsRequest): Promise<EIP1193Log[]>;
+	request(args: EIP1193PersonalSignRequest): Promise<DATA>;
+	request(args: EIP1193PTypedSignv4Request): Promise<DATA>;
+	request(args: EIP1193PTypedSignRequest): Promise<DATA>;
+	request(args: EIP1193ChainIdRequest): Promise<ChainId>;
+	request(args: EIP1193RequestAccountsRequest): Promise<EIP1193Accounts>;
+	request(
+		args: ERIP1193SwitchChainRequest
+	): Promise<EIP1193SwitchChainError | null>;
+	request(args: ERIP1193AddChainRequest): Promise<EIP1193AddChainError | null>;
+
+	// request(args: EIP1193GenericRequest): Promise<unknown>;
+}
+
+type BlockTag = QUANTITY | "latest" | "earliest" | "pending";
+type QUANTITY = `0x${string}`;
+type DATA = `0x${string}`;
+type ChainId = `0x${string}`;
+export type EIP1193Account = `0x${string}`;
+export type EIP1193Accounts = EIP1193Account[];

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "eip-1193",
+  "version": "0.0.1",
+  "description": "Types for EIP-1193",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "types": "index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}