Class Web3Public`Abstract`

Class containing methods for calling contracts in order to obtain information from the blockchain. To send transaction or execute contract method use Web3Private.

Hierarchy

Web3Public

Index

Methods

callContractMethod callForTokenInfo callForTokensInfo checkBalance getAllowance getBalance getBlockNumber getTokenBalance getTokensBalances getTransactionStatus healthCheck multicallContractMethod multicallContractMethods multicallContractsMethods setProvider

Methods

`Abstract` callContractMethod

callContractMethod<T>(contractAddress: string, contractAbi: AbiItem[], methodName: string, methodArguments?: unknown[], options?: object): Promise<T>
Calls pure method of smart-contract and returns its output value.
Type Parameters
- T extends Web3PrimitiveType = string
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
  
  Called method name.
- Optional methodArguments: unknown[]
  
  Method arguments.
- Optional options: object
  
  Transaction options.
Returns Promise<T>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:180

callForTokenInfo

callForTokenInfo(tokenAddress: string, tokenFields?: SupportedTokenField[]): Promise<Partial<Record<SupportedTokenField, string>>>
Gets token info by address.
Parameters
- tokenAddress: string
  
  Address of token.
- tokenFields: SupportedTokenField[] = ...
  
  Token's fields to get.
Returns Promise<Partial<Record<SupportedTokenField, string>>>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:82

`Abstract` callForTokensInfo

callForTokensInfo(tokenAddresses: string[] | readonly string[], tokenFields?: SupportedTokenField[]): Promise<Partial<Record<SupportedTokenField, string>>[]>
Gets tokens info by addresses.
Parameters
- tokenAddresses: string[] | readonly string[]
  
  Addresses of tokens.
- Optional tokenFields: SupportedTokenField[]
  
  Token's fields to get.
Returns Promise<Partial<Record<SupportedTokenField, string>>[]>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:95

checkBalance

checkBalance(token: Token<BlockchainName>, requiredAmount: BigNumber, userAddress: string): Promise<void>
Checks that user has enough balance.
Parameters
- token: Token<BlockchainName>
  
  Token to check balance of.
- requiredAmount: BigNumber
  
  Required user balance in Eth units.
- userAddress: string
  
  Wallet address, which contains tokens.
Returns Promise<void>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:65

`Abstract` getAllowance

getAllowance(tokenAddress: string, ownerAddress: string, spenderAddress: string): Promise<BigNumber>
Calls allowance method in token contract.

Returns
Token's amount, allowed to be spent.
Parameters
- tokenAddress: string
  
  Address of the smart-contract corresponding to the token.
- ownerAddress: string
  
  Wallet address to spend from.
- spenderAddress: string
  
  Wallet or contract address, allowed to spend.
Returns Promise<BigNumber>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:107

`Abstract` getBalance

getBalance(userAddress: string, tokenAddress?: string): Promise<BigNumber>
Gets account native or token balance in wei.
Parameters
- userAddress: string
  
  Wallet address, whose balance you want to find out.
- Optional tokenAddress: string
  
  Address of the smart-contract corresponding to the token,
Returns Promise<BigNumber>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:45

`Abstract` getBlockNumber

getBlockNumber(): Promise<number>
Gets last block number.

Returns
Block number.

Returns Promise<number>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:197

`Abstract` getTokenBalance

getTokenBalance(userAddress: string, tokenAddress: string): Promise<BigNumber>
Gets token's balance in wei.
Parameters
- userAddress: string
  
  Wallet address, whose balance you want to find out.
- tokenAddress: string
  
  Address of the smart-contract corresponding to the token.
Returns Promise<BigNumber>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:52

`Abstract` getTokensBalances

getTokensBalances(userAddress: string, tokensAddresses: string[]): Promise<BigNumber[]>
Parameters
- userAddress: string
- tokensAddresses: string[]
Returns Promise<BigNumber[]>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:54

`Abstract` getTransactionStatus

getTransactionStatus(hash: string): Promise<TxStatus>
Returns transaction status, based on transaction receipt.
Parameters
- hash: string
Returns Promise<TxStatus>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:191

`Abstract` healthCheck

healthCheck(timeoutMs: number): Promise<boolean>
Health-check current rpc node.

Returns
Null if healthcheck is not defined for current blockchain, else node health status.
Parameters
- timeoutMs: number
  
  Acceptable node response timeout.
Returns Promise<boolean>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:38

multicallContractMethod

multicallContractMethod<Output>(contractAddress: string, contractAbi: AbiItem[], methodName: string, methodCallsArguments: unknown[][]): Promise<ContractMulticallResponse<Output>[]>
Uses multicall to make several calls of one method in one contract.
Type Parameters
- Output extends Web3PrimitiveType
Parameters
- contractAddress: string
  
  Target contract address.
- contractAbi: AbiItem[]
  
  Target contract abi.
- methodName: string
  
  Method name.
- methodCallsArguments: unknown[][]
  
  Method parameters array, for each method call.
Returns Promise<ContractMulticallResponse<Output>[]>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:120

multicallContractMethods

multicallContractMethods<Output>(contractAddress: string, contractAbi: AbiItem[], methodsData: MethodData[]): Promise<ContractMulticallResponse<Output>[]>
Uses multicall to make several methods calls in one contract.
Type Parameters
- Output extends Web3PrimitiveType
Parameters
- contractAddress: string
  
  Target contract address.
- contractAbi: AbiItem[]
  
  Target contract abi.
- methodsData: MethodData[]
  
  Methods data, containing methods' names and arguments.
Returns Promise<ContractMulticallResponse<Output>[]>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:142

`Abstract` multicallContractsMethods

multicallContractsMethods<Output>(contractAbi: AbiItem[], contractsData: {
contractAddress: string;
methodsData: MethodData[];
}[]): Promise<ContractMulticallResponse<Output>[][]>
Uses multicall to make many methods calls in several contracts.
Type Parameters
- Output extends Web3PrimitiveType
Parameters
- contractAbi: AbiItem[]
  
  Target contract abi.
- contractsData: {
  contractAddress: string;
  methodsData: MethodData[];
  }[]
  
  Contract addresses and methods data, containing methods' names and arguments.
Returns Promise<ContractMulticallResponse<Output>[][]>
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:164

`Abstract` setProvider

setProvider(provider: unknown): void
Sets new provider to web3 instance.
Parameters
- provider: unknown
  
  New web3 provider, e.g. rpc link.
Returns void
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:31

Class Web3PublicAbstract

Hierarchy

Index

Methods

Methods

Abstract callContractMethod

Type Parameters

T extends Web3PrimitiveType = string

Parameters

contractAddress: string

contractAbi: AbiItem[]

methodName: string

Optional methodArguments: unknown[]

Optional options: object

Returns Promise<T>

callForTokenInfo

Parameters

tokenAddress: string

tokenFields: SupportedTokenField[] = ...

Returns Promise<Partial<Record<SupportedTokenField, string>>>

Abstract callForTokensInfo

Parameters

tokenAddresses: string[] | readonly string[]

Optional tokenFields: SupportedTokenField[]

Returns Promise<Partial<Record<SupportedTokenField, string>>[]>

checkBalance

Parameters

token: Token<BlockchainName>

requiredAmount: BigNumber

userAddress: string

Returns Promise<void>

Abstract getAllowance

Returns

Parameters

tokenAddress: string

ownerAddress: string

spenderAddress: string

Returns Promise<BigNumber>

Abstract getBalance

Parameters

userAddress: string

Optional tokenAddress: string

Returns Promise<BigNumber>

Abstract getBlockNumber

Returns

Returns Promise<number>

Abstract getTokenBalance

Parameters

userAddress: string

tokenAddress: string

Returns Promise<BigNumber>

Abstract getTokensBalances

Parameters

userAddress: string

tokensAddresses: string[]

Returns Promise<BigNumber[]>

Abstract getTransactionStatus

Parameters

hash: string

Returns Promise<TxStatus>

Abstract healthCheck

Returns

Parameters

timeoutMs: number

Returns Promise<boolean>

multicallContractMethod

Type Parameters

Output extends Web3PrimitiveType

Parameters

contractAddress: string

contractAbi: AbiItem[]

methodName: string

methodCallsArguments: unknown[][]

Returns Promise<ContractMulticallResponse<Output>[]>

multicallContractMethods

Type Parameters

Output extends Web3PrimitiveType

Parameters

contractAddress: string

contractAbi: AbiItem[]

Class Web3Public`Abstract`

`Abstract` callContractMethod

`Optional` methodArguments: unknown[]

`Optional` options: object

`Abstract` callForTokensInfo

`Optional` tokenFields: SupportedTokenField[]

`Abstract` getAllowance

`Abstract` getBalance

`Optional` tokenAddress: string

`Abstract` getBlockNumber

`Abstract` getTokenBalance

`Abstract` getTokensBalances

`Abstract` getTransactionStatus

`Abstract` healthCheck

`Abstract` multicallContractsMethods

contractsData: {
contractAddress: string;
methodsData: MethodData[];
}[]

`Abstract` setProvider