feat: Hardhat compatibility (Part 1 - Provider interface)

.github/workflows/on-pr.yml

@@ -23,7 +23,6 @@ jobs:
                 yarn build
             - name: Test docs examples
               run: |
-                cd docs
                 yarn test:examples
 
     install-build:

package.json

@@ -9,11 +9,13 @@
         "postinstall": "husky install",
         "build": "turbo build",
         "lint": "turbo lint",
-        "test": "turbo test --force && yarn merge-coverage",
+        "start-thor-solo": "echo 'Starting thor solo node ...\n' && docker compose up -d --wait && echo '\nThor solo node started'",
+        "stop-thor-solo": "docker compose down && echo '\nThor solo node stopped'",
+        "test": "(yarn start-thor-solo && turbo test --force && yarn merge-coverage) && (yarn stop-thor-solo) || (yarn stop-thor-solo)",
         "test:unit": "turbo test:unit",
-        "test:integration": "turbo test:integration",
+        "test:integration": "(yarn start-thor-solo && turbo test:integration) && (yarn stop-thor-solo) || (yarn stop-thor-solo)",
         "format": "turbo format",
-        "test:examples": "turbo test:examples",
+        "test:examples": "(yarn start-thor-solo && turbo test:examples) && (yarn stop-thor-solo) || (yarn stop-thor-solo)",
         "merge-coverage": "ts-node scripts/merge-coverage.ts",
         "generate:apidocs": "typedoc --options typedoc.json --logLevel Error",
         "generate:apidocs-debug": "typedoc --options typedoc.json --logLevel Verbose --plugin typedoc-plugin-missing-exports --validation.notDocumented"

packages/core/src/core.ts

@@ -1,3 +1,6 @@
+import { ethers } from 'ethers';
+
+// Our core library
 export * from './abi';
 export * from './address';
 export * from './bloom';
@@ -13,3 +16,6 @@ export * from './transaction';
 export * from './utils';
 export * from './bloom';
 export * from './certificate';
+
+// Other libraries
+export { ethers as vechain_sdk_core_ethers };

packages/core/src/utils/units/units.ts

@@ -52,7 +52,7 @@ const formatUnits = (
 /**
  * Parses a string number to a string with 18 decimals.
  *
- * VET is the native token of the VeChainThor blockchain.
+ * VET is the native token of the VechainThor blockchain.
  * It has 18 decimals.
  *
  * This method can parse any numeric string with 18 decimals (e.g., VTHO balance too).
@@ -69,7 +69,7 @@ const parseVET = (value: string): bigint => {
 /**
  * Converts a value into a decimal string assuming 18 decimals.
  *
- * VET is the native token of the VeChainThor blockchain.
+ * VET is the native token of the VechainThor blockchain.
  * It has 18 decimals.
  *
  * This method can format any numeric value with 18 decimals (e.g., VTHO balance too).

packages/errors/src/model/generic/function.ts

@@ -0,0 +1,19 @@
+import { type DefaultErrorData } from '../../types';
+import { ErrorBase } from '../base';
+
+/**
+ * Not implemented function
+ */
+class NotImplementedError extends ErrorBase<
+    FUNCTION.NOT_IMPLEMENTED,
+    DefaultErrorData
+> {}
+
+/**
+ * Errors enum.
+ */
+enum FUNCTION {
+    NOT_IMPLEMENTED = 'NOT_IMPLEMENTED'
+}
+
+export { NotImplementedError, FUNCTION };

packages/errors/src/model/generic/index.ts

@@ -0,0 +1 @@
+export * from './function';

packages/errors/src/model/index.ts

@@ -1,3 +1,4 @@
 export * from './base';
 export * from './core';
 export * from './network';
+export * from './generic';

packages/errors/src/types/errorTypes.ts

@@ -46,7 +46,9 @@ import {
     TransactionAlreadySignedError,
     TransactionBodyError,
     TransactionDelegationError,
-    TransactionNotSignedError
+    TransactionNotSignedError,
+    FUNCTION,
+    NotImplementedError
 } from '../model';
 
 /**
@@ -75,7 +77,8 @@ type ErrorCode =
     | DATA
     | TRANSACTION
     | HTTP_CLIENT
-    | POLL_ERROR;
+    | POLL_ERROR
+    | FUNCTION;
 
 /**
  * Conditional type to get the error data type from the error code.
@@ -106,7 +109,8 @@ const ERROR_CODES = {
     DATA,
     TRANSACTION,
     HTTP_CLIENT,
-    POLL_ERROR
+    POLL_ERROR,
+    FUNCTION
 };
 
 /**
@@ -182,7 +186,9 @@ type ErrorType<ErrorCodeT> =
                                                                     ? HTTPClientError
                                                                     : ErrorCodeT extends POLL_ERROR.POLL_EXECUTION_ERROR
                                                                       ? PollExecutionError
-                                                                      : never;
+                                                                      : ErrorCodeT extends FUNCTION.NOT_IMPLEMENTED
+                                                                        ? NotImplementedError
+                                                                        : never;
 
 /**
  * Map to get the error class from the error code.
@@ -236,7 +242,8 @@ const ErrorClassMap = new Map<
     [TRANSACTION.INVALID_TRANSACTION_BODY, TransactionBodyError],
     [TRANSACTION.INVALID_DELEGATION, TransactionDelegationError],
     [HTTP_CLIENT.INVALID_HTTP_REQUEST, HTTPClientError],
-    [POLL_ERROR.POLL_EXECUTION_ERROR, PollExecutionError]
+    [POLL_ERROR.POLL_EXECUTION_ERROR, PollExecutionError],
+    [FUNCTION.NOT_IMPLEMENTED, NotImplementedError]
 ]);
 
 export {

packages/ethers-adapter/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+    "extends": ["../../.eslintrc.json"]
+}

packages/ethers-adapter/Readme.md

@@ -0,0 +1,40 @@
+# @vechainfoundation/vechain-sdk-network
+
+Welcome to the **ethers-adapter package** of the vechain SDK!
+
+## Introduction
+The vechain SDK Ethers-Adapter: Enabling Ethers.js Integration
+
+The vechain SDK Ethers-Adapter 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 Ethers-Adapter 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.
+
+## Usage
+
+Explore examples of how to use this package in real-world scenarios at [vechain SDK examples](https://github.com/vechainfoundation/vechain-sdk/tree/main/docs/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!

packages/ethers-adapter/jest.config.js

@@ -0,0 +1,8 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    coverageReporters: ['html', 'lcov', 'json'],
+    runner: 'groups',
+    reporters: ['default', 'jest-junit']
+};

packages/ethers-adapter/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "@vechainfoundation/vechain-sdk-ethers-adapter",
+    "version": "1.0.0",
+    "private": false,
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "license": "MIT",
+    "scripts": {
+        "build": "rm -rf ./dist && tsup src/index.ts --format cjs,esm --dts",
+        "lint": "eslint --ext .ts src --ext .ts tests",
+        "test:unit": "rm -rf ./coverageUnit && jest --coverage --coverageDirectory=coverageUnit --group=unit",
+        "test:integration": "export JEST_INTEGRATION=true; rm -rf ./coverageIntegration && jest --coverage --coverageDirectory=coverageIntegration --group=integration",
+        "test": "export JEST_INTEGRATION=true; rm -rf ./coverage && jest --coverage --coverageDirectory=coverage --group=integration --group=unit",
+        "format": "prettier --write src/**/*.ts tests/**/*.ts"
+    },
+    "dependencies": {
+        "@vechainfoundation/vechain-sdk-errors": "*",
+        "@vechainfoundation/vechain-sdk-core": "*",
+        "@vechainfoundation/vechain-sdk-network": "*"
+    }
+}

packages/ethers-adapter/src/ethers-adapter.ts

@@ -0,0 +1 @@
+export * from './providers';

packages/ethers-adapter/src/index.ts

@@ -0,0 +1,5 @@
+import * as ethersAdapter from './ethers-adapter';
+
+export { ethersAdapter };
+
+export * from './ethers-adapter';

packages/ethers-adapter/src/providers/asbtract-provider.ts

@@ -0,0 +1,10 @@
+/**
+ * Abstract provider will implement Provider interface
+ *
+ * The abstract provider provides a base class for sub-classes to implement the Provider API.
+ *
+ * ------ TEMPORARY COMMENT ------
+ * The structure will generally abide to the the ethers abstract-provider.ts structure
+ * We need to understand if we want the plugins feature too
+ * ------------------------------
+ */

packages/ethers-adapter/src/providers/index.ts

@@ -0,0 +1,3 @@
+// export * from './asbtract-provider'
+// export * from './jsonrpc-provider'
+export * from './types.d';

packages/ethers-adapter/src/providers/jsonrpc-provider.ts

@@ -0,0 +1,7 @@
+/**
+ * ------- TEMPORARY COMMENT -------
+ * We can then decide to extend our abstract provider to allow json rpc calls
+ *
+ * This way also a json rpc wrapper (https://github.com/vechain/thorify) can be included in the sdk
+ * ------------------------------
+ */