Class HardhatVeChainProvider

This class is a wrapper for the VeChainProvider that Hardhat uses.

It exposes the interface that Hardhat expects, and uses the VeChainProvider as wrapped provider.

Hierarchy (view full)

VeChainProvider
- HardhatVeChainProvider

Index

Constructors

constructor

new HardhatVeChainProvider(walletToUse, nodeUrl, buildHardhatErrorFunctionCallback, debug?, enableDelegation?, rpcConfiguration?): HardhatVeChainProvider
Constructor with the network configuration.
Parameters
- walletToUse: ProviderInternalWallet
  The wallet to use.
- nodeUrl: string
  The node url to use
- buildHardhatErrorFunctionCallback: BuildHardhatErrorFunction
  The function to use to build Hardhat errors.
- debug: boolean = false
  Debug mode.
- enableDelegation: boolean = false
  Enable fee delegation or not.
- rpcConfiguration: {
  ethGetTransactionCountMustReturn0: boolean;
  } = ...
  - ethGetTransactionCountMustReturn0: boolean
Returns HardhatVeChainProvider
Overrides VeChainProvider.constructor
- Defined in provider/providers/hardhat-provider/hardhat-provider.ts:50

Properties

buildHardhatErrorFunctionCallback

buildHardhatErrorFunctionCallback: BuildHardhatErrorFunction

The function to use to build Hardhat errors.

debug

debug: boolean

Debug mode.

`Readonly`enableDelegation

enableDelegation: boolean = false

Enable fee delegation or not.

rpcConfiguration

rpcConfiguration: {
ethGetTransactionCountMustReturn0: boolean;
}

RPC configuration.

`Readonly`subscriptionManager

subscriptionManager: SubscriptionManager = ...

`Readonly`thorClient

thorClient: ThorClient

ThorClient instance.

`Optional` `Readonly`wallet

wallet?: ProviderInternalWallet

ProviderInternalWallet instance. It is optional because the majority of the methods do not require a wallet.

Methods

destroy

destroy(): void
Destroys the provider by closing the thorClient and stopping the provider poll instance if present. This is because thorClient and the provider might be initialized with a polling interval.

Returns void
Inherited from VeChainProvider.destroy
- Defined in provider/providers/vechain-provider/vechain-provider.ts:67

getPollInstance

getPollInstance(): EventPoll<SubscriptionEvent[]>
Returns the poll instance for subscriptions.

Returns EventPoll<SubscriptionEvent[]>
Inherited from VeChainProvider.getPollInstance
- Defined in provider/providers/vechain-provider/vechain-provider.ts:204

getSigner

getSigner(addressOrIndex?): Promise<VeChainSigner>
Get a signer into the internal wallet provider for the given address.
Parameters
- OptionaladdressOrIndex: string | number
  Address of index of the account.
Returns Promise<VeChainSigner>
The signer for the given address.
Inherited from VeChainProvider.getSigner
- Defined in provider/providers/vechain-provider/vechain-provider.ts:292

isThereActiveSubscriptions

isThereActiveSubscriptions(): boolean
Checks if there are active subscriptions. This method checks if there are any active log subscriptions or a new heads subscription.

Returns boolean
A boolean indicating whether there are active subscriptions.
Inherited from VeChainProvider.isThereActiveSubscriptions
- Defined in provider/providers/vechain-provider/vechain-provider.ts:194

lookupAddress

lookupAddress(address): Promise<string>
Use vet.domains to look up a verified primary name for an address
Parameters
- address: string
  The address to lookup
Returns Promise<string>
the primary name for an address or null
Inherited from VeChainProvider.lookupAddress
- Defined in provider/providers/vechain-provider/vechain-provider.ts:315

request

request(args): Promise<unknown>
It sends the request through the VeChainProvider.
Parameters
- args: EIP1193RequestArguments
  The request arguments.
Returns Promise<unknown>
Overrides VeChainProvider.request
- Defined in provider/providers/hardhat-provider/hardhat-provider.ts:130

resolveName

resolveName(vnsName): Promise<string>
Use vet.domains to resolve name to address
Parameters
- vnsName: string
  The name to resolve
Returns Promise<string>
the address for a name or null
Inherited from VeChainProvider.resolveName
- Defined in provider/providers/vechain-provider/vechain-provider.ts:306

send

send(method, params?): Promise<unknown>
Overload of the send method
Parameters
- method: string
  The method to call.
- Optionalparams: unknown[]
  The parameters to pass to the method.
Returns Promise<unknown>
- Defined in provider/providers/hardhat-provider/hardhat-provider.ts:85

sendAsync

sendAsync(payload, callback): Promise<void>
Overload of the sendAsync method. It is the same of the send method, but with a callback. Instead of returning the result, it calls the callback with the result.
Parameters
- payload: JsonRpcRequest
  The request payload (it contains method and params as 'send' method).
- callback: ((error: unknown, response: JsonRpcResponse) => void)
  The callback to call with the result.
  - - (error, response): void
    - Parameters
      error: unknown
      response: JsonRpcResponse
      Returns void
Returns Promise<void>
- Defined in provider/providers/hardhat-provider/hardhat-provider.ts:100

startSubscriptionsPolling

startSubscriptionsPolling(): boolean
Initializes and starts the polling mechanism for subscription events. This method sets up an event poll that periodically checks for new events related to active subscriptions, such as 'newHeads' or log subscriptions. When new data is available, it emits these events to listeners.

This method leverages the Poll.createEventPoll utility to create the polling mechanism, which is then started by invoking startListen on the poll instance.

Returns boolean
Inherited from VeChainProvider.startSubscriptionsPolling
- Defined in provider/providers/vechain-provider/vechain-provider.ts:127

stopSubscriptionsPolling

stopSubscriptionsPolling(): boolean
Stops the polling mechanism for subscription events. This method stops the polling mechanism for subscription events, if it is active.

Returns boolean
A boolean indicating whether the polling mechanism was stopped.
Inherited from VeChainProvider.stopSubscriptionsPolling
- Defined in provider/providers/vechain-provider/vechain-provider.ts:178

Class HardhatVeChainProvider

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ethGetTransactionCountMustReturn0: boolean

Returns HardhatVeChainProvider

Properties

buildHardhatErrorFunctionCallback

debug

ReadonlyenableDelegation

rpcConfiguration

ReadonlysubscriptionManager

ReadonlythorClient

Optional Readonlywallet

Methods

destroy

Returns void

getPollInstance

Returns EventPoll<SubscriptionEvent[]>

getSigner

Parameters

Returns Promise<VeChainSigner>

isThereActiveSubscriptions

Returns boolean

lookupAddress

Parameters

Returns Promise<string>

request

Parameters

Returns Promise<unknown>

resolveName

Parameters

Returns Promise<string>

send

Parameters

Returns Promise<unknown>

sendAsync

Parameters

Parameters

Returns void

Returns Promise<void>

startSubscriptionsPolling

Returns boolean

stopSubscriptionsPolling

Returns boolean

Settings

On This Page

`Readonly`enableDelegation

`Readonly`subscriptionManager

`Readonly`thorClient

`Optional` `Readonly`wallet