|
15 | 15 |
|
16 | 16 | ## Introduction
|
17 | 17 |
|
18 |
| -🚀 Welcome to the **vechain SDK**, your passport to the dazzling universe of decentralized wonders on the vechain blockchain. Brace yourself for a coding adventure like no other! Whether you're a blockchain bard or a coding wizard, our SDK is your key to unlocking the mysteries of secure and seamless blockchain development. Join us in this epic journey, where lines of code transform into spells of innovation, and every commit propels you deeper into the enchanted realms of VechainThor. Ready to embark on a coding odyssey? Let the vechain SDK be your guide! 🌌🔮 |
| 18 | +🚀 Welcome to the **vechain SDK**, your passport to the dazzling universe of decentralized wonders on the VeChain blockchain. Brace yourself for a coding adventure like no other! Whether you're a blockchain bard or a coding wizard, our SDK is your key to unlocking the mysteries of secure and seamless blockchain development. Join us in this epic journey, where lines of code transform into spells of innovation, and every commit propels you deeper into the enchanted realms of VeChainThor. Ready to embark on a coding odyssey? Let the VeChain SDK be your guide! 🌌🔮 |
19 | 19 |
|
20 | 20 | ## Repository Structure
|
21 | 21 |
|
22 |
| -Welcome to the vechain SDK repository! Here's a breakdown of our organized structure: |
| 22 | +Welcome to the VeChain SDK repository! Here's a breakdown of our organized structure: |
23 | 23 |
|
24 | 24 | - `./docs`: Your go-to destination for comprehensive documentation. Explore demonstrative examples showcasing the prowess of our SDK. Knowledge is power, and our docs are here to enlighten your path.
|
25 | 25 | - `./packages`: A hub for our monorepo packages, each serving a distinct purpose:
|
26 | 26 | - `./packages/core`: The heart of the SDK, housing essential modules for fundamental operations like hashing and cryptography. Dive into the core for the building blocks of your decentralized dreams.
|
27 | 27 | - `./packages/errors`: Delve into the world of error handling with the error package. This module is dedicated to managing and customizing errors within the SDK, ensuring your development experience remains resilient and smooth.
|
28 |
| - - `./packages/hardhat-plugin`: Seamlessly integrate the vechain SDK with Hardhat, the Ethereum development environment. This plugin provides a bridge between the vechain SDK and the Ethereum ecosystem, enabling you to leverage the best of both worlds. |
29 |
| - - `./packages/logging`: The logging package provides a simple and easy-to-use logging system for the vechain SDK. This module is dedicated to managing and customizing logs within the SDK, ensuring your development experience remains transparent and insightful. |
30 |
| - - `./packages/network`: Embark on a journey through the network module, your gateway to all things related to blockchain interaction and transaction dissemination. Here, the vechain SDK connects you seamlessly to the VechainThor blockchain. |
| 28 | + - `./packages/hardhat-plugin`: Seamlessly integrate the VeChain SDK with Hardhat, the Ethereum development environment. This plugin provides a bridge between the VeChain SDK and the Ethereum ecosystem, enabling you to leverage the best of both worlds. |
| 29 | + - `./packages/logging`: The logging package provides a simple and easy-to-use logging system for the VeChain SDK. This module is dedicated to managing and customizing logs within the SDK, ensuring your development experience remains transparent and insightful. |
| 30 | + - `./packages/network`: Embark on a journey through the network module, your gateway to all things related to blockchain interaction and transaction dissemination. Here, the VeChain SDK connects you seamlessly to the VeChainThor blockchain. |
31 | 31 | - `./packages/rpc-proxy`: This package is designed to bridge the gap between Thor's RESTful API and Ethereum's JSON-RPC.
|
32 | 32 |
|
33 |
| -Explore, experiment, and let the vechain SDK empowers your blockchain adventures! |
| 33 | +Explore, experiment, and let the VeChain SDK empowers your blockchain adventures! |
34 | 34 |
|
35 | 35 | ## SDK Development
|
36 | 36 |
|
@@ -254,7 +254,7 @@ This project is licensed under the [MIT license](./.github/LICENSE.md).
|
254 | 254 |
|
255 | 255 | ## Publishing
|
256 | 256 |
|
257 |
| -The vechain SDK uses `Changesets CLI`. To publish a new release: |
| 257 | +The VeChain SDK uses `Changesets CLI`. To publish a new release: |
258 | 258 | ``` bash
|
259 | 259 | yarn pre-release X.Y.Z
|
260 | 260 | yarn changeset publish
|
|
0 commit comments