eip-1193 0.1.4 → 0.2.0

package/index.d.ts

@@ -358,9 +358,29 @@ export type ERIP1193AddChainRequest = {
 	readonly params: [EIP1193AddChainParam];
 };
 
-export type EIP1193SubscribeRequest = {
+export type EIP1193OtherSubscribeRequest = {
 	readonly method: "eth_subscribe";
-	readonly params: ["newHeads"];
+	readonly params: ["newHeads" | "newPendingTransactions" | "syncing"];
+};
+
+export type EIP1193LogsSubscribeRequest = {
+	readonly method: "eth_subscribe";
+	readonly params: [
+		"logs",
+		{
+			address: EIP1193Account | EIP1193Account[];
+			topics: (EIP1193DATA[] | EIP1193DATA)[];
+		}
+	];
+};
+
+export type EIP1193SubscribeRequest =
+	| EIP1193LogsSubscribeRequest
+	| EIP1193OtherSubscribeRequest;
+
+export type EIP1193UnsubscribeRequest = {
+	readonly method: "eth_unsubscribe";
+	readonly params: [EIP1193DATA];
 };
 
 // ------------------------------------------------------------------------------------------------
@@ -409,7 +429,9 @@ export type EIP1193Request =
 	| EIP1193ChainIdRequest
 	| EIP1193RequestAccountsRequest
 	| ERIP1193SwitchChainRequest
-	| ERIP1193AddChainRequest;
+	| ERIP1193AddChainRequest
+	| EIP1193SubscribeRequest
+	| EIP1193UnsubscribeRequest;
 
 export type EIP1193GenericRequest = {
 	method: string;
@@ -422,22 +444,49 @@ export interface EIP1193ProviderRpcError extends Error {
 	data?: unknown;
 }
 
-export interface EIP1193ProviderMessage {
+export interface EIP1193ConnectInfoMessage {
+	readonly chainId: EIP1193ChainId;
+}
+
+export type EIP1193UnknownMessage = {
 	readonly type: string;
 	readonly data: unknown;
-}
+};
 
-export interface EIP1193EthSubscription extends EIP1193ProviderMessage {
+export type EIP1193UnknownSubscriptionMessage = EIP1193UnknownMessage & {
 	readonly type: "eth_subscription";
 	readonly data: {
-		readonly subscription: string;
+		readonly subscription: EIP1193DATA;
 		readonly result: unknown;
 	};
-}
+};
 
-export interface EIP1193ProviderConnectInfo {
-	readonly chainId: EIP1193ChainId;
-}
+export type EIP1193KnownSubscriptionMessage = EIP1193UnknownMessage & {
+	readonly type: "eth_subscription";
+	readonly data: {
+		readonly subscription: EIP1193DATA;
+		readonly result:
+			| EIP1193Log
+			| EIP1193Block
+			| EIP1193Transaction
+			| {
+					syncing: boolean;
+					status: {
+						startingBlock: number;
+						currentBlock: number;
+						highestBlock: number;
+						pulledStates: number;
+						knownStates: number;
+					};
+			  };
+	};
+};
+
+export type EIP1193SubscriptionMessage =
+	| EIP1193KnownSubscriptionMessage
+	| EIP1193UnknownSubscriptionMessage;
+
+export type EIP1193Message = EIP1193SubscriptionMessage | EIP1193UnknownMessage;
 
 export type EIP1193AddChainError = {
 	// TODO
@@ -528,37 +577,47 @@ export type EIP1193ProviderWithoutEvents<T = EIP1193Request> = {
 	): Promise<EIP1193SwitchChainError | null>;
 	request(args: ERIP1193AddChainRequest): Promise<EIP1193AddChainError | null>;
 	request(args: EIP1193SubscribeRequest): Promise<string>;
+	request(args: EIP1193UnsubscribeRequest): Promise<boolean>;
+
 	request(args: T): Promise<unknown>;
 	// request(args: EIP1193GenericRequest): Promise<unknown>;
 };
 
-export type EIP1193Provider<T = EIP1193Request> =
-	EIP1193ProviderWithoutEvents<T> & {
-		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;
-	};
+export interface EIP1193Provider<T = EIP1193Request>
+	extends EIP1193ProviderWithoutEvents<T> {
+	on(eventName: "message", listener: Listener<EIP1193Message>): this;
+	on(
+		eventName: "disconnect",
+		listener: Listener<EIP1193ProviderRpcError>
+	): this;
+	on(eventName: "accountsChanged", listener: Listener<EIP1193Account[]>): this;
+	on(eventName: "chainChanged", listener: Listener<EIP1193ChainId>): this;
+	on(eventName: "connect", listener: Listener<EIP1193ConnectInfoMessage>): this;
+	removeListener(
+		eventName: "message",
+		listener: Listener<EIP1193Message>
+	): this;
+	removeListener(
+		eventName: "disconnect",
+		listener: Listener<EIP1193ProviderRpcError>
+	): this;
+	removeListener(
+		eventName: "accountsChanged",
+		listener: Listener<EIP1193Account[]>
+	): this;
+	removeListener(
+		eventName: "chainChanged",
+		listener: Listener<EIP1193ChainId>
+	): this;
+	removeListener(
+		eventName: "connect",
+		listener: Listener<EIP1193ConnectInfoMessage>
+	): this;
+	// removeListener(
+	// 	eventName: string | symbol,
+	// 	listener: Listener<unknown>
+	// ): this;
+}
 
 export type EIP1193DATA = `0x${string}`;
 export type EIP1193BlockTag =

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eip-1193",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "Types for EIP-1193",
   "keywords": [],
   "author": "",