Skip to content

Commit 8efc144

Browse files
authored
SDK naming standard (#904)
* fix: rename VeChainThor * fix: rename vechain * fix: refactor * fix: refactor code * fix: fix space issue * fix: fix space issue
1 parent a3ffeea commit 8efc144

File tree

156 files changed

+710
-710
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

156 files changed

+710
-710
lines changed

.changeset/funny-masks-cheat.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
"@vechain/sdk-rpc-proxy": patch
99
---
1010

11-
First BETA release of the vechain SDK! :D
11+
First BETA release of the VeChain SDK! :D

.github/CODE_OF_CONDUCT.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Vechain SDK Code of Conduct
1+
#VeChain SDK Code of Conduct
22

33
## 1. Introduction
44

5-
The vechain SDK community is dedicated to providing a welcoming, inclusive, and harassment-free environment for everyone, regardless of age, gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, nationality, religion, or technical experience. This Code of Conduct outlines our expectations for all members of the vechain SDK community, as well as the consequences for unacceptable behavior.
5+
The VeChain SDK community is dedicated to providing a welcoming, inclusive, and harassment-free environment for everyone, regardless of age, gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, nationality, religion, or technical experience. This Code of Conduct outlines our expectations for all members of the VeChain SDK community, as well as the consequences for unacceptable behavior.
66

7-
We invite all those who participate in vechain SDK to help us create a safe and positive environment for everyone.
7+
We invite all those who participate in VeChain SDK to help us create a safe and positive environment for everyone.
88

99
## 2. Expected Behavior
1010

.github/CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Vechain SDK Contributing
1+
#VeChain SDK Contributing
22

33
## Introduction
44

5-
Thank you for considering contributing to the vechain SDK project.
6-
This SDK is an important part of the vechain ecosystem, and your contributions are greatly appreciated.
5+
Thank you for considering contributing to the VeChain SDK project.
6+
This SDK is an important part of the VeChain ecosystem, and your contributions are greatly appreciated.
77
This document outlines the process and guidelines for contributing.
88

99
## Getting Started
@@ -125,7 +125,7 @@ public static parseInteger(s: string): number {
125125
```
126126
## Tests
127127

128-
Testing is a crucial aspect of maintaining a high-quality codebase in the vechain SDK project. Tests not only validate the correctness of the code but also ensure that future changes do not inadvertently introduce bugs or regressions. It is imperative that all new features and bug fixes are accompanied by corresponding tests to verify their functionality. Additionally, existing code should have adequate test coverage to maintain its stability over time. We aim for 100% test coverage to guarantee the reliability of the SDK.
128+
Testing is a crucial aspect of maintaining a high-quality codebase in the VeChain SDK project. Tests not only validate the correctness of the code but also ensure that future changes do not inadvertently introduce bugs or regressions. It is imperative that all new features and bug fixes are accompanied by corresponding tests to verify their functionality. Additionally, existing code should have adequate test coverage to maintain its stability over time. We aim for 100% test coverage to guarantee the reliability of the SDK.
129129

130130
### Test Group Tagging
131131

@@ -224,7 +224,7 @@ All submissions, including submissions by project members, require a review. We
224224

225225
## Code of Conduct
226226

227-
We are committed to providing a welcoming and inclusive environment for everyone who contributes to or interacts with the vechain SDK project. To ensure a positive experience for our community, we have established a [Code of Conduct](CODE_OF_CONDUCT.md) that outlines our expectations for behavior. We encourage all contributors, maintainers, and users to familiarize themselves with this code, as it reflects our commitment to creating a diverse and respectful community. Thank you for helping us maintain a welcoming and collaborative space for all.
227+
We are committed to providing a welcoming and inclusive environment for everyone who contributes to or interacts with the VeChain SDK project. To ensure a positive experience for our community, we have established a [Code of Conduct](CODE_OF_CONDUCT.md) that outlines our expectations for behavior. We encourage all contributors, maintainers, and users to familiarize themselves with this code, as it reflects our commitment to creating a diverse and respectful community. Thank you for helping us maintain a welcoming and collaborative space for all.
228228

229229
## Thank You
230230

.github/ISSUE_TEMPLATE/config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Discord
44
url: https://discord.gg/vechain
5-
about: Join our Discord community to connect with other vechain enthusiasts, ask questions, and find answers.
5+
about: Join our Discord community to connect with other VeChain enthusiasts, ask questions, and find answers.
66
- name: Telegram
77
url: https://t.me/VeChainDevCommunity
8-
about: Join our Telegram community to connect with other vechain developers, ask questions, and find answers.
8+
about: Join our Telegram community to connect with other VeChain developers, ask questions, and find answers.

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,22 @@
1515

1616
## Introduction
1717

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! 🌌🔮
1919

2020
## Repository Structure
2121

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:
2323

2424
- `./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.
2525
- `./packages`: A hub for our monorepo packages, each serving a distinct purpose:
2626
- `./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.
2727
- `./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.
3131
- `./packages/rpc-proxy`: This package is designed to bridge the gap between Thor's RESTful API and Ethereum's JSON-RPC.
3232

33-
Explore, experiment, and let the vechain SDK empowers your blockchain adventures!
33+
Explore, experiment, and let the VeChain SDK empowers your blockchain adventures!
3434

3535
## SDK Development
3636

@@ -254,7 +254,7 @@ This project is licensed under the [MIT license](./.github/LICENSE.md).
254254

255255
## Publishing
256256

257-
The vechain SDK uses `Changesets CLI`. To publish a new release:
257+
The VeChain SDK uses `Changesets CLI`. To publish a new release:
258258
``` bash
259259
yarn pre-release X.Y.Z
260260
yarn changeset publish

apps/sdk-hardhat-integration/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Sample Hardhat project
22

3-
This is a sample project that showcases the usage of the vechain SDK Hardhat plugin, specifically the hardhat-plugin package, with illustrative examples.
3+
This is a sample project that showcases the usage of the VeChain SDK Hardhat plugin, specifically the hardhat-plugin package, with illustrative examples.
44

55
## Introduction
66

7-
The hardhat-plugin package serves as a crucial link between Hardhat and the vechain SDK, simplifying the process of creating, testing, and interacting with smart contracts on the VeChainThor blockchain network. Developers can utilize the functionalities provided by this plugin to seamlessly integrate vechain's blockchain infrastructure into their Hardhat projects.
7+
The hardhat-plugin package serves as a crucial link between Hardhat and the VeChain SDK, simplifying the process of creating, testing, and interacting with smart contracts on the VeChainThor blockchain network. Developers can utilize the functionalities provided by this plugin to seamlessly integrate vechain's blockchain infrastructure into their Hardhat projects.
88

99
## Commands
1010

1111
- **Install dependencies**: Execute `yarn install` to install the required dependencies.
1212
- **Compile**: Execute `yarn compile` to compile the smart contracts in the `contracts` folder.
1313
- **Testing**: Execute `yarn test` to test the smart contracts running the tests located on the `test` folder.
14-
- **Deploy**: Execute `yarn deploy-solo` to deploy the smart contracts on the solo network, and `yarn deploy-testnet` to deploy on the vechain testnet.
14+
- **Deploy**: Execute `yarn deploy-solo` to deploy the smart contracts on the solo network, and `yarn deploy-testnet` to deploy on the VeChain testnet.
1515

1616
## Usage
1717

apps/sdk-hardhat-integration/hardhat.config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { type HttpNetworkConfig } from 'hardhat/types';
88
/**
99
* Main hardhat configuration
1010
*
11-
* Here we have custom vechain networks: 'vechain_mainnet', 'vechain_testnet' and 'vechain_solo'
11+
* Here we have custom VeChain networks: 'vechain_mainnet', 'vechain_testnet' and 'vechain_solo'
1212
*
1313
* They have custom parameters:
1414
* - debug: whether to enable debug mode

apps/sdk-nextjs-integration/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sdk-nextjs-integration
22

3-
This is a simple web application built with React and the vechain SDK that allows users to view transaction history associated with a specific address on the vechain blockchain.
3+
This is a simple web application built with React and the VeChain SDK that allows users to view transaction history associated with a specific address on the VeChain blockchain.
44

55
## Getting Started
66

@@ -27,6 +27,6 @@ You can start editing the page by modifying `app/page.tsx`. The page auto-update
2727

2828
## Usage
2929

30-
- Enter the vechain address you want to retrieve transaction history for in the input field.
30+
- Enter the VeChain address you want to retrieve transaction history for in the input field.
3131
- The application will fetch and display the transaction history associated with the provided address.
3232
- Scroll horizontally to view all columns in the transaction history table.

apps/sdk-nextjs-integration/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vechain-sdk-nextjs",
3-
"description": "A Next.js sample app using the vechain SDK",
3+
"description": "A Next.js sample app using the VeChain SDK",
44
"version": "1.0.0-beta.5",
55
"private": true,
66
"scripts": {

apps/sdk-nextjs-integration/src/app/page.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
} from '@vechain/sdk-network';
99
import { unitsUtils } from '@vechain/sdk-core';
1010

11-
// Url of the vechain mainnet
11+
// Url of the VeChain mainnet
1212
const mainnetUrl = 'https://mainnet.vechain.org';
1313

1414
// Thor client

apps/sdk-node-integration/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# sdk-node-integration: vechain Transaction Logger
1+
# sdk-node-integration: VeChain Transaction Logger
22

3-
The vechain Transaction Logger is a TypeScript class that provides methods to monitor the transactions of a specific vechain account and optionally send webhook notifications when new transactions occur.
3+
The VeChain Transaction Logger is a TypeScript class that provides methods to monitor the transactions of a specific VeChain account and optionally send webhook notifications when new transactions occur.
44

55
## Features
66

7-
- Monitors transactions sent to and from a specified vechain account.
7+
- Monitors transactions sent to and from a specified VeChain account.
88
- Automatically filters out transactions that occurred before the latest timestamp.
99
- Optionally sends webhook notifications with transaction details when new transactions are detected.
1010

1111
## Usage
1212

1313
```typescript
14-
// Initialize the VeChainTransactionLogger with vechain node URL and optional webhook URL
14+
// Initialize the VeChainTransactionLogger with VeChain node URL and optional webhook URL
1515
const logger = new VeChainTransactionLogger('YOUR_VET_NODE_URL', 'YOUR_WEBHOOK_URL');
1616

1717
// Start monitoring transactions for a specific address
@@ -22,8 +22,8 @@ logger.stopLogging();
2222
```
2323
## Configuration
2424

25-
- `new VeChainTransactionLogger(url: string, webhookUrl?: string)`: Constructor to initialize the logger. Requires the URL of the vechain node. Optionally accepts the URL of the webhook endpoint.
26-
- `startLogging(address: string)`: Method to start monitoring transactions for the specified vechain account address.
25+
- `new VeChainTransactionLogger(url: string, webhookUrl?: string)`: Constructor to initialize the logger. Requires the URL of the VeChain node. Optionally accepts the URL of the webhook endpoint.
26+
- `startLogging(address: string)`: Method to start monitoring transactions for the specified VeChain account address.
2727
- `stopLogging()`: Method to stop monitoring transactions.
2828

2929
Webhook notifications: The logger can send webhook notifications with transaction details if a webhook URL is provided.

apps/sdk-node-integration/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sdk-user",
3-
"description": "A node sample app using the vechain SDK",
3+
"description": "A node sample app using the VeChain SDK",
44
"version": "1.0.0-beta.5",
55
"main": "dist/index.js",
66
"types": "src/index.ts",

docs/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Vechain SDK
1+
#VeChain SDK
22

3-
Welcome to the official documentation for the JavaScript vechain SDK!
3+
Welcome to the official documentation for the JavaScriptVeChain SDK!
44

5-
This SDK provides developers with tools and resources to integrate vechain blockchain functionality into their applications with ease. Whether you're building decentralized applications (dApps), managing digital assets, or exploring blockchain-based solutions, this SDK offers a comprehensive set of features to interact with the VeChainThor blockchain.
5+
This SDK provides developers with tools and resources to integrate VeChain blockchain functionality into their applications with ease. Whether you're building decentralized applications (dApps), managing digital assets, or exploring blockchain-based solutions, this SDK offers a comprehensive set of features to interact with the VeChainThor blockchain.
66

77
## Installation
88

9-
To start using the vechain SDK, you can install specific packages based on your needs. The SDK is a monorepo that includes various packages. Here are the packages available:
9+
To start using the VeChain SDK, you can install specific packages based on your needs. The SDK is a monorepo that includes various packages. Here are the packages available:
1010
- [@vechain/sdk-core](https://www.npmjs.com/package/@vechain/sdk-core)
1111
- [@vechain/sdk-network](https://www.npmjs.com/package/@vechain/sdk-network)
1212
- [@vechain/sdk-errors](https://www.npmjs.com/package/@vechain/sdk-errors)
@@ -29,8 +29,8 @@ yarn add @vechain/sdk-network
2929

3030
## Contributing
3131

32-
We welcome contributions from the community to improve the vechain SDK. If you want to contribute, please review our Contribution Guidelines for more information.
32+
We welcome contributions from the community to improve the VeChain SDK. If you want to contribute, please review our Contribution Guidelines for more information.
3333

3434
## License
3535

36-
The vechain SDK is licensed under the MIT License, which allows for both personal and commercial use.
36+
The VeChain SDK is licensed under the MIT License, which allows for both personal and commercial use.

docs/accounts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ for (let i = 0; i < 5; i++) {
119119

120120
On the other hand, Keystore is employed for encrypting private keys in accordance with the Ethereum standard. By using Keystore, the private keys can be securely encrypted to prevent unauthorized access or exposure.
121121

122-
Through the use of mnemonics and keystore, vechain SDK ensures secure and user-friendly account handling. Mnemonics allow for easy generation of private keys, while keystore provides an additional layer of protection by encrypting the private keys in a standardized manner as per Ethereum's security practices. These functionalities collectively contribute to a robust and secure approach to managing accounts within the Thor ecosystem.
122+
Through the use of mnemonics and keystore, VeChainSDK ensures secure and user-friendly account handling. Mnemonics allow for easy generation of private keys, while keystore provides an additional layer of protection by encrypting the private keys in a standardized manner as per Ethereum's security practices. These functionalities collectively contribute to a robust and secure approach to managing accounts within the Thor ecosystem.
123123

124124
```typescript { name=keystore, category=example }
125125
// 1 - Create private key using Secp256k1

docs/architecture.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Architecture
22

3-
The chapter is designed to provide a high-level understanding of the vechain SDK architecture and structure.
3+
The chapter is designed to provide a high-level understanding of the VeChain SDK architecture and structure.
44
Comprehensive diagrams, following the C4 model, are available for reference in the project's [GitHub repository](https://github.com/vechain/vechain-sdk-js/tree/main/docs/diagrams/architecture).
55

66
## Introduction
@@ -31,11 +31,11 @@ The network package is the network interaction responsible package of the vechai
3131
It is responsible for all interactions with the blockchain.
3232

3333
### Hardhat Plugin Package
34-
Seamlessly integrate the vechain SDK with Hardhat, the Ethereum development environment.
35-
This plugin provides a bridge between the vechain SDK and the Ethereum ecosystem, enabling you to leverage the best of both worlds.
34+
Seamlessly integrate the VeChain SDK with Hardhat, the Ethereum development environment.
35+
This plugin provides a bridge between the VeChain SDK and the Ethereum ecosystem, enabling you to leverage the best of both worlds.
3636

3737
### Logging Package
38-
The logging package provides a simple and easy-to-use logging system for the vechain SDK.
38+
The logging package provides a simple and easy-to-use logging system for the VeChain SDK.
3939
This module is dedicated to managing and customizing logs within the SDK, ensuring your development experience remains transparent and insightful.
4040

4141
### Provider Package

0 commit comments

Comments
 (0)