@cowprotocol/iframe-transport 2.2.4 → 2.2.6

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,5 +1,6 @@
1
1
  import { WindowListener } from './types';
2
2
  type AbstractRecord = Record<unknown, unknown>;
3
+ export declare function isLocalEnvOrigin(origin: string): boolean;
3
4
  export declare class IframeTransport<MethodsEmitPayloadMap extends AbstractRecord> {
4
5
  readonly key: string;
5
6
  constructor(key: string);
package/index.cjs CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("eventemitter3"),l="https://swap.cow.fi";function h(...i){process.env.NODE_ENV!=="test"&&console.debug("%c [COW][Widget]","font-weight: bold; color: #ff0000",...i)}function m(i){try{const{hostname:e}=new URL(i);return e==="localhost"||e==="127.0.0.1"||e==="::1"||e==="[::1]"}catch{return!1}}class f{constructor(e){this.key=e}postMessageToWindow(e,t,r,o=l){const n=typeof r=="object"?r:{},d={key:this.key,method:t,...n};e.postMessage(d,o)}listenToMessageFromWindow(e,t,r,o,n=l){const d=a=>{if(!(!R(a.data)||a.data.key!==this.key||a.data.method!==r)){if(!a.source||a.source!==t){if(!(m(a.origin)||m(n))){h("Rejected message due to source mismatch",{key:this.key,method:r,actualSource:a.source,expectedSource:t});return}h("Non-matching or missing message source. Continuing due to local env.",{key:this.key,method:r,actualSource:a.source,expectedSource:t})}if(a.origin!==n){h("Rejected message due to origin mismatch",{key:this.key,method:r,actualOrigin:a.origin,trustedOrigin:n});return}o(a.data)}};return e.addEventListener("message",d),d}stopListeningToMessageFromWindow(e,t,r){e.removeEventListener("message",r)}stopListeningWindowListener(e,t){e.removeEventListener("message",t)}}function R(i){return typeof i=="object"&&i!==null&&"key"in i&&"method"in i&&typeof i.key=="string"&&typeof i.method=="string"}var s=(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))(s||{});const c=new f("cowSwapIframeRpcProviderTransport");function v(i){if(i.isWalletConnect)return i?.session?.peer?.metadata}function w(i,e){return e.find(t=>t.provider===i)?.info}const P=["connect","disconnect","close","chainChanged","accountsChanged"],g=[];typeof window<"u"&&window.addEventListener("eip6963:announceProvider",i=>{const e=i;g.push(e.detail)});class O{constructor(e,t){this.iframeWindow=e,this.iframeOrigin=t}ethereumProvider=null;requestWaitingForConnection={};providerEventListeners=[];disconnect(){if(!(typeof window>"u")){if(this.ethereumProvider){const e=this.ethereumProvider;if(typeof e.removeListener=="function")for(const{event:t,handler:r}of this.providerEventListeners)e.removeListener(t,r)}this.providerEventListeners=[],this.ethereumProvider=null,c.stopListeningToMessageFromWindow(window,s.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),c.stopListeningToMessageFromWindow(window,s.REQUEST_PROVIDER_META_INFO,this.processProviderMetaInfoRequest)}}onConnect(e){typeof window>"u"||(this.ethereumProvider?this.disconnect():c.listenToMessageFromWindow(window,this.iframeWindow,s.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow,this.iframeOrigin),this.ethereumProvider=e,this.processPendingRequests(),P.forEach(t=>{const r=o=>this.onProviderEvent(t,o);this.providerEventListeners.push({event:t,handler:r}),e.on(t,r)}),c.listenToMessageFromWindow(window,this.iframeWindow,s.REQUEST_PROVIDER_META_INFO,this.processProviderMetaInfoRequest,this.iframeOrigin))}processPendingRequests(){Object.keys(this.requestWaitingForConnection).forEach(e=>{this.processRpcRequest(this.requestWaitingForConnection[e])}),this.requestWaitingForConnection={}}processRpcRequest(e){const{id:t,jsonrpc:r,method:o}=e;if(!this.ethereumProvider||!t)return;(o==="enable"?this.ethereumProvider.request({method:"eth_requestAccounts",id:t}):this.ethereumProvider.request({...e,id:t})).then(d=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:r,id:t,result:d}})).catch(d=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:r,id:t,error:d}}))}processRpcCallFromWindow=({rpcRequest:e})=>{if(!this.ethereumProvider){e.id&&(this.requestWaitingForConnection[e.id]=e);return}this.processRpcRequest(e)};processProviderMetaInfoRequest=()=>{if(!this.ethereumProvider)return;const e=w(this.ethereumProvider,g),t=v(this.ethereumProvider);c.postMessageToWindow(this.iframeWindow,s.SEND_PROVIDER_META_INFO,{providerEip6963Info:e,providerWcMetadata:t},this.iframeOrigin)};onProviderEvent(e,t){c.postMessageToWindow(this.iframeWindow,s.PROVIDER_ON_EVENT,{event:e,params:t},this.iframeOrigin)}forwardRpcResponseToIframe(e){c.postMessageToWindow(this.iframeWindow,s.PROVIDER_RPC_RESPONSE,e,this.iframeOrigin)}}function E(){const i=u(_())||u(T())||u(I());if(i)try{return new URL(i).origin}catch(e){console.error("[getParentOrigin] origin is invalid",e,{origin:i});return}}function u(i){return i&&i!=="null"?i:void 0}function _(){if(typeof window>"u")return;const i=window.location.ancestorOrigins;if(!(!i||i.length===0))return i[0]}function T(){if(!(typeof document>"u"||!document.referrer))try{return new URL(document.referrer).origin}catch{return}}function I(){if(!(typeof window>"u"||!window.parent||window.parent===window))try{return window.parent.location.origin}catch{return}}const M=6e5,C="2.0",y="https://swap.cow.fi";class N extends Error{isRpcError=!0;code;reason;constructor(e,t){super(`${e}: ${t}`),this.code=e,this.reason=t}}class S extends p{request({method:e,params:t}){return e==="wallet_revokePermissions"?Promise.resolve(null):this.send(e,t)}isConnected(){return!0}get isIFrame(){return!0}get currentProvider(){return this}enabled=null;timeoutMilliseconds;eventSource;eventTarget;targetOrigin;completers={};providerMetaInfo=null;providerMetaInfoCallback;constructor({targetOrigin:e,timeoutMilliseconds:t=M,eventSource:r=window,eventTarget:o=window.parent}={}){super(),this.timeoutMilliseconds=t,this.eventSource=r,this.eventTarget=o,this.targetOrigin=e||E()||y,c.listenToMessageFromWindow(this.eventSource,this.eventTarget,s.PROVIDER_RPC_RESPONSE,n=>{this.handleRpcRequests(n)},this.targetOrigin),c.listenToMessageFromWindow(this.eventSource,this.eventTarget,s.PROVIDER_ON_EVENT,n=>{this.handleOnEvent(n)},this.targetOrigin),c.listenToMessageFromWindow(this.eventSource,this.eventTarget,s.SEND_PROVIDER_META_INFO,n=>{this.providerMetaInfo=n,this.providerMetaInfoCallback&&this.providerMetaInfoCallback(this.providerMetaInfo)},this.targetOrigin)}async execute(e,t){const r=W(),o={jsonrpc:C,id:r,method:e,params:t},n=new Promise((d,a)=>this.completers[r]={resolve:d,reject:a});return c.postMessageToWindow(this.eventTarget,s.PROVIDER_RPC_REQUEST,{rpcRequest:o},this.targetOrigin),setTimeout(()=>{this.completers[r]&&(this.completers[r].reject(new Error("Request timed out. Please try again and submit it faster.")),delete this.completers[r])},this.timeoutMilliseconds),n}async send(e,t){const{method:r,params:o}=typeof e=="string"?{method:e,params:t}:{method:e.method,params:e.params},n=await this.execute(r,o);if("error"in n)throw new N(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 r=await this.execute(e.method,e.params);t(null,r)}catch(r){t(D(r),null)}}onProviderMetaInfo(e){this.providerMetaInfo?e(this.providerMetaInfo):(this.providerMetaInfoCallback=e,c.postMessageToWindow(this.eventTarget,s.REQUEST_PROVIDER_META_INFO,null,this.targetOrigin))}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 D(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=O;exports.IframeRpcProviderEvents=s;exports.IframeTransport=f;exports.WidgetEthereumProvider=S;exports.getParentOrigin=E;exports.iframeRpcProviderTransport=c;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("eventemitter3"),m="https://swap.cow.fi";function h(...i){process.env.NODE_ENV!=="test"&&console.debug("%c [COW][Widget]","font-weight: bold; color: #ff0000",...i)}function l(i){try{const{hostname:e}=new URL(i);return e==="localhost"||e==="127.0.0.1"||e==="::1"||e==="[::1]"}catch{return!1}}class f{constructor(e){this.key=e}postMessageToWindow(e,t,r,o=m){const n=typeof r=="object"?r:{},d={key:this.key,method:t,...n};e.postMessage(d,o)}listenToMessageFromWindow(e,t,r,o,n=m){const d=a=>{if(!(!R(a.data)||a.data.key!==this.key||a.data.method!==r)){if(!a.source||a.source!==t){if(!(l(a.origin)||l(n))){h("Rejected message due to source mismatch",{key:this.key,method:r,actualSource:a.source,expectedSource:t});return}h("Non-matching or missing message source. Continuing due to local env.",{key:this.key,method:r,actualSource:a.source,expectedSource:t})}if(a.origin!==n){h("Rejected message due to origin mismatch",{key:this.key,method:r,actualOrigin:a.origin,trustedOrigin:n});return}o(a.data)}};return e.addEventListener("message",d),d}stopListeningToMessageFromWindow(e,t,r){e.removeEventListener("message",r)}stopListeningWindowListener(e,t){e.removeEventListener("message",t)}}function R(i){return typeof i=="object"&&i!==null&&"key"in i&&"method"in i&&typeof i.key=="string"&&typeof i.method=="string"}var s=(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))(s||{});const c=new f("cowSwapIframeRpcProviderTransport");function v(i){if(i.isWalletConnect)return i?.session?.peer?.metadata}function w(i,e){return e.find(t=>t.provider===i)?.info}const P=["connect","disconnect","close","chainChanged","accountsChanged"],g=[];typeof window<"u"&&window.addEventListener("eip6963:announceProvider",i=>{const e=i;g.push(e.detail)});class O{constructor(e,t){this.iframeWindow=e,this.iframeOrigin=t}ethereumProvider=null;requestWaitingForConnection={};providerEventListeners=[];disconnect(){if(!(typeof window>"u")){if(this.ethereumProvider){const e=this.ethereumProvider;if(typeof e.removeListener=="function")for(const{event:t,handler:r}of this.providerEventListeners)e.removeListener(t,r)}this.providerEventListeners=[],this.ethereumProvider=null,c.stopListeningToMessageFromWindow(window,s.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow),c.stopListeningToMessageFromWindow(window,s.REQUEST_PROVIDER_META_INFO,this.processProviderMetaInfoRequest)}}onConnect(e){typeof window>"u"||(this.ethereumProvider?this.disconnect():c.listenToMessageFromWindow(window,this.iframeWindow,s.PROVIDER_RPC_REQUEST,this.processRpcCallFromWindow,this.iframeOrigin),this.ethereumProvider=e,this.processPendingRequests(),P.forEach(t=>{const r=o=>this.onProviderEvent(t,o);this.providerEventListeners.push({event:t,handler:r}),e.on(t,r)}),c.listenToMessageFromWindow(window,this.iframeWindow,s.REQUEST_PROVIDER_META_INFO,this.processProviderMetaInfoRequest,this.iframeOrigin))}processPendingRequests(){Object.keys(this.requestWaitingForConnection).forEach(e=>{this.processRpcRequest(this.requestWaitingForConnection[e])}),this.requestWaitingForConnection={}}processRpcRequest(e){const{id:t,jsonrpc:r,method:o}=e;if(!this.ethereumProvider||!t)return;(o==="enable"?this.ethereumProvider.request({method:"eth_requestAccounts",id:t}):this.ethereumProvider.request({...e,id:t})).then(d=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:r,id:t,result:d}})).catch(d=>this.forwardRpcResponseToIframe({rpcResponse:{jsonrpc:r,id:t,error:d}}))}processRpcCallFromWindow=({rpcRequest:e})=>{if(!this.ethereumProvider){e.id&&(this.requestWaitingForConnection[e.id]=e);return}this.processRpcRequest(e)};processProviderMetaInfoRequest=()=>{if(!this.ethereumProvider)return;const e=w(this.ethereumProvider,g),t=v(this.ethereumProvider);c.postMessageToWindow(this.iframeWindow,s.SEND_PROVIDER_META_INFO,{providerEip6963Info:e,providerWcMetadata:t},this.iframeOrigin)};onProviderEvent(e,t){c.postMessageToWindow(this.iframeWindow,s.PROVIDER_ON_EVENT,{event:e,params:t},this.iframeOrigin)}forwardRpcResponseToIframe(e){c.postMessageToWindow(this.iframeWindow,s.PROVIDER_RPC_RESPONSE,e,this.iframeOrigin)}}function E(){const i=u(_())||u(T())||u(I());if(i)try{return new URL(i).origin}catch(e){console.error("[getParentOrigin] origin is invalid",e,{origin:i});return}}function u(i){return i&&i!=="null"?i:void 0}function _(){if(typeof window>"u")return;const i=window.location.ancestorOrigins;if(!(!i||i.length===0))return i[0]}function T(){if(!(typeof document>"u"||!document.referrer))try{return new URL(document.referrer).origin}catch{return}}function I(){if(!(typeof window>"u"||!window.parent||window.parent===window))try{return window.parent.location.origin}catch{return}}const M=6e5,C="2.0",y="https://swap.cow.fi";class N extends Error{isRpcError=!0;code;reason;constructor(e,t){super(`${e}: ${t}`),this.code=e,this.reason=t}}class S extends p{request({method:e,params:t}){return e==="wallet_revokePermissions"?Promise.resolve(null):this.send(e,t)}isConnected(){return!0}get isIFrame(){return!0}get currentProvider(){return this}enabled=null;timeoutMilliseconds;eventSource;eventTarget;targetOrigin;completers={};providerMetaInfo=null;providerMetaInfoCallback;constructor({targetOrigin:e,timeoutMilliseconds:t=M,eventSource:r=window,eventTarget:o=window.parent}={}){super(),this.timeoutMilliseconds=t,this.eventSource=r,this.eventTarget=o,this.targetOrigin=e||E()||y,c.listenToMessageFromWindow(this.eventSource,this.eventTarget,s.PROVIDER_RPC_RESPONSE,n=>{this.handleRpcRequests(n)},this.targetOrigin),c.listenToMessageFromWindow(this.eventSource,this.eventTarget,s.PROVIDER_ON_EVENT,n=>{this.handleOnEvent(n)},this.targetOrigin),c.listenToMessageFromWindow(this.eventSource,this.eventTarget,s.SEND_PROVIDER_META_INFO,n=>{this.providerMetaInfo=n,this.providerMetaInfoCallback&&this.providerMetaInfoCallback(this.providerMetaInfo)},this.targetOrigin)}async execute(e,t){const r=W(),o={jsonrpc:C,id:r,method:e,params:t},n=new Promise((d,a)=>this.completers[r]={resolve:d,reject:a});return c.postMessageToWindow(this.eventTarget,s.PROVIDER_RPC_REQUEST,{rpcRequest:o},this.targetOrigin),setTimeout(()=>{this.completers[r]&&(this.completers[r].reject(new Error("Request timed out. Please try again and submit it faster.")),delete this.completers[r])},this.timeoutMilliseconds),n}async send(e,t){const{method:r,params:o}=typeof e=="string"?{method:e,params:t}:{method:e.method,params:e.params},n=await this.execute(r,o);if("error"in n)throw new N(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 r=await this.execute(e.method,e.params);t(null,r)}catch(r){t(D(r),null)}}onProviderMetaInfo(e){this.providerMetaInfo?e(this.providerMetaInfo):(this.providerMetaInfoCallback=e,c.postMessageToWindow(this.eventTarget,s.REQUEST_PROVIDER_META_INFO,null,this.targetOrigin))}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 D(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=O;exports.IframeRpcProviderEvents=s;exports.IframeTransport=f;exports.WidgetEthereumProvider=S;exports.getParentOrigin=E;exports.iframeRpcProviderTransport=c;exports.isLocalEnvOrigin=l;
package/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  export { IframeRpcProviderBridge } from './iframeRpcProvider/IframeRpcProviderBridge';
2
2
  export type { EthereumProviderWithRemoveListener } from './iframeRpcProvider/IframeRpcProviderBridge';
3
3
  export { WidgetEthereumProvider } from './iframeRpcProvider/WidgetEthereumProvider';
4
- export { IframeTransport } from './IframeTransport';
4
+ export { IframeTransport, isLocalEnvOrigin } from './IframeTransport';
5
5
  export { getParentOrigin } from './getParentOrigin';
6
6
  export * from './iframeRpcProvider/iframeRpcProviderEvents';
7
7
  export * from './types';
package/index.js CHANGED
@@ -487,5 +487,6 @@ export {
487
487
  E as IframeTransport,
488
488
  F as WidgetEthereumProvider,
489
489
  P as getParentOrigin,
490
- c as iframeRpcProviderTransport
490
+ c as iframeRpcProviderTransport,
491
+ m as isLocalEnvOrigin
491
492
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cowprotocol/iframe-transport",
3
- "version": "2.2.4",
3
+ "version": "2.2.6",
4
4
  "description": "CoW Swap iframe-transport",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,7 +15,7 @@
15
15
  "access": "public"
16
16
  },
17
17
  "dependencies": {
18
- "@cowprotocol/types": "^4.3.1",
18
+ "@cowprotocol/types": "^4.3.2",
19
19
  "eventemitter3": "^4.0.0"
20
20
  },
21
21
  "exports": {