@cowprotocol/iframe-transport 1.0.0

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.
@@ -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,44 @@
1
+ import { EthereumProvider, JsonRpcRequestMessage } from '../types';
2
+ /**
3
+ * Handles JSON-RPC request comming 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 onProviderEvent;
40
+ /**
41
+ * Forward a JSON-RPC message to the content window.
42
+ */
43
+ private forwardRpcResponseToIframe;
44
+ }
@@ -0,0 +1,114 @@
1
+ import { EventEmitter } from 'eventemitter3';
2
+ import { JsonRpcRequest } from '../types';
3
+ interface ProviderConnectInfo {
4
+ readonly chainId: string;
5
+ }
6
+ interface ProviderRpcError extends Error {
7
+ message: string;
8
+ code: number;
9
+ data?: unknown;
10
+ }
11
+ interface ProviderMessage {
12
+ type: string;
13
+ data: unknown;
14
+ }
15
+ type RpcCallback = (error: any, response: any) => void;
16
+ /**
17
+ * Options for constructing the iframe ethereum provider.
18
+ */
19
+ interface IFrameEthereumProviderOptions {
20
+ targetOrigin?: string;
21
+ timeoutMilliseconds?: number;
22
+ eventSource?: Window;
23
+ eventTarget?: Window;
24
+ }
25
+ export type IFrameEthereumProviderEventTypes = 'message' | 'connect' | 'disconnect' | 'chainChanged' | 'close' | 'notification' | 'networkChanged' | 'accountsChanged';
26
+ /**
27
+ * Export the type information about the different events that are emitted.
28
+ */
29
+ export interface IFrameEthereumProviderEvents {
30
+ on(event: 'message', handler: (message: ProviderMessage) => void): this;
31
+ on(event: 'connect', handler: (connectInfo: ProviderConnectInfo) => void): this;
32
+ on(event: 'disconnect', handler: (error: ProviderRpcError) => void): this;
33
+ on(event: 'close', handler: (code: number, reason: string) => void): this;
34
+ on(event: 'notification', handler: (result: any) => void): this;
35
+ on(event: 'chainChanged', handler: (chainId: string) => void): this;
36
+ on(event: 'networkChanged', handler: (networkId: string) => void): this;
37
+ on(event: 'accountsChanged', handler: (accounts: string[]) => void): this;
38
+ }
39
+ /**
40
+ * Represents an error in an RPC returned from the event source. Always contains a code and a reason. The message
41
+ * is constructed from both.
42
+ */
43
+ export declare class RpcError extends Error {
44
+ readonly isRpcError = true;
45
+ readonly code: number;
46
+ readonly reason: string;
47
+ constructor(code: number, reason: string);
48
+ }
49
+ /**
50
+ * This is the primary artifact of this library.
51
+ */
52
+ export declare class WidgetEthereumProvider extends EventEmitter<IFrameEthereumProviderEventTypes> {
53
+ request({ method, params }: JsonRpcRequest): Promise<any>;
54
+ isConnected(): true;
55
+ /**
56
+ * Differentiate this provider from other providers by providing an isIFrame property that always returns true.
57
+ */
58
+ get isIFrame(): true;
59
+ /**
60
+ * Always return this for currentProvider.
61
+ */
62
+ get currentProvider(): WidgetEthereumProvider;
63
+ private enabled;
64
+ private readonly timeoutMilliseconds;
65
+ private readonly eventSource;
66
+ private readonly eventTarget;
67
+ private readonly completers;
68
+ constructor({ timeoutMilliseconds, eventSource, eventTarget, }?: IFrameEthereumProviderOptions);
69
+ /**
70
+ * Helper method that handles transport and request wrapping
71
+ * @param method method to execute
72
+ * @param params params to pass the method
73
+ */
74
+ private execute;
75
+ /**
76
+ * Send the JSON RPC and return the result.
77
+ */
78
+ send<TResult = any>(request: JsonRpcRequest, callback: RpcCallback): Promise<TResult>;
79
+ send<TResult = any>(method: string, params: unknown[] | undefined): Promise<TResult>;
80
+ /**
81
+ * Request the parent window to enable access to the user's web3 provider. Return accounts list immediately if already enabled.
82
+ */
83
+ enable(): Promise<string[]>;
84
+ /**
85
+ * Backwards compatibility method for web3.
86
+ * @param payload payload to send to the provider
87
+ * @param callback callback to be called when the provider resolves
88
+ */
89
+ sendAsync(payload: JsonRpcRequest, callback: (error: string | null, result: {
90
+ method: string;
91
+ params?: any[];
92
+ result: any;
93
+ } | any) => void): Promise<void>;
94
+ /**
95
+ * Handle a Rpc Request
96
+ */
97
+ private handleRpcRequests;
98
+ private handleOnEvent;
99
+ private emitNotification;
100
+ private emitConnect;
101
+ /**
102
+ * @deprecated See https://eips.ethereum.org/EIPS/eip-1193
103
+ */
104
+ private emitClose;
105
+ private emitDisconnect;
106
+ private emitChainChanged;
107
+ /**
108
+ * @deprecated See https://eips.ethereum.org/EIPS/eip-1193
109
+ */
110
+ private emitNetworkChanged;
111
+ private emitAccountsChanged;
112
+ private emitMessage;
113
+ }
114
+ export {};
@@ -0,0 +1,23 @@
1
+ import { IframeTransport } from '../IframeTransport';
2
+ import { JsonRpcRequestMessage, JsonRpcResponse } 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 declare enum IframeRpcProviderEvents {
14
+ PROVIDER_RPC_REQUEST = "PROVIDER_RPC_REQUEST",
15
+ PROVIDER_RPC_RESPONSE = "PROVIDER_RPC_RESPONSE",
16
+ PROVIDER_ON_EVENT = "PROVIDER_ON_EVENT"
17
+ }
18
+ export interface IframeEventsPayloadMap {
19
+ [IframeRpcProviderEvents.PROVIDER_RPC_REQUEST]: ProviderRpcRequestPayload;
20
+ [IframeRpcProviderEvents.PROVIDER_RPC_RESPONSE]: ProviderRpcResponsePayload;
21
+ [IframeRpcProviderEvents.PROVIDER_ON_EVENT]: ProviderOnEventPayload;
22
+ }
23
+ export declare const iframeRpcProviderTransport: IframeTransport<IframeEventsPayloadMap>;
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 @@
1
+ "use strict";var b=Object.defineProperty;var I=(a,n,e)=>n in a?b(a,n,{enumerable:!0,configurable:!0,writable:!0,value:e}):a[n]=e;var E=(a,n,e)=>(I(a,typeof n!="symbol"?n+"":n,e),e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class C{constructor(n){this.key=n}postMessageToWindow(n,e,t){const h=typeof t=="object"?t:{},d={key:this.key,method:e,...h};n.postMessage(d,"*")}listenToMessageFromWindow(n,e,t){const h=d=>{!S(d.data)||d.data.key!==this.key||d.data.method!==e||t(d.data)};return n.addEventListener("message",h),h}stopListeningToMessageFromWindow(n,e,t){n.removeEventListener("message",t)}stopListeningWindowListener(n,e){n.removeEventListener("message",e)}}function S(a){return typeof a=="object"&&a!==null&&"key"in a&&"method"in a&&typeof a.key=="string"&&typeof a.method=="string"}var R=(a=>(a.PROVIDER_RPC_REQUEST="PROVIDER_RPC_REQUEST",a.PROVIDER_RPC_RESPONSE="PROVIDER_RPC_RESPONSE",a.PROVIDER_ON_EVENT="PROVIDER_ON_EVENT",a))(R||{});const w=new C("cowSwapIframeRpcProviderTransport"),k=["connect","disconnect","close","chainChanged","accountsChanged"];class W{constructor(n){E(this,"ethereumProvider",null);E(this,"requestWaitingForConnection",{});E(this,"processRpcCallFromWindow",({rpcRequest:n})=>{if(!this.ethereumProvider){n.id&&(this.requestWaitingForConnection[n.id]=n);return}this.processRpcRequest(n)});this.iframeWidow=n}disconnect(){this.ethereumProvider=null,w.stopListeningToMessageFromWindow(window,R.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow)}onConnect(n){this.ethereumProvider?this.disconnect():w.listenToMessageFromWindow(window,R.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),this.ethereumProvider=n,this.processPendingRequests(),k.forEach(e=>{n.on(e,t=>this.onProviderEvent(e,t))})}processPendingRequests(){Object.keys(this.requestWaitingForConnection).forEach(n=>{this.processRpcRequest(this.requestWaitingForConnection[n])}),this.requestWaitingForConnection={}}processRpcRequest(n){const{id:e,jsonrpc:t,method:h}=n;if(!this.ethereumProvider||!e)return;(h==="enable"?this.ethereumProvider.enable():this.ethereumProvider.request({...n,id:e})).then(p=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:t,id:e,result:p}})).catch(p=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:t,id:e,error:p}}))}onProviderEvent(n,e){w.postMessageToWindow(this.iframeWidow,R.PROVIDER_ON_EVENT,{event:n,params:e})}forwardRpcResponseToIframe(n){w.postMessageToWindow(this.iframeWidow,R.PROVIDER_RPC_RESPONSE,n)}}var T={exports:{}};(function(a){var n=Object.prototype.hasOwnProperty,e="~";function t(){}Object.create&&(t.prototype=Object.create(null),new t().__proto__||(e=!1));function h(c,s,i){this.fn=c,this.context=s,this.once=i||!1}function d(c,s,i,o,v){if(typeof i!="function")throw new TypeError("The listener must be a function");var m=new h(i,o||c,v),l=e?e+s:s;return c._events[l]?c._events[l].fn?c._events[l]=[c._events[l],m]:c._events[l].push(m):(c._events[l]=m,c._eventsCount++),c}function p(c,s){--c._eventsCount===0?c._events=new t:delete c._events[s]}function f(){this._events=new t,this._eventsCount=0}f.prototype.eventNames=function(){var s=[],i,o;if(this._eventsCount===0)return s;for(o in i=this._events)n.call(i,o)&&s.push(e?o.slice(1):o);return Object.getOwnPropertySymbols?s.concat(Object.getOwnPropertySymbols(i)):s},f.prototype.listeners=function(s){var i=e?e+s:s,o=this._events[i];if(!o)return[];if(o.fn)return[o.fn];for(var v=0,m=o.length,l=new Array(m);v<m;v++)l[v]=o[v].fn;return l},f.prototype.listenerCount=function(s){var i=e?e+s:s,o=this._events[i];return o?o.fn?1:o.length:0},f.prototype.emit=function(s,i,o,v,m,l){var g=e?e+s:s;if(!this._events[g])return!1;var r=this._events[g],_=arguments.length,P,u;if(r.fn){switch(r.once&&this.removeListener(s,r.fn,void 0,!0),_){case 1:return r.fn.call(r.context),!0;case 2:return r.fn.call(r.context,i),!0;case 3:return r.fn.call(r.context,i,o),!0;case 4:return r.fn.call(r.context,i,o,v),!0;case 5:return r.fn.call(r.context,i,o,v,m),!0;case 6:return r.fn.call(r.context,i,o,v,m,l),!0}for(u=1,P=new Array(_-1);u<_;u++)P[u-1]=arguments[u];r.fn.apply(r.context,P)}else{var O=r.length,y;for(u=0;u<O;u++)switch(r[u].once&&this.removeListener(s,r[u].fn,void 0,!0),_){case 1:r[u].fn.call(r[u].context);break;case 2:r[u].fn.call(r[u].context,i);break;case 3:r[u].fn.call(r[u].context,i,o);break;case 4:r[u].fn.call(r[u].context,i,o,v);break;default:if(!P)for(y=1,P=new Array(_-1);y<_;y++)P[y-1]=arguments[y];r[u].fn.apply(r[u].context,P)}}return!0},f.prototype.on=function(s,i,o){return d(this,s,i,o,!1)},f.prototype.once=function(s,i,o){return d(this,s,i,o,!0)},f.prototype.removeListener=function(s,i,o,v){var m=e?e+s:s;if(!this._events[m])return this;if(!i)return p(this,m),this;var l=this._events[m];if(l.fn)l.fn===i&&(!v||l.once)&&(!o||l.context===o)&&p(this,m);else{for(var g=0,r=[],_=l.length;g<_;g++)(l[g].fn!==i||v&&!l[g].once||o&&l[g].context!==o)&&r.push(l[g]);r.length?this._events[m]=r.length===1?r[0]:r:p(this,m)}return this},f.prototype.removeAllListeners=function(s){var i;return s?(i=e?e+s:s,this._events[i]&&p(this,i)):(this._events=new t,this._eventsCount=0),this},f.prototype.off=f.prototype.removeListener,f.prototype.addListener=f.prototype.on,f.prefixed=e,f.EventEmitter=f,a.exports=f})(T);var N=T.exports;const x=6e5,M="2.0";function D(){return Math.floor(Math.random()*Number.MAX_SAFE_INTEGER)}class F extends Error{constructor(e,t){super(`${e}: ${t}`);E(this,"isRpcError",!0);E(this,"code");E(this,"reason");this.code=e,this.reason=t}}class L extends N.EventEmitter{constructor({timeoutMilliseconds:e=x,eventSource:t=window,eventTarget:h=window.parent}={}){super();E(this,"enabled",null);E(this,"timeoutMilliseconds");E(this,"eventSource");E(this,"eventTarget");E(this,"completers",{});E(this,"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])});this.timeoutMilliseconds=e,this.eventSource=t,this.eventTarget=h,w.listenToMessageFromWindow(this.eventSource,R.PROVIDER_RPC_RESPONSE,d=>{this.handleRpcRequests(d)}),w.listenToMessageFromWindow(this.eventSource,R.PROVIDER_ON_EVENT,d=>{this.handleOnEvent(d)})}request({method:e,params:t}){return this.send(e,t)}isConnected(){return!0}get isIFrame(){return!0}get currentProvider(){return this}async execute(e,t){const h=D(),d={jsonrpc:M,id:h,method:e,params:t},p=new Promise((f,c)=>this.completers[h]={resolve:f,reject:c});return w.postMessageToWindow(this.eventTarget,R.PROVIDER_RPC_REQUEST,{rpcRequest:d}),setTimeout(()=>{this.completers[h]&&(this.completers[h].reject(new Error("Request timed out. Please try again and submit it faster.")),delete this.completers[h])},this.timeoutMilliseconds),p}async send(e,t){const{method:h,params:d}=typeof e=="string"?{method:e,params:t}:{method:e.method,params:e.params},p=await this.execute(h,d);if("error"in p)throw new F(p.error.code,p.error.message);return p.result}async enable(){if(this.enabled===null){const e=this.enabled=this.send("enable",[]).catch(t=>{throw this.enabled===e&&(this.enabled=null),t})}return this.enabled}async sendAsync(e,t){try{const h=await this.execute(e.method,e.params);t(null,h)}catch(h){t(h,null)}}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)}}exports.IframeRpcProviderBridge=W;exports.IframeRpcProviderEvents=R;exports.IframeTransport=C;exports.WidgetEthereumProvider=L;exports.iframeRpcProviderTransport=w;
package/index.mjs ADDED
@@ -0,0 +1,423 @@
1
+ var O = Object.defineProperty;
2
+ var b = (a, n, e) => n in a ? O(a, n, { enumerable: !0, configurable: !0, writable: !0, value: e }) : a[n] = e;
3
+ var E = (a, n, e) => (b(a, typeof n != "symbol" ? n + "" : n, e), e);
4
+ class k {
5
+ constructor(n) {
6
+ this.key = n;
7
+ }
8
+ postMessageToWindow(n, e, t) {
9
+ const h = typeof t == "object" ? t : {}, d = {
10
+ key: this.key,
11
+ method: e,
12
+ ...h
13
+ };
14
+ n.postMessage(
15
+ d,
16
+ "*"
17
+ // TODO: Change to CoW specific origin in production. https://github.com/cowprotocol/cowswap/issues/3828
18
+ );
19
+ }
20
+ listenToMessageFromWindow(n, e, t) {
21
+ const h = (d) => {
22
+ !S(d.data) || d.data.key !== this.key || d.data.method !== e || t(d.data);
23
+ };
24
+ return n.addEventListener("message", h), h;
25
+ }
26
+ stopListeningToMessageFromWindow(n, e, t) {
27
+ n.removeEventListener("message", t);
28
+ }
29
+ stopListeningWindowListener(n, e) {
30
+ n.removeEventListener("message", e);
31
+ }
32
+ }
33
+ function S(a) {
34
+ return typeof a == "object" && a !== null && "key" in a && "method" in a && typeof a.key == "string" && typeof a.method == "string";
35
+ }
36
+ var _ = /* @__PURE__ */ ((a) => (a.PROVIDER_RPC_REQUEST = "PROVIDER_RPC_REQUEST", a.PROVIDER_RPC_RESPONSE = "PROVIDER_RPC_RESPONSE", a.PROVIDER_ON_EVENT = "PROVIDER_ON_EVENT", a))(_ || {});
37
+ const P = new k(
38
+ "cowSwapIframeRpcProviderTransport"
39
+ ), I = ["connect", "disconnect", "close", "chainChanged", "accountsChanged"];
40
+ class L {
41
+ /**
42
+ * Creates an instance of IframeRpcProviderBridge.
43
+ * @param iframeWidow - The iFrame window that will post up general RPC messages and to which the IframeRpcProviderBridge will forward the RPC result.
44
+ * Also it will receive some special RPC events coming from the wallet, like connect/chainChanged,accountChanged
45
+ */
46
+ constructor(n) {
47
+ /**
48
+ * The Ethereum provider instance.
49
+ * When is null the JSON-RPC bridge is disconnected from the Ethereum provider.
50
+ * */
51
+ E(this, "ethereumProvider", null);
52
+ /** Stored JSON-RPC requests, to queue them when disconnected. */
53
+ E(this, "requestWaitingForConnection", {});
54
+ E(this, "processRpcCallFromWindow", ({ rpcRequest: n }) => {
55
+ if (!this.ethereumProvider) {
56
+ n.id && (this.requestWaitingForConnection[n.id] = n);
57
+ return;
58
+ }
59
+ this.processRpcRequest(n);
60
+ });
61
+ this.iframeWidow = n;
62
+ }
63
+ /**
64
+ * Disconnects the JSON-RPC bridge from the Ethereum provider.
65
+ */
66
+ disconnect() {
67
+ this.ethereumProvider = null, P.stopListeningToMessageFromWindow(
68
+ window,
69
+ _.PROVIDER_RPC_REQUEST,
70
+ this.processRpcCallFromWindow
71
+ );
72
+ }
73
+ /**
74
+ * Handles the 'connect' event and sets up event listeners for Ethereum provider events.
75
+ * @param newProvider - The Ethereum provider to connect.
76
+ */
77
+ onConnect(n) {
78
+ this.ethereumProvider ? this.disconnect() : P.listenToMessageFromWindow(
79
+ window,
80
+ _.PROVIDER_RPC_REQUEST,
81
+ this.processRpcCallFromWindow
82
+ ), this.ethereumProvider = n, this.processPendingRequests(), I.forEach((e) => {
83
+ n.on(e, (t) => this.onProviderEvent(e, t));
84
+ });
85
+ }
86
+ processPendingRequests() {
87
+ Object.keys(this.requestWaitingForConnection).forEach((n) => {
88
+ this.processRpcRequest(this.requestWaitingForConnection[n]);
89
+ }), this.requestWaitingForConnection = {};
90
+ }
91
+ /**
92
+ * Processes a JSON-RPC request and sends appropriate response or error via the content window.
93
+ * @param request - The JSON-RPC request to be processed.
94
+ */
95
+ processRpcRequest(n) {
96
+ const { id: e, jsonrpc: t, method: h } = n;
97
+ if (!this.ethereumProvider || !e)
98
+ return;
99
+ (h === "enable" ? this.ethereumProvider.enable() : this.ethereumProvider.request({ ...n, id: e })).then(
100
+ (p) => this.forwardRpcResponseToIframe({
101
+ rpcResponse: { jsonrpc: t, id: e, result: p }
102
+ })
103
+ ).catch(
104
+ (p) => this.forwardRpcResponseToIframe({
105
+ rpcResponse: { jsonrpc: t, id: e, error: p }
106
+ })
107
+ );
108
+ }
109
+ onProviderEvent(n, e) {
110
+ P.postMessageToWindow(this.iframeWidow, _.PROVIDER_ON_EVENT, {
111
+ event: n,
112
+ params: e
113
+ });
114
+ }
115
+ /**
116
+ * Forward a JSON-RPC message to the content window.
117
+ */
118
+ forwardRpcResponseToIframe(n) {
119
+ P.postMessageToWindow(
120
+ this.iframeWidow,
121
+ _.PROVIDER_RPC_RESPONSE,
122
+ n
123
+ );
124
+ }
125
+ }
126
+ var C = { exports: {} };
127
+ (function(a) {
128
+ var n = Object.prototype.hasOwnProperty, e = "~";
129
+ function t() {
130
+ }
131
+ Object.create && (t.prototype = /* @__PURE__ */ Object.create(null), new t().__proto__ || (e = !1));
132
+ function h(c, r, i) {
133
+ this.fn = c, this.context = r, this.once = i || !1;
134
+ }
135
+ function d(c, r, i, o, v) {
136
+ if (typeof i != "function")
137
+ throw new TypeError("The listener must be a function");
138
+ var m = new h(i, o || c, v), l = e ? e + r : r;
139
+ return c._events[l] ? c._events[l].fn ? c._events[l] = [c._events[l], m] : c._events[l].push(m) : (c._events[l] = m, c._eventsCount++), c;
140
+ }
141
+ function p(c, r) {
142
+ --c._eventsCount === 0 ? c._events = new t() : delete c._events[r];
143
+ }
144
+ function f() {
145
+ this._events = new t(), this._eventsCount = 0;
146
+ }
147
+ f.prototype.eventNames = function() {
148
+ var r = [], i, o;
149
+ if (this._eventsCount === 0)
150
+ return r;
151
+ for (o in i = this._events)
152
+ n.call(i, o) && r.push(e ? o.slice(1) : o);
153
+ return Object.getOwnPropertySymbols ? r.concat(Object.getOwnPropertySymbols(i)) : r;
154
+ }, f.prototype.listeners = function(r) {
155
+ var i = e ? e + r : r, o = this._events[i];
156
+ if (!o)
157
+ return [];
158
+ if (o.fn)
159
+ return [o.fn];
160
+ for (var v = 0, m = o.length, l = new Array(m); v < m; v++)
161
+ l[v] = o[v].fn;
162
+ return l;
163
+ }, f.prototype.listenerCount = function(r) {
164
+ var i = e ? e + r : r, o = this._events[i];
165
+ return o ? o.fn ? 1 : o.length : 0;
166
+ }, f.prototype.emit = function(r, i, o, v, m, l) {
167
+ var g = e ? e + r : r;
168
+ if (!this._events[g])
169
+ return !1;
170
+ var s = this._events[g], R = arguments.length, w, u;
171
+ if (s.fn) {
172
+ switch (s.once && this.removeListener(r, s.fn, void 0, !0), R) {
173
+ case 1:
174
+ return s.fn.call(s.context), !0;
175
+ case 2:
176
+ return s.fn.call(s.context, i), !0;
177
+ case 3:
178
+ return s.fn.call(s.context, i, o), !0;
179
+ case 4:
180
+ return s.fn.call(s.context, i, o, v), !0;
181
+ case 5:
182
+ return s.fn.call(s.context, i, o, v, m), !0;
183
+ case 6:
184
+ return s.fn.call(s.context, i, o, v, m, l), !0;
185
+ }
186
+ for (u = 1, w = new Array(R - 1); u < R; u++)
187
+ w[u - 1] = arguments[u];
188
+ s.fn.apply(s.context, w);
189
+ } else {
190
+ var T = s.length, y;
191
+ for (u = 0; u < T; u++)
192
+ switch (s[u].once && this.removeListener(r, s[u].fn, void 0, !0), R) {
193
+ case 1:
194
+ s[u].fn.call(s[u].context);
195
+ break;
196
+ case 2:
197
+ s[u].fn.call(s[u].context, i);
198
+ break;
199
+ case 3:
200
+ s[u].fn.call(s[u].context, i, o);
201
+ break;
202
+ case 4:
203
+ s[u].fn.call(s[u].context, i, o, v);
204
+ break;
205
+ default:
206
+ if (!w)
207
+ for (y = 1, w = new Array(R - 1); y < R; y++)
208
+ w[y - 1] = arguments[y];
209
+ s[u].fn.apply(s[u].context, w);
210
+ }
211
+ }
212
+ return !0;
213
+ }, f.prototype.on = function(r, i, o) {
214
+ return d(this, r, i, o, !1);
215
+ }, f.prototype.once = function(r, i, o) {
216
+ return d(this, r, i, o, !0);
217
+ }, f.prototype.removeListener = function(r, i, o, v) {
218
+ var m = e ? e + r : r;
219
+ if (!this._events[m])
220
+ return this;
221
+ if (!i)
222
+ return p(this, m), this;
223
+ var l = this._events[m];
224
+ if (l.fn)
225
+ l.fn === i && (!v || l.once) && (!o || l.context === o) && p(this, m);
226
+ else {
227
+ for (var g = 0, s = [], R = l.length; g < R; g++)
228
+ (l[g].fn !== i || v && !l[g].once || o && l[g].context !== o) && s.push(l[g]);
229
+ s.length ? this._events[m] = s.length === 1 ? s[0] : s : p(this, m);
230
+ }
231
+ return this;
232
+ }, f.prototype.removeAllListeners = function(r) {
233
+ var i;
234
+ return r ? (i = e ? e + r : r, this._events[i] && p(this, i)) : (this._events = new t(), this._eventsCount = 0), this;
235
+ }, f.prototype.off = f.prototype.removeListener, f.prototype.addListener = f.prototype.on, f.prefixed = e, f.EventEmitter = f, a.exports = f;
236
+ })(C);
237
+ var W = C.exports;
238
+ const x = 6e5, N = "2.0";
239
+ function M() {
240
+ return Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
241
+ }
242
+ class D extends Error {
243
+ constructor(e, t) {
244
+ super(`${e}: ${t}`);
245
+ E(this, "isRpcError", !0);
246
+ E(this, "code");
247
+ E(this, "reason");
248
+ this.code = e, this.reason = t;
249
+ }
250
+ }
251
+ class V extends W.EventEmitter {
252
+ constructor({
253
+ timeoutMilliseconds: e = x,
254
+ eventSource: t = window,
255
+ eventTarget: h = window.parent
256
+ } = {}) {
257
+ super();
258
+ E(this, "enabled", null);
259
+ E(this, "timeoutMilliseconds");
260
+ E(this, "eventSource");
261
+ E(this, "eventTarget");
262
+ E(this, "completers", {});
263
+ /**
264
+ * Handle a Rpc Request
265
+ */
266
+ E(this, "handleRpcRequests", ({ rpcResponse: e }) => {
267
+ if (e.id === void 0 || e.id === null)
268
+ return;
269
+ const t = this.completers["" + e.id];
270
+ 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]);
271
+ });
272
+ this.timeoutMilliseconds = e, this.eventSource = t, this.eventTarget = h, P.listenToMessageFromWindow(
273
+ this.eventSource,
274
+ _.PROVIDER_RPC_RESPONSE,
275
+ (d) => {
276
+ this.handleRpcRequests(d);
277
+ }
278
+ ), P.listenToMessageFromWindow(
279
+ this.eventSource,
280
+ _.PROVIDER_ON_EVENT,
281
+ (d) => {
282
+ this.handleOnEvent(d);
283
+ }
284
+ );
285
+ }
286
+ request({ method: e, params: t }) {
287
+ return this.send(e, t);
288
+ }
289
+ isConnected() {
290
+ return !0;
291
+ }
292
+ /**
293
+ * Differentiate this provider from other providers by providing an isIFrame property that always returns true.
294
+ */
295
+ get isIFrame() {
296
+ return !0;
297
+ }
298
+ /**
299
+ * Always return this for currentProvider.
300
+ */
301
+ get currentProvider() {
302
+ return this;
303
+ }
304
+ /**
305
+ * Helper method that handles transport and request wrapping
306
+ * @param method method to execute
307
+ * @param params params to pass the method
308
+ */
309
+ async execute(e, t) {
310
+ const h = M(), d = {
311
+ jsonrpc: N,
312
+ id: h,
313
+ method: e,
314
+ params: t
315
+ }, p = new Promise(
316
+ (f, c) => this.completers[h] = { resolve: f, reject: c }
317
+ );
318
+ return P.postMessageToWindow(this.eventTarget, _.PROVIDER_RPC_REQUEST, {
319
+ rpcRequest: d
320
+ }), setTimeout(() => {
321
+ this.completers[h] && (this.completers[h].reject(new Error("Request timed out. Please try again and submit it faster.")), delete this.completers[h]);
322
+ }, this.timeoutMilliseconds), p;
323
+ }
324
+ async send(e, t) {
325
+ const { method: h, params: d } = typeof e == "string" ? { method: e, params: t } : { method: e.method, params: e.params }, p = await this.execute(h, d);
326
+ if ("error" in p)
327
+ throw new D(p.error.code, p.error.message);
328
+ return p.result;
329
+ }
330
+ /**
331
+ * Request the parent window to enable access to the user's web3 provider. Return accounts list immediately if already enabled.
332
+ */
333
+ async enable() {
334
+ if (this.enabled === null) {
335
+ const e = this.enabled = this.send("enable", []).catch((t) => {
336
+ throw this.enabled === e && (this.enabled = null), t;
337
+ });
338
+ }
339
+ return this.enabled;
340
+ }
341
+ /**
342
+ * Backwards compatibility method for web3.
343
+ * @param payload payload to send to the provider
344
+ * @param callback callback to be called when the provider resolves
345
+ */
346
+ async sendAsync(e, t) {
347
+ try {
348
+ const h = await this.execute(e.method, e.params);
349
+ t(null, h);
350
+ } catch (h) {
351
+ t(h, null);
352
+ }
353
+ }
354
+ handleOnEvent(e) {
355
+ const t = e.params;
356
+ switch (e.event) {
357
+ case "notification":
358
+ this.emitNotification(t);
359
+ break;
360
+ case "connect":
361
+ this.emitConnect(t);
362
+ break;
363
+ case "disconnect":
364
+ this.emitDisconnect(t);
365
+ break;
366
+ case "chainChanged":
367
+ this.emitChainChanged(t);
368
+ break;
369
+ case "accountsChanged":
370
+ this.emitAccountsChanged(t);
371
+ break;
372
+ case "message":
373
+ this.emitMessage(t);
374
+ break;
375
+ case "networkChanged":
376
+ this.emitNetworkChanged(t);
377
+ break;
378
+ case "close":
379
+ this.emitClose(t);
380
+ break;
381
+ default:
382
+ console.warn(`[WidgetEthereumProvider] Unknown event type: ${e.event}`);
383
+ break;
384
+ }
385
+ }
386
+ emitNotification(e) {
387
+ this.emit("notification", e);
388
+ }
389
+ emitConnect(e) {
390
+ this.enabled === null && (this.enabled = Promise.resolve([])), this.emit("connect", e);
391
+ }
392
+ /**
393
+ * @deprecated See https://eips.ethereum.org/EIPS/eip-1193
394
+ */
395
+ emitClose(e) {
396
+ Array.isArray(e) && e.length === 2 ? this.emit("close", e[0], e[1]) : this.emit("close");
397
+ }
398
+ emitDisconnect(e) {
399
+ this.emit("disconnect", e);
400
+ }
401
+ emitChainChanged(e) {
402
+ this.emit("chainChanged", e);
403
+ }
404
+ /**
405
+ * @deprecated See https://eips.ethereum.org/EIPS/eip-1193
406
+ */
407
+ emitNetworkChanged(e) {
408
+ this.emit("networkChanged", e);
409
+ }
410
+ emitAccountsChanged(e) {
411
+ this.enabled = Promise.resolve(e), this.emit("accountsChanged", e);
412
+ }
413
+ emitMessage(e) {
414
+ this.emit("message", e);
415
+ }
416
+ }
417
+ export {
418
+ L as IframeRpcProviderBridge,
419
+ _ as IframeRpcProviderEvents,
420
+ k as IframeTransport,
421
+ V as WidgetEthereumProvider,
422
+ P as iframeRpcProviderTransport
423
+ };
package/package.json ADDED
@@ -0,0 +1,24 @@
1
+ {
2
+ "name": "@cowprotocol/iframe-transport",
3
+ "version": "1.0.0",
4
+ "type": "commonjs",
5
+ "description": "CoW Swap iframe-transport",
6
+ "main": "index.js",
7
+ "exports": {
8
+ "import": "./index.js",
9
+ "require": "./index.mjs"
10
+ },
11
+ "license": "ISC",
12
+ "repository": {
13
+ "type": "git",
14
+ "url": "https://github.com/cowprotocol/cowswap"
15
+ },
16
+ "keywords": [
17
+ "cowprotocol",
18
+ "iframe-transport",
19
+ "cowswap",
20
+ "dex"
21
+ ],
22
+ "dependencies": {
23
+ }
24
+ }
package/types.d.ts ADDED
@@ -0,0 +1,47 @@
1
+ export interface JsonRpcRequest {
2
+ id?: number;
3
+ method: string;
4
+ params?: any[];
5
+ }
6
+ export interface JsonRpcRequestMessage {
7
+ jsonrpc: '2.0';
8
+ id?: number;
9
+ method: string;
10
+ params: unknown[] | undefined;
11
+ }
12
+ export interface BaseJsonRpcResponseMessage {
13
+ id: number;
14
+ jsonrpc: '2.0';
15
+ }
16
+ export interface JsonRpcSucessfulResponseMessage<TResult = unknown> extends BaseJsonRpcResponseMessage {
17
+ result: TResult;
18
+ }
19
+ export interface JsonRpcError<TData = unknown> {
20
+ code: number;
21
+ message: string;
22
+ data?: TData;
23
+ }
24
+ export interface JsonRpcErrorResponseMessage<TErrorData = unknown> extends BaseJsonRpcResponseMessage {
25
+ error: JsonRpcError<TErrorData>;
26
+ }
27
+ export type JsonRpcResponse = JsonRpcRequestMessage | JsonRpcErrorResponseMessage | JsonRpcSucessfulResponseMessage;
28
+ export interface EthereumProvider {
29
+ /**
30
+ * Subscribes to Ethereum-related events.
31
+ * @param event - The event to subscribe to.
32
+ * @param args - Arguments for the event.
33
+ */
34
+ on(event: string, args: unknown): void;
35
+ /**
36
+ * Sends a JSON-RPC request to the Ethereum provider and returns the response.
37
+ * @param params - JSON-RPC request parameters.
38
+ * @returns A promise that resolves with the response.
39
+ */
40
+ request<T>(params: JsonRpcRequest): Promise<T>;
41
+ /**
42
+ * Requests permission to connect to the Ethereum provider.
43
+ * @returns A promise that resolves once permission is granted.
44
+ */
45
+ enable(): Promise<void>;
46
+ }
47
+ export type WindowListener = (event: MessageEvent<unknown>) => void;