Class Web3Provider

Hierarchy (view full)

SCProvider
- Web3Provider

Implements

Provider

Index

Constructors

constructor

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

Properties

`Private` `Readonly` _providerName

_providerName: string = 'Massa web3 provider'

account

account: Account

client

client: PublicAPI

Accessors

accountName

get accountName(): string
Returns string
Implementation of Provider.accountName
- Defined in src/provider/web3Provider/web3Provider.ts:53

address

get address(): string
Returns string
Implementation of Provider.address
- Defined in src/provider/web3Provider/web3Provider.ts:61

providerName

get providerName(): string
Returns string
Implementation of Provider.providerName
- Defined in src/provider/web3Provider/web3Provider.ts:57

Methods

balance

balance(final?): Promise<bigint>
Parameters
- final: boolean = true
Returns Promise<bigint>
Implementation of Provider.balance
- Defined in src/provider/web3Provider/web3Provider.ts:65

buyRolls

buyRolls(amount, opts?): Promise<Operation>
Buys rolls.
Parameters
- amount: bigint
  The number of rolls to buy.
- Optional opts: OperationOptions
  Optional operation details.
Returns Promise<Operation>
The ID of the operation.

Throws
If the amount of rolls is not a positive non-zero value.
Implementation of Provider.buyRolls
- Defined in src/provider/web3Provider/web3Provider.ts:122

`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.
Inherited from SCProvider.call
- Defined in src/provider/web3Provider/smartContracts.ts:57

callSC

callSC(params): Promise<Operation>
Parameters
- params: CallSCParams
Returns Promise<Operation>
Implementation of Provider.callSC
- Defined in src/provider/web3Provider/web3Provider.ts:186

`Protected` checkAccountBalance

checkAccountBalance(coins): Promise<void>
Parameters
- coins: bigint
Returns Promise<void>
Inherited from SCProvider.checkAccountBalance
- 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.
Inherited from SCProvider.deploy
- Defined in src/provider/web3Provider/smartContracts.ts:149

deploySC

deploySC(params): Promise<SmartContract>
Parameters
- params: DeploySCParams
Returns Promise<SmartContract>
Implementation of Provider.deploySC
- Defined in src/provider/web3Provider/web3Provider.ts:191

getEvents

getEvents(filter): Promise<SCEvent[]>
Parameters
- filter: EventFilter
Returns Promise<SCEvent[]>
Implementation of Provider.getEvents
- Defined in src/provider/web3Provider/web3Provider.ts:205

`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.
Inherited from SCProvider.getGasEstimation
- Defined in src/provider/web3Provider/smartContracts.ts:105

getNodeStatus

getNodeStatus(): Promise<NodeStatusInfo>
Returns Promise<NodeStatusInfo>
Implementation of Provider.getNodeStatus
- Defined in src/provider/web3Provider/web3Provider.ts:209

getOperationStatus

getOperationStatus(opId): Promise<OperationStatus>
Parameters
- opId: string
Returns Promise<OperationStatus>
Implementation of Provider.getOperationStatus
- Defined in src/provider/web3Provider/web3Provider.ts:201

getStorageKeys

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

networkInfos

networkInfos(): Promise<Network>
Returns Promise<Network>
Implementation of Provider.networkInfos
- Defined in src/provider/web3Provider/web3Provider.ts:69

readSC

readSC(params): Promise<ReadSCData>
Reads smart contract function.
Parameters
- params: ReadSCParams
  readSCParams.
Returns Promise<ReadSCData>
A promise that resolves to a ReadSCData.
Implementation of Provider.readSC
Inherited from SCProvider.readSC
- 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[]>
Implementation of Provider.readStorage
Inherited from SCProvider.readStorage
- Defined in src/provider/web3Provider/smartContracts.ts:188

`Private` rollOperation

rollOperation(type, amount, opts?): Promise<Operation>
Parameters
- type: OperationType
- amount: bigint
- Optional opts: OperationOptions
Returns Promise<Operation>
- Defined in src/provider/web3Provider/web3Provider.ts:86

sellRolls

sellRolls(amount, opts?): Promise<Operation>
Sells rolls.
Parameters
- amount: bigint
  The number of rolls to sell.
- Optional opts: OperationOptions
  Optional operation details.
Returns Promise<Operation>
The ID of the operation.

Throws
If the amount of rolls is not a positive non-zero value.
Implementation of Provider.sellRolls
- Defined in src/provider/web3Provider/web3Provider.ts:135

sign

sign(data): Promise<SignedData>
Parameters
- data: string | Uint8Array | Buffer
Returns Promise<SignedData>
Implementation of Provider.sign
- Defined in src/provider/web3Provider/web3Provider.ts:179

transfer

transfer(to, amount, opts?): Promise<Operation>
Transfers tokens.
Parameters
- to: string | Address
  The address of the recipient.
- amount: bigint
  The amount of tokens to transfer.
- Optional opts: OperationOptions
  Optional operation details.
Returns Promise<Operation>
The ID of the operation.

Throws
If the amount of tokens is not a positive non-zero value.
Implementation of Provider.transfer
- Defined in src/provider/web3Provider/web3Provider.ts:149

`Static` buildnet

buildnet(account): Web3Provider
Parameters
- account: Account
Returns Web3Provider
- Defined in src/provider/web3Provider/web3Provider.ts:46

`Static` fromRPCUrl

fromRPCUrl(url, account): Web3Provider
Parameters
- url: string
- account: Account
Returns Web3Provider
- Defined in src/provider/web3Provider/web3Provider.ts:38

`Static` mainnet

mainnet(account): Web3Provider
Parameters
- account: Account
Returns Web3Provider
- Defined in src/provider/web3Provider/web3Provider.ts:42

Class Web3Provider

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Web3Provider

Properties

Private Readonly _providerName

account

client

Accessors

accountName

Returns string

address

Returns string

providerName

Returns string

Methods

balance

Parameters

Returns Promise<bigint>

buyRolls

Parameters

Returns Promise<Operation>

Throws

Protected call

Parameters

Returns Promise<string>

callSC

Parameters

Returns Promise<Operation>

Protected checkAccountBalance

Parameters

Returns Promise<void>

Protected deploy

Parameters

Returns Promise<string>

Throws

deploySC

Parameters

Returns Promise<SmartContract>

getEvents

Parameters

Returns Promise<SCEvent[]>

Protected getGasEstimation

Parameters

Returns Promise<bigint>

Remarks

Throws

getNodeStatus

Returns Promise<NodeStatusInfo>

getOperationStatus

Parameters

Returns Promise<OperationStatus>

getStorageKeys

Parameters

Returns Promise<Uint8Array[]>

networkInfos

Returns Promise<Network>

readSC

Parameters

Returns Promise<ReadSCData>

readStorage

Parameters

Returns Promise<Uint8Array[]>

Private rollOperation

Parameters

Returns Promise<Operation>

sellRolls

Parameters

Returns Promise<Operation>

Throws

sign

Parameters

`Private` `Readonly` _providerName

`Protected` call

`Protected` checkAccountBalance

`Protected` deploy

`Protected` getGasEstimation

`Private` rollOperation

`Static` buildnet

`Static` fromRPCUrl

`Static` mainnet