Class GrpcProvider

GrpcProvider implements the Provider interface using gRPC for Massa blockchain interactions

Hierarchy (view full)

GrpcPublicProvider
- GrpcProvider

Implements

Provider

Constructors

constructor

new GrpcProvider(client, url, account): GrpcProvider
Creates a new GrpcProvider instance
Parameters
- client: PublicServiceClient
- url: string
  The gRPC endpoint URL
- account: Account
  The account associated with this provider
Returns GrpcProvider
Overrides GrpcPublicProvider.constructor
- Defined in provider/grpcProvider/grpcProvider.ts:23

Properties

client

client: PublicServiceClient

url

url: string

The gRPC endpoint URL

Accessors

accountName

get accountName(): string
Gets the name of the associated account

Returns string
Implementation of Provider.accountName
- Defined in provider/grpcProvider/grpcProvider.ts:68

address

get address(): string
Gets the address of the associated account

Returns string
Implementation of Provider.address
- Defined in provider/grpcProvider/grpcProvider.ts:62

providerName

get providerName(): string
Gets the name of the provider

Returns string
Implementation of Provider.providerName
- Defined in provider/grpcProvider/grpcProvider.ts:74

Methods

balance

balance(final?): Promise<bigint>
Retrieves the balance of the associated account
Parameters
- final: boolean = true
Returns Promise<bigint>
Implementation of Provider.balance
- Defined in provider/grpcProvider/grpcProvider.ts:89

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 GrpcPublicProvider.balanceOf
- Defined in provider/grpcProvider/grpcPublicProvider.ts:328

buyRolls

buyRolls(): Promise<Operation>
Returns Promise<Operation>
Deprecated
This method cannot be implemented in the GRPC provider. Use another provider or alternative method for buying rolls.
Implementation of Provider.buyRolls
- Defined in provider/grpcProvider/grpcProvider.ts:108

callSC

callSC(): Promise<Operation>
Returns Promise<Operation>
Deprecated
This method cannot be implemented in the GRPC provider. Use another provider or alternative method for calling smart contracts.
Implementation of Provider.callSC
- Defined in provider/grpcProvider/grpcProvider.ts:135

deploySC

deploySC(): Promise<SmartContract>
Returns Promise<SmartContract>
Deprecated
This method cannot be implemented in the GRPC provider. Use another provider or alternative method for deploying smart contracts.
Implementation of Provider.deploySC
- Defined in provider/grpcProvider/grpcProvider.ts:153

executeSC

executeSC(): Promise<Operation>
Returns Promise<Operation>
Deprecated
This method cannot be implemented in the GRPC provider. Use another provider or alternative method for executing smart contracts.
Implementation of Provider.executeSC
- Defined in provider/grpcProvider/grpcProvider.ts:144

executeSCReadOnly

executeSCReadOnly(params): Promise<ExecuteSCReadOnlyResult>
Parameters
- params: ExecuteSCReadOnlyParams
Returns Promise<ExecuteSCReadOnlyResult>
Implementation of Provider.executeSCReadOnly
Inherited from GrpcPublicProvider.executeSCReadOnly
- Defined in provider/grpcProvider/grpcPublicProvider.ts:1019

getBlocks

getBlocks(blockIds): Promise<BlockWrapper[]>
Retrieves detailed information about specified blocks
Parameters
- blockIds: string[]
Returns Promise<BlockWrapper[]>
Inherited from GrpcPublicProvider.getBlocks
- Defined in provider/grpcProvider/grpcPublicProvider.ts:671

getEndorsements

getEndorsements(endorsementIds): Promise<EndorsementWrapper[]>
Retrieves detailed information about specified endorsements
Parameters
- endorsementIds: string[]
Returns Promise<EndorsementWrapper[]>
Inherited from GrpcPublicProvider.getEndorsements
- Defined in provider/grpcProvider/grpcPublicProvider.ts:659

getEvents

getEvents(filter): Promise<OutputEvents>
Retrieves events based on specified filters
Parameters
- filter: EventFilter
Returns Promise<OutputEvents>
Implementation of Provider.getEvents
Inherited from GrpcPublicProvider.getEvents
- Defined in provider/grpcProvider/grpcPublicProvider.ts:714

getNextBlockBestParent

getNextBlockBestParent(): Promise<BlockParent[]>
Retrieves the best parent blocks for the next block

Returns Promise<BlockParent[]>
Inherited from GrpcPublicProvider.getNextBlockBestParent
- Defined in provider/grpcProvider/grpcPublicProvider.ts:649

getNodeStatus

getNodeStatus(): Promise<NodeStatusInfo>
Returns Promise<NodeStatusInfo>
Implementation of Provider.getNodeStatus
Inherited from GrpcPublicProvider.getNodeStatus
- Defined in provider/grpcProvider/grpcPublicProvider.ts:894

getOperationABICallStacks

getOperationABICallStacks(operationIds): Promise<ABICallStack[]>
Retrieves ABI call stacks for specified operations
Parameters
- operationIds: string[]
Returns Promise<ABICallStack[]>
Inherited from GrpcPublicProvider.getOperationABICallStacks
- Defined in provider/grpcProvider/grpcPublicProvider.ts:421

getOperationStatus

getOperationStatus(opId): Promise<OperationStatus>
Parameters
- opId: string
Returns Promise<OperationStatus>
Implementation of Provider.getOperationStatus
Inherited from GrpcPublicProvider.getOperationStatus
- Defined in provider/grpcProvider/grpcPublicProvider.ts:823

getOperations

getOperations(operationIds): Promise<OperationWrapper[]>
Retrieves detailed information about specified operations
Parameters
- operationIds: string[]
Returns Promise<OperationWrapper[]>
Inherited from GrpcPublicProvider.getOperations
- Defined in provider/grpcProvider/grpcPublicProvider.ts:639

getSelectorDraws

getSelectorDraws(addresses?, slotRange?): Promise<SlotDraw[]>
Retrieves selector draws for specified addresses and slot range
Parameters
- Optional addresses: string[]
- Optional slotRange: SlotRange
Returns Promise<SlotDraw[]>
Inherited from GrpcPublicProvider.getSelectorDraws
- Defined in provider/grpcProvider/grpcPublicProvider.ts:613

getSlotABICallStacks

getSlotABICallStacks(slots): Promise<SlotABICallStacks[]>
Retrieves ABI call stacks for specified slots
Parameters
- slots: Slot[]
Returns Promise<SlotABICallStacks[]>
Inherited from GrpcPublicProvider.getSlotABICallStacks
- Defined in provider/grpcProvider/grpcPublicProvider.ts:434

getSlotTransfers

getSlotTransfers(slots): Promise<TransferInfos[]>
Retrieves transfer information for specified slots
Parameters
- slots: Slot[]
Returns Promise<TransferInfos[]>
Inherited from GrpcPublicProvider.getSlotTransfers
- Defined in provider/grpcProvider/grpcPublicProvider.ts:448

getStakers

getStakers(minRolls?, maxRolls?, limit?): Promise<StakerEntry[]>
Retrieves a list of stakers with optional filtering by rolls
Parameters
- Optional minRolls: number
- Optional maxRolls: number
- Optional limit: number
Returns Promise<StakerEntry[]>
Inherited from GrpcPublicProvider.getStakers
- Defined in provider/grpcProvider/grpcPublicProvider.ts:863

getStorageKeys

getStorageKeys(address, filter?, final?): Promise<Uint8Array[]>
Retrieves storage keys for a smart contract with optional filtering and pagination
Parameters
- address: string
- Optional filter: string | Uint8Array
- Optional final: boolean
Returns Promise<Uint8Array[]>
Implementation of Provider.getStorageKeys
Inherited from GrpcPublicProvider.getStorageKeys
- Defined in provider/grpcProvider/grpcPublicProvider.ts:495

getTransactionsThroughput

getTransactionsThroughput(): Promise<number>
Retrieves the current transaction throughput of the network

Returns Promise<number>
Inherited from GrpcPublicProvider.getTransactionsThroughput
- Defined in provider/grpcProvider/grpcPublicProvider.ts:604

networkInfos

networkInfos(): Promise<Network>
Returns Promise<Network>
Implementation of Provider.networkInfos
Inherited from GrpcPublicProvider.networkInfos
- Defined in provider/grpcProvider/grpcPublicProvider.ts:801

newBlockStream

newBlockStream(addresses?, blockIds?, slotRange?): ClientReadableStream<NewBlocksServerResponse>
Streams new blocks
Parameters
- Optional addresses: string[]
  Optional list of addresses to filter by
- Optional blockIds: string[]
  Optional list of block IDs to filter by
- Optional slotRange: SlotRange
  Optional slot range to filter by
Returns ClientReadableStream<NewBlocksServerResponse>
A stream of new blocks
Inherited from GrpcPublicProvider.newBlockStream
- Defined in provider/grpcProvider/grpcPublicProvider.ts:252

newEndorsementsStream

newEndorsementsStream(addresses?, endorsementIds?, blockIds?): ClientReadableStream<NewEndorsementsServerResponse>
Streams new endorsements
Parameters
- Optional addresses: string[]
  Optional list of addresses to filter by
- Optional endorsementIds: string[]
  Optional list of endorsement IDs to filter by
- Optional blockIds: string[]
  Optional list of block IDs to filter by
Returns ClientReadableStream<NewEndorsementsServerResponse>
A stream of new endorsements
Inherited from GrpcPublicProvider.newEndorsementsStream
- Defined in provider/grpcProvider/grpcPublicProvider.ts:215

newFilledBlocksStream

newFilledBlocksStream(addresses?, blockIds?, slotRange?): ClientReadableStream<NewFilledBlocksServerResponse>
Streams new filled blocks
Parameters
- Optional addresses: string[]
  Optional list of addresses to filter by
- Optional blockIds: string[]
  Optional list of block IDs to filter by
- Optional slotRange: SlotRange
  Optional slot range to filter by
Returns ClientReadableStream<NewFilledBlocksServerResponse>
A stream of new filled blocks
Inherited from GrpcPublicProvider.newFilledBlocksStream
- Defined in provider/grpcProvider/grpcPublicProvider.ts:180

newOperationsStream

newOperationsStream(addresses?, operationIds?, types?): ClientReadableStream<NewOperationsServerResponse>
Streams new operations
Parameters
- Optional addresses: string[]
  Optional list of addresses to filter by
- Optional operationIds: string[]
  Optional list of operation IDs to filter by
- Optional types: OpType[]
  Optional list of operation types to filter by
Returns ClientReadableStream<NewOperationsServerResponse>
A stream of new operations
Inherited from GrpcPublicProvider.newOperationsStream
- Defined in provider/grpcProvider/grpcPublicProvider.ts:287

newSlotExecutionOutputsStream

newSlotExecutionOutputsStream(filters): ClientReadableStream<NewSlotExecutionOutputsServerResponse>
Streams new slot execution outputs
Parameters
- filters: SlotExecutionOutputFilter
  The filters to apply to the stream
Returns ClientReadableStream<NewSlotExecutionOutputsServerResponse>
A stream of new slot execution outputs
Inherited from GrpcPublicProvider.newSlotExecutionOutputsStream
- Defined in provider/grpcProvider/grpcPublicProvider.ts:126

queryState

queryState(queries): Promise<QueryStateResponse>
Executes a state query on the blockchain
Parameters
- queries: ExecutionQueryRequestItem[]
Returns Promise<QueryStateResponse>
Inherited from GrpcPublicProvider.queryState
- Defined in provider/grpcProvider/grpcPublicProvider.ts:320

readSC

readSC(params): Promise<ReadSCData>
Executes a read-only smart contract call
Parameters
- params: ReadSCParams
Returns Promise<ReadSCData>
Implementation of Provider.readSC
Overrides GrpcPublicProvider.readSC
- Defined in provider/grpcProvider/grpcProvider.ts:81

readStorage

readStorage(address, keys, final?): Promise<(null | Uint8Array)[]>
Reads storage values for specified keys in a smart contract
Parameters
- address: string
- keys: string[] | Uint8Array[]
- final: boolean = true
Returns Promise<(null | Uint8Array)[]>
Implementation of Provider.readStorage
Inherited from GrpcPublicProvider.readStorage
- Defined in provider/grpcProvider/grpcPublicProvider.ts:570

searchBlocks

searchBlocks(blockIds?, addresses?, slotRange?): Promise<BlockInfo[]>
Searches for blocks based on various criteria
Parameters
- Optional blockIds: string[]
- Optional addresses: string[]
- Optional slotRange: SlotRange
Returns Promise<BlockInfo[]>
Inherited from GrpcPublicProvider.searchBlocks
- Defined in provider/grpcProvider/grpcPublicProvider.ts:681

searchEndorsements

searchEndorsements(endorsementIds?, addresses?, blockIds?): Promise<EndorsementInfo[]>
Searches for endorsements based on various criteria
Parameters
- Optional endorsementIds: string[]
- Optional addresses: string[]
- Optional blockIds: string[]
Returns Promise<EndorsementInfo[]>
Inherited from GrpcPublicProvider.searchEndorsements
- Defined in provider/grpcProvider/grpcPublicProvider.ts:462

searchOperations

searchOperations(operationIds?, addresses?): Promise<OperationInfo[]>
Searches for operations based on IDs or addresses
Parameters
- Optional operationIds: string[]
- Optional addresses: string[]
Returns Promise<OperationInfo[]>
Inherited from GrpcPublicProvider.searchOperations
- Defined in provider/grpcProvider/grpcPublicProvider.ts:396

sellRolls

sellRolls(): Promise<Operation>
Returns Promise<Operation>
Deprecated
This method cannot be implemented in the GRPC provider. Use another provider or alternative method for selling rolls.
Implementation of Provider.sellRolls
- Defined in provider/grpcProvider/grpcProvider.ts:117

sign

sign(): Promise<SignedData>
Returns Promise<SignedData>
Deprecated
This method cannot be implemented in the GRPC provider. Use another provider or alternative method for signing data.
Implementation of Provider.sign
- Defined in provider/grpcProvider/grpcProvider.ts:99

transfer

transfer(): Promise<Operation>
Returns Promise<Operation>
Deprecated
This method cannot be implemented in the GRPC provider. Use another provider or alternative method for transferring assets.
Implementation of Provider.transfer
- Defined in provider/grpcProvider/grpcProvider.ts:126

`Static` buildnet

buildnet(account): GrpcProvider
Parameters
- account: Account
Returns GrpcProvider
- Defined in provider/grpcProvider/grpcProvider.ts:39
buildnet(): GrpcPublicProvider
Returns GrpcPublicProvider
- Defined in provider/grpcProvider/grpcProvider.ts:40

`Static` fromGrpcUrl

fromGrpcUrl(url, account): GrpcProvider
Parameters
- url: string
- account: Account
Returns GrpcProvider
Overrides GrpcPublicProvider.fromGrpcUrl
- Defined in provider/grpcProvider/grpcProvider.ts:47
fromGrpcUrl(url): GrpcPublicProvider
Parameters
- url: string
Returns GrpcPublicProvider
Overrides GrpcPublicProvider.fromGrpcUrl
- Defined in provider/grpcProvider/grpcProvider.ts:48

`Static` mainnet

mainnet(account): GrpcProvider
Parameters
- account: Account
Returns GrpcProvider
- Defined in provider/grpcProvider/grpcProvider.ts:31
mainnet(): GrpcPublicProvider
Returns GrpcPublicProvider
- Defined in provider/grpcProvider/grpcProvider.ts:32

Class GrpcProvider

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GrpcProvider

Properties

client

url

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

Returns Promise<Operation>

Deprecated

callSC

Returns Promise<Operation>

Deprecated

deploySC

Returns Promise<SmartContract>

Deprecated

executeSC

Returns Promise<Operation>

Deprecated

executeSCReadOnly

Parameters

Returns Promise<ExecuteSCReadOnlyResult>

getBlocks

Parameters

Returns Promise<BlockWrapper[]>

getEndorsements

Parameters

Returns Promise<EndorsementWrapper[]>

getEvents

Parameters

Returns Promise<OutputEvents>

getNextBlockBestParent

Returns Promise<BlockParent[]>

getNodeStatus

Returns Promise<NodeStatusInfo>

getOperationABICallStacks

Parameters

Returns Promise<ABICallStack[]>

getOperationStatus

Parameters

Returns Promise<OperationStatus>

getOperations

Parameters

Returns Promise<OperationWrapper[]>

getSelectorDraws

Parameters

Returns Promise<SlotDraw[]>

getSlotABICallStacks

Parameters

Returns Promise<SlotABICallStacks[]>

getSlotTransfers

Parameters

Returns Promise<TransferInfos[]>

getStakers

Parameters

Returns Promise<StakerEntry[]>

getStorageKeys

Parameters

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

`Static` buildnet

`Static` fromGrpcUrl

`Static` mainnet