Class Web3KeyWriteProvider Abstract

Hierarchy

Web3KeyReadProvider
- Web3KeyWriteProvider

Constructors

constructor

new Web3KeyWriteProvider(): Web3KeyWriteProvider

Inherited from Web3KeyReadProvider.constructor
Returns Web3KeyWriteProvider

Properties

Protected _currentAccount

_currentAccount: null | string = null

Protected _currentChain

_currentChain: number = 0

Protected _rpcConfig

_rpcConfig: TRPCConfig = RPC_URLS_BY_NETWORK

Protected accounts

accounts: string[] = []

persistStorageService

persistStorageService: PersistStorageService = ...

Protected provider

provider: provider = null

Private walletMeta

walletMeta: undefined | IWalletMeta

Protected web3

web3: null | default = null

Accessors

currentAccount

get currentAccount(): string
set currentAccount(addr: null | string): void

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:129
Returns string
- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:133
Parameters
- addr: null | string
Returns void

currentChain

get currentChain(): number
set currentChain(chainId: number): void

Inherited from Web3KeyReadProvider.currentChain
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:33
Returns number
Inherited from Web3KeyReadProvider.currentChain
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:40
Parameters
- chainId: number
Returns void

rpcConfig

get rpcConfig(): TRPCConfig
set rpcConfig(config: TRPCConfig): void

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:121
RPC config for the provider. It contains RPC urls for each specified network.

Returns TRPCConfig
- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:125
RPC config for the provider. It contains RPC urls for each specified network.

Parameters
- config: TRPCConfig
Returns void

Methods

addNetworkToWallet

addNetworkToWallet(chainId: number): Promise<any>

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:480
Parameters
- chainId: number
Returns Promise<any>

addTokenToWallet

addTokenToWallet(__namedParameters: ITokenInfo): Promise<boolean>

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:393
Specification can be found here.

Parameters
- __namedParameters: ITokenInfo
Returns Promise<boolean>

Private addWalletEventsListener

addWalletEventsListener(): void

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:532
Adds event listeners for the wallet

Returns void

connect

connect(): Promise<void>

Overrides Web3KeyReadProvider.connect
- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:174
Returns Promise<void>

createContract

createContract(abi: any, address: string): Contract

Inherited from Web3KeyReadProvider.createContract
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:90
Parameters
- abi: any
- address: string
Returns Contract

disconnect

disconnect(): void

Overrides Web3KeyReadProvider.disconnect
- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:182
Returns void

executeBatchCalls

executeBatchCalls<T>(calls: TWeb3Call<T>[]): Promise<T[]>

Inherited from Web3KeyReadProvider.executeBatchCalls
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:168
executeBatchCalls is supposed to decrease calls to blockchain. It only sends one request and returns data from each call.

Type Parameters
- T
Parameters
- calls: TWeb3Call<T>[]
  
  web3 calls
Returns Promise<T[]>
array of return values from web3 calls

getBlockNumber

getBlockNumber(): Promise<number>

Inherited from Web3KeyReadProvider.getBlockNumber
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:204
Returns Promise<number>

getContractMethodFee

getContractMethodFee(methodEstimateGas: number): Promise<BigNumber>

Inherited from Web3KeyReadProvider.getContractMethodFee
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:188
Parameters
- methodEstimateGas: number
Returns Promise<BigNumber>

getErc20Balance

getErc20Balance(contract: Contract, address: string): Promise<BigNumber>

Inherited from Web3KeyReadProvider.getErc20Balance
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:51
Parameters
- contract: Contract
- address: string
Returns Promise<BigNumber>

getFormattedBalance

getFormattedBalance(balance: Value, decimals: Value): BigNumber

Inherited from Web3KeyReadProvider.getFormattedBalance
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:44
Parameters
- balance: Value
- decimals: Value
Returns BigNumber

Private getMaxFees

getMaxFees(): Promise<IGetMaxFeesResult>

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:328
Calculates max fees for transaction. Thess values are available for networks with EIP-1559 support.

note
If current network is Binance Smart Chain, will return default values.

Returns Promise<IGetMaxFeesResult>
Max fees for transaction.

getReadWeb3

getReadWeb3(): default

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:304
Returns web3 instance for read operations.

Returns default
Web3 instance.

getSafeGasPriceWei

getSafeGasPriceWei(): Promise<BigNumber>

Overrides Web3KeyReadProvider.getSafeGasPriceWei
- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:523
Returns Promise<BigNumber>

getTokenBalance

getTokenBalance(contract: Contract, address: string): Promise<BigNumber>

Inherited from Web3KeyReadProvider.getTokenBalance
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:64
Parameters
- contract: Contract
- address: string
Returns Promise<BigNumber>

Private getUnlockedAccounts

getUnlockedAccounts(web3: default): Promise<string[]>

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:372
Parameters
- web3: default
Returns Promise<string[]>

getWalletMeta

getWalletMeta(): IWalletMeta

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:148
Returns current wallet meta.

example
const { name, icon, id } = provider.getWalletMeta();

Returns IWalletMeta

getWeb3

getWeb3(): default

Inherited from Web3KeyReadProvider.getWeb3
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:77
Returns default

Abstract inject

inject(): Promise<void>

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:116
This method allows you to inject a provider and set up web3. It is used before connecting to the provider.

Returns Promise<void>

Private isBinance

isBinance(): boolean

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:365
Returns boolean
true if current network is Binance Smart Chain.

isConnected

isConnected(): boolean

Inherited from Web3KeyReadProvider.isConnected
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:29
Returns boolean

Private removeWalletEventsListener

removeWalletEventsListener(provider?: provider): void

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:569
Removes event listeners for the wallet

Parameters
- provider: provider = ...
Returns void

sendTransactionAsync

sendTransactionAsync(from: string, to: string, sendOptions: ISendOptions): Promise<IWeb3SendResult>

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:199
Custom replacement for web3js methods.myMethod.send.

Parameters
- from: string
  
  Address of the sender.
- to: string
  
  Address of the recipient.
- sendOptions: ISendOptions
  
  Options for sending transaction.
Returns Promise<IWeb3SendResult>
Promise with transaction hash and receipt promise.

Private setWalletMeta

setWalletMeta(): void

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:159
Sets wallet meta based on provider.

Returns void

signMessage

signMessage(message: string, account?: string): Promise<any>

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:507
Parameters
- message: string
- account: string = ...
Returns Promise<any>

switchNetwork

switchNetwork(chainId: number): Promise<void>

- Defined in packages/provider/src/providerManager/providers/Web3KeyWriteProvider.ts:422
Request to switch network. If network is not added, will add it.

Parameters
- chainId: number
  
  the number of the network to switch to
Returns Promise<void>

watchAsset

watchAsset(config: { address: string; decimals?: number; image?: string; symbol: string; type: "ERC20" }): Promise<void>

Inherited from Web3KeyReadProvider.watchAsset
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:127
Parameters
- config: { address: string; decimals?: number; image?: string; symbol: string; type: "ERC20" }
  - address: string
  - Optional decimals?: number
  - Optional image?: string
  - symbol: string
  - type: "ERC20"
Returns Promise<void>

Static isInjected

isInjected(): boolean

Inherited from Web3KeyReadProvider.isInjected
- Defined in packages/provider/src/providerManager/providers/Web3KeyReadProvider.ts:25
Returns boolean

Generated using TypeDoc