@0xsequence/provider 0.35.5 → 0.35.6

package/dist/0xsequence-provider.cjs.dev.js

@@ -597,9 +597,14 @@ class BaseWalletTransport {
     };
 
     this.handleMessage = async function (message) {
-      const request = message; // ensure initial handshake is complete before accepting
+      const request = message; // ensure signer is ready to handle requests
+
+      if (_this.walletRequestHandler.getSigner() === undefined) {
+        await _this.walletRequestHandler.signerReady();
+      } // ensure initial handshake is complete before accepting
       // other kinds of messages.
 
+
       if (_this._init !== exports.InitState.OK) {
         if (request.type === exports.EventType.INIT) {
           if (_this.isValidInitAck(message)) {
@@ -671,6 +676,13 @@ class BaseWalletTransport {
           intent,
           networkId
         });
+      }
+
+      _this.walletRequestHandler.setOpenIntent(intent); // ensure signer is ready
+
+
+      if (_this.walletRequestHandler.getSigner() === undefined) {
+        await _this.walletRequestHandler.signerReady();
       } // init handshake for certain transports, before we can open the communication.
       //
       // for example, with the window-transport, we have to exchange messages to determine the
@@ -1616,12 +1628,6 @@ class WindowMessageHandler extends BaseWalletTransport {
     if (!session) {
       utils.logger.error('window session is undefined');
       return;
-    }
-
-    if (session.intent && isNewWindowSession) {
-      window.history.replaceState({
-        openWalletIntent: true
-      }, document.title, pathname);
     } // record parent window instance for communication
 
 
@@ -1700,13 +1706,18 @@ class WindowMessageHandler extends BaseWalletTransport {
 }
 
 class WalletRequestHandler {
+  // signer interface of the wallet. A null value means there is no signer (ie. user not signed in). An undefined
+  // value means the signer state is unknown, usually meaning the wallet app is booting up and initializing. Of course
+  // a Signer value is the actually interface to a signed-in account
   constructor(_signer, prompter, mainnetNetworks, testnetNetworks = []) {
     var _this = this;
 
     this.signer = void 0;
+    this.signerReadyCallbacks = [];
     this.prompter = void 0;
     this.mainnetNetworks = void 0;
     this.testnetNetworks = void 0;
+    this._openIntent = void 0;
     this._connectOptions = void 0;
     this._defaultNetworkId = void 0;
     this._chainId = void 0;
@@ -1744,6 +1755,10 @@ class WalletRequestHandler {
         result: null
       };
 
+      if (_this.signer === undefined) {
+        await _this.signerReady();
+      }
+
       try {
         // only allow public json rpc method to the provider when user is not logged in, aka signer is not set
         if ((!_this.signer || _this.signer === null) && !permittedJsonRpcMethods.includes(request.method)) {
@@ -2142,7 +2157,7 @@ class WalletRequestHandler {
   }
 
   async signIn(signer, options = {}) {
-    this.signer = signer;
+    this.setSigner(signer);
     const {
       connect,
       mainnetNetworks,
@@ -2189,6 +2204,29 @@ class WalletRequestHandler {
     }
   }
 
+  signOut() {
+    // signed out state
+    this.signer = null;
+  }
+
+  signerReset() {
+    // resetting signer puts the wallet in an uninitialized state, which requires the app to
+    // re-initiatize and set the signer either as "null" (ie. no signer) or "Signer" (ie. signed in).
+    this.signer = undefined;
+  }
+
+  signerReady() {
+    return new Promise((resolve, reject) => {
+      if (this.signer !== undefined) {
+        resolve(undefined);
+      } else {
+        this.signerReadyCallbacks.push(() => {
+          resolve(undefined);
+        });
+      }
+    });
+  }
+
   async connect(options) {
     if (!this.signer) {
       return {
@@ -2277,6 +2315,14 @@ class WalletRequestHandler {
     }
   }
 
+  get openIntent() {
+    return this._openIntent;
+  }
+
+  setOpenIntent(intent) {
+    this._openIntent = intent;
+  }
+
   get connectOptions() {
     return this._connectOptions;
   }
@@ -2390,6 +2436,14 @@ class WalletRequestHandler {
 
   setSigner(signer) {
     this.signer = signer;
+
+    if (signer !== undefined) {
+      for (let i = 0; i < this.signerReadyCallbacks.length; i++) {
+        this.signerReadyCallbacks[i]();
+      }
+
+      this.signerReadyCallbacks = [];
+    }
   }
 
   async handleConfirmWalletDeployPrompt(prompter, signer, chainId) {

package/dist/0xsequence-provider.cjs.prod.js

@@ -597,9 +597,14 @@ class BaseWalletTransport {
     };
 
     this.handleMessage = async function (message) {
-      const request = message; // ensure initial handshake is complete before accepting
+      const request = message; // ensure signer is ready to handle requests
+
+      if (_this.walletRequestHandler.getSigner() === undefined) {
+        await _this.walletRequestHandler.signerReady();
+      } // ensure initial handshake is complete before accepting
       // other kinds of messages.
 
+
       if (_this._init !== exports.InitState.OK) {
         if (request.type === exports.EventType.INIT) {
           if (_this.isValidInitAck(message)) {
@@ -671,6 +676,13 @@ class BaseWalletTransport {
           intent,
           networkId
         });
+      }
+
+      _this.walletRequestHandler.setOpenIntent(intent); // ensure signer is ready
+
+
+      if (_this.walletRequestHandler.getSigner() === undefined) {
+        await _this.walletRequestHandler.signerReady();
       } // init handshake for certain transports, before we can open the communication.
       //
       // for example, with the window-transport, we have to exchange messages to determine the
@@ -1616,12 +1628,6 @@ class WindowMessageHandler extends BaseWalletTransport {
     if (!session) {
       utils.logger.error('window session is undefined');
       return;
-    }
-
-    if (session.intent && isNewWindowSession) {
-      window.history.replaceState({
-        openWalletIntent: true
-      }, document.title, pathname);
     } // record parent window instance for communication
 
 
@@ -1700,13 +1706,18 @@ class WindowMessageHandler extends BaseWalletTransport {
 }
 
 class WalletRequestHandler {
+  // signer interface of the wallet. A null value means there is no signer (ie. user not signed in). An undefined
+  // value means the signer state is unknown, usually meaning the wallet app is booting up and initializing. Of course
+  // a Signer value is the actually interface to a signed-in account
   constructor(_signer, prompter, mainnetNetworks, testnetNetworks = []) {
     var _this = this;
 
     this.signer = void 0;
+    this.signerReadyCallbacks = [];
     this.prompter = void 0;
     this.mainnetNetworks = void 0;
     this.testnetNetworks = void 0;
+    this._openIntent = void 0;
     this._connectOptions = void 0;
     this._defaultNetworkId = void 0;
     this._chainId = void 0;
@@ -1744,6 +1755,10 @@ class WalletRequestHandler {
         result: null
       };
 
+      if (_this.signer === undefined) {
+        await _this.signerReady();
+      }
+
       try {
         // only allow public json rpc method to the provider when user is not logged in, aka signer is not set
         if ((!_this.signer || _this.signer === null) && !permittedJsonRpcMethods.includes(request.method)) {
@@ -2142,7 +2157,7 @@ class WalletRequestHandler {
   }
 
   async signIn(signer, options = {}) {
-    this.signer = signer;
+    this.setSigner(signer);
     const {
       connect,
       mainnetNetworks,
@@ -2189,6 +2204,29 @@ class WalletRequestHandler {
     }
   }
 
+  signOut() {
+    // signed out state
+    this.signer = null;
+  }
+
+  signerReset() {
+    // resetting signer puts the wallet in an uninitialized state, which requires the app to
+    // re-initiatize and set the signer either as "null" (ie. no signer) or "Signer" (ie. signed in).
+    this.signer = undefined;
+  }
+
+  signerReady() {
+    return new Promise((resolve, reject) => {
+      if (this.signer !== undefined) {
+        resolve(undefined);
+      } else {
+        this.signerReadyCallbacks.push(() => {
+          resolve(undefined);
+        });
+      }
+    });
+  }
+
   async connect(options) {
     if (!this.signer) {
       return {
@@ -2277,6 +2315,14 @@ class WalletRequestHandler {
     }
   }
 
+  get openIntent() {
+    return this._openIntent;
+  }
+
+  setOpenIntent(intent) {
+    this._openIntent = intent;
+  }
+
   get connectOptions() {
     return this._connectOptions;
   }
@@ -2390,6 +2436,14 @@ class WalletRequestHandler {
 
   setSigner(signer) {
     this.signer = signer;
+
+    if (signer !== undefined) {
+      for (let i = 0; i < this.signerReadyCallbacks.length; i++) {
+        this.signerReadyCallbacks[i]();
+      }
+
+      this.signerReadyCallbacks = [];
+    }
   }
 
   async handleConfirmWalletDeployPrompt(prompter, signer, chainId) {

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

@@ -593,9 +593,14 @@ class BaseWalletTransport {
     };
 
     this.handleMessage = async function (message) {
-      const request = message; // ensure initial handshake is complete before accepting
+      const request = message; // ensure signer is ready to handle requests
+
+      if (_this.walletRequestHandler.getSigner() === undefined) {
+        await _this.walletRequestHandler.signerReady();
+      } // ensure initial handshake is complete before accepting
       // other kinds of messages.
 
+
       if (_this._init !== InitState.OK) {
         if (request.type === EventType.INIT) {
           if (_this.isValidInitAck(message)) {
@@ -667,6 +672,13 @@ class BaseWalletTransport {
           intent,
           networkId
         });
+      }
+
+      _this.walletRequestHandler.setOpenIntent(intent); // ensure signer is ready
+
+
+      if (_this.walletRequestHandler.getSigner() === undefined) {
+        await _this.walletRequestHandler.signerReady();
       } // init handshake for certain transports, before we can open the communication.
       //
       // for example, with the window-transport, we have to exchange messages to determine the
@@ -1612,12 +1624,6 @@ class WindowMessageHandler extends BaseWalletTransport {
     if (!session) {
       logger.error('window session is undefined');
       return;
-    }
-
-    if (session.intent && isNewWindowSession) {
-      window.history.replaceState({
-        openWalletIntent: true
-      }, document.title, pathname);
     } // record parent window instance for communication
 
 
@@ -1696,13 +1702,18 @@ class WindowMessageHandler extends BaseWalletTransport {
 }
 
 class WalletRequestHandler {
+  // signer interface of the wallet. A null value means there is no signer (ie. user not signed in). An undefined
+  // value means the signer state is unknown, usually meaning the wallet app is booting up and initializing. Of course
+  // a Signer value is the actually interface to a signed-in account
   constructor(_signer, prompter, mainnetNetworks, testnetNetworks = []) {
     var _this = this;
 
     this.signer = void 0;
+    this.signerReadyCallbacks = [];
     this.prompter = void 0;
     this.mainnetNetworks = void 0;
     this.testnetNetworks = void 0;
+    this._openIntent = void 0;
     this._connectOptions = void 0;
     this._defaultNetworkId = void 0;
     this._chainId = void 0;
@@ -1740,6 +1751,10 @@ class WalletRequestHandler {
         result: null
       };
 
+      if (_this.signer === undefined) {
+        await _this.signerReady();
+      }
+
       try {
         // only allow public json rpc method to the provider when user is not logged in, aka signer is not set
         if ((!_this.signer || _this.signer === null) && !permittedJsonRpcMethods.includes(request.method)) {
@@ -2138,7 +2153,7 @@ class WalletRequestHandler {
   }
 
   async signIn(signer, options = {}) {
-    this.signer = signer;
+    this.setSigner(signer);
     const {
       connect,
       mainnetNetworks,
@@ -2185,6 +2200,29 @@ class WalletRequestHandler {
     }
   }
 
+  signOut() {
+    // signed out state
+    this.signer = null;
+  }
+
+  signerReset() {
+    // resetting signer puts the wallet in an uninitialized state, which requires the app to
+    // re-initiatize and set the signer either as "null" (ie. no signer) or "Signer" (ie. signed in).
+    this.signer = undefined;
+  }
+
+  signerReady() {
+    return new Promise((resolve, reject) => {
+      if (this.signer !== undefined) {
+        resolve(undefined);
+      } else {
+        this.signerReadyCallbacks.push(() => {
+          resolve(undefined);
+        });
+      }
+    });
+  }
+
   async connect(options) {
     if (!this.signer) {
       return {
@@ -2273,6 +2311,14 @@ class WalletRequestHandler {
     }
   }
 
+  get openIntent() {
+    return this._openIntent;
+  }
+
+  setOpenIntent(intent) {
+    this._openIntent = intent;
+  }
+
   get connectOptions() {
     return this._connectOptions;
   }
@@ -2386,6 +2432,14 @@ class WalletRequestHandler {
 
   setSigner(signer) {
     this.signer = signer;
+
+    if (signer !== undefined) {
+      for (let i = 0; i < this.signerReadyCallbacks.length; i++) {
+        this.signerReadyCallbacks[i]();
+      }
+
+      this.signerReadyCallbacks = [];
+    }
   }
 
   async handleConfirmWalletDeployPrompt(prompter, signer, chainId) {

package/dist/declarations/src/transports/wallet-request-handler.d.ts

@@ -1,4 +1,4 @@
-import { ProviderMessageRequest, ProviderMessageResponse, ProviderMessageRequestHandler, MessageToSign, ProviderRpcError, ConnectOptions, ConnectDetails, PromptConnectDetails, WalletSession, ProviderEventTypes } from '../types';
+import { ProviderMessageRequest, ProviderMessageResponse, ProviderMessageRequestHandler, MessageToSign, ProviderRpcError, ConnectOptions, ConnectDetails, PromptConnectDetails, WalletSession, OpenWalletIntent, ProviderEventTypes } from '../types';
 import { ExternalProvider } from '@ethersproject/providers';
 import { Networks, NetworkConfig, JsonRpcHandler, JsonRpcRequest, JsonRpcResponseCallback } from '@0xsequence/network';
 import { Signer } from '@0xsequence/wallet';
@@ -11,15 +11,20 @@ export interface WalletSignInOptions {
 }
 export declare class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, ProviderMessageRequestHandler {
     private signer;
+    private signerReadyCallbacks;
     private prompter;
     private mainnetNetworks;
     private testnetNetworks;
+    private _openIntent?;
     private _connectOptions?;
     private _defaultNetworkId?;
     private _chainId?;
     private events;
-    constructor(signer: Signer | null, prompter: WalletUserPrompter | null, mainnetNetworks: Networks, testnetNetworks?: Networks);
+    constructor(signer: Signer | null | undefined, prompter: WalletUserPrompter | null, mainnetNetworks: Networks, testnetNetworks?: Networks);
     signIn(signer: Signer | null, options?: WalletSignInOptions): Promise<void>;
+    signOut(): void;
+    signerReset(): void;
+    signerReady(): Promise<unknown>;
     connect(options?: ConnectOptions): Promise<ConnectDetails>;
     promptConnect: (options?: ConnectOptions | undefined) => Promise<ConnectDetails>;
     sendMessageRequest(message: ProviderMessageRequest): Promise<ProviderMessageResponse>;
@@ -28,6 +33,8 @@ export declare class WalletRequestHandler implements ExternalProvider, JsonRpcHa
     once<K extends keyof ProviderEventTypes>(event: K, fn: ProviderEventTypes[K]): void;
     getAddress(): Promise<string>;
     getChainId(): Promise<number>;
+    get openIntent(): OpenWalletIntent | undefined;
+    setOpenIntent(intent: OpenWalletIntent | undefined): void;
     get connectOptions(): ConnectOptions | undefined;
     setConnectOptions(options: ConnectOptions | undefined): void;
     get defaultNetworkId(): string | number | undefined;
@@ -40,8 +47,8 @@ export declare class WalletRequestHandler implements ExternalProvider, JsonRpcHa
     notifyWalletContext(): Promise<void>;
     notifyClose(error?: ProviderRpcError): void;
     isSignedIn(): boolean;
-    getSigner(): Signer | null;
-    setSigner(signer: Signer | null): void;
+    getSigner(): Signer | null | undefined;
+    setSigner(signer: Signer | null | undefined): void;
     private handleConfirmWalletDeployPrompt;
 }
 export interface WalletUserPrompter {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "0.35.5",
+  "version": "0.35.6",
   "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.35.5",
-    "@0xsequence/auth": "^0.35.5",
-    "@0xsequence/config": "^0.35.5",
-    "@0xsequence/network": "^0.35.5",
-    "@0xsequence/transactions": "^0.35.5",
-    "@0xsequence/utils": "^0.35.5",
-    "@0xsequence/wallet": "^0.35.5",
+    "@0xsequence/abi": "^0.35.6",
+    "@0xsequence/auth": "^0.35.6",
+    "@0xsequence/config": "^0.35.6",
+    "@0xsequence/network": "^0.35.6",
+    "@0xsequence/transactions": "^0.35.6",
+    "@0xsequence/utils": "^0.35.6",
+    "@0xsequence/wallet": "^0.35.6",
     "@ethersproject/abstract-signer": "^5.5.0",
     "@ethersproject/hash": "^5.5.0",
     "@ethersproject/providers": "^5.5.1",

package/src/transports/base-wallet-transport.ts

@@ -100,6 +100,11 @@ export abstract class BaseWalletTransport implements WalletTransport {
   handleMessage = async (message: ProviderMessage<any>) => {
     const request = message
 
+    // ensure signer is ready to handle requests
+    if (this.walletRequestHandler.getSigner() === undefined) {
+      await this.walletRequestHandler.signerReady()
+    }
+
     // ensure initial handshake is complete before accepting
     // other kinds of messages.
     if (this._init !== InitState.OK) {
@@ -314,12 +319,20 @@ export abstract class BaseWalletTransport implements WalletTransport {
       this.saveTransportSession({ sessionId, intent, networkId })
     }
 
+    this.walletRequestHandler.setOpenIntent(intent)
+
+    // ensure signer is ready
+    if (this.walletRequestHandler.getSigner() === undefined) {
+      await this.walletRequestHandler.signerReady()
+    }
+
     // init handshake for certain transports, before we can open the communication.
     //
     // for example, with the window-transport, we have to exchange messages to determine the
     // origin host of the dapp.
     await this.init()
 
+
     // Prepare connect options from intent
     if (intent && intent.type === 'connect' && intent.options) {
       const connectOptions = intent.options

package/src/transports/wallet-request-handler.ts

@@ -10,6 +10,7 @@ import {
   ConnectDetails,
   PromptConnectDetails,
   WalletSession,
+  OpenWalletIntent,
   ErrSignedInRequired,
   ProviderEventTypes,
   TypedEventEmitter
@@ -41,11 +42,17 @@ export interface WalletSignInOptions {
 }
 
 export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, ProviderMessageRequestHandler {
-  private signer: Signer | null
+  // signer interface of the wallet. A null value means there is no signer (ie. user not signed in). An undefined
+  // value means the signer state is unknown, usually meaning the wallet app is booting up and initializing. Of course
+  // a Signer value is the actually interface to a signed-in account
+  private signer: Signer | null | undefined
+  private signerReadyCallbacks: Array<() => void> = []
+
   private prompter: WalletUserPrompter | null
   private mainnetNetworks: NetworkConfig[]
   private testnetNetworks: NetworkConfig[]
 
+  private _openIntent?: OpenWalletIntent
   private _connectOptions?: ConnectOptions
   private _defaultNetworkId?: string | number
   private _chainId?: number
@@ -53,7 +60,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
   private events: TypedEventEmitter<ProviderEventTypes> = new EventEmitter() as TypedEventEmitter<ProviderEventTypes>
 
   constructor(
-    signer: Signer | null,
+    signer: Signer | null | undefined,
     prompter: WalletUserPrompter | null,
     mainnetNetworks: Networks,
     testnetNetworks: Networks = []
@@ -65,7 +72,8 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
   }
 
   async signIn(signer: Signer | null, options: WalletSignInOptions = {}) {
-    this.signer = signer
+    this.setSigner(signer)
+
 
     const { connect, mainnetNetworks, testnetNetworks, defaultNetworkId } = options
 
@@ -109,6 +117,29 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
     }
   }
 
+  signOut() {
+    // signed out state
+    this.signer = null
+  }
+
+  signerReset() {
+    // resetting signer puts the wallet in an uninitialized state, which requires the app to
+    // re-initiatize and set the signer either as "null" (ie. no signer) or "Signer" (ie. signed in).
+    this.signer = undefined
+  }
+
+  signerReady() {
+    return new Promise((resolve, reject) => {
+      if (this.signer !== undefined) {
+        resolve(undefined)
+      } else {
+        this.signerReadyCallbacks.push(() => {
+          resolve(undefined)
+        })
+      }
+    })
+  }
+
   async connect(options?: ConnectOptions): Promise<ConnectDetails> {
     if (!this.signer) {
       return {
@@ -165,6 +196,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
     }
 
     const promptConnectDetails = await this.prompter.promptConnect(options || this._connectOptions).catch(_ => {
+
       return { connected: false } as ConnectDetails
     })
 
@@ -208,6 +240,10 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
       result: null
     }
 
+    if (this.signer === undefined) {
+      await this.signerReady()
+    }
+
     try {
       // only allow public json rpc method to the provider when user is not logged in, aka signer is not set
       if ((!this.signer || this.signer === null) && !permittedJsonRpcMethods.includes(request.method)) {
@@ -583,6 +619,14 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
     }
   }
 
+  get openIntent(): OpenWalletIntent | undefined {
+    return this._openIntent
+  }
+
+  setOpenIntent(intent: OpenWalletIntent | undefined) {
+    this._openIntent = intent
+  }
+
   get connectOptions(): ConnectOptions | undefined {
     return this._connectOptions
   }
@@ -682,12 +726,19 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
     return !!this.signer
   }
 
-  getSigner(): Signer | null {
+  getSigner(): Signer | null | undefined {
     return this.signer
   }
 
-  setSigner(signer: Signer | null) {
+  setSigner(signer: Signer | null | undefined) {
     this.signer = signer
+
+    if (signer !== undefined) {
+      for (let i=0; i < this.signerReadyCallbacks.length; i++) {
+        this.signerReadyCallbacks[i]()
+      }
+      this.signerReadyCallbacks = []
+    }
   }
 
   private async handleConfirmWalletDeployPrompt(

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

@@ -47,10 +47,6 @@ export class WindowMessageHandler extends BaseWalletTransport {
       return
     }
 
-    if (session.intent && isNewWindowSession) {
-      window.history.replaceState({ openWalletIntent: true }, document.title, pathname)
-    }
-
     // record parent window instance for communication
     this.parentWindow = parent.window.opener