@cowprotocol/iframe-transport 2.0.8 → 2.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/IframeTransport.d.ts +11 -0
- package/iframeRpcProvider/IframeRpcProviderBridge.d.ts +45 -0
- package/iframeRpcProvider/WidgetEthereumProvider.d.ts +123 -0
- package/iframeRpcProvider/iframeRpcProviderEvents.d.ts +31 -0
- package/iframeRpcProvider/utils.d.ts +4 -0
- package/index.cjs +1 -0
- package/index.d.ts +5 -0
- package/index.js +395 -0
- package/package.json +18 -6
- package/types.d.ts +59 -0
- package/.babelrc +0 -20
- package/CHANGELOG.md +0 -151
- package/jest.config.ts +0 -11
- package/project.json +0 -42
- package/src/IframeTransport.ts +0 -73
- package/src/iframeRpcProvider/IframeRpcProviderBridge.ts +0 -192
- package/src/iframeRpcProvider/WidgetEthereumProvider.ts +0 -489
- package/src/iframeRpcProvider/iframeRpcProviderEvents.ts +0 -40
- package/src/iframeRpcProvider/utils.ts +0 -18
- package/src/index.ts +0 -5
- package/src/types.ts +0 -75
- package/tsconfig.json +0 -21
- package/tsconfig.lib.json +0 -10
- package/tsconfig.spec.json +0 -20
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { WindowListener } from './types';
|
|
2
|
+
type AbstractRecord = Record<unknown, unknown>;
|
|
3
|
+
export declare class IframeTransport<MethodsEmitPayloadMap extends AbstractRecord> {
|
|
4
|
+
readonly key: string;
|
|
5
|
+
constructor(key: string);
|
|
6
|
+
postMessageToWindow<T extends keyof MethodsEmitPayloadMap>(contentWindow: Window, method: T, payload: MethodsEmitPayloadMap[T]): void;
|
|
7
|
+
listenToMessageFromWindow<T extends keyof MethodsEmitPayloadMap>(contentWindow: Window, method: T, callback: (payload: MethodsEmitPayloadMap[T]) => void): (payload: MessageEvent<unknown>) => void;
|
|
8
|
+
stopListeningToMessageFromWindow<T extends keyof MethodsEmitPayloadMap>(contentWindow: Window, _method: T, callback: (payload: MethodsEmitPayloadMap[T]) => void): void;
|
|
9
|
+
stopListeningWindowListener(contentWindow: Window, callback: WindowListener): void;
|
|
10
|
+
}
|
|
11
|
+
export {};
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { EthereumProvider, JsonRpcRequestMessage } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* Handles JSON-RPC request coming from an iFrame by delegating to a given Ethereum provider.
|
|
4
|
+
* The result will be passed back to the iFrame.
|
|
5
|
+
*
|
|
6
|
+
* Additionally, it will forward some special events from the wallet, to the iFrame window, for example connect/disconnect/chainChanged
|
|
7
|
+
*/
|
|
8
|
+
export declare class IframeRpcProviderBridge {
|
|
9
|
+
private iframeWidow;
|
|
10
|
+
/**
|
|
11
|
+
* The Ethereum provider instance.
|
|
12
|
+
* When is null the JSON-RPC bridge is disconnected from the Ethereum provider.
|
|
13
|
+
* */
|
|
14
|
+
private ethereumProvider;
|
|
15
|
+
/** Stored JSON-RPC requests, to queue them when disconnected. */
|
|
16
|
+
private requestWaitingForConnection;
|
|
17
|
+
/**
|
|
18
|
+
* Creates an instance of IframeRpcProviderBridge.
|
|
19
|
+
* @param iframeWidow - The iFrame window that will post up general RPC messages and to which the IframeRpcProviderBridge will forward the RPC result.
|
|
20
|
+
* Also it will receive some special RPC events coming from the wallet, like connect/chainChanged,accountChanged
|
|
21
|
+
*/
|
|
22
|
+
constructor(iframeWidow: Window);
|
|
23
|
+
/**
|
|
24
|
+
* Disconnects the JSON-RPC bridge from the Ethereum provider.
|
|
25
|
+
*/
|
|
26
|
+
disconnect(): void;
|
|
27
|
+
/**
|
|
28
|
+
* Handles the 'connect' event and sets up event listeners for Ethereum provider events.
|
|
29
|
+
* @param newProvider - The Ethereum provider to connect.
|
|
30
|
+
*/
|
|
31
|
+
onConnect(newProvider: EthereumProvider): void;
|
|
32
|
+
private processPendingRequests;
|
|
33
|
+
/**
|
|
34
|
+
* Processes a JSON-RPC request and sends appropriate response or error via the content window.
|
|
35
|
+
* @param request - The JSON-RPC request to be processed.
|
|
36
|
+
*/
|
|
37
|
+
processRpcRequest(request: JsonRpcRequestMessage): void;
|
|
38
|
+
private processRpcCallFromWindow;
|
|
39
|
+
private processProviderMetaInfoRequest;
|
|
40
|
+
private onProviderEvent;
|
|
41
|
+
/**
|
|
42
|
+
* Forward a JSON-RPC message to the content window.
|
|
43
|
+
*/
|
|
44
|
+
private forwardRpcResponseToIframe;
|
|
45
|
+
}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { default as EventEmitter } from 'eventemitter3';
|
|
2
|
+
import { ProviderMetaInfoPayload } from './iframeRpcProviderEvents';
|
|
3
|
+
import { JsonRpcRequest } from '../types';
|
|
4
|
+
interface ProviderConnectInfo {
|
|
5
|
+
readonly chainId: string;
|
|
6
|
+
}
|
|
7
|
+
interface ProviderMessage {
|
|
8
|
+
type: string;
|
|
9
|
+
data: unknown;
|
|
10
|
+
}
|
|
11
|
+
interface ProviderRpcError extends Error {
|
|
12
|
+
message: string;
|
|
13
|
+
code: number;
|
|
14
|
+
data?: unknown;
|
|
15
|
+
}
|
|
16
|
+
type RpcCallback = (error: any, response: any) => void;
|
|
17
|
+
/**
|
|
18
|
+
* Export the type information about the different events that are emitted.
|
|
19
|
+
*/
|
|
20
|
+
export interface IFrameEthereumProviderEvents {
|
|
21
|
+
on(event: 'message', handler: (message: ProviderMessage) => void): this;
|
|
22
|
+
on(event: 'connect', handler: (connectInfo: ProviderConnectInfo) => void): this;
|
|
23
|
+
on(event: 'disconnect', handler: (error: ProviderRpcError) => void): this;
|
|
24
|
+
on(event: 'close', handler: (code: number, reason: string) => void): this;
|
|
25
|
+
on(event: 'notification', handler: (result: any) => void): this;
|
|
26
|
+
on(event: 'chainChanged', handler: (chainId: string) => void): this;
|
|
27
|
+
on(event: 'networkChanged', handler: (networkId: string) => void): this;
|
|
28
|
+
on(event: 'accountsChanged', handler: (accounts: string[]) => void): this;
|
|
29
|
+
}
|
|
30
|
+
export type IFrameEthereumProviderEventTypes = 'message' | 'connect' | 'disconnect' | 'chainChanged' | 'close' | 'notification' | 'networkChanged' | 'accountsChanged';
|
|
31
|
+
/**
|
|
32
|
+
* Options for constructing the iframe ethereum provider.
|
|
33
|
+
*/
|
|
34
|
+
interface IFrameEthereumProviderOptions {
|
|
35
|
+
targetOrigin?: string;
|
|
36
|
+
timeoutMilliseconds?: number;
|
|
37
|
+
eventSource?: Window;
|
|
38
|
+
eventTarget?: Window;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Represents an error in an RPC returned from the event source. Always contains a code and a reason. The message
|
|
42
|
+
* is constructed from both.
|
|
43
|
+
*/
|
|
44
|
+
export declare class RpcError extends Error {
|
|
45
|
+
readonly isRpcError = true;
|
|
46
|
+
readonly code: number;
|
|
47
|
+
readonly reason: string;
|
|
48
|
+
constructor(code: number, reason: string);
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* This is the primary artifact of this library.
|
|
52
|
+
*/
|
|
53
|
+
export declare class WidgetEthereumProvider extends EventEmitter<IFrameEthereumProviderEventTypes> {
|
|
54
|
+
request({ method, params }: JsonRpcRequest): Promise<any>;
|
|
55
|
+
isConnected(): true;
|
|
56
|
+
/**
|
|
57
|
+
* Differentiate this provider from other providers by providing an isIFrame property that always returns true.
|
|
58
|
+
*/
|
|
59
|
+
get isIFrame(): true;
|
|
60
|
+
/**
|
|
61
|
+
* Always return this for currentProvider.
|
|
62
|
+
*/
|
|
63
|
+
get currentProvider(): WidgetEthereumProvider;
|
|
64
|
+
private enabled;
|
|
65
|
+
private readonly timeoutMilliseconds;
|
|
66
|
+
private readonly eventSource;
|
|
67
|
+
private readonly eventTarget;
|
|
68
|
+
private readonly completers;
|
|
69
|
+
private providerMetaInfo;
|
|
70
|
+
private providerMetaInfoCallback?;
|
|
71
|
+
constructor({ timeoutMilliseconds, eventSource, eventTarget, }?: IFrameEthereumProviderOptions);
|
|
72
|
+
/**
|
|
73
|
+
* Helper method that handles transport and request wrapping
|
|
74
|
+
* @param method method to execute
|
|
75
|
+
* @param params params to pass the method
|
|
76
|
+
*/
|
|
77
|
+
private execute;
|
|
78
|
+
/**
|
|
79
|
+
* Send the JSON RPC and return the result.
|
|
80
|
+
*/
|
|
81
|
+
send<TResult = any>(request: JsonRpcRequest, callback: RpcCallback): Promise<TResult>;
|
|
82
|
+
send<TResult = any>(method: string, params: unknown[] | undefined): Promise<TResult>;
|
|
83
|
+
/**
|
|
84
|
+
* Request the parent window to enable access to the user's web3 provider. Return accounts list immediately if already enabled.
|
|
85
|
+
* Keep the legacy method for backward compatibility.
|
|
86
|
+
*/
|
|
87
|
+
enable(): Promise<string[]>;
|
|
88
|
+
/**
|
|
89
|
+
* Backwards compatibility method for web3.
|
|
90
|
+
* @param payload payload to send to the provider
|
|
91
|
+
* @param callback callback to be called when the provider resolves
|
|
92
|
+
*/
|
|
93
|
+
sendAsync(payload: JsonRpcRequest, callback: (error: string | null, result: {
|
|
94
|
+
method: string;
|
|
95
|
+
params?: unknown[];
|
|
96
|
+
result: unknown;
|
|
97
|
+
} | unknown) => void): Promise<void>;
|
|
98
|
+
/**
|
|
99
|
+
* Subscribe to provider meta info
|
|
100
|
+
* @param callback
|
|
101
|
+
*/
|
|
102
|
+
onProviderMetaInfo(callback: (data: ProviderMetaInfoPayload) => void): void;
|
|
103
|
+
/**
|
|
104
|
+
* Handle a Rpc Request
|
|
105
|
+
*/
|
|
106
|
+
private handleRpcRequests;
|
|
107
|
+
private handleOnEvent;
|
|
108
|
+
private emitNotification;
|
|
109
|
+
private emitConnect;
|
|
110
|
+
/**
|
|
111
|
+
* @deprecated See https://eips.ethereum.org/EIPS/eip-1193
|
|
112
|
+
*/
|
|
113
|
+
private emitClose;
|
|
114
|
+
private emitDisconnect;
|
|
115
|
+
private emitChainChanged;
|
|
116
|
+
/**
|
|
117
|
+
* @deprecated See https://eips.ethereum.org/EIPS/eip-1193
|
|
118
|
+
*/
|
|
119
|
+
private emitNetworkChanged;
|
|
120
|
+
private emitAccountsChanged;
|
|
121
|
+
private emitMessage;
|
|
122
|
+
}
|
|
123
|
+
export {};
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { IframeTransport } from '../IframeTransport';
|
|
2
|
+
import { EIP6963ProviderInfo, JsonRpcRequestMessage, JsonRpcResponse, ProviderWcMetadata } from '../types';
|
|
3
|
+
export interface ProviderRpcRequestPayload {
|
|
4
|
+
rpcRequest: JsonRpcRequestMessage;
|
|
5
|
+
}
|
|
6
|
+
export type ProviderRpcResponsePayload = {
|
|
7
|
+
rpcResponse: JsonRpcResponse;
|
|
8
|
+
};
|
|
9
|
+
export interface ProviderOnEventPayload {
|
|
10
|
+
event: string;
|
|
11
|
+
params: unknown;
|
|
12
|
+
}
|
|
13
|
+
export interface ProviderMetaInfoPayload {
|
|
14
|
+
providerEip6963Info?: EIP6963ProviderInfo;
|
|
15
|
+
providerWcMetadata?: ProviderWcMetadata;
|
|
16
|
+
}
|
|
17
|
+
export declare enum IframeRpcProviderEvents {
|
|
18
|
+
PROVIDER_RPC_REQUEST = "PROVIDER_RPC_REQUEST",
|
|
19
|
+
PROVIDER_RPC_RESPONSE = "PROVIDER_RPC_RESPONSE",
|
|
20
|
+
PROVIDER_ON_EVENT = "PROVIDER_ON_EVENT",
|
|
21
|
+
SEND_PROVIDER_META_INFO = "SEND_PROVIDER_META_INFO",
|
|
22
|
+
REQUEST_PROVIDER_META_INFO = "REQUEST_PROVIDER_META_INFO"
|
|
23
|
+
}
|
|
24
|
+
export interface IframeEventsPayloadMap {
|
|
25
|
+
[IframeRpcProviderEvents.PROVIDER_RPC_REQUEST]: ProviderRpcRequestPayload;
|
|
26
|
+
[IframeRpcProviderEvents.PROVIDER_RPC_RESPONSE]: ProviderRpcResponsePayload;
|
|
27
|
+
[IframeRpcProviderEvents.PROVIDER_ON_EVENT]: ProviderOnEventPayload;
|
|
28
|
+
[IframeRpcProviderEvents.SEND_PROVIDER_META_INFO]: ProviderMetaInfoPayload;
|
|
29
|
+
[IframeRpcProviderEvents.REQUEST_PROVIDER_META_INFO]: null;
|
|
30
|
+
}
|
|
31
|
+
export declare const iframeRpcProviderTransport: IframeTransport<IframeEventsPayloadMap>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { EIP6963ProviderDetail } from '@cowprotocol/types';
|
|
2
|
+
import { EIP6963ProviderInfo, ProviderWcMetadata } from '../types';
|
|
3
|
+
export declare function getProviderWcMetadata(provider: any): ProviderWcMetadata | undefined;
|
|
4
|
+
export declare function getEip6963ProviderInfo(provider: unknown, eip6963Providers: EIP6963ProviderDetail[]): EIP6963ProviderInfo | undefined;
|
package/index.cjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const m=require("eventemitter3");class d{constructor(e){this.key=e}postMessageToWindow(e,t,s){const r=typeof s=="object"?s:{},n={key:this.key,method:t,...r};e.postMessage(n,"*")}listenToMessageFromWindow(e,t,s){const r=n=>{!l(n.data)||n.data.key!==this.key||n.data.method!==t||s(n.data)};return e.addEventListener("message",r),r}stopListeningToMessageFromWindow(e,t,s){e.removeEventListener("message",s)}stopListeningWindowListener(e,t){e.removeEventListener("message",t)}}function l(i){return typeof i=="object"&&i!==null&&"key"in i&&"method"in i&&typeof i.key=="string"&&typeof i.method=="string"}var o=(i=>(i.PROVIDER_RPC_REQUEST="PROVIDER_RPC_REQUEST",i.PROVIDER_RPC_RESPONSE="PROVIDER_RPC_RESPONSE",i.PROVIDER_ON_EVENT="PROVIDER_ON_EVENT",i.SEND_PROVIDER_META_INFO="SEND_PROVIDER_META_INFO",i.REQUEST_PROVIDER_META_INFO="REQUEST_PROVIDER_META_INFO",i))(o||{});const a=new d("cowSwapIframeRpcProviderTransport");function E(i){if(i.isWalletConnect)return i?.session?.peer?.metadata}function R(i,e){return e.find(t=>t.provider===i)?.info}const f=["connect","disconnect","close","chainChanged","accountsChanged"],h=[];typeof window<"u"&&window.addEventListener("eip6963:announceProvider",i=>{const e=i;h.push(e.detail)});class p{constructor(e){this.iframeWidow=e}ethereumProvider=null;requestWaitingForConnection={};disconnect(){typeof window>"u"||(this.ethereumProvider=null,a.stopListeningToMessageFromWindow(window,o.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),a.stopListeningToMessageFromWindow(window,o.REQUEST_PROVIDER_META_INFO,this.processProviderMetaInfoRequest))}onConnect(e){typeof window>"u"||(this.ethereumProvider?this.disconnect():a.listenToMessageFromWindow(window,o.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),this.ethereumProvider=e,this.processPendingRequests(),f.forEach(t=>{e.on(t,s=>this.onProviderEvent(t,s))}),a.listenToMessageFromWindow(window,o.REQUEST_PROVIDER_META_INFO,this.processProviderMetaInfoRequest))}processPendingRequests(){Object.keys(this.requestWaitingForConnection).forEach(e=>{this.processRpcRequest(this.requestWaitingForConnection[e])}),this.requestWaitingForConnection={}}processRpcRequest(e){const{id:t,jsonrpc:s,method:r}=e;if(!this.ethereumProvider||!t)return;(r==="enable"?this.ethereumProvider.request({method:"eth_requestAccounts",id:t}):this.ethereumProvider.request({...e,id:t})).then(c=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:s,id:t,result:c}})).catch(c=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:s,id:t,error:c}}))}processRpcCallFromWindow=({rpcRequest:e})=>{if(!this.ethereumProvider){e.id&&(this.requestWaitingForConnection[e.id]=e);return}this.processRpcRequest(e)};processProviderMetaInfoRequest=()=>{if(!this.ethereumProvider)return;const e=R(this.ethereumProvider,h),t=E(this.ethereumProvider);a.postMessageToWindow(this.iframeWidow,o.SEND_PROVIDER_META_INFO,{providerEip6963Info:e,providerWcMetadata:t})};onProviderEvent(e,t){a.postMessageToWindow(this.iframeWidow,o.PROVIDER_ON_EVENT,{event:e,params:t})}forwardRpcResponseToIframe(e){a.postMessageToWindow(this.iframeWidow,o.PROVIDER_RPC_RESPONSE,e)}}const g=6e5,P="2.0";class _ extends Error{isRpcError=!0;code;reason;constructor(e,t){super(`${e}: ${t}`),this.code=e,this.reason=t}}class v extends m{request({method:e,params:t}){return this.send(e,t)}isConnected(){return!0}get isIFrame(){return!0}get currentProvider(){return this}enabled=null;timeoutMilliseconds;eventSource;eventTarget;completers={};providerMetaInfo=null;providerMetaInfoCallback;constructor({timeoutMilliseconds:e=g,eventSource:t=window,eventTarget:s=window.parent}={}){super(),this.timeoutMilliseconds=e,this.eventSource=t,this.eventTarget=s,a.listenToMessageFromWindow(this.eventSource,o.PROVIDER_RPC_RESPONSE,r=>{this.handleRpcRequests(r)}),a.listenToMessageFromWindow(this.eventSource,o.PROVIDER_ON_EVENT,r=>{this.handleOnEvent(r)}),a.listenToMessageFromWindow(this.eventSource,o.SEND_PROVIDER_META_INFO,r=>{this.providerMetaInfo=r,this.providerMetaInfoCallback&&this.providerMetaInfoCallback(this.providerMetaInfo)})}async execute(e,t){const s=w(),r={jsonrpc:P,id:s,method:e,params:t},n=new Promise((c,u)=>this.completers[s]={resolve:c,reject:u});return a.postMessageToWindow(this.eventTarget,o.PROVIDER_RPC_REQUEST,{rpcRequest:r}),setTimeout(()=>{this.completers[s]&&(this.completers[s].reject(new Error("Request timed out. Please try again and submit it faster.")),delete this.completers[s])},this.timeoutMilliseconds),n}async send(e,t){const{method:s,params:r}=typeof e=="string"?{method:e,params:t}:{method:e.method,params:e.params},n=await this.execute(s,r);if("error"in n)throw new _(n.error.code,n.error.message);return n.result}async enable(){if(this.enabled===null){const e=this.enabled=this.send("eth_requestAccounts",[]).catch(t=>{throw this.enabled===e&&(this.enabled=null),t})}return this.enabled}async sendAsync(e,t){try{const s=await this.execute(e.method,e.params);t(null,s)}catch(s){t(I(s),null)}}onProviderMetaInfo(e){this.providerMetaInfo?e(this.providerMetaInfo):(this.providerMetaInfoCallback=e,a.postMessageToWindow(this.eventTarget,o.REQUEST_PROVIDER_META_INFO,null))}handleRpcRequests=({rpcResponse:e})=>{if(e.id===void 0||e.id===null)return;const t=this.completers[""+e.id];t&&("error"in e||"result"in e?t.resolve(e):t.reject(new Error("Response from provider did not have error or result key")),delete this.completers[e.id])};handleOnEvent(e){const t=e.params;switch(e.event){case"notification":this.emitNotification(t);break;case"connect":this.emitConnect(t);break;case"disconnect":this.emitDisconnect(t);break;case"chainChanged":this.emitChainChanged(t);break;case"accountsChanged":this.emitAccountsChanged(t);break;case"message":this.emitMessage(t);break;case"networkChanged":this.emitNetworkChanged(t);break;case"close":this.emitClose(t);break;default:console.warn(`[WidgetEthereumProvider] Unknown event type: ${e.event}`);break}}emitNotification(e){this.emit("notification",e)}emitConnect(e){this.enabled===null&&(this.enabled=Promise.resolve([])),this.emit("connect",e)}emitClose(e){Array.isArray(e)&&e.length===2?this.emit("close",e[0],e[1]):this.emit("close")}emitDisconnect(e){this.emit("disconnect",e)}emitChainChanged(e){this.emit("chainChanged",e)}emitNetworkChanged(e){this.emit("networkChanged",e)}emitAccountsChanged(e){this.enabled=Promise.resolve(e),this.emit("accountsChanged",e)}emitMessage(e){this.emit("message",e)}}function w(){return Math.floor(Math.random()*Number.MAX_SAFE_INTEGER)}function I(i){if(!i)return null;if(typeof i=="string")return i;if(i instanceof Error||i.message)return i.message;try{return JSON.stringify(i)}catch{const e="Unknown WidgetEthereumProvider error";return console.error(e,i),e}}exports.IframeRpcProviderBridge=p;exports.IframeRpcProviderEvents=o;exports.IframeTransport=d;exports.WidgetEthereumProvider=v;exports.iframeRpcProviderTransport=a;
|
package/index.d.ts
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { IframeRpcProviderBridge } from './iframeRpcProvider/IframeRpcProviderBridge';
|
|
2
|
+
export { WidgetEthereumProvider } from './iframeRpcProvider/WidgetEthereumProvider';
|
|
3
|
+
export { IframeTransport } from './IframeTransport';
|
|
4
|
+
export * from './iframeRpcProvider/iframeRpcProviderEvents';
|
|
5
|
+
export * from './types';
|
package/index.js
ADDED
|
@@ -0,0 +1,395 @@
|
|
|
1
|
+
import u from "eventemitter3";
|
|
2
|
+
class m {
|
|
3
|
+
constructor(e) {
|
|
4
|
+
this.key = e;
|
|
5
|
+
}
|
|
6
|
+
postMessageToWindow(e, t, i) {
|
|
7
|
+
const n = typeof i == "object" ? i : {}, o = {
|
|
8
|
+
key: this.key,
|
|
9
|
+
method: t,
|
|
10
|
+
...n
|
|
11
|
+
};
|
|
12
|
+
e.postMessage(
|
|
13
|
+
o,
|
|
14
|
+
"*"
|
|
15
|
+
// TODO: Change to CoW specific origin in production. https://github.com/cowprotocol/cowswap/issues/3828
|
|
16
|
+
);
|
|
17
|
+
}
|
|
18
|
+
listenToMessageFromWindow(e, t, i) {
|
|
19
|
+
const n = (o) => {
|
|
20
|
+
!l(o.data) || o.data.key !== this.key || o.data.method !== t || i(o.data);
|
|
21
|
+
};
|
|
22
|
+
return e.addEventListener("message", n), n;
|
|
23
|
+
}
|
|
24
|
+
stopListeningToMessageFromWindow(e, t, i) {
|
|
25
|
+
e.removeEventListener("message", i);
|
|
26
|
+
}
|
|
27
|
+
stopListeningWindowListener(e, t) {
|
|
28
|
+
e.removeEventListener("message", t);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
function l(s) {
|
|
32
|
+
return typeof s == "object" && s !== null && "key" in s && "method" in s && typeof s.key == "string" && typeof s.method == "string";
|
|
33
|
+
}
|
|
34
|
+
var r = /* @__PURE__ */ ((s) => (s.PROVIDER_RPC_REQUEST = "PROVIDER_RPC_REQUEST", s.PROVIDER_RPC_RESPONSE = "PROVIDER_RPC_RESPONSE", s.PROVIDER_ON_EVENT = "PROVIDER_ON_EVENT", s.SEND_PROVIDER_META_INFO = "SEND_PROVIDER_META_INFO", s.REQUEST_PROVIDER_META_INFO = "REQUEST_PROVIDER_META_INFO", s))(r || {});
|
|
35
|
+
const a = new m("cowSwapIframeRpcProviderTransport");
|
|
36
|
+
function E(s) {
|
|
37
|
+
if (s.isWalletConnect)
|
|
38
|
+
return s?.session?.peer?.metadata;
|
|
39
|
+
}
|
|
40
|
+
function R(s, e) {
|
|
41
|
+
return e.find((t) => t.provider === s)?.info;
|
|
42
|
+
}
|
|
43
|
+
const f = ["connect", "disconnect", "close", "chainChanged", "accountsChanged"], d = [];
|
|
44
|
+
typeof window < "u" && window.addEventListener("eip6963:announceProvider", (s) => {
|
|
45
|
+
const e = s;
|
|
46
|
+
d.push(e.detail);
|
|
47
|
+
});
|
|
48
|
+
class I {
|
|
49
|
+
/**
|
|
50
|
+
* Creates an instance of IframeRpcProviderBridge.
|
|
51
|
+
* @param iframeWidow - The iFrame window that will post up general RPC messages and to which the IframeRpcProviderBridge will forward the RPC result.
|
|
52
|
+
* Also it will receive some special RPC events coming from the wallet, like connect/chainChanged,accountChanged
|
|
53
|
+
*/
|
|
54
|
+
constructor(e) {
|
|
55
|
+
this.iframeWidow = e;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* The Ethereum provider instance.
|
|
59
|
+
* When is null the JSON-RPC bridge is disconnected from the Ethereum provider.
|
|
60
|
+
* */
|
|
61
|
+
ethereumProvider = null;
|
|
62
|
+
/** Stored JSON-RPC requests, to queue them when disconnected. */
|
|
63
|
+
requestWaitingForConnection = {};
|
|
64
|
+
/**
|
|
65
|
+
* Disconnects the JSON-RPC bridge from the Ethereum provider.
|
|
66
|
+
*/
|
|
67
|
+
disconnect() {
|
|
68
|
+
typeof window > "u" || (this.ethereumProvider = null, a.stopListeningToMessageFromWindow(window, r.PROVIDER_RPC_REQUEST, this.processRpcCallFromWindow), a.stopListeningToMessageFromWindow(window, r.REQUEST_PROVIDER_META_INFO, this.processProviderMetaInfoRequest));
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Handles the 'connect' event and sets up event listeners for Ethereum provider events.
|
|
72
|
+
* @param newProvider - The Ethereum provider to connect.
|
|
73
|
+
*/
|
|
74
|
+
onConnect(e) {
|
|
75
|
+
typeof window > "u" || (this.ethereumProvider ? this.disconnect() : a.listenToMessageFromWindow(window, r.PROVIDER_RPC_REQUEST, this.processRpcCallFromWindow), this.ethereumProvider = e, this.processPendingRequests(), f.forEach((t) => {
|
|
76
|
+
e.on(t, (i) => this.onProviderEvent(t, i));
|
|
77
|
+
}), a.listenToMessageFromWindow(window, r.REQUEST_PROVIDER_META_INFO, this.processProviderMetaInfoRequest));
|
|
78
|
+
}
|
|
79
|
+
// TODO: Add proper return type annotation
|
|
80
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
81
|
+
processPendingRequests() {
|
|
82
|
+
Object.keys(this.requestWaitingForConnection).forEach((e) => {
|
|
83
|
+
this.processRpcRequest(this.requestWaitingForConnection[e]);
|
|
84
|
+
}), this.requestWaitingForConnection = {};
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Processes a JSON-RPC request and sends appropriate response or error via the content window.
|
|
88
|
+
* @param request - The JSON-RPC request to be processed.
|
|
89
|
+
*/
|
|
90
|
+
// TODO: Add proper return type annotation
|
|
91
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
92
|
+
processRpcRequest(e) {
|
|
93
|
+
const {
|
|
94
|
+
id: t,
|
|
95
|
+
jsonrpc: i,
|
|
96
|
+
method: n
|
|
97
|
+
} = e;
|
|
98
|
+
if (!this.ethereumProvider || !t)
|
|
99
|
+
return;
|
|
100
|
+
// Keep the legacy "enable" method for backward compatibility
|
|
101
|
+
(n === "enable" ? this.ethereumProvider.request({
|
|
102
|
+
method: "eth_requestAccounts",
|
|
103
|
+
id: t
|
|
104
|
+
}) : this.ethereumProvider.request({
|
|
105
|
+
...e,
|
|
106
|
+
id: t
|
|
107
|
+
})).then((c) => this.forwardRpcResponseToIframe({
|
|
108
|
+
rpcResponse: {
|
|
109
|
+
jsonrpc: i,
|
|
110
|
+
id: t,
|
|
111
|
+
result: c
|
|
112
|
+
}
|
|
113
|
+
})).catch((c) => this.forwardRpcResponseToIframe({
|
|
114
|
+
rpcResponse: {
|
|
115
|
+
jsonrpc: i,
|
|
116
|
+
id: t,
|
|
117
|
+
error: c
|
|
118
|
+
}
|
|
119
|
+
}));
|
|
120
|
+
}
|
|
121
|
+
processRpcCallFromWindow = ({
|
|
122
|
+
rpcRequest: e
|
|
123
|
+
}) => {
|
|
124
|
+
if (!this.ethereumProvider) {
|
|
125
|
+
e.id && (this.requestWaitingForConnection[e.id] = e);
|
|
126
|
+
return;
|
|
127
|
+
}
|
|
128
|
+
this.processRpcRequest(e);
|
|
129
|
+
};
|
|
130
|
+
processProviderMetaInfoRequest = () => {
|
|
131
|
+
if (!this.ethereumProvider) return;
|
|
132
|
+
const e = R(this.ethereumProvider, d), t = E(this.ethereumProvider);
|
|
133
|
+
a.postMessageToWindow(this.iframeWidow, r.SEND_PROVIDER_META_INFO, {
|
|
134
|
+
providerEip6963Info: e,
|
|
135
|
+
providerWcMetadata: t
|
|
136
|
+
});
|
|
137
|
+
};
|
|
138
|
+
onProviderEvent(e, t) {
|
|
139
|
+
a.postMessageToWindow(this.iframeWidow, r.PROVIDER_ON_EVENT, {
|
|
140
|
+
event: e,
|
|
141
|
+
params: t
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Forward a JSON-RPC message to the content window.
|
|
146
|
+
*/
|
|
147
|
+
// TODO: Add proper return type annotation
|
|
148
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
149
|
+
forwardRpcResponseToIframe(e) {
|
|
150
|
+
a.postMessageToWindow(this.iframeWidow, r.PROVIDER_RPC_RESPONSE, e);
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
const p = 6e5, g = "2.0";
|
|
154
|
+
class P extends Error {
|
|
155
|
+
isRpcError = !0;
|
|
156
|
+
code;
|
|
157
|
+
reason;
|
|
158
|
+
constructor(e, t) {
|
|
159
|
+
super(`${e}: ${t}`), this.code = e, this.reason = t;
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
class T extends u {
|
|
163
|
+
// TODO: Add proper return type annotation
|
|
164
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
165
|
+
request({
|
|
166
|
+
method: e,
|
|
167
|
+
params: t
|
|
168
|
+
}) {
|
|
169
|
+
return this.send(e, t);
|
|
170
|
+
}
|
|
171
|
+
isConnected() {
|
|
172
|
+
return !0;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Differentiate this provider from other providers by providing an isIFrame property that always returns true.
|
|
176
|
+
*/
|
|
177
|
+
get isIFrame() {
|
|
178
|
+
return !0;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Always return this for currentProvider.
|
|
182
|
+
*/
|
|
183
|
+
get currentProvider() {
|
|
184
|
+
return this;
|
|
185
|
+
}
|
|
186
|
+
enabled = null;
|
|
187
|
+
timeoutMilliseconds;
|
|
188
|
+
eventSource;
|
|
189
|
+
eventTarget;
|
|
190
|
+
completers = {};
|
|
191
|
+
providerMetaInfo = null;
|
|
192
|
+
providerMetaInfoCallback;
|
|
193
|
+
constructor({
|
|
194
|
+
timeoutMilliseconds: e = p,
|
|
195
|
+
eventSource: t = window,
|
|
196
|
+
eventTarget: i = window.parent
|
|
197
|
+
} = {}) {
|
|
198
|
+
super(), this.timeoutMilliseconds = e, this.eventSource = t, this.eventTarget = i, a.listenToMessageFromWindow(this.eventSource, r.PROVIDER_RPC_RESPONSE, (n) => {
|
|
199
|
+
this.handleRpcRequests(n);
|
|
200
|
+
}), a.listenToMessageFromWindow(this.eventSource, r.PROVIDER_ON_EVENT, (n) => {
|
|
201
|
+
this.handleOnEvent(n);
|
|
202
|
+
}), a.listenToMessageFromWindow(this.eventSource, r.SEND_PROVIDER_META_INFO, (n) => {
|
|
203
|
+
this.providerMetaInfo = n, this.providerMetaInfoCallback && this.providerMetaInfoCallback(this.providerMetaInfo);
|
|
204
|
+
});
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* Helper method that handles transport and request wrapping
|
|
208
|
+
* @param method method to execute
|
|
209
|
+
* @param params params to pass the method
|
|
210
|
+
*/
|
|
211
|
+
async execute(e, t) {
|
|
212
|
+
const i = _(), n = {
|
|
213
|
+
jsonrpc: g,
|
|
214
|
+
id: i,
|
|
215
|
+
method: e,
|
|
216
|
+
params: t
|
|
217
|
+
}, o = new Promise((c, h) => this.completers[i] = {
|
|
218
|
+
resolve: c,
|
|
219
|
+
reject: h
|
|
220
|
+
});
|
|
221
|
+
return a.postMessageToWindow(this.eventTarget, r.PROVIDER_RPC_REQUEST, {
|
|
222
|
+
rpcRequest: n
|
|
223
|
+
}), setTimeout(() => {
|
|
224
|
+
this.completers[i] && (this.completers[i].reject(new Error("Request timed out. Please try again and submit it faster.")), delete this.completers[i]);
|
|
225
|
+
}, this.timeoutMilliseconds), o;
|
|
226
|
+
}
|
|
227
|
+
// TODO: Replace any with proper type definitions
|
|
228
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
229
|
+
async send(e, t) {
|
|
230
|
+
const {
|
|
231
|
+
method: i,
|
|
232
|
+
params: n
|
|
233
|
+
} = typeof e == "string" ? {
|
|
234
|
+
method: e,
|
|
235
|
+
params: t
|
|
236
|
+
} : {
|
|
237
|
+
method: e.method,
|
|
238
|
+
params: e.params
|
|
239
|
+
}, o = await this.execute(i, n);
|
|
240
|
+
if ("error" in o)
|
|
241
|
+
throw new P(o.error.code, o.error.message);
|
|
242
|
+
return o.result;
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* Request the parent window to enable access to the user's web3 provider. Return accounts list immediately if already enabled.
|
|
246
|
+
* Keep the legacy method for backward compatibility.
|
|
247
|
+
*/
|
|
248
|
+
async enable() {
|
|
249
|
+
if (this.enabled === null) {
|
|
250
|
+
const e = this.enabled = this.send("eth_requestAccounts", []).catch((t) => {
|
|
251
|
+
throw this.enabled === e && (this.enabled = null), t;
|
|
252
|
+
});
|
|
253
|
+
}
|
|
254
|
+
return this.enabled;
|
|
255
|
+
}
|
|
256
|
+
/**
|
|
257
|
+
* Backwards compatibility method for web3.
|
|
258
|
+
* @param payload payload to send to the provider
|
|
259
|
+
* @param callback callback to be called when the provider resolves
|
|
260
|
+
*/
|
|
261
|
+
async sendAsync(e, t) {
|
|
262
|
+
try {
|
|
263
|
+
const i = await this.execute(e.method, e.params);
|
|
264
|
+
t(null, i);
|
|
265
|
+
} catch (i) {
|
|
266
|
+
t(w(i), null);
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
/**
|
|
270
|
+
* Subscribe to provider meta info
|
|
271
|
+
* @param callback
|
|
272
|
+
*/
|
|
273
|
+
// TODO: Add proper return type annotation
|
|
274
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
275
|
+
onProviderMetaInfo(e) {
|
|
276
|
+
this.providerMetaInfo ? e(this.providerMetaInfo) : (this.providerMetaInfoCallback = e, a.postMessageToWindow(this.eventTarget, r.REQUEST_PROVIDER_META_INFO, null));
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* Handle a Rpc Request
|
|
280
|
+
*/
|
|
281
|
+
// TODO: Add proper return type annotation
|
|
282
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
283
|
+
handleRpcRequests = ({
|
|
284
|
+
rpcResponse: e
|
|
285
|
+
}) => {
|
|
286
|
+
if (e.id === void 0 || e.id === null)
|
|
287
|
+
return;
|
|
288
|
+
const t = this.completers["" + e.id];
|
|
289
|
+
t && ("error" in e || "result" in e ? t.resolve(e) : t.reject(new Error("Response from provider did not have error or result key")), delete this.completers[e.id]);
|
|
290
|
+
};
|
|
291
|
+
// TODO: Add proper return type annotation
|
|
292
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
293
|
+
handleOnEvent(e) {
|
|
294
|
+
const t = e.params;
|
|
295
|
+
switch (e.event) {
|
|
296
|
+
case "notification":
|
|
297
|
+
this.emitNotification(t);
|
|
298
|
+
break;
|
|
299
|
+
case "connect":
|
|
300
|
+
this.emitConnect(t);
|
|
301
|
+
break;
|
|
302
|
+
case "disconnect":
|
|
303
|
+
this.emitDisconnect(t);
|
|
304
|
+
break;
|
|
305
|
+
case "chainChanged":
|
|
306
|
+
this.emitChainChanged(t);
|
|
307
|
+
break;
|
|
308
|
+
case "accountsChanged":
|
|
309
|
+
this.emitAccountsChanged(t);
|
|
310
|
+
break;
|
|
311
|
+
case "message":
|
|
312
|
+
this.emitMessage(t);
|
|
313
|
+
break;
|
|
314
|
+
// Deprecated events below 👇 --------------------------------------
|
|
315
|
+
case "networkChanged":
|
|
316
|
+
this.emitNetworkChanged(t);
|
|
317
|
+
break;
|
|
318
|
+
case "close":
|
|
319
|
+
this.emitClose(t);
|
|
320
|
+
break;
|
|
321
|
+
// END OF: Deprecated events --------------------------------------
|
|
322
|
+
default:
|
|
323
|
+
console.warn(`[WidgetEthereumProvider] Unknown event type: ${e.event}`);
|
|
324
|
+
break;
|
|
325
|
+
}
|
|
326
|
+
}
|
|
327
|
+
// TODO: Add proper return type annotation
|
|
328
|
+
// TODO: Replace any with proper type definitions
|
|
329
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type, @typescript-eslint/no-explicit-any
|
|
330
|
+
emitNotification(e) {
|
|
331
|
+
this.emit("notification", e);
|
|
332
|
+
}
|
|
333
|
+
// TODO: Add proper return type annotation
|
|
334
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
335
|
+
emitConnect(e) {
|
|
336
|
+
this.enabled === null && (this.enabled = Promise.resolve([])), this.emit("connect", e);
|
|
337
|
+
}
|
|
338
|
+
/**
|
|
339
|
+
* @deprecated See https://eips.ethereum.org/EIPS/eip-1193
|
|
340
|
+
*/
|
|
341
|
+
// TODO: Add proper return type annotation
|
|
342
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
343
|
+
emitClose(e) {
|
|
344
|
+
Array.isArray(e) && e.length === 2 ? this.emit("close", e[0], e[1]) : this.emit("close");
|
|
345
|
+
}
|
|
346
|
+
// TODO: Add proper return type annotation
|
|
347
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
348
|
+
emitDisconnect(e) {
|
|
349
|
+
this.emit("disconnect", e);
|
|
350
|
+
}
|
|
351
|
+
// TODO: Add proper return type annotation
|
|
352
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
353
|
+
emitChainChanged(e) {
|
|
354
|
+
this.emit("chainChanged", e);
|
|
355
|
+
}
|
|
356
|
+
/**
|
|
357
|
+
* @deprecated See https://eips.ethereum.org/EIPS/eip-1193
|
|
358
|
+
*/
|
|
359
|
+
// TODO: Add proper return type annotation
|
|
360
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
361
|
+
emitNetworkChanged(e) {
|
|
362
|
+
this.emit("networkChanged", e);
|
|
363
|
+
}
|
|
364
|
+
// TODO: Add proper return type annotation
|
|
365
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
366
|
+
emitAccountsChanged(e) {
|
|
367
|
+
this.enabled = Promise.resolve(e), this.emit("accountsChanged", e);
|
|
368
|
+
}
|
|
369
|
+
// TODO: Add proper return type annotation
|
|
370
|
+
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
371
|
+
emitMessage(e) {
|
|
372
|
+
this.emit("message", e);
|
|
373
|
+
}
|
|
374
|
+
}
|
|
375
|
+
function _() {
|
|
376
|
+
return Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
|
|
377
|
+
}
|
|
378
|
+
function w(s) {
|
|
379
|
+
if (!s) return null;
|
|
380
|
+
if (typeof s == "string") return s;
|
|
381
|
+
if (s instanceof Error || s.message) return s.message;
|
|
382
|
+
try {
|
|
383
|
+
return JSON.stringify(s);
|
|
384
|
+
} catch {
|
|
385
|
+
const e = "Unknown WidgetEthereumProvider error";
|
|
386
|
+
return console.error(e, s), e;
|
|
387
|
+
}
|
|
388
|
+
}
|
|
389
|
+
export {
|
|
390
|
+
I as IframeRpcProviderBridge,
|
|
391
|
+
r as IframeRpcProviderEvents,
|
|
392
|
+
m as IframeTransport,
|
|
393
|
+
T as WidgetEthereumProvider,
|
|
394
|
+
a as iframeRpcProviderTransport
|
|
395
|
+
};
|
package/package.json
CHANGED
|
@@ -1,16 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cowprotocol/iframe-transport",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.10",
|
|
4
4
|
"description": "CoW Swap iframe-transport",
|
|
5
|
-
"
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/cowprotocol/cowswap.git",
|
|
8
|
+
"directory": "libs/iframe-transport"
|
|
9
|
+
},
|
|
10
|
+
"type": "module",
|
|
11
|
+
"main": "./index.js",
|
|
12
|
+
"types": "./index.d.ts",
|
|
8
13
|
"license": "ISC",
|
|
9
14
|
"publishConfig": {
|
|
10
15
|
"access": "public"
|
|
11
16
|
},
|
|
12
17
|
"dependencies": {
|
|
13
|
-
"
|
|
14
|
-
"
|
|
18
|
+
"@cowprotocol/types": "^4.1.0",
|
|
19
|
+
"eventemitter3": "^4.0.0"
|
|
20
|
+
},
|
|
21
|
+
"exports": {
|
|
22
|
+
".": {
|
|
23
|
+
"types": "./index.d.ts",
|
|
24
|
+
"import": "./index.js",
|
|
25
|
+
"require": "./index.cjs"
|
|
26
|
+
}
|
|
15
27
|
}
|
|
16
28
|
}
|