Class SolanaWeb3Public

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
- SolanaWeb3Public

Index

Constructors

constructor

Methods

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

Constructors

constructor

new SolanaWeb3Public(connection: Connection): SolanaWeb3Public
Parameters
- connection: Connection
Returns SolanaWeb3Public
Overrides Web3Public.constructor
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:27

Methods

callContractMethod

callContractMethod<T>(_contractAddress: string, _contractAbi: AbiItem[], _methodName: string, _methodArguments?: unknown[], _options?: {
    from?: string;
    gas?: string;
    gasPrice?: string;
    value?: string;
}): 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.
- _methodArguments: unknown[] = []
  
  Method arguments.
- _options: {
      from?: string;
      gas?: string;
      gasPrice?: string;
      value?: string;
  } = {}
  
  Transaction options.
  - Optional from?: string
  - Optional gas?: string
  - Optional gasPrice?: string
  - Optional value?: string
Returns Promise<T>
Overrides Web3Public.callContractMethod
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:114

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>>>
Inherited from Web3Public.callForTokenInfo
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:82

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.
- tokenFields: SupportedTokenField[] = ...
  
  Token's fields to get.
Returns Promise<Partial<Record<SupportedTokenField, string>>[]>
Overrides Web3Public.callForTokensInfo
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:62

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>
Inherited from Web3Public.checkBalance
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:65

getAllowance

getAllowance(): Promise<BigNumber>
Calls allowance method in token contract.

Returns
Token's amount, allowed to be spent.

Returns Promise<BigNumber>
Overrides Web3Public.getAllowance
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:191

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.
- tokenAddress: string
  
  Address of the smart-contract corresponding to the token,
Returns Promise<BigNumber>
Overrides Web3Public.getBalance
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:96

getBlockNumber

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

Returns
Block number.

Returns Promise<number>
Overrides Web3Public.getBlockNumber
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:31

getRecentBlockhash

getRecentBlockhash(): Promise<Readonly<{
blockhash: string;
lastValidBlockHeight: number;
}>>
Returns Promise<Readonly<{
blockhash: string;
lastValidBlockHeight: number;
}>>
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:199

getTokenBalance

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

getTokensBalances

getTokensBalances(address: string, tokensAddresses: string[]): Promise<BigNumber[]>
Gets balance of multiple tokens.
Parameters
- address: string
  
  Wallet address.
- tokensAddresses: string[]
  
  Tokens addresses.
Returns Promise<BigNumber[]>
Overrides Web3Public.getTokensBalances
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:157

getTransactionStatus

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

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 = 4000
  
  Acceptable node response timeout.
Returns Promise<boolean>
Overrides Web3Public.healthCheck
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:129

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>[]>
Inherited from Web3Public.multicallContractMethod
- 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>[]>
Inherited from Web3Public.multicallContractMethods
- Defined in src/core/blockchain/web3-public-service/web3-public/web3-public.ts:142

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>[][]>
Overrides Web3Public.multicallContractsMethods
- Defined in src/core/blockchain/web3-public-service/web3-public/solana-web3-public/solana-web3-public.ts:35

setProvider

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

Class SolanaWeb3Public

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

connection: Connection

Returns SolanaWeb3Public

Methods

callContractMethod

Type Parameters

T extends Web3PrimitiveType = string

Parameters

_contractAddress: string

_contractAbi: AbiItem[]

_methodName: string

_methodArguments: unknown[] = []

_options: { from?: string; gas?: string; gasPrice?: string; value?: string; } = {}

Optional from?: string

Optional gas?: string

Optional gasPrice?: string

Optional value?: string

Returns Promise<T>

callForTokenInfo

Parameters

tokenAddress: string

tokenFields: SupportedTokenField[] = ...

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

callForTokensInfo

Parameters

tokenAddresses: string[] | readonly string[]

tokenFields: SupportedTokenField[] = ...

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

checkBalance

Parameters

token: Token<BlockchainName>

requiredAmount: BigNumber

userAddress: string

Returns Promise<void>

getAllowance

Returns

Returns Promise<BigNumber>

getBalance

Parameters

userAddress: string

tokenAddress: string

Returns Promise<BigNumber>

getBlockNumber

Returns

Returns Promise<number>

getRecentBlockhash

Returns Promise<Readonly<{ blockhash: string; lastValidBlockHeight: number; }>>

getTokenBalance

Parameters

address: string

tokenAddress: string

Returns Promise<BigNumber>

getTokensBalances

Parameters

address: string

tokensAddresses: string[]

Returns Promise<BigNumber[]>

getTransactionStatus

Parameters

hash: string

Returns Promise<TxStatus>

healthCheck

Returns

Parameters

timeoutMs: number = 4000

Returns Promise<boolean>

multicallContractMethod

Type Parameters

Output extends Web3PrimitiveType

Parameters

contractAddress: string

contractAbi: AbiItem[]

methodName: string

_options: {
from?: string;
gas?: string;
gasPrice?: string;
value?: string;
} = {}

`Optional` from?: string

`Optional` gas?: string

`Optional` gasPrice?: string

`Optional` value?: string

Returns Promise<Readonly<{
blockhash: string;
lastValidBlockHeight: number;
}>>

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