Class EvmWeb3Private

Class containing methods for executing the functions of contracts and sending transactions in order to change the state of the blockchain. To get information from the blockchain use Web3Public.

Hierarchy

Web3Private
- EvmWeb3Private

Index

Constructors

constructor

new EvmWeb3Private(walletProviderCore: WalletProviderCore<default>): EvmWeb3Private
Parameters
- walletProviderCore: WalletProviderCore<default>
Returns EvmWeb3Private
Overrides Web3Private.constructor
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:104

Properties

address

address: string

Current wallet provider address.

`Readonly` web3

web3: default

Instance of web3, initialized with ethereum wallet, e.g. Metamask, WalletConnect.

Methods

approveOnPermit2

approveOnPermit2(tokenAddress: string, permit2Address: string, spenderAddress: string, amount?: BigNumber | "infinity", deadline?: BigNumber, options?: EvmTransactionOptions): Promise<TransactionReceipt>
Parameters
- tokenAddress: string
  
  Token address you want to approve for spending
- permit2Address: string
  
  Addres of permit2 contract
- spenderAddress: string
  
  Contract address spending your tokens
- amount: BigNumber | "infinity" = 'infinity'
  
  Approved amount
- deadline: BigNumber = ...
  
  Ms number added to current time (Date.now()) until approve expiration
- options: EvmTransactionOptions = {}
Returns Promise<TransactionReceipt>
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:383

approveTokens

approveTokens(tokenAddress: string, spenderAddress: string, amount?: BigNumber | "infinity", options??: EvmTransactionOptions): Promise<TransactionReceipt>
Executes approve method in ERC-20 token contract.

Returns
Approval transaction receipt.
Parameters
- tokenAddress: string
  
  Address of the smart-contract corresponding to the token.
- spenderAddress: string
  
  Wallet or contract address to approve.
- amount: BigNumber | "infinity" = 'infinity'
  
  Token amount to approve in wei.
- Optional options: EvmTransactionOptions = {}
  
  Additional options.
Returns Promise<TransactionReceipt>
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:339

checkBlockchainCorrect

checkBlockchainCorrect(blockchainName: BlockchainName): Promise<void>
Checks, that selected blockchain in wallet is equal to passed blockchain.
Parameters
- blockchainName: BlockchainName
Returns Promise<void>
Inherited from Web3Private.checkBlockchainCorrect
- Defined in src/core/blockchain/web3-private-service/web3-private/web3-private.ts:52

encodeApprove

encodeApprove(tokenAddress: string, spenderAddress: string, value: BigNumber | "infinity", options??: EvmTransactionOptions): Promise<TransactionConfig>
Build encoded approve transaction config.

Returns
Encoded approve transaction config.
Parameters
- tokenAddress: string
  
  Address of the smart-contract corresponding to the token.
- spenderAddress: string
  
  Wallet or contract address to approve.
- value: BigNumber | "infinity"
  
  Amount of tokens in approval window in spending cap field
- Optional options: EvmTransactionOptions = {}
  
  Additional options.
Returns Promise<TransactionConfig>
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:432

executeContractMethod

executeContractMethod(contractAddress: string, contractAbi: AbiItem[], methodName: string, methodArguments: unknown[], options??: EvmTransactionOptions): Promise<TransactionReceipt>
Executes method of smart-contract and resolve the promise when the transaction is included in the block.

Returns
Smart-contract method returned value.
Parameters
- contractAddress: string
  
  Address of smart-contract which method is to be executed.
- contractAbi: AbiItem[]
  
  Abi of smart-contract which method is to be executed.
- methodName: string
  
  Method name to execute.
- methodArguments: unknown[]
  
  Method arguments.
- Optional options: EvmTransactionOptions = {}
  
  Additional options.
Returns Promise<TransactionReceipt>
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:205

getBlockchainName

getBlockchainName(): Promise<undefined | BlockchainName>
Gets currently selected blockchain in wallet.

Returns Promise<undefined | BlockchainName>
Overrides Web3Private.getBlockchainName
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:111

sendTransaction

sendTransaction(toAddress: string, options??: EvmTransactionOptions): Promise<TransactionReceipt>
Sends Eth in transaction and resolve the promise when the transaction is included in the block.

Returns
Transaction receipt.
Parameters
- toAddress: string
  
  Eth receiver address.
- Optional options: EvmTransactionOptions = {}
  
  Additional options.
Returns Promise<TransactionReceipt>
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:122

setAddress

setAddress(address: string): void
Parameters
- address: string
Returns void
Inherited from Web3Private.setAddress
- Defined in src/core/blockchain/web3-private-service/web3-private/web3-private.ts:33

simulateTransaction

simulateTransaction(toAddress: string, options: EvmTransactionOptions, blockchain: EvmBlockchainName): Promise<EvmTransactionOptions>
Parameters
- toAddress: string
- options: EvmTransactionOptions
- blockchain: EvmBlockchainName
Returns Promise<EvmTransactionOptions>
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:466

tryExecuteContractMethod

tryExecuteContractMethod(contractAddress: string, contractAbi: AbiItem[], methodName: string, methodArguments: unknown[], options??: EvmTransactionOptions, allowError?: ((err: Web3Error) => boolean)): Promise<TransactionReceipt>
Tries to execute method of smart-contract and resolve the promise when the transaction is included in the block or rejects the error.
Parameters
- contractAddress: string
  
  Address of smart-contract which method is to be executed.
- contractAbi: AbiItem[]
  
  Abi of smart-contract which method is to be executed.
- methodName: string
  
  Method name to execute.
- methodArguments: unknown[]
  
  Method arguments.
- Optional options: EvmTransactionOptions = {}
  
  Additional options.
- Optional allowError: ((err: Web3Error) => boolean)
  
  Check error and decides to execute contact if error is allowed.
  - - (err: Web3Error): boolean
    - Parameters
      
      err: Web3Error
      
      Returns boolean
Returns Promise<TransactionReceipt>
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:245

trySendTransaction

trySendTransaction(toAddress: string, options?: EvmTransactionOptions): Promise<TransactionReceipt>
Tries to send Eth in transaction and resolve the promise when the transaction is included in the block or rejects the error.

Returns
Transaction receipt.
Parameters
- toAddress: string
  
  Eth receiver address.
- Optional options: EvmTransactionOptions
  
  Additional options.
Returns Promise<TransactionReceipt>
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:152

`Static` parseError

parseError(err: Web3Error): RubicSdkError
Parses web3 error by its code or message.
Parameters
- err: Web3Error
  
  Web3 error to parse.
Returns RubicSdkError
- Defined in src/core/blockchain/web3-private-service/web3-private/evm-web3-private/evm-web3-private.ts:39

`Static` stringifyAmount

stringifyAmount(amount: string | number | BigNumber, multiplier?: number): string
Converts number, string or BigNumber value to integer string.
Parameters
- amount: string | number | BigNumber
  
  Value to convert.
- multiplier: number = 1
  
  Amount multiplier.
Returns string
Inherited from Web3Private.stringifyAmount
- Defined in src/core/blockchain/web3-private-service/web3-private/web3-private.ts:17

Class EvmWeb3Private

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

walletProviderCore: WalletProviderCore<default>

Returns EvmWeb3Private

Properties

address

Readonly web3

Methods

approveOnPermit2

Parameters

tokenAddress: string

permit2Address: string

spenderAddress: string

amount: BigNumber | "infinity" = 'infinity'

deadline: BigNumber = ...

options: EvmTransactionOptions = {}

Returns Promise<TransactionReceipt>

approveTokens

Returns

Parameters

tokenAddress: string

spenderAddress: string

amount: BigNumber | "infinity" = 'infinity'

Optional options: EvmTransactionOptions = {}

Returns Promise<TransactionReceipt>

checkBlockchainCorrect

Parameters

blockchainName: BlockchainName

Returns Promise<void>

encodeApprove

Returns

Parameters

tokenAddress: string

spenderAddress: string

value: BigNumber | "infinity"

Optional options: EvmTransactionOptions = {}

Returns Promise<TransactionConfig>

executeContractMethod

Returns

Parameters

contractAddress: string

contractAbi: AbiItem[]

methodName: string

methodArguments: unknown[]

Optional options: EvmTransactionOptions = {}

Returns Promise<TransactionReceipt>

getBlockchainName

Returns Promise<undefined | BlockchainName>

sendTransaction

Returns

Parameters

toAddress: string

Optional options: EvmTransactionOptions = {}

Returns Promise<TransactionReceipt>

setAddress

Parameters

address: string

Returns void

simulateTransaction

Parameters

toAddress: string

options: EvmTransactionOptions

blockchain: EvmBlockchainName

Returns Promise<EvmTransactionOptions>

tryExecuteContractMethod

Parameters

contractAddress: string

contractAbi: AbiItem[]

methodName: string

methodArguments: unknown[]

Optional options: EvmTransactionOptions = {}

Optional allowError: ((err: Web3Error) => boolean)

Parameters

`Readonly` web3

`Optional` options: EvmTransactionOptions = {}

`Optional` options: EvmTransactionOptions = {}

`Optional` options: EvmTransactionOptions = {}

`Optional` options: EvmTransactionOptions = {}

`Optional` options: EvmTransactionOptions = {}

`Optional` allowError: ((err: Web3Error) => boolean)

`Optional` options: EvmTransactionOptions

`Static` parseError

`Static` stringifyAmount