refactor: using only viem for EIP712 (#1516)

* refactor: using viem for eip721

* refactor: using viem for eip721

* refactor: using viem for eip721

* refactor: using viem for eip721

* refactor: using viem for eip721

* refactor: using viem for eip721

* refactor: using viem for eip721

* fix: new slack version

.github/workflows/unit-integration-test.yml

@@ -76,14 +76,14 @@ jobs:
               if: always()  && github.ref == 'refs/heads/main' && (steps.unit-test.outcome == 'failure')
               uses: slackapi/slack-github-action@v2.0.0
               with:
+                webhook: ${{ secrets.SLACK_WEBHOOK_URL }}
+                webhook-type: webhook-trigger
                 payload: |
                   {
                     "source": "GitHub",
                     "repo": "${{ github.repository}}",
                     "branch": "${{ github.head_ref || github.ref_name }}",
                     "message": "unit tests failed, see run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
                   }
-              env:
-                SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
               

docs/examples/transactions/full-flow-delegator-private-key.ts

@@ -12,7 +12,7 @@ import {
     THOR_SOLO_URL,
     ThorClient,
     VeChainProvider
-} from '@vechain/sdk-network'; // START_SNIPPET: FullFlowDelegatorPrivateKeySnippet
+} from '@vechain/sdk-network';
 import { expect } from 'expect';
 
 // START_SNIPPET: FullFlowDelegatorPrivateKeySnippet

docs/examples/transactions/full-flow-delegator-url.ts

@@ -12,7 +12,7 @@ import {
     TESTNET_URL,
     ThorClient,
     VeChainProvider
-} from '@vechain/sdk-network'; // START_SNIPPET: FullFlowDelegatorUrlSnippet
+} from '@vechain/sdk-network';
 import { expect } from 'expect';
 
 // START_SNIPPET: FullFlowDelegatorUrlSnippet

docs/examples/transactions/full-flow-no-delegator.ts

@@ -12,7 +12,7 @@ import {
     THOR_SOLO_URL,
     ThorClient,
     VeChainProvider
-} from '@vechain/sdk-network'; // START_SNIPPET: FullFlowNoDelegatorSnippet
+} from '@vechain/sdk-network';
 import { expect } from 'expect';
 
 // START_SNIPPET: FullFlowNoDelegatorSnippet

docs/transactions.md

@@ -370,10 +370,6 @@ In the following complete examples, we will explore the entire lifecycle of a Ve
 1. **No Delegation (Signing Only with an Origin Private Key)**: In this scenario, we'll demonstrate the basic process of creating a transaction, signing it with the origin private key, and sending it to the VeChainThor blockchain without involving fee delegation.
 
 ```typescript { name=full-flow-no-delegator, category=example }
-import { expect } from 'expect';
-
-// START_SNIPPET: FullFlowNoDelegatorSnippet
-
 // 1 - Create the thor client
 const thorSoloClient = ThorClient.at(THOR_SOLO_URL, {
     isPollingEnabled: false
@@ -456,10 +452,6 @@ const txReceipt = await thorSoloClient.transactions.waitForTransaction(
 2. **Delegation with Private Key**: Here, we'll extend the previous example by incorporating fee delegation. The transaction sender will delegate the transaction fee payment to another entity (delegator), and we'll guide you through the steps of building, signing, and sending such a transaction.
 
 ```typescript { name=full-flow-delegator-private-key, category=example }
-import { expect } from 'expect';
-
-// START_SNIPPET: FullFlowDelegatorPrivateKeySnippet
-
 // 1 - Create the thor client
 const thorSoloClient = ThorClient.at(THOR_SOLO_URL, {
     isPollingEnabled: false
@@ -561,10 +553,6 @@ const txReceipt = await thorSoloClient.transactions.waitForTransaction(
 3. **Delegation with URL**: This example will showcase the use of a delegation URL for fee delegation. The sender will specify a delegation URL in the `signTransaction` options, allowing a designated sponsor to pay the transaction fee. We'll cover the full process, from building clauses to verifying the transaction on-chain.
 
 ```typescript { name=full-flow-delegator-url, category=example }
-import { expect } from 'expect';
-
-// START_SNIPPET: FullFlowDelegatorUrlSnippet
-
 // 1 - Create the thor client
 const thorClient = ThorClient.at(TESTNET_URL, {
     isPollingEnabled: false

packages/aws-kms-adapter/package.json

@@ -44,7 +44,6 @@
     "@vechain/sdk-errors": "1.0.0-rc.2",
     "@vechain/sdk-network": "1.0.0-rc.2",
     "asn1js": "^3.0.5",
-    "ethers": "6.13.4",
-    "viem": "^2.21.19"
+    "viem": "^2.21.45"
   }
 }

packages/aws-kms-adapter/src/KMSVeChainSigner.ts

@@ -12,11 +12,12 @@ import {
 } from '@vechain/sdk-network';
 import { BitString, ObjectIdentifier, Sequence, verifySchema } from 'asn1js';
 import {
+    hashTypedData,
+    recoverPublicKey,
+    toHex,
     type TypedDataDomain,
-    TypedDataEncoder,
-    type TypedDataField
-} from 'ethers';
-import { recoverPublicKey, toHex } from 'viem';
+    type TypedDataParameter
+} from 'viem';
 import { KMSVeChainProvider } from './KMSVeChainProvider';
 
 class KMSVeChainSigner extends VeChainAbstractSigner {
@@ -388,20 +389,21 @@ class KMSVeChainSigner extends VeChainAbstractSigner {
      */
     public async signTypedData(
         domain: TypedDataDomain,
-        types: Record<string, TypedDataField[]>,
-        value: Record<string, unknown>
+        types: Record<string, TypedDataParameter[]>,
+        primaryType: string,
+        message: Record<string, unknown>
     ): Promise<string> {
         try {
             const payload = Hex.of(
-                TypedDataEncoder.hash(domain, types, value)
+                hashTypedData({ domain, types, primaryType, message })
             ).bytes;
 
             return await this.signPayload(payload);
         } catch (error) {
             throw new SignerMethodError(
                 'KMSVeChainSigner.signTypedData',
                 'The typed data could not be signed.',
-                { domain, types, value },
+                { domain, types, primaryType, message },
                 error
             );
         }

packages/aws-kms-adapter/tests/KMSVeChainSigner.solo.test.ts

@@ -299,6 +299,7 @@ describe('KMSVeChainSigner - Thor Solo', () => {
             const signature = await signer.signTypedData(
                 typedData.domain,
                 typedData.types,
+                typedData.primaryType,
                 typedData.data
             );
             expect(signature).toBeDefined();

packages/aws-kms-adapter/tests/KMSVeChainSigner.unit.test.ts

@@ -5,7 +5,7 @@ import {
     type ThorClient,
     type TransactionRequestInput
 } from '@vechain/sdk-network';
-import { type TypedDataDomain, type TypedDataField } from 'ethers';
+import { type TypedDataDomain, type TypedDataParameter } from 'viem';
 import { KMSVeChainProvider, KMSVeChainSigner } from '../src';
 import { EIP712_CONTRACT, EIP712_FROM, EIP712_TO } from './fixture';
 jest.mock('asn1js', () => ({
@@ -136,6 +136,7 @@ describe('KMSVeChainSigner', () => {
                             }
                         ]
                     },
+                    'Mail',
                     {
                         from: {
                             name: 'Cow',
@@ -159,7 +160,8 @@ describe('KMSVeChainSigner', () => {
             await expect(
                 signer.signTypedData(
                     {} as unknown as TypedDataDomain,
-                    {} as unknown as Record<string, TypedDataField[]>,
+                    {} as unknown as Record<string, TypedDataParameter[]>,
+                    'primaryType',
                     {} as unknown as Record<string, unknown>
                 )
             ).rejects.toThrow(SignerMethodError);

packages/core/package.json

@@ -49,7 +49,7 @@
     "abitype": "^1.0.6",
     "ethers": "6.13.4",
     "fast-json-stable-stringify": "^2.1.0",
-    "viem": "^2.21.19"
+    "viem": "^2.21.45"
   },
   "devDependencies": {
     "bignumber.js": "^9.1.2",

packages/network/package.json

@@ -49,7 +49,7 @@
     "abitype": "^1.0.6",
     "ethers": "6.13.4",
     "isomorphic-ws": "^5.0.0",
-    "viem": "^2.21.19",
+    "viem": "^2.21.45",
     "ws": "^8.18.0"
   },
   "devDependencies": {

packages/network/src/provider/utils/rpc-mapper/methods/eth_signTypedData_v4/eth_signTypedData_v4.ts

@@ -4,7 +4,7 @@ import {
     JSONRPCInvalidParams,
     stringifyData
 } from '@vechain/sdk-errors';
-import type { TypedDataDomain, TypedDataField } from 'ethers';
+import type { TypedDataDomain, TypedDataParameter } from 'viem';
 import type { VeChainSigner } from '../../../../../signer/signers';
 import type { ThorClient } from '../../../../../thor-client';
 import type { VeChainProvider } from '../../../../providers/vechain-provider';
@@ -61,7 +61,7 @@ const ethSignTypedDataV4 = async (
         {
             primaryType: string;
             domain: TypedDataDomain;
-            types: Record<string, TypedDataField[]>;
+            types: Record<string, TypedDataParameter[]>;
             message: Record<string, unknown>;
         }
     ];
@@ -74,6 +74,7 @@ const ethSignTypedDataV4 = async (
         return await signer.signTypedData(
             typedData.domain,
             typedData.types,
+            typedData.primaryType,
             typedData.message
         );
     } catch (error) {

packages/network/src/signer/signers/types.d.ts

@@ -4,6 +4,7 @@ import {
     type HardhatVeChainProvider,
     type VeChainProvider
 } from '../../provider';
+import { type TypedDataDomain, type TypedDataParameter } from 'viem';
 
 /**
  * Available types for the VeChainProvider's
@@ -358,9 +359,10 @@ interface VeChainSigner {
      *  Signs the [[link-eip-712]] typed data.
      */
     signTypedData: (
-        domain: vechain_sdk_core_ethers.TypedDataDomain,
-        types: Record<string, vechain_sdk_core_ethers.TypedDataField[]>,
-        value: Record<string, unknown>,
+        domain: TypedDataDomain,
+        types: Record<string, TypedDataParameter[]>,
+        primaryType: string,
+        message: Record<string, unknown>,
         options?: SignTypedDataOptions
     ) => Promise<string>;
 

packages/network/src/signer/signers/vechain-abstract-signer/vechain-abstract-signer.ts

@@ -8,7 +8,7 @@ import {
     type TransactionClause
 } from '@vechain/sdk-core';
 import { InvalidDataType, JSONRPCInvalidParams } from '@vechain/sdk-errors';
-import { type TypedDataDomain, type TypedDataField } from 'ethers';
+import { type TypedDataDomain, type TypedDataParameter } from 'viem';
 import { RPC_METHODS } from '../../../provider/utils/const/rpc-mapper/rpc-methods';
 import { type TransactionSimulationResult } from '../../../thor-client';
 import { vnsUtils } from '../../../utils';
@@ -336,15 +336,17 @@ abstract class VeChainAbstractSigner implements VeChainSigner {
      * Signs the [[link-eip-712]] typed data.
      *
      * @param {TypedDataDomain} domain - The domain parameters used for signing.
-     * @param {Record<string, TypedDataField[]>} types - The types used for signing.
-     * @param {Record<string, unknown>} value - The message data to be signed.
+     * @param {Record<string, TypedDataParameter[]>} types - The types used for signing.
+     * @param {string} primaryType - The primary type used for signing.
+     * @param {Record<string, unknown>} message - The message data to be signed.
      *
      * @return {Promise<string>} - A promise that resolves with the signature string.
      */
     abstract signTypedData(
         domain: TypedDataDomain,
-        types: Record<string, TypedDataField[]>,
-        value: Record<string, unknown>,
+        types: Record<string, TypedDataParameter[]>,
+        primaryType: string,
+        message: Record<string, unknown>,
         options?: SignTypedDataOptions
     ): Promise<string>;
 

packages/network/src/signer/signers/vechain-private-key-signer/vechain-private-key-signer.ts

@@ -15,10 +15,10 @@ import {
     stringifyData
 } from '@vechain/sdk-errors';
 import {
+    hashTypedData,
     type TypedDataDomain,
-    TypedDataEncoder,
-    type TypedDataField
-} from 'ethers';
+    type TypedDataParameter
+} from 'viem';
 import { RPC_METHODS } from '../../../provider/utils/const/rpc-mapper/rpc-methods';
 import {
     DelegationHandler,
@@ -198,20 +198,22 @@ class VeChainPrivateKeySigner extends VeChainAbstractSigner {
      * albeit Ethereum Name Services are not resolved because he resolution depends on **ethers** provider implementation.
      *
      * @param {TypedDataDomain} domain - The domain parameters used for signing.
-     * @param {Record<string, TypedDataField[]>} types - The types used for signing.
-     * @param {Record<string, unknown>} value - The value data to be signed.
+     * @param {Record<string, TypedDataParameter[]>} types - The types used for signing.
+     * @param {string} primaryType - The primary type used for signing.
+     * @param {Record<string, unknown>} message - The value data to be signed.
      *
      * @return {Promise<string>} - A promise that resolves with the signature string.
      */
     async signTypedData(
         domain: TypedDataDomain,
-        types: Record<string, TypedDataField[]>,
-        value: Record<string, unknown>
+        types: Record<string, TypedDataParameter[]>,
+        primaryType: string,
+        message: Record<string, unknown>
     ): Promise<string> {
         return await new Promise((resolve, reject) => {
             try {
                 const hash = Hex.of(
-                    TypedDataEncoder.hash(domain, types, value)
+                    hashTypedData({ domain, types, primaryType, message })
                 ).bytes;
                 const sign = Secp256k1.sign(
                     hash,

packages/network/tests/signer/signers/vechain-private-key-signer/vechain-private-key-signer.unit.test.ts

@@ -22,6 +22,7 @@ import {
     populateCallTestCases,
     populateCallTestCasesAccount
 } from './fixture';
+import { InvalidAbiEncodingTypeError } from 'viem';
 
 /**
  * VeChain base signer tests
@@ -290,9 +291,10 @@ describe('VeChain base signer tests', () => {
                 signer.signTypedData(
                     eip712TestCases.invalid.domain,
                     eip712TestCases.invalid.types,
+                    eip712TestCases.invalid.primaryType,
                     eip712TestCases.invalid.data
                 )
-            ).rejects.toThrowError(TypeError);
+            ).rejects.toThrowError(InvalidAbiEncodingTypeError);
         });
 
         test('signTypedData - exception when parsing to hex', async () => {
@@ -313,6 +315,7 @@ describe('VeChain base signer tests', () => {
                 signer.signTypedData(
                     eip712TestCases.valid.domain,
                     eip712TestCases.valid.types,
+                    eip712TestCases.valid.primaryType,
                     eip712TestCases.valid.data
                 )
             ).rejects.toThrowError(expectedErrorString);
@@ -321,6 +324,7 @@ describe('VeChain base signer tests', () => {
                 signer.signTypedData(
                     eip712TestCases.valid.domain,
                     eip712TestCases.valid.types,
+                    eip712TestCases.valid.primaryType,
                     eip712TestCases.valid.data
                 )
             ).rejects.toThrowError('Error while signing typed data');
@@ -341,6 +345,7 @@ describe('VeChain base signer tests', () => {
             ).signTypedData(
                 eip712TestCases.valid.domain,
                 eip712TestCases.valid.types,
+                eip712TestCases.valid.primaryType,
                 eip712TestCases.valid.data
             );
             expect(actual).toBe(expected);