Skip to content

Remove duplicated defaultChainId on wallet request handler #381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 28, 2023
Merged

Remove duplicated defaultChainId on wallet request handler #381

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a8036d
Remove duplicated defaultChainId on wrh
Agusx1211 Jun 28, 2023
d235448
defaultNetworkId -> defaultChainId
Agusx1211 Jun 28, 2023
b6a8cde
Eager return chainId if set web3provider
Agusx1211 Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions packages/provider/src/transports/base-wallet-transport.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,9 +385,10 @@ export abstract class BaseWalletTransport implements WalletTransport {
let chainId: number | undefined = undefined
try {
if (networkId) {
chainId = this.walletRequestHandler.setDefaultNetwork(networkId)
const networkIdNumber = ethers.BigNumber.from(networkId).toNumber()
chainId = await this.walletRequestHandler.setDefaultNetwork(networkIdNumber)
} else {
chainId = this.walletRequestHandler.defaultNetworkId
chainId = this.walletRequestHandler.defaultNetworkId()
}
} catch (err) {
console.error(err)
Expand Down Expand Up @@ -422,9 +423,10 @@ export abstract class BaseWalletTransport implements WalletTransport {
let chainId: number | undefined = undefined
try {
if (networkId) {
chainId = this.walletRequestHandler.setDefaultNetwork(networkId)
const networkIdNumber = ethers.BigNumber.from(networkId).toNumber()
chainId = await this.walletRequestHandler.setDefaultNetwork(networkIdNumber)
} else {
chainId = this.walletRequestHandler.defaultNetworkId
chainId = this.walletRequestHandler.defaultNetworkId()
}
} catch (err) {
console.error(err)
Expand Down
53 changes: 26 additions & 27 deletions packages/provider/src/transports/wallet-request-handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ const SIGNER_READY_TIMEOUT = 10000

export interface WalletSignInOptions {
connect?: boolean
networks?: NetworkConfig[]
defaultNetworkId?: string | number
defaultNetworkId?: number
}

export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, ProviderMessageRequestHandler {
Expand All @@ -51,19 +50,18 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P

onConnectOptionsChange: ((connectOptions: ConnectOptions | undefined) => void) | undefined = undefined

public defaultNetworkId: number

constructor(
account: Account | null | undefined,
prompter: WalletUserPrompter | null,
networks: NetworkConfig[],
defaultNetworkId?: string | number
networks: NetworkConfig[]
) {
this.account = account
this.prompter = prompter
this.networks = networks
}

this.defaultNetworkId = defaultNetworkId ? this.findNetworkID(defaultNetworkId) : networks[0].chainId
defaultNetworkId(): number {
return this.prompter?.getDefaultNetwork() ?? this.networks[0].chainId
}

private findNetworkID(network: string | number) {
Expand All @@ -82,14 +80,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
async signIn(account: Account | null, options: WalletSignInOptions = {}) {
this.setAccount(account)

const { connect, networks, defaultNetworkId } = options

if (networks !== undefined && networks.length > 0) {
const networkId = defaultNetworkId || this.defaultNetworkId
if (networkId) {
this.setDefaultNetwork(networkId)
}
}
const { connect, defaultNetworkId } = options

// Optionally, connect the dapp and wallet. In case connectOptions are provided, we will perform
// necessary auth request, and then notify the dapp of the 'connect' details.
Expand Down Expand Up @@ -117,6 +108,10 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
this.notifyClose()
}
}

if (defaultNetworkId && this.defaultNetworkId() !== defaultNetworkId) {
await this.prompter?.promptChangeNetwork(defaultNetworkId)
}
}

signOut() {
Expand Down Expand Up @@ -155,7 +150,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
}
}

let chainId: number
let chainId: number | string
switch (typeof options?.networkId) {
case 'string':
// First see if it matches the name of a network
Expand All @@ -171,7 +166,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
chainId = options.networkId
break
default:
chainId = this.defaultNetworkId
chainId = this.prompter?.getDefaultNetwork() ?? 1
break
}

Expand Down Expand Up @@ -280,7 +275,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
if (!account) throw new Error('WalletRequestHandler: wallet account is not configured')

// fetch the provider for the specific chain, or undefined will select defaultChain
const provider = this.account?.provider(chainId ?? this.defaultNetworkId)
const provider = this.account?.provider(chainId ?? this.defaultNetworkId())
if (!provider) throw new Error(`WalletRequestHandler: wallet provider is not configured for chainId ${chainId}`)
const jsonRpcProvider = provider instanceof ethers.providers.JsonRpcProvider ? provider : undefined

Expand Down Expand Up @@ -351,7 +346,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
// if (process.env.TEST_MODE === 'true' && this.prompter === null) {
if (this.prompter === null) {
// prompter is null, so we'll sign from here
sig = await account.signMessage(prefixedMessage, chainId ?? this.defaultNetworkId)
sig = await account.signMessage(prefixedMessage, chainId ?? this.defaultNetworkId())
} else {
const promptResultForDeployment = request.method === 'sequence_sign' || await this.handleConfirmWalletDeployPrompt(this.prompter, account, chainId)
if (promptResultForDeployment) {
Expand Down Expand Up @@ -392,7 +387,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P

if (this.prompter === null) {
// prompter is null, so we'll sign from here
sig = await account.signTypedData(typedData.domain, typedData.types, typedData.message, chainId ?? this.defaultNetworkId)
sig = await account.signTypedData(typedData.domain, typedData.types, typedData.message, chainId ?? this.defaultNetworkId())
} else {
const promptResultForDeployment = request.method === 'sequence_signTypedData_v4' || await this.handleConfirmWalletDeployPrompt(this.prompter, account, chainId)
if (promptResultForDeployment) {
Expand Down Expand Up @@ -426,7 +421,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
let txnHash = ''
if (this.prompter === null) {
// prompter is null, so we'll send from here
const txnResponse = await account.sendTransaction(transactionParams, chainId ?? this.defaultNetworkId)
const txnResponse = await account.sendTransaction(transactionParams, chainId ?? this.defaultNetworkId())
txnHash = txnResponse.hash
} else {
// prompt user to provide the response
Expand Down Expand Up @@ -457,7 +452,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
//
// TODO: verify serializing / transporting the SignedTransaction object works as expected, most likely however
// we will want to resolveProperties the big number values to hex strings
response.result = await account.signTransactions(transaction, chainId ?? this.defaultNetworkId)
response.result = await account.signTransactions(transaction, chainId ?? this.defaultNetworkId())
} else {
response.result = await this.prompter.promptSignTransaction(transaction, chainId, this.connectOptions)
}
Expand Down Expand Up @@ -546,7 +541,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P

const chainId = ethers.BigNumber.from(switchParams.chainId)

this.setDefaultNetwork(chainId.toString())
this.setDefaultNetwork(chainId.toNumber())

response.result = null // success
break
Expand Down Expand Up @@ -704,9 +699,9 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
this.onConnectOptionsChange?.(options)
}

setDefaultNetwork(chainId: string | number): number {
this.defaultNetworkId = this.findNetworkID(chainId)
return this.defaultNetworkId
async setDefaultNetwork(chainId: number): Promise<number> {
await this.prompter?.promptChangeNetwork(chainId)
return this.defaultNetworkId()
}

async getNetworks(jsonRpcResponse?: boolean): Promise<NetworkConfig[]> {
Expand Down Expand Up @@ -754,7 +749,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
const n = networks || (await this.getNetworks(true))
this.events.emit('networks', n)
if (n.length > 0) {
const defaultNetwork = n.find(network => network.chainId === this.defaultNetworkId)
const defaultNetwork = n.find(network => network.chainId === this.defaultNetworkId())
if (defaultNetwork) {
this.events.emit('chainChanged', ethers.utils.hexlify(defaultNetwork.chainId))
}
Expand Down Expand Up @@ -831,13 +826,17 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
}

export interface WalletUserPrompter {
getDefaultNetwork(): number

promptConnect(options?: ConnectOptions): Promise<PromptConnectDetails>
promptSignInConnect(options?: ConnectOptions): Promise<PromptConnectDetails>

promptSignMessage(message: MessageToSign, options?: ConnectOptions): Promise<string>
promptSignTransaction(txn: commons.transaction.Transactionish, chainId?: number, options?: ConnectOptions): Promise<string>
promptSendTransaction(txn: commons.transaction.Transactionish, chainId?: number, options?: ConnectOptions): Promise<string>
promptConfirmWalletDeploy(chainId: number, options?: ConnectOptions): Promise<boolean>

promptChangeNetwork(chainId: number): Promise<boolean>
}

interface LegacyWalletState {
Expand Down