provider.md

Provider

Overview

The VeChain Provider is a powerful tool designed to interact with the VeChain blockchain seamlessly. This documentation outlines the features, usage, and configuration of the VeChain Provider and its companion, the Hardhat Provider.

VeChain Provider

The VeChain Provider is our core provider, offering direct interaction with the VeChain blockchain. It extends EventEmitter and implements EIP1193ProviderMessage for efficient event handling and message passing.

Features

• Seamless interaction with the VeChain blockchain.
• Event handling capabilities using EventEmitter.
• Implementation of EIP1193ProviderMessage for standardized message communication.

Usage

To use the VeChain Provider in your project, follow these steps:

• Import the provider in your code:

  import { VeChainProvider } from '@vechain/sdk-network';

• Initialize the provider:

  const provider = new VeChainProvider(thorClient, wallet);

• Start interacting with the VeChain blockchain using the available methods provided by the VeChainProvider.

Example:

// 1 - Create thor client for testnet
const thorClient = ThorClient.at(TESTNET_URL);

// 2 - Init provider
const provider = new VeChainProvider(thorClient);

// 3 - Call RPC function
const rpcCallChainId = await provider.request({
    method: 'eth_chainId'
});

HardHat Provider

The Hardhat Provider is a wrapper around the core VeChain Provider specifically designed for Hardhat integration. It simplifies the process of using the VeChain Provider within a Hardhat environment.

Features

• Wrapper around the core VeChain Provider.
• Simplified integration with Hardhat projects.

Usage

To use the Hardhat Provider in your project, follow these steps:

• Import the provider in your code:

  import { HardhatVeChainProvider } from '@vechain/sdk-network';

• Initialize the provider:

  const provider = new HardhatVeChainProvider(
          new ProviderInternalBaseWallet([]),
          testnetUrl,
          (message: string, parent?: Error) => new Error(message, parent)
      );

• Start interacting with the VeChain blockchain using the available methods provided by the HardhatVeChainProvider.

Example:

// 1 - Init provider
const provider = new HardhatVeChainProvider(
    new ProviderInternalBaseWallet([]),
    TESTNET_URL,
    (message: string, parent?: Error) => new Error(message, parent)
);

// 2 - Call RPC function
const rpcCallChainId = await provider.request({
    method: 'eth_chainId'
});