Main v2 update (#270)

* feat: add core * feat: new dependencies * feat: address utils * feat: certificate * feat: version 12 of beta * feat: implement sdk core in certificate-wallet.ts and wallet-manager.ts * feat: version 12 of sdk core * 266 use sdk instead of thor devkit (#267) * feat: working tests * feat: remove thor-devkit * fix: e2e tests * fix: tests * Refactor inputs (#268) * fix: refactor inputs * fix: improve inputs * Sonar integration (#254) * Create sonar-scan.yml * Create sonar-project.properties * remove test branch from workflow --------- Co-authored-by: Fabio Rigamonti <[email protected]> * fix: packages --------- Co-authored-by: Davide Carpini <[email protected]> Co-authored-by: Fabio Rigamonti <[email protected]> Co-authored-by: WaqarAhmedVC <[email protected]>
vechain · Aug 19, 2024 · 7d5ac85 · 7d5ac85
1 parent 5b81864
commit 7d5ac85
Show file tree

Hide file tree

Showing 33 changed files with 4,995 additions and 4,798 deletions.
diff --git a/.github/workflows/sonar-scan.yml b/.github/workflows/sonar-scan.yml
@@ -0,0 +1,27 @@
+name: PR Sonar Scan
+
+on:
+    push:
+        branches:
+          - main
+    pull_request:
+
+jobs:
+  sonar-scan:
+    name: Sonar Scan
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: SonarCloud Scan
+        uses: sonarsource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          args: >
+            -Dsonar.verbose=false
+            -Dsonar.branch.name=${{ github.head_ref || github.ref_name }}
diff --git a/examples/sample-angular-app/src/app/app-routing.module.ts b/examples/sample-angular-app/src/app/app-routing.module.ts
@@ -1,7 +1,6 @@
 // Angular modules
 import { NgModule } from '@angular/core';
-import { Routes } from '@angular/router';
-import { RouterModule } from '@angular/router';
+import { type Routes, RouterModule } from '@angular/router';
 
 const routes: Routes = [];
 

diff --git a/examples/sample-angular-app/src/app/app.module.ts b/examples/sample-angular-app/src/app/app.module.ts
@@ -1,20 +1,15 @@
 // Angular modules
-import { HttpClient } from '@angular/common/http';
-import { HttpClientModule } from '@angular/common/http';
+import { HttpClient, HttpClientModule } from '@angular/common/http';
 import { NgModule } from '@angular/core';
 import { BrowserModule } from '@angular/platform-browser';
 import { DatePipe } from '@angular/common';
 import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
-
 // External modules
-import { TranslateModule } from '@ngx-translate/core';
-import { TranslateLoader } from '@ngx-translate/core';
+import { TranslateModule, TranslateLoader } from '@ngx-translate/core';
 import { TranslateHttpLoader } from '@ngx-translate/http-loader';
 import { AngularSvgIconModule } from 'angular-svg-icon';
-
 // Internal modules
 import { AppRoutingModule } from './app-routing.module';
-
 // Components
 import { AppComponent } from './app.component';
 

diff --git a/examples/sample-react-app/vite.config.ts b/examples/sample-react-app/vite.config.ts
@@ -26,7 +26,7 @@ export default defineConfig(({ mode }) => {
         //vitest
         test: {
             globals: true,
-            environment: 'jsdom',
+            environment: 'happy-dom',
             setupFiles: [
                 resolve(__dirname, 'test/setup/setup.ts'),
                 resolve(__dirname, 'test/setup/resizeObserverMock.ts'),

diff --git a/packages/dapp-kit-react/package.json b/packages/dapp-kit-react/package.json
@@ -29,15 +29,15 @@
         "@vechain/connex-framework": "2.1.0",
         "@vechain/dapp-kit": "*",
         "@vechain/dapp-kit-ui": "*",
-        "thor-devkit": "2.0.5",
+        "@vechain/sdk-core": "1.0.0-beta.24",
         "valtio": "1.11.2"
     },
     "devDependencies": {
         "@testing-library/react": "^14.1.2",
         "@types/react": "^18.2.28",
         "@types/react-dom": "^18.2.13",
         "@vechain/repo-config": "https://github.com/vechain/repo-config#v0.0.1",
-        "eslint": "*",
+        "eslint": "^8.15.0",
         "react": "^18.2.0",
         "tsup": "*",
         "typescript": "*",

diff --git a/packages/dapp-kit-react/src/DAppKitProvider.tsx b/packages/dapp-kit-react/src/DAppKitProvider.tsx
@@ -10,7 +10,7 @@ import type { WalletSource } from '@vechain/dapp-kit';
 import { DAppKitUI } from '@vechain/dapp-kit-ui';
 import { subscribeKey } from 'valtio/vanilla/utils';
 import type { DAppKitProviderOptions, DAppKitContext } from './types';
-import * as ThorDevkit from 'thor-devkit';
+import { type Certificate } from '@vechain/sdk-core';
 
 /**
  * Context
@@ -74,9 +74,7 @@ export const DAppKitProvider: React.FC<DAppKitProviderOptions> = ({
         connex.wallet.state.source,
     );
     const [connectionCertificate, setConnectionCertificate] =
-        useState<ThorDevkit.Certificate | null>(
-            connex.wallet.state.connectionCertificate,
-        );
+        useState<Certificate | null>(connex.wallet.state.connectionCertificate);
 
     useEffect(() => {
         const addressSub = subscribeKey(connex.wallet.state, 'address', (v) => {

diff --git a/packages/dapp-kit-react/src/types.ts b/packages/dapp-kit-react/src/types.ts
@@ -1,8 +1,9 @@
 /// <reference types="@vechain/connex" />
 import type React from 'react';
-import * as ThorDevkit from 'thor-devkit';
 import type { ConnectResponse, WalletSource } from '@vechain/dapp-kit';
 import { type DAppKitUIOptions } from '@vechain/dapp-kit-ui';
+import { type Certificate } from '@vechain/sdk-core';
+
 export type { WalletConnectOptions, DAppKitOptions } from '@vechain/dapp-kit';
 export type { DAppKitUIOptions } from '@vechain/dapp-kit-ui';
 
@@ -37,7 +38,7 @@ export interface DAppKitContext {
         connect: () => Promise<ConnectResponse>;
         account: string | null;
         source: WalletSource | null;
-        connectionCertificate: ThorDevkit.Certificate | null;
+        connectionCertificate: Certificate | null;
     };
     modal: {
         open: () => void;

diff --git a/packages/dapp-kit-react/test/helpers/mocked-signer.ts b/packages/dapp-kit-react/test/helpers/mocked-signer.ts
@@ -1,23 +1,31 @@
 /// <reference types="@vechain/connex" />
-import { blake2b256, Certificate, HDNode, secp256k1 } from 'thor-devkit';
+import {
+    addressUtils,
+    blake2b256,
+    Certificate,
+    HDNode,
+    secp256k1,
+    certificate,
+    Hex0x,
+} from '@vechain/sdk-core';
 
 const mnemonicWords =
     'denial kitchen pet squirrel other broom bar gas better priority spoil cross';
 
 const hdNode = HDNode.fromMnemonic(mnemonicWords.split(' '));
 
-const firstAccount = hdNode.derive(0);
+const firstAccount = hdNode.deriveChild(0);
 
-const privateKey: Buffer = firstAccount.privateKey!;
-const address = firstAccount.address;
+const privateKey = firstAccount.privateKey!;
+const address = addressUtils.fromPrivateKey(privateKey);
 
 const mockedConnexSigner: Connex.Signer = {
     signTx() {
         return Promise.resolve({ txid: '0x1234', signer: address });
     },
 
     signCert(msg) {
-        const certificate: Certificate = {
+        const newCertificate: Certificate = {
             domain: ' localhost:3000',
             timestamp: 12341234,
             signer: address,
@@ -26,17 +34,17 @@ const mockedConnexSigner: Connex.Signer = {
         };
 
         const signature = secp256k1.sign(
-            blake2b256(Certificate.encode(certificate)),
+            blake2b256(certificate.encode(newCertificate)),
             privateKey,
         );
 
         return Promise.resolve({
             annex: {
-                domain: certificate.domain,
-                timestamp: certificate.timestamp,
-                signer: certificate.signer,
+                domain: newCertificate.domain,
+                timestamp: newCertificate.timestamp,
+                signer: newCertificate.signer,
             },
-            signature: `0x${signature.toString('hex')}`,
+            signature: Hex0x.of(signature),
         });
     },
 };

diff --git a/packages/dapp-kit-react/test/useWallet.test.tsx b/packages/dapp-kit-react/test/useWallet.test.tsx
@@ -55,7 +55,7 @@ describe('useWallet', () => {
         await waitFor(() => {
             expect(result.current.source).toBe('sync2');
             expect(result.current.account).toBe(
-                '0xf077b491b355e64048ce21e3a6fc4751eeea77fa',
+                '0xf077b491b355E64048cE21E3A6Fc4751eEeA77fa',
             );
         });
 

diff --git a/packages/dapp-kit-react/vite.config.ts b/packages/dapp-kit-react/vite.config.ts
@@ -5,7 +5,7 @@ import { defineConfig } from 'vitest/config';
 export default defineConfig({
     test: {
         include: ['test/**/*.test.ts', 'test/**/*.test.tsx'],
-        environment: 'jsdom',
+        environment: 'happy-dom',
         reporters: 'dot',
         setupFiles: [resolve(__dirname, 'test/setup/setup.ts')],
         coverage: {

diff --git a/packages/dapp-kit-ui/src/components/buttons/button.ts b/packages/dapp-kit-ui/src/components/buttons/button.ts
@@ -76,22 +76,20 @@ export class Button extends LitElement {
     mobile = false;
 
     override render(): TemplateResult {
-        return html`
-            ${this.address
-                ? html`<vdk-address-button
-                      .mode=${this.mode}
-                      .address=${this.address}
-                      .disabled=${this.disabled}
-                      .mobile=${this.mobile}
-                  ></vdk-address-button>`
-                : html`<vdk-connect-button
-                      .mode=${this.mode}
-                      .i18n=${this.i18n}
-                      .language=${this.language}
-                      .disabled=${this.disabled}
-                      .mobile=${this.mobile}
-                  ></vdk-connect-button>`}
-        `;
+        return this.address
+            ? html`<vdk-address-button
+                  .mode=${this.mode}
+                  .address=${this.address}
+                  .disabled=${this.disabled}
+                  .mobile=${this.mobile}
+              ></vdk-address-button>`
+            : html`<vdk-connect-button
+                  .mode=${this.mode}
+                  .i18n=${this.i18n}
+                  .language=${this.language}
+                  .disabled=${this.disabled}
+                  .mobile=${this.mobile}
+              ></vdk-connect-button>`;
     }
 }
 

diff --git a/packages/dapp-kit-ui/vite.config.ts b/packages/dapp-kit-ui/vite.config.ts
@@ -6,7 +6,7 @@ import { resolve } from 'node:path'; // eslint-disable-next-line import/no-defau
 export default defineConfig({
     test: {
         include: ['test/**/*.test.ts'],
-        environment: 'jsdom',
+        environment: 'happy-dom',
         reporters: 'dot',
         setupFiles: [resolve(__dirname, 'test/setup/setup.ts')],
         coverage: {

diff --git a/packages/dapp-kit/package.json b/packages/dapp-kit/package.json
@@ -27,11 +27,11 @@
         "@vechain/connex-driver": "2.1.0",
         "@vechain/connex-framework": "2.1.0",
         "@vechain/connex-types": "^2.1.0",
+        "@vechain/sdk-core": "1.0.0-beta.24",
         "@walletconnect/modal": "2.6.2",
         "@walletconnect/sign-client": "2.10.2",
         "@walletconnect/utils": "2.10.2",
         "events": "^3.3.0",
-        "thor-devkit": "2.0.5",
         "valtio": "1.11.2"
     },
     "devDependencies": {
@@ -40,8 +40,8 @@
         "@vechain/repo-config": "https://github.com/vechain/repo-config#v0.0.1",
         "@vitest/coverage-v8": "^0.34.6",
         "@walletconnect/types": "2.10.2",
-        "eslint": "*",
-        "happy-dom": "^12.10.3",
+        "eslint": "^8.15.0",
+        "happy-dom": "^14.12.3",
         "lokijs": "^1.5.12",
         "tsup": "*",
         "typescript": "*",

diff --git a/packages/dapp-kit/src/classes/certificate-wallet.ts b/packages/dapp-kit/src/classes/certificate-wallet.ts
@@ -1,4 +1,4 @@
-import * as ThorDevkit from 'thor-devkit';
+import { certificate } from '@vechain/sdk-core';
 import type { BaseWallet, ConnectResponse, ConnexWallet } from '../types';
 import { DEFAULT_CONNECT_CERT_MESSAGE } from '../constants';
 
@@ -34,7 +34,7 @@ class CertificateBasedWallet implements ConnexWallet {
         };
 
         try {
-            ThorDevkit.Certificate.verify(connectionCertificate);
+            certificate.verify(connectionCertificate);
 
             return {
                 account: signer,

diff --git a/packages/dapp-kit/src/classes/wallet-manager.ts b/packages/dapp-kit/src/classes/wallet-manager.ts
@@ -1,14 +1,14 @@
-import * as ThorDevkit from 'thor-devkit';
 import { proxy, subscribe } from 'valtio/vanilla';
 import { subscribeKey } from 'valtio/vanilla/utils';
+import { certificate } from '@vechain/sdk-core';
 import type {
     ConnectResponse,
     ConnexWallet,
     DAppKitOptions,
     WalletManagerState,
     WalletSource,
 } from '../types';
-import { DAppKitLogger, Storage, createWallet } from '../utils';
+import { createWallet, DAppKitLogger, Storage } from '../utils';
 import { DEFAULT_CONNECT_CERT_MESSAGE, WalletSources } from '../constants';
 
 class WalletManager {
@@ -89,7 +89,7 @@ class WalletManager {
         };
 
         try {
-            ThorDevkit.Certificate.verify(connectionCertificate);
+            certificate.verify(connectionCertificate);
             this.state.address = signer;
             this.state.connectionCertificate = connectionCertificate;
             return {

diff --git a/packages/dapp-kit/src/dapp-kit.ts b/packages/dapp-kit/src/dapp-kit.ts
@@ -3,23 +3,40 @@ import {
     SimpleNet,
 } from '@vechain/connex-driver/dist/index.js';
 import { Framework } from '@vechain/connex-framework';
-import * as ThorDevkit from 'thor-devkit';
+import { blake2b256, Hex } from '@vechain/sdk-core';
 import { WalletManager } from './classes';
 import { DAppKitLogger, normalizeGenesisBlock } from './utils';
 import type { DAppKitOptions } from './types';
 
 const cache: Record<string, DriverNoVendor | undefined> = {};
 
+/**
+ * START: TEMPORARY COMMENT
+ * For hashing we will improve SDK conversion and encoding later
+ * END: TEMPORARY COMMENT
+ *
+ * Create a new Thor driver
+ *
+ * @param node - The node URL
+ * @param genesis - The genesis block
+ */
 const createThorDriver = (
     node: string,
     genesis: Connex.Thor.Block,
 ): DriverNoVendor => {
-    const key = ThorDevkit.blake2b256(
-        JSON.stringify({
-            node,
-            genesis,
-        }),
-    ).toString('hex');
+    // Stringify the certificate to hash
+    const certificateToHash = JSON.stringify({
+        node,
+        genesis,
+    });
+
+    // Encode the certificate to hash
+    const encodedCertificateToHash = new TextEncoder().encode(
+        certificateToHash.normalize(),
+    );
+
+    // Get the key (the hash of the certificate) without 0x prefix
+    const key: string = Hex.canon(blake2b256(encodedCertificateToHash, 'hex'));
 
     let driver = cache[key];
     if (!driver) {

diff --git a/packages/dapp-kit/src/types/types.d.ts b/packages/dapp-kit/src/types/types.d.ts
@@ -1,6 +1,6 @@
-import * as ThorDevkit from 'thor-devkit';
 import type { WalletConnectOptions } from '@vechain/dapp-kit';
-import type { LogLevel } from '../utils/logger';
+import { type Certificate } from '@vechain/sdk-core';
+import type { LogLevel } from '../utils';
 
 declare global {
     interface Window {
@@ -58,14 +58,14 @@ type ConnexWallet = BaseWallet & {
 interface ConnectResponse {
     account: string;
     verified: boolean;
-    connectionCertificate?: ThorDevkit.Certificate;
+    connectionCertificate?: Certificate;
 }
 
 interface WalletManagerState {
     source: WalletSource | null;
     address: string | null;
     availableSources: WalletSource[];
-    connectionCertificate: ThorDevkit.Certificate | null;
+    connectionCertificate: Certificate | null;
 }
 
 export type {

diff --git a/packages/dapp-kit/src/utils/create-wc-client.ts b/packages/dapp-kit/src/utils/create-wc-client.ts
@@ -3,7 +3,7 @@ import type {
     ResolvedSignClient,
     WalletConnectOptions,
     WCClient,
-} from '../types/wc-types';
+} from '../types';
 
 const _cachedClients: Record<string, WCClient | undefined> = {};