@cowprotocol/iframe-transport 1.2.0 → 2.0.2

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.
@@ -1,45 +0,0 @@
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
- }
@@ -1,123 +0,0 @@
1
- import { EventEmitter } from 'eventemitter3';
2
- import { ProviderMetaInfoPayload } from './iframeRpcProviderEvents';
3
- import { JsonRpcRequest } from '../types';
4
- interface ProviderConnectInfo {
5
- readonly chainId: string;
6
- }
7
- interface ProviderRpcError extends Error {
8
- message: string;
9
- code: number;
10
- data?: unknown;
11
- }
12
- interface ProviderMessage {
13
- type: string;
14
- data: unknown;
15
- }
16
- type RpcCallback = (error: any, response: any) => void;
17
- /**
18
- * Options for constructing the iframe ethereum provider.
19
- */
20
- interface IFrameEthereumProviderOptions {
21
- targetOrigin?: string;
22
- timeoutMilliseconds?: number;
23
- eventSource?: Window;
24
- eventTarget?: Window;
25
- }
26
- export type IFrameEthereumProviderEventTypes = 'message' | 'connect' | 'disconnect' | 'chainChanged' | 'close' | 'notification' | 'networkChanged' | 'accountsChanged';
27
- /**
28
- * Export the type information about the different events that are emitted.
29
- */
30
- export interface IFrameEthereumProviderEvents {
31
- on(event: 'message', handler: (message: ProviderMessage) => void): this;
32
- on(event: 'connect', handler: (connectInfo: ProviderConnectInfo) => void): this;
33
- on(event: 'disconnect', handler: (error: ProviderRpcError) => void): this;
34
- on(event: 'close', handler: (code: number, reason: string) => void): this;
35
- on(event: 'notification', handler: (result: any) => void): this;
36
- on(event: 'chainChanged', handler: (chainId: string) => void): this;
37
- on(event: 'networkChanged', handler: (networkId: string) => void): this;
38
- on(event: 'accountsChanged', handler: (accounts: string[]) => void): this;
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?: any[];
96
- result: any;
97
- } | any) => 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 {};
@@ -1,31 +0,0 @@
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>;
@@ -1,4 +0,0 @@
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.d.ts DELETED
@@ -1,5 +0,0 @@
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 DELETED
@@ -1 +0,0 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class O{constructor(e){this.key=e}postMessageToWindow(e,t,o){const u=typeof o=="object"?o:{},f={key:this.key,method:t,...u};e.postMessage(f,"*")}listenToMessageFromWindow(e,t,o){const u=f=>{!M(f.data)||f.data.key!==this.key||f.data.method!==t||o(f.data)};return e.addEventListener("message",u),u}stopListeningToMessageFromWindow(e,t,o){e.removeEventListener("message",o)}stopListeningWindowListener(e,t){e.removeEventListener("message",t)}}function M(a){return typeof a=="object"&&a!==null&&"key"in a&&"method"in a&&typeof a.key=="string"&&typeof a.method=="string"}var v=(a=>(a.PROVIDER_RPC_REQUEST="PROVIDER_RPC_REQUEST",a.PROVIDER_RPC_RESPONSE="PROVIDER_RPC_RESPONSE",a.PROVIDER_ON_EVENT="PROVIDER_ON_EVENT",a.SEND_PROVIDER_META_INFO="SEND_PROVIDER_META_INFO",a.REQUEST_PROVIDER_META_INFO="REQUEST_PROVIDER_META_INFO",a))(v||{});const E=new O("cowSwapIframeRpcProviderTransport");function S(a){if(a.isWalletConnect)return a?.session?.peer?.metadata}function N(a,e){return e.find(t=>t.provider===a)?.info}const b=["connect","disconnect","close","chainChanged","accountsChanged"],y=[];typeof window<"u"&&window.addEventListener("eip6963:announceProvider",a=>{const e=a;y.push(e.detail)});class W{constructor(e){this.iframeWidow=e}ethereumProvider=null;requestWaitingForConnection={};disconnect(){typeof window>"u"||(this.ethereumProvider=null,E.stopListeningToMessageFromWindow(window,v.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),E.stopListeningToMessageFromWindow(window,v.REQUEST_PROVIDER_META_INFO,this.processProviderMetaInfoRequest))}onConnect(e){typeof window>"u"||(this.ethereumProvider?this.disconnect():E.listenToMessageFromWindow(window,v.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),this.ethereumProvider=e,this.processPendingRequests(),b.forEach(t=>{e.on(t,o=>this.onProviderEvent(t,o))}),E.listenToMessageFromWindow(window,v.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:o,method:u}=e;if(!this.ethereumProvider||!t)return;(u==="enable"?this.ethereumProvider.request({method:"eth_requestAccounts",id:t}):this.ethereumProvider.request({...e,id:t})).then(R=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:o,id:t,result:R}})).catch(R=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:o,id:t,error:R}}))}processRpcCallFromWindow=({rpcRequest:e})=>{if(!this.ethereumProvider){e.id&&(this.requestWaitingForConnection[e.id]=e);return}this.processRpcRequest(e)};processProviderMetaInfoRequest=()=>{if(!this.ethereumProvider)return;const e=N(this.ethereumProvider,y),t=S(this.ethereumProvider);E.postMessageToWindow(this.iframeWidow,v.SEND_PROVIDER_META_INFO,{providerEip6963Info:e,providerWcMetadata:t})};onProviderEvent(e,t){E.postMessageToWindow(this.iframeWidow,v.PROVIDER_ON_EVENT,{event:e,params:t})}forwardRpcResponseToIframe(e){E.postMessageToWindow(this.iframeWidow,v.PROVIDER_RPC_RESPONSE,e)}}var T={exports:{}},I;function D(){return I||(I=1,function(a){var e=Object.prototype.hasOwnProperty,t="~";function o(){}Object.create&&(o.prototype=Object.create(null),new o().__proto__||(t=!1));function u(c,r,s){this.fn=c,this.context=r,this.once=s||!1}function f(c,r,s,i,m){if(typeof s!="function")throw new TypeError("The listener must be a function");var p=new u(s,i||c,m),h=t?t+r:r;return c._events[h]?c._events[h].fn?c._events[h]=[c._events[h],p]:c._events[h].push(p):(c._events[h]=p,c._eventsCount++),c}function R(c,r){--c._eventsCount===0?c._events=new o:delete c._events[r]}function l(){this._events=new o,this._eventsCount=0}l.prototype.eventNames=function(){var r=[],s,i;if(this._eventsCount===0)return r;for(i in s=this._events)e.call(s,i)&&r.push(t?i.slice(1):i);return Object.getOwnPropertySymbols?r.concat(Object.getOwnPropertySymbols(s)):r},l.prototype.listeners=function(r){var s=t?t+r:r,i=this._events[s];if(!i)return[];if(i.fn)return[i.fn];for(var m=0,p=i.length,h=new Array(p);m<p;m++)h[m]=i[m].fn;return h},l.prototype.listenerCount=function(r){var s=t?t+r:r,i=this._events[s];return i?i.fn?1:i.length:0},l.prototype.emit=function(r,s,i,m,p,h){var _=t?t+r:r;if(!this._events[_])return!1;var n=this._events[_],g=arguments.length,w,d;if(n.fn){switch(n.once&&this.removeListener(r,n.fn,void 0,!0),g){case 1:return n.fn.call(n.context),!0;case 2:return n.fn.call(n.context,s),!0;case 3:return n.fn.call(n.context,s,i),!0;case 4:return n.fn.call(n.context,s,i,m),!0;case 5:return n.fn.call(n.context,s,i,m,p),!0;case 6:return n.fn.call(n.context,s,i,m,p,h),!0}for(d=1,w=new Array(g-1);d<g;d++)w[d-1]=arguments[d];n.fn.apply(n.context,w)}else{var C=n.length,P;for(d=0;d<C;d++)switch(n[d].once&&this.removeListener(r,n[d].fn,void 0,!0),g){case 1:n[d].fn.call(n[d].context);break;case 2:n[d].fn.call(n[d].context,s);break;case 3:n[d].fn.call(n[d].context,s,i);break;case 4:n[d].fn.call(n[d].context,s,i,m);break;default:if(!w)for(P=1,w=new Array(g-1);P<g;P++)w[P-1]=arguments[P];n[d].fn.apply(n[d].context,w)}}return!0},l.prototype.on=function(r,s,i){return f(this,r,s,i,!1)},l.prototype.once=function(r,s,i){return f(this,r,s,i,!0)},l.prototype.removeListener=function(r,s,i,m){var p=t?t+r:r;if(!this._events[p])return this;if(!s)return R(this,p),this;var h=this._events[p];if(h.fn)h.fn===s&&(!m||h.once)&&(!i||h.context===i)&&R(this,p);else{for(var _=0,n=[],g=h.length;_<g;_++)(h[_].fn!==s||m&&!h[_].once||i&&h[_].context!==i)&&n.push(h[_]);n.length?this._events[p]=n.length===1?n[0]:n:R(this,p)}return this},l.prototype.removeAllListeners=function(r){var s;return r?(s=t?t+r:r,this._events[s]&&R(this,s)):(this._events=new o,this._eventsCount=0),this},l.prototype.off=l.prototype.removeListener,l.prototype.addListener=l.prototype.on,l.prefixed=t,l.EventEmitter=l,a.exports=l}(T)),T.exports}var F=D();const k=6e5,V="2.0";function A(){return Math.floor(Math.random()*Number.MAX_SAFE_INTEGER)}class x extends Error{isRpcError=!0;code;reason;constructor(e,t){super(`${e}: ${t}`),this.code=e,this.reason=t}}class L extends F.EventEmitter{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=k,eventSource:t=window,eventTarget:o=window.parent}={}){super(),this.timeoutMilliseconds=e,this.eventSource=t,this.eventTarget=o,E.listenToMessageFromWindow(this.eventSource,v.PROVIDER_RPC_RESPONSE,u=>{this.handleRpcRequests(u)}),E.listenToMessageFromWindow(this.eventSource,v.PROVIDER_ON_EVENT,u=>{this.handleOnEvent(u)}),E.listenToMessageFromWindow(this.eventSource,v.SEND_PROVIDER_META_INFO,u=>{this.providerMetaInfo=u,this.providerMetaInfoCallback&&this.providerMetaInfoCallback(this.providerMetaInfo)})}async execute(e,t){const o=A(),u={jsonrpc:V,id:o,method:e,params:t},f=new Promise((R,l)=>this.completers[o]={resolve:R,reject:l});return E.postMessageToWindow(this.eventTarget,v.PROVIDER_RPC_REQUEST,{rpcRequest:u}),setTimeout(()=>{this.completers[o]&&(this.completers[o].reject(new Error("Request timed out. Please try again and submit it faster.")),delete this.completers[o])},this.timeoutMilliseconds),f}async send(e,t){const{method:o,params:u}=typeof e=="string"?{method:e,params:t}:{method:e.method,params:e.params},f=await this.execute(o,u);if("error"in f)throw new x(f.error.code,f.error.message);return f.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 o=await this.execute(e.method,e.params);t(null,o)}catch(o){t(o,null)}}onProviderMetaInfo(e){this.providerMetaInfo?e(this.providerMetaInfo):(this.providerMetaInfoCallback=e,E.postMessageToWindow(this.eventTarget,v.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)}}exports.IframeRpcProviderBridge=W;exports.IframeRpcProviderEvents=v;exports.IframeTransport=O;exports.WidgetEthereumProvider=L;exports.iframeRpcProviderTransport=E;