Class JsonRpcProvider

Hierarchy (view full)

JsonRpcPublicProvider
- JsonRpcProvider

Implements

Provider

Index

Constructors

constructor

new JsonRpcProvider(client, account): JsonRpcProvider
Parameters
- client: PublicAPI
- account: Account
Returns JsonRpcProvider
Overrides JsonRpcPublicProvider.constructor
- Defined in provider/jsonRpcProvider/jsonRpcProvider.ts:45

Properties

account

account: Account

client

client: PublicAPI

Accessors

accountName

get accountName(): string
Returns string
Implementation of Provider.accountName
- Defined in provider/jsonRpcProvider/jsonRpcProvider.ts:84

address

get address(): string
Returns string
Implementation of Provider.address
- Defined in provider/jsonRpcProvider/jsonRpcProvider.ts:92

providerName

get providerName(): string
Returns string
Implementation of Provider.providerName
- Defined in provider/jsonRpcProvider/jsonRpcProvider.ts:88

Methods

balance

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

balanceOf

balanceOf(addresses, final?): Promise<{
address: string;
balance: bigint;
}[]>
Parameters
- addresses: string[]
- final: boolean = true
Returns Promise<{
address: string;
balance: bigint;
}[]>
Implementation of Provider.balanceOf
Inherited from JsonRpcPublicProvider.balanceOf
- Defined in provider/jsonRpcProvider/jsonRpcPublicProvider.ts:50

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 provider/jsonRpcProvider/jsonRpcProvider.ts:136

callSC

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

deploySC

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

executeSC

executeSC(params): Promise<Operation>
Executes Binary Smart Contract Code Onchain

Executes a binary code (smart contract) directly on the blockchain without deploying or storing it. This function is particularly useful for one-off actions or tasks that require blockchain execution but do not need the persistence or state of a deployed smart contract.
Parameters
- params: ExecuteScParams
Returns Promise<Operation>
Remarks
If the execution involves storing data or spending coins, the sender's address (i.e., the user's address initiating the contract execution) will be used.

See
https://docs.massa.net/docs/learn/operation-format-execution#executesc-operation-payload for more details on the setup and usage of the datastore during execution.
Implementation of Provider.executeSC
- Defined in provider/jsonRpcProvider/jsonRpcProvider.ts:221

executeSCGasEstimation

executeSCGasEstimation(params): Promise<bigint>
Parameters
- params: ExecuteSCReadOnlyParams
Returns Promise<bigint>
Overrides JsonRpcPublicProvider.executeSCGasEstimation
- Defined in provider/jsonRpcProvider/jsonRpcProvider.ts:383

executeSCReadOnly

executeSCReadOnly(params): Promise<ExecuteSCReadOnlyResult>
Parameters
- params: ExecuteSCReadOnlyParams
Returns Promise<ExecuteSCReadOnlyResult>
Implementation of Provider.executeSCReadOnly
Overrides JsonRpcPublicProvider.executeSCReadOnly
- Defined in provider/jsonRpcProvider/jsonRpcProvider.ts:373

getEvents

getEvents(filter): Promise<OutputEvents>
Parameters
- filter: EventFilter
Returns Promise<OutputEvents>
Implementation of Provider.getEvents
Inherited from JsonRpcPublicProvider.getEvents
- Defined in provider/jsonRpcProvider/jsonRpcPublicProvider.ts:87

getGasEstimation

getGasEstimation(params): Promise<bigint>
Returns the gas estimation for a given function.
Parameters
- params: ReadSCParams
  ReadSCParams. caller must be provided
Returns Promise<bigint>
The gas estimation for the operation execution.

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

Throws
If the read operation returns an error.
Overrides JsonRpcPublicProvider.getGasEstimation
- Defined in provider/jsonRpcProvider/jsonRpcProvider.ts:368

getNodeStatus

getNodeStatus(): Promise<NodeStatusInfo>
Returns Promise<NodeStatusInfo>
Implementation of Provider.getNodeStatus
Inherited from JsonRpcPublicProvider.getNodeStatus
- Defined in provider/jsonRpcProvider/jsonRpcPublicProvider.ts:91

getOperationStatus

getOperationStatus(opId): Promise<OperationStatus>
Parameters
- opId: string
Returns Promise<OperationStatus>
Implementation of Provider.getOperationStatus
Inherited from JsonRpcPublicProvider.getOperationStatus
- Defined in provider/jsonRpcProvider/jsonRpcPublicProvider.ts:83

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 JsonRpcPublicProvider.getStorageKeys
- Defined in provider/jsonRpcProvider/jsonRpcPublicProvider.ts:116

networkInfos

networkInfos(): Promise<Network>
Returns Promise<Network>
Implementation of Provider.networkInfos
Inherited from JsonRpcPublicProvider.networkInfos
- Defined in provider/jsonRpcProvider/jsonRpcPublicProvider.ts:66

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
Overrides JsonRpcPublicProvider.readSC
- Defined in provider/jsonRpcProvider/jsonRpcProvider.ts:360

readStorage

readStorage(address, keys, final?): Promise<(null | Uint8Array)[]>
Parameters
- address: string
- keys: string[] | Uint8Array[]
- final: boolean = true
Returns Promise<(null | Uint8Array)[]>
Implementation of Provider.readStorage
Inherited from JsonRpcPublicProvider.readStorage
- Defined in provider/jsonRpcProvider/jsonRpcPublicProvider.ts:172

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 provider/jsonRpcProvider/jsonRpcProvider.ts:149

sign

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

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 provider/jsonRpcProvider/jsonRpcProvider.ts:163

Class JsonRpcProvider

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns JsonRpcProvider

Properties

account

client

Accessors

accountName

Returns string

address

Returns string

providerName

Returns string

Methods

balance

Parameters

Returns Promise<bigint>

balanceOf

Parameters

Returns Promise<{ address: string; balance: bigint; }[]>

buyRolls

Parameters

Returns Promise<Operation>

Throws

callSC

Parameters

Returns Promise<Operation>

deploySC

Parameters

Returns Promise<SmartContract>

executeSC

Parameters

Returns Promise<Operation>

Remarks

See

executeSCGasEstimation

Parameters

Returns Promise<bigint>

executeSCReadOnly

Parameters

Returns Promise<ExecuteSCReadOnlyResult>

getEvents

Parameters

Returns Promise<OutputEvents>

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<(null | Uint8Array)[]>

sellRolls

Parameters

Returns Promise<Operation>

Throws

sign

Parameters

Returns Promise<{
address: string;
balance: bigint;
}[]>

`Static` buildnet

`Static` fromRPCUrl

`Static` mainnet