@0xsequence/provider 1.1.8 → 1.1.10

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

@@ -3585,16 +3585,16 @@ class DefaultChainIdTracker {
     return parseInt(read);
   }
 }
-
+DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
 /**
  *  This is a wallet client for sequence wallet-webapp. It connects using *some* transport
  *  and it allows to perform all sequence specific (or write) operations related to the wallet.
- *
+ *s
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
  */
-DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
 class SequenceClient {
-  constructor(transport, store, defaultChainId) {
+  constructor(transport, store, options) {
+    var _options$defaultEIP;
     this.callbacks = {};
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
@@ -3603,6 +3603,8 @@ class SequenceClient {
     } else {
       throw new Error('Invalid transport');
     }
+    const defaultChainId = typeof options === 'number' ? options : options == null ? void 0 : options.defaultChainId;
+    this.defaultEIP6492 = typeof options === 'number' ? false : (_options$defaultEIP = options == null ? void 0 : options.defaultEIP6492) != null ? _options$defaultEIP : false;
     this.session = new SequenceClientSession(store);
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId);
     this.transport.on('accountsChanged', accounts => {
@@ -3786,6 +3788,10 @@ class SequenceClient {
   // Working with sendAsync is less idiomatic
   // but transport uses it instead of send, so we wrap it
   send(request, chainId) {
+    // Internally when sending requests we use `legacy_sign`
+    // to avoid the default EIP6492 behavior overriding an explicit
+    // "legacy sign" request, so we map the method here.
+    request.method = this.mapSignMethod(request.method);
     return new Promise((resolve, reject) => {
       this.transport.sendAsync(request, (error, response) => {
         if (error) {
@@ -3812,8 +3818,48 @@ class SequenceClient {
     }
     return connectedSession.networks;
   }
+
+  // NOTICE: `legacy_sign` will get overriden by `send`
+  // it is done this way to ensure that:
+  //  - `send` handles `personal_sign` as a request for the default sign method
+  //  - explicit `personal_sign` is not replaced by `sequence_sign` (if default is EI6492)
+  signMethod(options) {
+    if ((options == null ? void 0 : options.eip6492) === undefined) {
+      return 'personal_sign';
+    }
+    return options.eip6492 ? 'sequence_sign' : 'legacy_sign';
+  }
+  signTypedDataMethod(options) {
+    if ((options == null ? void 0 : options.eip6492) === undefined) {
+      return 'eth_signTypedData_v4';
+    }
+    return options.eip6492 ? 'sequence_signTypedData_v4' : 'legacy_signTypedData_v4';
+  }
+  mapSignMethod(method) {
+    if (method === 'personal_sign') {
+      if (this.defaultEIP6492) {
+        return 'sequence_sign';
+      } else {
+        return 'personal_sign';
+      }
+    }
+    if (method === 'eth_signTypedData_v4') {
+      if (this.defaultEIP6492) {
+        return 'sequence_signTypedData_v4';
+      } else {
+        return 'eth_signTypedData_v4';
+      }
+    }
+    if (method === 'legacy_sign') {
+      return 'personal_sign';
+    }
+    if (method === 'legacy_signTypedData_v4') {
+      return 'eth_signTypedData_v4';
+    }
+    return method;
+  }
   async signMessage(message, options) {
-    const method = options != null && options.eip6492 ? 'sequence_sign' : 'personal_sign';
+    const method = this.signMethod(options);
 
     // Address is ignored by the wallet webapp
     return this.send({
@@ -3822,7 +3868,7 @@ class SequenceClient {
     }, options == null ? void 0 : options.chainId);
   }
   async signTypedData(typedData, options) {
-    const method = options != null && options.eip6492 ? 'sequence_signTypedData_v4' : 'eth_signTypedData_v4';
+    const method = this.signTypedDataMethod(options);
 
     // TODO: Stop using ethers for this, this is the only place where we use it
     // and it makes the client depend on ethers.
@@ -3932,7 +3978,10 @@ const initWallet = partialConfig => {
   const itemStore = config.localStorage || useBestStore();
 
   // Create client, provider and return signer
-  const client = new SequenceClient(config.transports, itemStore, defaultNetwork);
+  const client = new SequenceClient(config.transports, itemStore, {
+    defaultChainId: defaultNetwork,
+    defaultEIP6492: config.defaultEIP6492
+  });
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId);
   return sequenceWalletProvider;
 };

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

@@ -3585,16 +3585,16 @@ class DefaultChainIdTracker {
     return parseInt(read);
   }
 }
-
+DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
 /**
  *  This is a wallet client for sequence wallet-webapp. It connects using *some* transport
  *  and it allows to perform all sequence specific (or write) operations related to the wallet.
- *
+ *s
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
  */
-DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
 class SequenceClient {
-  constructor(transport, store, defaultChainId) {
+  constructor(transport, store, options) {
+    var _options$defaultEIP;
     this.callbacks = {};
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
@@ -3603,6 +3603,8 @@ class SequenceClient {
     } else {
       throw new Error('Invalid transport');
     }
+    const defaultChainId = typeof options === 'number' ? options : options == null ? void 0 : options.defaultChainId;
+    this.defaultEIP6492 = typeof options === 'number' ? false : (_options$defaultEIP = options == null ? void 0 : options.defaultEIP6492) != null ? _options$defaultEIP : false;
     this.session = new SequenceClientSession(store);
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId);
     this.transport.on('accountsChanged', accounts => {
@@ -3786,6 +3788,10 @@ class SequenceClient {
   // Working with sendAsync is less idiomatic
   // but transport uses it instead of send, so we wrap it
   send(request, chainId) {
+    // Internally when sending requests we use `legacy_sign`
+    // to avoid the default EIP6492 behavior overriding an explicit
+    // "legacy sign" request, so we map the method here.
+    request.method = this.mapSignMethod(request.method);
     return new Promise((resolve, reject) => {
       this.transport.sendAsync(request, (error, response) => {
         if (error) {
@@ -3812,8 +3818,48 @@ class SequenceClient {
     }
     return connectedSession.networks;
   }
+
+  // NOTICE: `legacy_sign` will get overriden by `send`
+  // it is done this way to ensure that:
+  //  - `send` handles `personal_sign` as a request for the default sign method
+  //  - explicit `personal_sign` is not replaced by `sequence_sign` (if default is EI6492)
+  signMethod(options) {
+    if ((options == null ? void 0 : options.eip6492) === undefined) {
+      return 'personal_sign';
+    }
+    return options.eip6492 ? 'sequence_sign' : 'legacy_sign';
+  }
+  signTypedDataMethod(options) {
+    if ((options == null ? void 0 : options.eip6492) === undefined) {
+      return 'eth_signTypedData_v4';
+    }
+    return options.eip6492 ? 'sequence_signTypedData_v4' : 'legacy_signTypedData_v4';
+  }
+  mapSignMethod(method) {
+    if (method === 'personal_sign') {
+      if (this.defaultEIP6492) {
+        return 'sequence_sign';
+      } else {
+        return 'personal_sign';
+      }
+    }
+    if (method === 'eth_signTypedData_v4') {
+      if (this.defaultEIP6492) {
+        return 'sequence_signTypedData_v4';
+      } else {
+        return 'eth_signTypedData_v4';
+      }
+    }
+    if (method === 'legacy_sign') {
+      return 'personal_sign';
+    }
+    if (method === 'legacy_signTypedData_v4') {
+      return 'eth_signTypedData_v4';
+    }
+    return method;
+  }
   async signMessage(message, options) {
-    const method = options != null && options.eip6492 ? 'sequence_sign' : 'personal_sign';
+    const method = this.signMethod(options);
 
     // Address is ignored by the wallet webapp
     return this.send({
@@ -3822,7 +3868,7 @@ class SequenceClient {
     }, options == null ? void 0 : options.chainId);
   }
   async signTypedData(typedData, options) {
-    const method = options != null && options.eip6492 ? 'sequence_signTypedData_v4' : 'eth_signTypedData_v4';
+    const method = this.signTypedDataMethod(options);
 
     // TODO: Stop using ethers for this, this is the only place where we use it
     // and it makes the client depend on ethers.
@@ -3932,7 +3978,10 @@ const initWallet = partialConfig => {
   const itemStore = config.localStorage || useBestStore();
 
   // Create client, provider and return signer
-  const client = new SequenceClient(config.transports, itemStore, defaultNetwork);
+  const client = new SequenceClient(config.transports, itemStore, {
+    defaultChainId: defaultNetwork,
+    defaultEIP6492: config.defaultEIP6492
+  });
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId);
   return sequenceWalletProvider;
 };

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

@@ -3581,16 +3581,16 @@ class DefaultChainIdTracker {
     return parseInt(read);
   }
 }
-
+DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
 /**
  *  This is a wallet client for sequence wallet-webapp. It connects using *some* transport
  *  and it allows to perform all sequence specific (or write) operations related to the wallet.
- *
+ *s
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
  */
-DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
 class SequenceClient {
-  constructor(transport, store, defaultChainId) {
+  constructor(transport, store, options) {
+    var _options$defaultEIP;
     this.callbacks = {};
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
@@ -3599,6 +3599,8 @@ class SequenceClient {
     } else {
       throw new Error('Invalid transport');
     }
+    const defaultChainId = typeof options === 'number' ? options : options == null ? void 0 : options.defaultChainId;
+    this.defaultEIP6492 = typeof options === 'number' ? false : (_options$defaultEIP = options == null ? void 0 : options.defaultEIP6492) != null ? _options$defaultEIP : false;
     this.session = new SequenceClientSession(store);
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId);
     this.transport.on('accountsChanged', accounts => {
@@ -3782,6 +3784,10 @@ class SequenceClient {
   // Working with sendAsync is less idiomatic
   // but transport uses it instead of send, so we wrap it
   send(request, chainId) {
+    // Internally when sending requests we use `legacy_sign`
+    // to avoid the default EIP6492 behavior overriding an explicit
+    // "legacy sign" request, so we map the method here.
+    request.method = this.mapSignMethod(request.method);
     return new Promise((resolve, reject) => {
       this.transport.sendAsync(request, (error, response) => {
         if (error) {
@@ -3808,8 +3814,48 @@ class SequenceClient {
     }
     return connectedSession.networks;
   }
+
+  // NOTICE: `legacy_sign` will get overriden by `send`
+  // it is done this way to ensure that:
+  //  - `send` handles `personal_sign` as a request for the default sign method
+  //  - explicit `personal_sign` is not replaced by `sequence_sign` (if default is EI6492)
+  signMethod(options) {
+    if ((options == null ? void 0 : options.eip6492) === undefined) {
+      return 'personal_sign';
+    }
+    return options.eip6492 ? 'sequence_sign' : 'legacy_sign';
+  }
+  signTypedDataMethod(options) {
+    if ((options == null ? void 0 : options.eip6492) === undefined) {
+      return 'eth_signTypedData_v4';
+    }
+    return options.eip6492 ? 'sequence_signTypedData_v4' : 'legacy_signTypedData_v4';
+  }
+  mapSignMethod(method) {
+    if (method === 'personal_sign') {
+      if (this.defaultEIP6492) {
+        return 'sequence_sign';
+      } else {
+        return 'personal_sign';
+      }
+    }
+    if (method === 'eth_signTypedData_v4') {
+      if (this.defaultEIP6492) {
+        return 'sequence_signTypedData_v4';
+      } else {
+        return 'eth_signTypedData_v4';
+      }
+    }
+    if (method === 'legacy_sign') {
+      return 'personal_sign';
+    }
+    if (method === 'legacy_signTypedData_v4') {
+      return 'eth_signTypedData_v4';
+    }
+    return method;
+  }
   async signMessage(message, options) {
-    const method = options != null && options.eip6492 ? 'sequence_sign' : 'personal_sign';
+    const method = this.signMethod(options);
 
     // Address is ignored by the wallet webapp
     return this.send({
@@ -3818,7 +3864,7 @@ class SequenceClient {
     }, options == null ? void 0 : options.chainId);
   }
   async signTypedData(typedData, options) {
-    const method = options != null && options.eip6492 ? 'sequence_signTypedData_v4' : 'eth_signTypedData_v4';
+    const method = this.signTypedDataMethod(options);
 
     // TODO: Stop using ethers for this, this is the only place where we use it
     // and it makes the client depend on ethers.
@@ -3928,7 +3974,10 @@ const initWallet = partialConfig => {
   const itemStore = config.localStorage || useBestStore();
 
   // Create client, provider and return signer
-  const client = new SequenceClient(config.transports, itemStore, defaultNetwork);
+  const client = new SequenceClient(config.transports, itemStore, {
+    defaultChainId: defaultNetwork,
+    defaultEIP6492: config.defaultEIP6492
+  });
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId);
   return sequenceWalletProvider;
 };

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

@@ -33,10 +33,14 @@ export declare class DefaultChainIdTracker {
     setDefaultChainId(chainId: number): void;
     getDefaultChainId(): number;
 }
+export type SequenceClientOptions = {
+    defaultChainId?: number;
+    defaultEIP6492?: boolean;
+};
 /**
  *  This is a wallet client for sequence wallet-webapp. It connects using *some* transport
  *  and it allows to perform all sequence specific (or write) operations related to the wallet.
- *
+ *s
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
  */
 export declare class SequenceClient {
@@ -44,7 +48,8 @@ export declare class SequenceClient {
     private readonly defaultChainId;
     private readonly callbacks;
     readonly transport: ProviderTransport;
-    constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, defaultChainId?: number);
+    readonly defaultEIP6492: boolean;
+    constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, options?: SequenceClientOptions | number);
     registerCallback<K extends keyof WalletEventTypes>(eventName: K, callback: WalletEventTypes[K]): () => void;
     onOpen(callback: WalletEventTypes['open']): () => void;
     onClose(callback: WalletEventTypes['close']): () => void;
@@ -66,6 +71,9 @@ export declare class SequenceClient {
     disconnect(): Promise<void>;
     send(request: JsonRpcRequest, chainId?: number): Promise<any>;
     getNetworks(pull?: boolean): Promise<NetworkConfig[]>;
+    private signMethod;
+    private signTypedDataMethod;
+    private mapSignMethod;
     signMessage(message: ethers.BytesLike, options?: OptionalEIP6492 & OptionalChainId): Promise<string>;
     signTypedData(typedData: TypedData, options?: OptionalEIP6492 & OptionalChainId): Promise<string>;
     sendTransaction(tx: ethers.providers.TransactionRequest[] | ethers.providers.TransactionRequest, options?: OptionalChainId): Promise<string>;

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

@@ -5,6 +5,7 @@ import { SequenceProvider } from "./provider.js";
 export interface ProviderConfig {
     localStorage?: ItemStore;
     defaultNetwork?: ChainIdLike;
+    defaultEIP6492?: boolean;
     networks?: Partial<NetworkConfig>[];
     transports?: MuxTransportTemplate;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "description": "provider sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
   "source": "src/index.ts",
@@ -11,15 +11,15 @@
   "dependencies": {
     "eventemitter2": "^6.4.5",
     "webextension-polyfill": "^0.10.0",
-    "@0xsequence/abi": "1.1.8",
-    "@0xsequence/account": "1.1.8",
-    "@0xsequence/auth": "1.1.8",
-    "@0xsequence/migration": "1.1.8",
-    "@0xsequence/core": "1.1.8",
-    "@0xsequence/network": "1.1.8",
-    "@0xsequence/relayer": "1.1.8",
-    "@0xsequence/utils": "1.1.8",
-    "@0xsequence/wallet": "1.1.8"
+    "@0xsequence/abi": "1.1.10",
+    "@0xsequence/auth": "1.1.10",
+    "@0xsequence/core": "1.1.10",
+    "@0xsequence/migration": "1.1.10",
+    "@0xsequence/account": "1.1.10",
+    "@0xsequence/network": "1.1.10",
+    "@0xsequence/relayer": "1.1.10",
+    "@0xsequence/utils": "1.1.10",
+    "@0xsequence/wallet": "1.1.10"
   },
   "peerDependencies": {
     "ethers": ">=5.5 < 6"

package/src/client.ts

@@ -112,10 +112,15 @@ export class DefaultChainIdTracker {
   }
 }
 
+export type SequenceClientOptions = {
+  defaultChainId?: number
+  defaultEIP6492?: boolean
+}
+
 /**
  *  This is a wallet client for sequence wallet-webapp. It connects using *some* transport
  *  and it allows to perform all sequence specific (or write) operations related to the wallet.
- *
+ *s
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
  */
 export class SequenceClient {
@@ -125,7 +130,9 @@ export class SequenceClient {
 
   public readonly transport: ProviderTransport
 
-  constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, defaultChainId?: number) {
+  public readonly defaultEIP6492: boolean
+
+  constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, options?: SequenceClientOptions | number) {
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport)
     } else if (isProviderTransport(transport)) {
@@ -134,6 +141,9 @@ export class SequenceClient {
       throw new Error('Invalid transport')
     }
 
+    const defaultChainId = typeof options === 'number' ? options : options?.defaultChainId
+    this.defaultEIP6492 = typeof options === 'number' ? false : options?.defaultEIP6492 ?? false
+
     this.session = new SequenceClientSession(store)
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId)
 
@@ -334,6 +344,12 @@ export class SequenceClient {
   // Working with sendAsync is less idiomatic
   // but transport uses it instead of send, so we wrap it
   send(request: JsonRpcRequest, chainId?: number): Promise<any> {
+
+    // Internally when sending requests we use `legacy_sign`
+    // to avoid the default EIP6492 behavior overriding an explicit
+    // "legacy sign" request, so we map the method here.
+    request.method = this.mapSignMethod(request.method)
+
     return new Promise((resolve, reject) => {
       this.transport.sendAsync(
         request,
@@ -366,15 +382,63 @@ export class SequenceClient {
     return connectedSession.networks
   }
 
+  // NOTICE: `legacy_sign` will get overriden by `send`
+  // it is done this way to ensure that:
+  //  - `send` handles `personal_sign` as a request for the default sign method
+  //  - explicit `personal_sign` is not replaced by `sequence_sign` (if default is EI6492)
+  private signMethod(options?: OptionalEIP6492) {
+    if (options?.eip6492 === undefined) {
+      return 'personal_sign'
+    }
+
+    return options.eip6492 ? 'sequence_sign' : 'legacy_sign'
+  }
+
+  private signTypedDataMethod(options?: OptionalEIP6492) {
+    if (options?.eip6492 === undefined) {
+      return 'eth_signTypedData_v4'
+    }
+
+    return options.eip6492 ? 'sequence_signTypedData_v4' : 'legacy_signTypedData_v4'
+  }
+
+  private mapSignMethod(method: string): string {
+    if (method === 'personal_sign') {
+      if (this.defaultEIP6492) {
+        return 'sequence_sign'
+      } else {
+        return 'personal_sign'
+      }
+    }
+
+    if (method === 'eth_signTypedData_v4') {
+      if (this.defaultEIP6492) {
+        return 'sequence_signTypedData_v4'
+      } else {
+        return 'eth_signTypedData_v4'
+      }
+    }
+
+    if (method === 'legacy_sign') {
+      return 'personal_sign'
+    }
+
+    if (method === 'legacy_signTypedData_v4') {
+      return 'eth_signTypedData_v4'
+    }
+
+    return method
+  }
+
   async signMessage(message: ethers.BytesLike, options?: OptionalEIP6492 & OptionalChainId): Promise<string> {
-    const method = options?.eip6492 ? 'sequence_sign' : 'personal_sign'
+    const method = this.signMethod(options)
 
     // Address is ignored by the wallet webapp
     return this.send({ method, params: [message, this.getAddress()] }, options?.chainId)
   }
 
   async signTypedData(typedData: TypedData, options?: OptionalEIP6492 & OptionalChainId): Promise<string> {
-    const method = options?.eip6492 ? 'sequence_signTypedData_v4' : 'eth_signTypedData_v4'
+    const method = this.signTypedDataMethod(options)
 
     // TODO: Stop using ethers for this, this is the only place where we use it
     // and it makes the client depend on ethers.

package/src/init.ts

@@ -26,6 +26,9 @@ export interface ProviderConfig {
   // need to match
   defaultNetwork?: ChainIdLike
 
+  // defaultEIP6492 defines if EIP-6492 is enabled by default when signing messages.
+  defaultEIP6492?: boolean
+
   // networks is a configuration list of networks used by the wallet. This list
   // is combined with the network list specified by sequence.js.
   // notice that this can only replace the rpc urls on the dapp side,
@@ -115,9 +118,12 @@ export const initWallet = (partialConfig?: Partial<ProviderConfig>) => {
   const itemStore = config.localStorage || useBestStore()
 
   // Create client, provider and return signer
-  const client = new SequenceClient(config.transports, itemStore, defaultNetwork)
-  sequenceWalletProvider = new SequenceProvider(client, providerForChainId)
+  const client = new SequenceClient(config.transports, itemStore, {
+    defaultChainId: defaultNetwork,
+    defaultEIP6492: config.defaultEIP6492
+  })
 
+  sequenceWalletProvider = new SequenceProvider(client, providerForChainId)
   return sequenceWalletProvider
 }