Class SCProvider

Hierarchy (view full)

SCProvider
- Web3Provider

Index

Constructors

Properties

Methods

call checkAccountBalance deploy getGasEstimation getStorageKeys readSC readStorage

Constructors

constructor

new SCProvider(client, account): SCProvider
Parameters
- client: PublicAPI
- account: Account
Returns SCProvider
- Defined in src/provider/web3Provider/smartContracts.ts:30

Properties

account

account: Account

client

client: PublicAPI

Methods

`Protected` call

call(params): Promise<string>
Executes a smart contract call operation
Parameters
- params: CallSCParams
  callSCParams.
Returns Promise<string>
A promise that resolves to an Operation object representing the transaction.
- Defined in src/provider/web3Provider/smartContracts.ts:57

`Protected` checkAccountBalance

checkAccountBalance(coins): Promise<void>
Parameters
- coins: bigint
Returns Promise<void>
- Defined in src/provider/web3Provider/smartContracts.ts:120

`Protected` deploy

deploy(params): Promise<string>
Deploys a smart contract on the blockchain.
Parameters
- params: DeploySCParams
  Optional deployment details with defaults as follows:
Returns Promise<string>
The deployed smart contract.

Throws
If the account has insufficient balance to deploy the smart contract.
- Defined in src/provider/web3Provider/smartContracts.ts:149

`Protected` getGasEstimation

getGasEstimation(params): Promise<bigint>
Returns the gas estimation for a given function.
Parameters
- params: CallSCParams
  callSCParams.
Returns Promise<bigint>
The gas estimation for the function.

Remarks
To avoid running out of gas, the gas estimation is increased by 20%.

Throws
If the read operation returns an error.
- Defined in src/provider/web3Provider/smartContracts.ts:105

getStorageKeys

getStorageKeys(address, filter?, final?): Promise<Uint8Array[]>
Parameters
- address: string
- filter: string | Uint8Array = ...
- final: boolean = true
Returns Promise<Uint8Array[]>
- Defined in src/provider/web3Provider/smartContracts.ts:178

readSC

readSC(params): Promise<ReadSCData>
Reads smart contract function.
Parameters
- params: ReadSCParams
  readSCParams.
Returns Promise<ReadSCData>
A promise that resolves to a ReadSCData.
- Defined in src/provider/web3Provider/smartContracts.ts:40

readStorage

readStorage(address, keys, final?): Promise<Uint8Array[]>
Parameters
- address: string
- keys: string[] | Uint8Array[]
- final: boolean = true
Returns Promise<Uint8Array[]>
- Defined in src/provider/web3Provider/smartContracts.ts:188