@0xsequence/provider 0.40.2 → 0.40.5

package/dist/0xsequence-provider.esm.js

@@ -589,19 +589,19 @@ class WalletRequestHandler {
               let sig = ''; // Message must be prefixed with "\x19Ethereum Signed Message:\n"
               // as defined by EIP-191
 
-              message = prefixEIP191Message(message); // TODO:
+              const prefixedMessage = prefixEIP191Message(message); // TODO:
               // if (process.env.TEST_MODE === 'true' && this.prompter === null) {
 
               if (_this.prompter === null) {
                 // prompter is null, so we'll sign from here
-                sig = await signer.signMessage(ethers.utils.arrayify(message), chainId);
+                sig = await signer.signMessage(prefixedMessage, chainId);
               } else {
                 const promptResultForDeployment = await _this.handleConfirmWalletDeployPrompt(_this.prompter, signer, chainId);
 
                 if (promptResultForDeployment) {
                   sig = await _this.prompter.promptSignMessage({
                     chainId: chainId,
-                    message
+                    message: prefixedMessage
                   }, _this.connectOptions);
                 }
               }
@@ -3141,6 +3141,257 @@ class BaseInjectedTransport extends EventEmitter2 {
 
 }
 
+/**
+ * This will redirect console logs from Sequence.js & the wallet to the Unreal console, for debugging purposes.
+ */
+function overrideLogs(side) {
+  var _window$ue;
+
+  if ((_window$ue = window.ue) != null && _window$ue.sequencewallettransport && !window.logsOverriddenForUnreal) {
+    var _window$ue2;
+
+    const t = (_window$ue2 = window.ue) == null ? void 0 : _window$ue2.sequencewallettransport;
+
+    console.log = (...args) => {
+      t.logfromjs(`${side}: ${stringify(args)}`);
+    };
+
+    console.warn = (...args) => {
+      t.warnfromjs(`${side}: ${stringify(args)}`);
+    };
+
+    console.error = (...args) => {
+      t.errorfromjs(`${side}: ${stringify(args)}`);
+    };
+
+    window.logsOverriddenForUnreal = true;
+  }
+}
+
+function stringify(things) {
+  return things.map(a => typeof a === 'object' ? a instanceof Error ? a.message : JSON.stringify(a) : String(a)).join(' ');
+}
+
+let registeredUnrealMessageProvider; // all lowercase is an annoying limitation of Unreal CEF BindUObject
+
+/**
+ * Initialized on dApp side
+ */
+class UnrealMessageProvider extends BaseProviderTransport {
+  constructor(walletAppURL) {
+    super();
+    this.walletURL = void 0;
+
+    this.register = () => {
+      var _window$ue;
+
+      overrideLogs('dapp');
+
+      if (registeredUnrealMessageProvider) {
+        // overriding the registered message provider
+        registeredUnrealMessageProvider.unregister();
+        registeredUnrealMessageProvider = this;
+      } // listen for incoming messages from wallet
+
+
+      if ((_window$ue = window.ue) != null && _window$ue.sequencewallettransport) {
+        window.ue.sequencewallettransport.onmessagefromwallet = this.onUnrealCallback;
+      }
+
+      registeredUnrealMessageProvider = this;
+      this._registered = true;
+      console.log('registering transport!');
+    };
+
+    this.unregister = () => {
+      var _window$ue2, _window$ue2$sequencew;
+
+      this._registered = false;
+      this.closeWallet(); // disable message listener
+
+      if (registeredUnrealMessageProvider === this) {
+        registeredUnrealMessageProvider = undefined;
+      }
+
+      if (((_window$ue2 = window.ue) == null ? void 0 : (_window$ue2$sequencew = _window$ue2.sequencewallettransport) == null ? void 0 : _window$ue2$sequencew.onmessagefromwallet) === this.onUnrealCallback) {
+        delete window.ue.sequencewallettransport.onmessagefromwallet;
+      } // clear event listeners
+
+
+      this.events.removeAllListeners();
+    };
+
+    this.openWallet = (path, intent, networkId) => {
+      if (this.isOpened()) {
+        // TODO focus wallet
+        console.log('wallet already open!');
+        return;
+      }
+
+      console.log('opening wallet!'); // Instantiate new walletURL for this call
+
+      const walletURL = new URL(this.walletURL.href);
+      const windowSessionParams = new WindowSessionParams();
+
+      if (path) {
+        walletURL.pathname = path.toLowerCase();
+      } // Set session, intent and network id on walletURL
+
+
+      this._init = InitState.NIL;
+      this._sessionId = `${performance.now()}`;
+      windowSessionParams.set('sid', this._sessionId);
+
+      if (intent) {
+        // encode intent as base64 url-encoded param
+        windowSessionParams.set('intent', base64EncodeObject(intent));
+      }
+
+      if (networkId) {
+        windowSessionParams.set('net', `${networkId}`);
+      } // serialize params
+
+
+      walletURL.search = windowSessionParams.toString();
+      console.log('opening wallet to', walletURL.href);
+      window.open(walletURL.href);
+    };
+
+    this.onUnrealCallback = message => {
+      if (!message) {
+        throw new Error('ProviderMessage object is empty');
+      } // handle message with base message provider
+
+
+      this.handleMessage(message);
+    };
+
+    this.walletURL = new URL(walletAppURL);
+  }
+
+  closeWallet() {
+    this.close();
+  } // onmessage, receives ProviderMessageResponse from the wallet unreal transport
+
+
+  // all lowercase is an annoying limitation of Unreal CEF BindUObject
+  sendMessage(message) {
+    var _window$ue3, _window$ue3$sequencew;
+
+    const postedMessage = typeof message !== 'string' ? JSON.stringify(message) : message;
+    console.log('Sending message to wallet:', postedMessage);
+    (_window$ue3 = window.ue) == null ? void 0 : (_window$ue3$sequencew = _window$ue3.sequencewallettransport) == null ? void 0 : _window$ue3$sequencew.sendmessagetowallet(postedMessage);
+  }
+
+}
+
+/**
+ * Initialized on Wallet side
+ */
+class UnrealMessageHandler extends BaseWalletTransport {
+  constructor(walletRequestHandler) {
+    super(walletRequestHandler);
+
+    this.onMessageFromUnreal = request => {
+      // Wallet always expects json-rpc request messages from a dapp
+      logger.debug('RECEIVED MESSAGE', request); // Handle message via the base transport
+
+      this.handleMessage(request);
+    };
+
+    this.getUnrealTransportSession = windowParams => {
+      const params = new WindowSessionParams(windowParams);
+      return {
+        sessionId: params.get('sid'),
+        networkId: params.get('net'),
+        intent: base64DecodeObject(params.get('intent'))
+      };
+    };
+
+    this._init = InitState.NIL;
+  }
+
+  async register(windowHref) {
+    var _window$ue;
+
+    if (((_window$ue = window.ue) == null ? void 0 : _window$ue.sequencewallettransport) === undefined) {
+      return;
+    }
+
+    overrideLogs('wallet'); // record open details (sessionId + default network) from the window url
+
+    const {
+      search: rawParams
+    } = new URL(windowHref || window.location.href);
+    let session = this.getUnrealTransportSession(rawParams); // provider should always include sid when opening a new window
+
+    const isNewWindowSession = !!session.sessionId; // attempt to restore previous session in the case of a redirect or window reload
+
+    if (!isNewWindowSession) {
+      session = await this.getCachedTransportSession();
+    }
+
+    if (!session) {
+      logger.error('unreal session is undefined');
+      return;
+    } // listen for window-transport requests
+
+
+    window.ue.sequencewallettransport.onmessagefromsequencejs = this.onMessageFromUnreal;
+    this._registered = true; // send open event to the app which opened us
+
+    this.open(session).then(opened => {
+      if (!opened) {
+        var _session;
+
+        const err = `failed to open to network ${(_session = session) == null ? void 0 : _session.networkId}`;
+        logger.error(err);
+        this.notifyClose({
+          message: err
+        });
+        window.close();
+      }
+    }).catch(e => {
+      var _session2;
+
+      const err = `failed to open to network ${(_session2 = session) == null ? void 0 : _session2.networkId}, due to: ${e}`;
+      logger.error(err);
+      this.notifyClose({
+        message: err
+      });
+      window.close();
+    });
+  }
+
+  unregister() {
+    var _window$ue2, _window$ue2$sequencew;
+
+    if (((_window$ue2 = window.ue) == null ? void 0 : (_window$ue2$sequencew = _window$ue2.sequencewallettransport) == null ? void 0 : _window$ue2$sequencew.onmessagefromsequencejs) === this.onMessageFromUnreal) {
+      delete window.ue.sequencewallettransport.onmessagefromsequencejs;
+    }
+
+    this._registered = false;
+  } // onmessage is called when (the wallet) receives request messages from the dapp
+  // over the unreal json-messaging transport
+
+
+  // sendMessage sends message to the dapp window
+  sendMessage(message) {
+    var _window$ue3, _window$ue3$sequencew;
+
+    if (message.type !== EventType.INIT && this._init !== InitState.OK) {
+      logger.error('impossible state, should not be calling postMessage until inited');
+      return;
+    } // prepare payload
+
+
+    const payload = JSON.stringify(message); // post-message to app.
+
+    (_window$ue3 = window.ue) == null ? void 0 : (_window$ue3$sequencew = _window$ue3.sequencewallettransport) == null ? void 0 : _window$ue3$sequencew.sendmessagetosequencejs(payload);
+  }
+
+}
+
 class WalletUtils {
   constructor(walletProvider) {
     var _this = this;
@@ -3246,7 +3497,7 @@ class Wallet {
     this.providers = void 0;
 
     this.init = () => {
-      var _this$config$transpor, _this$config$transpor2, _this$config$transpor3, _this$config$transpor4, _this$config$transpor5, _this$config$transpor6;
+      var _this$config$transpor, _this$config$transpor2, _this$config$transpor3, _this$config$transpor4, _this$config$transpor5, _this$config$transpor6, _this$config$transpor7, _this$config$transpor8;
 
       if (this.transport.provider) {
         // init must have already been called
@@ -3278,6 +3529,11 @@ class Wallet {
         // this.transport.messageProvider.add(this.transport.extensionMessageProvider)
       }
 
+      if ((_this$config$transpor7 = this.config.transports) != null && (_this$config$transpor8 = _this$config$transpor7.unrealTransport) != null && _this$config$transpor8.enabled) {
+        this.transport.unrealMessageProvider = new UnrealMessageProvider(this.config.walletAppURL);
+        this.transport.messageProvider.add(this.transport.unrealMessageProvider);
+      }
+
       this.transport.messageProvider.register(); // .....
 
       this.transport.allowProvider = allowProviderMiddleware(request => {
@@ -3817,4 +4073,4 @@ const getWallet = () => {
   return walletInstance;
 };
 
-export { BaseInjectedTransport, BaseProviderTransport, BaseWalletTransport, CHANNEL_ID, DefaultProviderConfig, ErrSignedInRequired, EventType, ExtensionMessageHandler, ExtensionMessageProvider, InitState, LocalStorage, LocalStore, LocalWeb3Provider, MuxMessageProvider, OpenState, PROVIDER_OPEN_TIMEOUT, ProviderError, ProxyMessageChannel, ProxyMessageChannelPort, ProxyMessageHandler, ProxyMessageProvider, Wallet, WalletRequestHandler, Web3Provider, Web3Signer, WindowMessageHandler, WindowMessageProvider, WindowSessionParams, getWallet, initWallet, isBrowserExtension, isSequenceProvider, isValidMessageSignature, isValidSignature, isValidTypedDataSignature, isWalletUpToDate, messageToBytes, nextMessageIdx, prefixEIP191Message, recoverWalletConfig };
+export { BaseInjectedTransport, BaseProviderTransport, BaseWalletTransport, CHANNEL_ID, DefaultProviderConfig, ErrSignedInRequired, EventType, ExtensionMessageHandler, ExtensionMessageProvider, InitState, LocalStorage, LocalStore, LocalWeb3Provider, MuxMessageProvider, OpenState, PROVIDER_OPEN_TIMEOUT, ProviderError, ProxyMessageChannel, ProxyMessageChannelPort, ProxyMessageHandler, ProxyMessageProvider, UnrealMessageHandler, UnrealMessageProvider, Wallet, WalletRequestHandler, Web3Provider, Web3Signer, WindowMessageHandler, WindowMessageProvider, WindowSessionParams, getWallet, initWallet, isBrowserExtension, isSequenceProvider, isValidMessageSignature, isValidSignature, isValidTypedDataSignature, isWalletUpToDate, messageToBytes, nextMessageIdx, prefixEIP191Message, recoverWalletConfig };

package/dist/declarations/src/transports/index.d.ts

@@ -5,3 +5,4 @@ export * from './mux-transport';
 export * from './window-transport';
 export * from './wallet-request-handler';
 export * from './extension-transport';
+export * from './unreal-transport';

package/dist/declarations/src/transports/unreal-transport/index.d.ts

@@ -0,0 +1,2 @@
+export * from './unreal-message-provider';
+export * from './unreal-message-handler';

package/dist/declarations/src/transports/unreal-transport/overridelogs.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This will redirect console logs from Sequence.js & the wallet to the Unreal console, for debugging purposes.
+ */
+export declare function overrideLogs(side: 'dapp' | 'wallet'): void;

package/dist/declarations/src/transports/unreal-transport/unreal-message-handler.d.ts

@@ -0,0 +1,14 @@
+import { ProviderMessage } from '../../types';
+import { WalletRequestHandler } from '../wallet-request-handler';
+import { BaseWalletTransport } from '../base-wallet-transport';
+/**
+ * Initialized on Wallet side
+ */
+export declare class UnrealMessageHandler extends BaseWalletTransport {
+    constructor(walletRequestHandler: WalletRequestHandler);
+    register(windowHref?: string | URL): Promise<void>;
+    unregister(): void;
+    private onMessageFromUnreal;
+    sendMessage(message: ProviderMessage<any>): void;
+    private getUnrealTransportSession;
+}

package/dist/declarations/src/transports/unreal-transport/unreal-message-provider.d.ts

@@ -0,0 +1,15 @@
+import { OpenWalletIntent, ProviderMessage } from '../../types';
+import { BaseProviderTransport } from '../base-provider-transport';
+/**
+ * Initialized on dApp side
+ */
+export declare class UnrealMessageProvider extends BaseProviderTransport {
+    private walletURL;
+    constructor(walletAppURL: string);
+    register: () => void;
+    unregister: () => void;
+    openWallet: (path?: string | undefined, intent?: OpenWalletIntent | undefined, networkId?: string | number | undefined) => void;
+    closeWallet(): void;
+    private onUnrealCallback;
+    sendMessage(message: ProviderMessage<unknown>): void;
+}

package/dist/declarations/src/types.d.ts

@@ -192,7 +192,7 @@ export declare type OpenWalletIntent = {
     method: string;
 };
 export interface MessageToSign {
-    message?: string;
+    message?: Uint8Array;
     typedData?: TypedData;
     chainId?: number;
 }

package/dist/declarations/src/wallet.d.ts

@@ -95,6 +95,9 @@ export interface ProviderConfig {
             enabled: boolean;
             runtime: Runtime.Static;
         };
+        unrealTransport?: {
+            enabled: boolean;
+        };
     };
     walletContext?: WalletContext;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "0.40.2",
+  "version": "0.40.5",
   "description": "provider sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
   "source": "src/index.ts",
@@ -13,13 +13,13 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@0xsequence/abi": "^0.40.2",
-    "@0xsequence/auth": "^0.40.2",
-    "@0xsequence/config": "^0.40.2",
-    "@0xsequence/network": "^0.40.2",
-    "@0xsequence/transactions": "^0.40.2",
-    "@0xsequence/utils": "^0.40.2",
-    "@0xsequence/wallet": "^0.40.2",
+    "@0xsequence/abi": "^0.40.5",
+    "@0xsequence/auth": "^0.40.5",
+    "@0xsequence/config": "^0.40.5",
+    "@0xsequence/network": "^0.40.5",
+    "@0xsequence/transactions": "^0.40.5",
+    "@0xsequence/utils": "^0.40.5",
+    "@0xsequence/wallet": "^0.40.5",
     "@ethersproject/abstract-signer": "^5.5.0",
     "@ethersproject/hash": "^5.5.0",
     "@ethersproject/providers": "^5.5.1",

package/src/transports/index.ts

@@ -5,3 +5,4 @@ export * from './mux-transport'
 export * from './window-transport'
 export * from './wallet-request-handler'
 export * from './extension-transport'
+export * from './unreal-transport'

package/src/transports/unreal-transport/index.ts

@@ -0,0 +1,2 @@
+export * from './unreal-message-provider'
+export * from './unreal-message-handler'

package/src/transports/unreal-transport/overridelogs.ts

@@ -0,0 +1,36 @@
+interface UnrealInjectedWindow {
+  ue?: {
+    sequencewallettransport?: {
+      logfromjs: (message: string) => void
+      warnfromjs: (message: string) => void
+      errorfromjs: (message: string) => void
+    }
+  }
+  logsOverriddenForUnreal?: boolean
+}
+declare const window: Window & typeof globalThis & UnrealInjectedWindow
+
+/**
+ * This will redirect console logs from Sequence.js & the wallet to the Unreal console, for debugging purposes.
+ */
+export function overrideLogs(side: 'dapp' | 'wallet') {
+  if (window.ue?.sequencewallettransport && !window.logsOverriddenForUnreal) {
+    const t = window.ue?.sequencewallettransport
+    console.log = (...args: unknown[]) => {
+      t.logfromjs(`${side}: ${stringify(args)}`)
+    }
+    console.warn = (...args: unknown[]) => {
+      t.warnfromjs(`${side}: ${stringify(args)}`)
+    }
+    console.error = (...args: unknown[]) => {
+      t.errorfromjs(`${side}: ${stringify(args)}`)
+    }
+    window.logsOverriddenForUnreal = true
+  }
+}
+
+function stringify(things: unknown[]): string {
+  return things
+    .map(a => (typeof a === 'object' ? (a instanceof Error ? a.message : JSON.stringify(a)) : String(a)))
+    .join(' ')
+}

package/src/transports/unreal-transport/unreal-message-handler.ts

@@ -0,0 +1,121 @@
+import {
+  ProviderMessageRequest,
+  ProviderMessage,
+  EventType,
+  InitState,
+  WindowSessionParams,
+  OpenWalletIntent,
+  ProviderRpcError,
+  TransportSession
+} from '../../types'
+import { WalletRequestHandler } from '../wallet-request-handler'
+import { BaseWalletTransport } from '../base-wallet-transport'
+import { logger, base64DecodeObject } from '@0xsequence/utils'
+import { overrideLogs } from './overridelogs'
+
+// all lowercase is an annoying limitation of Unreal CEF BindUObject
+interface UnrealInjectedWalletWindow {
+  ue?: {
+    sequencewallettransport?: {
+      onmessagefromsequencejs?: (message: ProviderMessageRequest) => void
+      sendmessagetosequencejs: (message: string) => void
+    }
+  }
+}
+declare const window: Window & typeof globalThis & UnrealInjectedWalletWindow
+
+/**
+ * Initialized on Wallet side
+ */
+export class UnrealMessageHandler extends BaseWalletTransport {
+  constructor(walletRequestHandler: WalletRequestHandler) {
+    super(walletRequestHandler)
+    this._init = InitState.NIL
+  }
+
+  async register(windowHref?: string | URL) {
+    if (window.ue?.sequencewallettransport === undefined) {
+      return
+    }
+    overrideLogs('wallet')
+
+    // record open details (sessionId + default network) from the window url
+    const { search: rawParams } = new URL(windowHref || window.location.href)
+
+    let session: TransportSession | null = this.getUnrealTransportSession(rawParams)
+
+    // provider should always include sid when opening a new window
+    const isNewWindowSession = !!session.sessionId
+
+    // attempt to restore previous session in the case of a redirect or window reload
+    if (!isNewWindowSession) {
+      session = await this.getCachedTransportSession()
+    }
+
+    if (!session) {
+      logger.error('unreal session is undefined')
+      return
+    }
+
+    // listen for window-transport requests
+    window.ue.sequencewallettransport.onmessagefromsequencejs = this.onMessageFromUnreal
+    this._registered = true
+
+    // send open event to the app which opened us
+    this.open(session)
+      .then(opened => {
+        if (!opened) {
+          const err = `failed to open to network ${session?.networkId}`
+          logger.error(err)
+          this.notifyClose({ message: err } as ProviderRpcError)
+          window.close()
+        }
+      })
+      .catch(e => {
+        const err = `failed to open to network ${session?.networkId}, due to: ${e}`
+        logger.error(err)
+        this.notifyClose({ message: err } as ProviderRpcError)
+        window.close()
+      })
+  }
+
+  unregister() {
+    if (window.ue?.sequencewallettransport?.onmessagefromsequencejs === this.onMessageFromUnreal) {
+      delete window.ue.sequencewallettransport.onmessagefromsequencejs
+    }
+    this._registered = false
+  }
+
+  // onmessage is called when (the wallet) receives request messages from the dapp
+  // over the unreal json-messaging transport
+  private onMessageFromUnreal = (request: ProviderMessageRequest) => {
+    // Wallet always expects json-rpc request messages from a dapp
+
+    logger.debug('RECEIVED MESSAGE', request)
+
+    // Handle message via the base transport
+    this.handleMessage(request)
+  }
+
+  // sendMessage sends message to the dapp window
+  sendMessage(message: ProviderMessage<any>) {
+    if (message.type !== EventType.INIT && this._init !== InitState.OK) {
+      logger.error('impossible state, should not be calling postMessage until inited')
+      return
+    }
+    // prepare payload
+    const payload = JSON.stringify(message)
+
+    // post-message to app.
+    window.ue?.sequencewallettransport?.sendmessagetosequencejs(payload)
+  }
+
+  private getUnrealTransportSession = (windowParams: string | undefined): TransportSession => {
+    const params = new WindowSessionParams(windowParams)
+    return {
+      sessionId: params.get('sid'),
+      networkId: params.get('net'),
+      intent: base64DecodeObject<OpenWalletIntent>(params.get('intent'))
+    }
+  }
+}