@vechain/sdk-provider

Welcome to the provider package of the vechain SDK!

Introduction

The vechain SDK Provider: Enabling Ethers.js Integration

The vechain SDK Provider is a sophisticated tool designed to facilitate developers' interactions with the VechainThor blockchain through the utilization of standard ethers.js constructs. This package serves as an advanced wrapper built atop the vechain SDK Network package. It is meticulously crafted to extend and complement the already comprehensive features set provided for decentralized application (dApp) development on the VechainThor blockchain.

At its core, the vechain SDK Provider primarily focuses on offering seamless integration of the signer and provider constructs, which are fundamental components of the ethers.js library. This integration is carefully adapted to align with the unique architecture and functionalities of the vechain SDK, thereby ensuring a fluid and intuitive development experience.

Key Features

Explore the rich feature set of the vechain SDK Network package, tailored for VechainThor blockchain and dApp development:

• Blocks and Node Status: Interact with and retrieve information about blocks on the VechainThor blockchain. Vechain SDK Network allows developers to access block data and query the status of connected veChain nodes.
• Accounts: Facilitate interactions with Externally Owned Accounts (EOAs), empowering developers to manage and transact with individual user accounts on the VechainThor blockchain. This includes sending VET tokens and interacting with VTHO (VeThor) tokens.
• Smart Contracts: With vechain SDK Network, seamlessly interact with and manage smart contracts deployed on the VechainThor blockchain. Deploy contracts, invoke functions, and retrieve contract data effortlessly.
• Transactions: Initiate various transactions on the VechainThor blockchain using vechain SDK Network. Developers can create and broadcast transactions, including token transfers, contract interactions, and asset management.
• Certificates: Manage certificates and certificate-related operations on the blockchain with vechain SDK Network. Certificates play a crucial role in identity verification and access control within dApps.
• Queries: Efficiently retrieve specific data from the blockchain using vechain SDK Network's querying system. This includes querying transaction details, contract state, and other relevant blockchain information for streamlined dApp development.

Vechain SDK Network is your all-in-one solution for seamlessly integrating with the VechainThor blockchain, providing a reliable and feature-rich experience for dApp developers. Dive into the world of vechain SDK Network and elevate your decentralized applications with ease.

Commands

• Build: Execute yarn build to build the package.
• Lint: Execute yarn lint to lint the package.
• Format: Execute yarn format to format the package.
• Test:unit: Execute yarn test:unit to run unit tests.
• Test:integration: Execute yarn test:integration to run integration tests.
• Test: Execute yarn test to run all tests on the package.
  • NOTE: Tests and Integration tests require thor-solo to be running locally. You can run and stop separately thor solo node with yarn start-thor-solo and yarn stop-thor-solo or run all tests with yarn test:solo which will start thor solo node, run all tests and stop thor solo at the end. Same for integration tests. You can directly run yarn test:integration:solo to run integration tests with thor solo.

Usage

Explore examples of how to use this package in real-world scenarios at vechain SDK examples.

Feel free to leverage these resources and don't hesitate to reach out if you have any questions or need further assistance.

Happy coding with the vechain SDK!