@0xsequence/provider 0.0.0-20230505164841 → 0.0.0-20230509145455

package/dist/0xsequence-provider.cjs.d.ts

@@ -1 +1,11 @@
-export * from "./declarations/src/index";
+// are you seeing an error that a default export doesn't exist but your source file has a default export?
+// you should run `yarn` or `yarn preconstruct dev` if preconstruct dev isn't in your postinstall hook
+
+// curious why you need to?
+// this file exists so that you can import from the entrypoint normally
+// except that it points to your source file and you don't need to run build constantly
+// which means we need to re-export all of the modules from your source file
+// and since export * doesn't include default exports, we need to read your source file
+// to check for a default export and re-export it if it exists
+// it's not ideal, but it works pretty well ¯\_(ツ)_/¯
+export * from "../src/index";

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

@@ -1,7 +1,16 @@
-'use strict';
+"use strict";
+// this file might look strange and you might be wondering what it's for
+// it's lets you import your source files by importing this entrypoint
+// as you would import it if it was built with preconstruct build
+// this file is slightly different to some others though
+// it has a require hook which compiles your code with Babel
+// this means that you don't have to set up @babel/register or anything like that
+// but you can still require this module and it'll be compiled
 
-if (process.env.NODE_ENV === "production") {
-  module.exports = require("./0xsequence-provider.cjs.prod.js");
-} else {
-  module.exports = require("./0xsequence-provider.cjs.dev.js");
-}
+// this bit of code imports the require hook and registers it
+let unregister = require("../../../node_modules/.pnpm/@preconstruct+hook@0.4.0/node_modules/@preconstruct/hook").___internalHook(typeof __dirname === 'undefined' ? undefined : __dirname, "../../..", "..");
+
+// this re-exports the source file
+module.exports = require("../src/index.ts");
+
+unregister();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "0.0.0-20230505164841",
+  "version": "0.0.0-20230509145455",
   "description": "provider sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
   "source": "src/index.ts",
@@ -9,17 +9,16 @@
   "author": "Horizon Blockchain Games",
   "license": "Apache-2.0",
   "dependencies": {
+    "@0xsequence/abi": "0.0.0-20230509145455",
+    "@0xsequence/auth": "0.0.0-20230509145455",
+    "@0xsequence/config": "0.0.0-20230509145455",
+    "@0xsequence/network": "0.0.0-20230509145455",
+    "@0xsequence/relayer": "0.0.0-20230509145455",
+    "@0xsequence/transactions": "0.0.0-20230509145455",
+    "@0xsequence/utils": "0.0.0-20230509145455",
+    "@0xsequence/wallet": "0.0.0-20230509145455",
     "eventemitter2": "^6.4.5",
-    "webextension-polyfill": "^0.10.0",
-    "@0xsequence/abi": "0.0.0-20230505164841",
-    "@0xsequence/account": "0.0.0-20230505164841",
-    "@0xsequence/auth": "0.0.0-20230505164841",
-    "@0xsequence/core": "0.0.0-20230505164841",
-    "@0xsequence/migration": "0.0.0-20230505164841",
-    "@0xsequence/network": "0.0.0-20230505164841",
-    "@0xsequence/relayer": "0.0.0-20230505164841",
-    "@0xsequence/utils": "0.0.0-20230505164841",
-    "@0xsequence/wallet": "0.0.0-20230505164841"
+    "webextension-polyfill": "^0.10.0"
   },
   "peerDependencies": {
     "ethers": ">=5.5 < 6"

package/src/provider.ts

@@ -1,23 +1,21 @@
-import { ethers, BytesLike, Bytes, providers, TypedDataDomain, TypedDataField } from 'ethers'
-
+import { ethers, BytesLike, Bytes, providers, TypedDataDomain, TypedDataField, BigNumber } from 'ethers'
 import {
   NetworkConfig,
+  WalletContext,
   ChainIdLike,
   JsonRpcHandler,
   JsonRpcFetchFunc,
   JsonRpcRequest,
   JsonRpcResponseCallback,
-  JsonRpcSender,
-  maybeChainId
+  maybeChainId,
+  JsonRpcSender
 } from '@0xsequence/network'
-
 import { resolveArrayProperties, Signer } from '@0xsequence/wallet'
+import { WalletConfig, WalletState } from '@0xsequence/config'
 import { Relayer } from '@0xsequence/relayer'
 import { Deferrable, shallowCopy, resolveProperties, Forbid } from '@0xsequence/utils'
+import { TransactionRequest, TransactionResponse, SignedTransactions } from '@0xsequence/transactions'
 import { WalletRequestHandler } from './transports/wallet-request-handler'
-import { commons, universal } from '@0xsequence/core'
-import { Account, AccountStatus } from '@0xsequence/account'
-import { ExtendedTransactionRequest, toExtended } from './extended'
 
 export class Web3Provider extends providers.Web3Provider implements JsonRpcHandler {
   static isSequenceProvider(cand: any): cand is Web3Provider {
@@ -64,21 +62,15 @@ export class Web3Provider extends providers.Web3Provider implements JsonRpcHandl
   }
 
   async getChainId(): Promise<number> {
-    // If the dapp is asking for a particular default chain, then we first need to see
-    // if the wallet supports the network, for that we need to query the wallet networks
-    // and see if it contains the default chain. If it does, then we can return the default.
-    if (this._defaultChainId) {
-      const networks = await this.getNetworks()
-      if (networks.find((n) => n.chainId === this._defaultChainId)) return this._defaultChainId
-      throw new Error(`Default chainId ${this._defaultChainId} not supported by wallet`)
-    }
+    // TODO: is it safe to memoize this?
+    const result = await this.send('eth_chainId', [])
+    const chainId = ethers.BigNumber.from(result).toNumber()
 
-    // If there is no default chain, then we can just return the chainId of the provider
-    return this.send('eth_chainId', [])
-  }
+    if (this._defaultChainId && this._defaultChainId !== chainId) {
+      throw new Error(`provider chainId (${chainId}) does not match provider-bound chainId ${this._defaultChainId}`)
+    }
 
-  getNetworks(): Promise<NetworkConfig[]> {
-    return this.send('sequence_getNetworks', [])
+    return chainId
   }
 }
 
@@ -88,8 +80,8 @@ export function isSequenceProvider(provider: any): provider is Web3Provider {
 }
 
 export class LocalWeb3Provider extends Web3Provider {
-  constructor(account: Account, networks?: NetworkConfig[]) {
-    const walletRequestHandler = new WalletRequestHandler(account, null, null, networks || [])
+  constructor(signer: Signer, networks?: NetworkConfig[]) {
+    const walletRequestHandler = new WalletRequestHandler(signer, null, null, networks || [])
     super(walletRequestHandler)
   }
 }
@@ -116,7 +108,7 @@ export class Web3Signer extends Signer implements TypedDataSigner {
   // memoized
   _address: string
   _index: number
-  _context: commons.context.VersionedContext
+  _context: WalletContext
   _networks: NetworkConfig[]
   private _providers: { [key: number]: Web3Provider } = {}
 
@@ -132,7 +124,7 @@ export class Web3Signer extends Signer implements TypedDataSigner {
     return ethers.utils.getAddress(this._address)
   }
 
-  signTransaction(transaction: Deferrable<ethers.providers.TransactionRequest>): Promise<string> {
+  signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string> {
     // TODO .. since ethers isn't using this method, perhaps we will?
     throw new Error('signTransaction is unsupported, use signTransactions instead')
   }
@@ -183,53 +175,55 @@ export class Web3Signer extends Signer implements TypedDataSigner {
     throw new Error('TODO')
   }
 
-  async getWalletContext(): Promise<commons.context.VersionedContext> {
+  async getWalletContext(): Promise<WalletContext> {
     if (!this._context) {
       this._context = await this.provider.send('sequence_getWalletContext', [])
     }
     return this._context
   }
 
-  async getWalletConfig(chainId?: ChainIdLike): Promise<commons.config.Config> {
-    const reqChainId = maybeChainId(chainId) || this.defaultChainId
-    if (!reqChainId) throw new Error('chainId is required')
-    return (await this.provider.send(
+  async getWalletConfig(chainId?: ChainIdLike): Promise<WalletConfig[]> {
+    return await this.provider.send(
       'sequence_getWalletConfig',
-      [reqChainId],
-      reqChainId
-    ))[0]
+      [maybeChainId(chainId)],
+      maybeChainId(chainId) || this.defaultChainId
+    )
   }
 
-  async getWalletState(chainId?: ChainIdLike): Promise<AccountStatus> {
-    const reqChainId = maybeChainId(chainId) || this.defaultChainId
-    if (!reqChainId) throw new Error('chainId is required')    
-    return (await this.provider.send(
+  async getWalletState(chainId?: ChainIdLike): Promise<WalletState[]> {
+    return await this.provider.send(
       'sequence_getWalletState',
-      [reqChainId],
-      reqChainId
-    ))[0].status
+      [maybeChainId(chainId)],
+      maybeChainId(chainId) || this.defaultChainId
+    )
   }
 
   async getNetworks(): Promise<NetworkConfig[]> {
-    if (!this._networks) this._networks = await this.provider.getNetworks()
+    if (!this._networks) {
+      this._networks = await this.provider.send('sequence_getNetworks', [])
+    }
     return this._networks
   }
 
   async getSigners(): Promise<string[]> {
     const networks = await this.getNetworks()
 
-    // TODO: Replace this with a method that aggregates signer addresses from all chains
-    const config = await this.getWalletConfig(networks[0].chainId)
-    if (!config) {
+    const authChainId = networks.find(n => n.isAuthChain)
+    if (!authChainId) {
+      throw new Error('authChainId could not be determined from network list')
+    }
+
+    const walletConfig = await this.getWalletConfig(authChainId)
+    if (!walletConfig || walletConfig.length === 0) {
       throw new Error(`walletConfig returned zero results for authChainId {authChainId}`)
     }
 
-    return universal.genericCoderFor(config.version).config.signersOf(config).map((s) => s.address)
+    return walletConfig[0].signers.map(s => s.address)
   }
 
   // signMessage matches implementation from ethers JsonRpcSigner for compatibility, but with
   // multi-chain support.
-  async signMessage(message: BytesLike, chainId?: ChainIdLike, allSigners?: boolean, sequenceVerified?: boolean): Promise<string> {
+  async signMessage(message: BytesLike, chainId?: ChainIdLike, allSigners?: boolean): Promise<string> {
     const provider = await this.getSender(maybeChainId(chainId) || this.defaultChainId)
 
     const data = typeof message === 'string' ? ethers.utils.toUtf8Bytes(message) : message
@@ -238,10 +232,7 @@ export class Web3Signer extends Signer implements TypedDataSigner {
     // NOTE: as of ethers v5.5, it switched to using personal_sign, see
     // https://github.com/ethers-io/ethers.js/pull/1542 and see
     // https://github.com/WalletConnect/walletconnect-docs/issues/32 for additional info.
-    return provider!.send(
-      sequenceVerified ? 'sequence_sign' : 'personal_sign',
-      [ethers.utils.hexlify(data), address]
-    )
+    return await provider!.send('personal_sign', [ethers.utils.hexlify(data), address])
   }
 
   // signTypedData matches implementation from ethers JsonRpcSigner for compatibility, but with
@@ -251,16 +242,15 @@ export class Web3Signer extends Signer implements TypedDataSigner {
     types: Record<string, Array<TypedDataField>>,
     message: Record<string, any>,
     chainId?: ChainIdLike,
-    allSigners?: boolean,
-    sequenceVerified?: boolean
+    allSigners?: boolean
   ): Promise<string> {
     // Populate any ENS names (in-place)
     // const populated = await ethers.utils._TypedDataEncoder.resolveNames(domain, types, message, (name: string) => {
     //   return this.provider.resolveName(name)
     // })
 
-    return this.provider.send(
-      sequenceVerified ? 'sequence_signTypedData_v4' : 'eth_signTypedData_v4',
+    return await this.provider.send(
+      'eth_signTypedData_v4',
       [await this.getAddress(), ethers.utils._TypedDataEncoder.getPayload(domain, types, message)],
       maybeChainId(chainId) || this.defaultChainId
     )
@@ -269,16 +259,17 @@ export class Web3Signer extends Signer implements TypedDataSigner {
   // sendTransaction matches implementation from ethers JsonRpcSigner for compatibility, but with
   // multi-chain support.
   async sendTransaction(
-    transaction: Deferrable<ExtendedTransactionRequest>,
-    chainId?: ChainIdLike
-  ): Promise<commons.transaction.TransactionResponse> {
+    transaction: Deferrable<TransactionRequest>,
+    chainId?: ChainIdLike,
+    allSigners?: boolean
+  ): Promise<TransactionResponse> {
     const provider = await this.getSender(maybeChainId(chainId) || this.defaultChainId)
 
     const tx = this.sendUncheckedTransaction(transaction, chainId).then(hash => {
       return ethers.utils
         .poll(
           () => {
-            return provider!.getTransaction(hash).then((tx: ethers.providers.TransactionResponse) => {
+            return provider!.getTransaction(hash).then((tx: TransactionResponse) => {
               if (tx === null) {
                 return undefined
               }
@@ -300,10 +291,11 @@ export class Web3Signer extends Signer implements TypedDataSigner {
   // sendTransactionBatch is a convenience method to call sendTransaction in a batch format, allowing you to
   // send multiple transaction as a single payload and just one on-chain transaction.
   async sendTransactionBatch(
-    transactions: Deferrable<ethers.providers.TransactionRequest[]>,
-    chainId?: ChainIdLike
-  ): Promise<ethers.providers.TransactionResponse> {
-    const batch = await resolveArrayProperties<Forbid<ethers.providers.TransactionRequest, 'wait'>[]>(transactions)
+    transactions: Deferrable<Forbid<TransactionRequest, 'wait'>[]>,
+    chainId?: ChainIdLike,
+    allSigners?: boolean
+  ): Promise<TransactionResponse> {
+    const batch = await resolveArrayProperties<Forbid<TransactionRequest, 'wait'>[]>(transactions)
     if (!batch || batch.length === 0) {
       throw new Error('cannot send empty batch')
     }
@@ -313,31 +305,33 @@ export class Web3Signer extends Signer implements TypedDataSigner {
       throw new Error('transaction request expected for sendTransactionBatch, transaction response found')
     }
 
-    const asExtended = toExtended(batch)
-    return this.sendTransaction(asExtended, chainId)
+    const tx: TransactionRequest = { ...batch[0] }
+    if (batch.length > 1) {
+      tx.auxiliary = batch.splice(1)
+    }
+
+    return this.sendTransaction(tx, chainId, allSigners)
   }
 
   signTransactions(
-    transaction: Deferrable<ethers.providers.TransactionRequest>,
-    chainId?: ChainIdLike
-  ): Promise<commons.transaction.SignedTransactionBundle> {
+    transaction: Deferrable<TransactionRequest>,
+    chainId?: ChainIdLike,
+    allSigners?: boolean
+  ): Promise<SignedTransactions> {
     transaction = shallowCopy(transaction)
     // TODO: transaction argument..? make sure to resolve any properties and serialize property before sending over
     // the wire.. see sendUncheckedTransaction and resolveProperties
     return this.provider.send('eth_signTransaction', [transaction], maybeChainId(chainId) || this.defaultChainId)
   }
 
-  sendSignedTransactions(
-    signedTxs: commons.transaction.SignedTransactionBundle,
-    chainId?: ChainIdLike
-  ): Promise<ethers.providers.TransactionResponse> {
+  sendSignedTransactions(signedTxs: SignedTransactions, chainId?: ChainIdLike): Promise<TransactionResponse> {
     // sequence_relay
     throw new Error('TODO')
   }
 
   // updateConfig..
   // NOTE: this is not supported by the remote wallet by default.
-  async updateConfig(newConfig?: commons.config.Config): Promise<[commons.config.Config, ethers.providers.TransactionResponse | undefined]> {
+  async updateConfig(newConfig?: WalletConfig): Promise<[WalletConfig, TransactionResponse | undefined]> {
     // sequence_updateConfig
     const [config, tx] = await this.provider.send('sequence_updateConfig', [newConfig], this.defaultChainId)
     if (tx === null) {
@@ -350,7 +344,7 @@ export class Web3Signer extends Signer implements TypedDataSigner {
 
   // publishConfig..
   // NOTE: this is not supported by the remote wallet by default.
-  async publishConfig(): Promise<ethers.providers.TransactionResponse | undefined> {
+  async publishConfig(): Promise<TransactionResponse | undefined> {
     const provider = await this.getSender(this.defaultChainId)
 
     const tx = await provider!.send('sequence_publishConfig', [])
@@ -391,7 +385,7 @@ export class Web3Signer extends Signer implements TypedDataSigner {
     return this.signTypedData(domain, types, message, chainId, allSigners)
   }
 
-  async sendUncheckedTransaction(transaction: Deferrable<ExtendedTransactionRequest>, chainId?: ChainIdLike): Promise<string> {
+  async sendUncheckedTransaction(transaction: Deferrable<TransactionRequest>, chainId?: ChainIdLike): Promise<string> {
     transaction = shallowCopy(transaction)
 
     const fromAddress = this.getAddress()
@@ -466,7 +460,7 @@ const allowedTransactionKeys: { [key: string]: boolean } = {
 }
 
 const hexlifyTransaction = (
-  transaction: ExtendedTransactionRequest,
+  transaction: TransactionRequest,
   allowExtra?: { [key: string]: boolean }
 ): { [key: string]: string } => {
   // Check only allowed properties are given
@@ -519,9 +513,9 @@ const hexlifyTransaction = (
 }
 
 class UncheckedJsonRpcSigner extends Web3Signer {
-  sendTransaction(transaction: Deferrable<ethers.providers.TransactionRequest>): Promise<commons.transaction.TransactionResponse> {
+  sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse> {
     return this.sendUncheckedTransaction(transaction).then(hash => {
-      return <commons.transaction.TransactionResponse>{
+      return <TransactionResponse>{
         chainId: 0,
         confirmations: 0,
         data: '',

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

@@ -17,10 +17,9 @@ import {
   TypedEventEmitter
 } from '../types'
 
-import { NetworkConfig, JsonRpcRequest, JsonRpcResponseCallback } from '@0xsequence/network'
+import { NetworkConfig, WalletContext, JsonRpcRequest, JsonRpcResponseCallback, JsonRpcResponse } from '@0xsequence/network'
 import { logger } from '@0xsequence/utils'
 import { ethers } from 'ethers'
-import { commons } from '@0xsequence/core'
 
 export const PROVIDER_OPEN_TIMEOUT = 30000 // in ms
 
@@ -40,7 +39,7 @@ export abstract class BaseProviderTransport implements ProviderTransport {
   protected connectPayload: ConnectDetails | undefined
   protected accountsChangedPayload: { accounts: string[]; origin?: string } | undefined
   protected networksPayload: NetworkConfig[] | undefined
-  protected walletContextPayload: commons.context.VersionedContext | undefined
+  protected walletContextPayload: WalletContext | undefined
 
   protected _sessionId?: string
   protected _init: InitState

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

@@ -5,22 +5,23 @@ import {
   ProviderMessageRequest,
   EventType,
   ProviderMessageResponse,
+  ProviderMessageTransport,
   ProviderRpcError,
   InitState,
   ConnectDetails,
+  OpenWalletIntent,
   WalletSession,
   TransportSession
 } from '../types'
 
 import { WalletRequestHandler } from './wallet-request-handler'
 
-import { NetworkConfig, JsonRpcRequest, JsonRpcResponseCallback } from '@0xsequence/network'
+import { NetworkConfig, WalletContext, JsonRpcRequest, JsonRpcResponseCallback } from '@0xsequence/network'
 import { logger, sanitizeAlphanumeric, sanitizeHost, sanitizeNumberString } from '@0xsequence/utils'
 import { AuthorizationOptions } from '@0xsequence/auth'
 
 import { PROVIDER_OPEN_TIMEOUT } from './base-provider-transport'
 import { isBrowserExtension, LocalStorage } from '../utils'
-import { commons } from '@0xsequence/core'
 
 const TRANSPORT_SESSION_LS_KEY = '@sequence.transportSession'
 
@@ -69,7 +70,7 @@ export abstract class BaseWalletTransport implements WalletTransport {
       }
     })
 
-    this.walletRequestHandler.on('walletContext', (walletContext: commons.context.VersionedContext) => {
+    this.walletRequestHandler.on('walletContext', (walletContext: WalletContext) => {
       if (!this.registered || !walletContext) return
       this.notifyWalletContext(walletContext)
     })
@@ -230,7 +231,7 @@ export abstract class BaseWalletTransport implements WalletTransport {
     })
   }
 
-  notifyWalletContext(walletContext: commons.context.VersionedContext) {
+  notifyWalletContext(walletContext: WalletContext) {
     this.sendMessage({
       idx: -1,
       type: EventType.WALLET_CONTEXT,
@@ -367,7 +368,7 @@ export abstract class BaseWalletTransport implements WalletTransport {
     }
 
     // ensure signer is ready
-    await this.walletRequestHandler.getAccount()
+    await this.walletRequestHandler.getSigner()
 
     // Notify open and proceed to prompt for connection if intended
     if (!(await this.walletRequestHandler.isSignedIn())) {
@@ -385,9 +386,9 @@ export abstract class BaseWalletTransport implements WalletTransport {
         let chainId: number | undefined = undefined
         try {
           if (networkId) {
-            chainId = this.walletRequestHandler.setDefaultNetwork(networkId)
+            chainId = await this.walletRequestHandler.setDefaultNetwork(networkId, false)
           } else {
-            chainId = this.walletRequestHandler.defaultNetworkId
+            chainId = await this.walletRequestHandler.getChainId()
           }
         } catch (err) {
           console.error(err)
@@ -422,9 +423,9 @@ export abstract class BaseWalletTransport implements WalletTransport {
         let chainId: number | undefined = undefined
         try {
           if (networkId) {
-            chainId = this.walletRequestHandler.setDefaultNetwork(networkId)
+            chainId = await this.walletRequestHandler.setDefaultNetwork(networkId, false)
           } else {
-            chainId = this.walletRequestHandler.defaultNetworkId
+            chainId = await this.walletRequestHandler.getChainId()
           }
         } catch (err) {
           console.error(err)