fix: switch json.stringify function (#931)

* fix: switch json.stringify function * fix: solved WS issue
vechain · May 31, 2024 · 021a5c9 · 021a5c9 · github-actions · May 31, 2024
1 parent effc6d2
commit 021a5c9
Show file tree

Hide file tree

Showing 51 changed files with 322 additions and 200 deletions.
diff --git a/apps/sdk-hardhat-integration/scripts/deploy.ts b/apps/sdk-hardhat-integration/scripts/deploy.ts
@@ -1,4 +1,5 @@
 import { ethers } from 'hardhat';
+import { stringifyData } from '@vechain/sdk-errors';
 
 async function main(): Promise<void> {
     const signer = (await ethers.getSigners())[0];
@@ -12,7 +13,7 @@ async function main(): Promise<void> {
 
     console.log(
         'Contract deployment with the following transaction:',
-        JSON.stringify(txResponse)
+        stringifyData(txResponse)
     );
 }
 

diff --git a/apps/sdk-hardhat-integration/scripts/temp_test_ethers.ts b/apps/sdk-hardhat-integration/scripts/temp_test_ethers.ts
diff --git a/docs/contracts.md b/docs/contracts.md
@@ -38,7 +38,7 @@ After deploying a smart contract, interacting with its functions is the next ste
 
 ```typescript { name=contract-function-call, category=example }
 // 1 - Init a simple contract ABI
-const contractABI = JSON.stringify([
+const contractABI = stringifyData([
     {
         constant: false,
         inputs: [

diff --git a/docs/encoding.md b/docs/encoding.md
@@ -53,7 +53,7 @@ The contract interface is used to provide a higher level of abstraction to allow
 ```typescript { name=contract, category=example }
 // 1 - Create a new function
 
-const contractABI = JSON.stringify([
+const contractABI = stringifyData([
     {
         constant: false,
         inputs: [

diff --git a/docs/examples/contracts/contract-function-call.ts b/docs/examples/contracts/contract-function-call.ts
@@ -1,10 +1,11 @@
 import { clauseBuilder, coder, type FunctionFragment } from '@vechain/sdk-core';
 import { expect } from 'expect';
+import { stringifyData } from '@vechain/sdk-errors';
 
 // START_SNIPPET: ContractFunctionCallSnippet
 
 // 1 - Init a simple contract ABI
-const contractABI = JSON.stringify([
+const contractABI = stringifyData([
     {
         constant: false,
         inputs: [

diff --git a/docs/examples/encoding/contract.ts b/docs/examples/encoding/contract.ts
@@ -1,11 +1,12 @@
 import { coder } from '@vechain/sdk-core';
 import { expect } from 'expect';
+import { stringifyData } from '@vechain/sdk-errors';
 
 // START_SNIPPET: ContractSnippet
 
 // 1 - Create a new function
 
-const contractABI = JSON.stringify([
+const contractABI = stringifyData([
     {
         constant: false,
         inputs: [

diff --git a/docs/examples/encoding/rlp.ts b/docs/examples/encoding/rlp.ts
@@ -1,5 +1,6 @@
 import { RLP_CODER } from '@vechain/sdk-core';
 import { expect } from 'expect';
+import { stringifyData } from '@vechain/sdk-errors';
 
 // START_SNIPPET: RlpSnippet
 
@@ -35,4 +36,4 @@ const obj = rlp.decodeObject(data);
 expect(data.toString('hex')).toBe(
     'd7947567d83b7b8d80addcb281a71d54fc7b3364ffed0a80'
 );
-expect(JSON.stringify(obj)).toBe(JSON.stringify(clause));
+expect(stringifyData(obj)).toBe(stringifyData(clause));
diff --git a/docs/examples/evm-extension/evm-extension.ts b/docs/examples/evm-extension/evm-extension.ts
@@ -1,9 +1,10 @@
-import { FunctionFragment, coder } from '@vechain/sdk-core';
-import { ThorClient } from '@vechain/sdk-network'
+import { coder, type FunctionFragment } from '@vechain/sdk-core';
+import { ThorClient } from '@vechain/sdk-network';
 import { expect } from 'expect';
+import { stringifyData } from '@vechain/sdk-errors';
 
 // ABI of the `TestingContract` smart contract
-const TESTING_CONTRACT_ABI = JSON.stringify([
+const TESTING_CONTRACT_ABI = stringifyData([
     {
         inputs: [
             {
@@ -794,4 +795,4 @@ const totalSupply = await thorSoloClient.contracts.executeCall(
 // END_SNIPPET: EVMExtensionSnippet
 
 // Check the result
-expect(totalSupply).toStrictEqual([10000000000000000000000000000n]);
+expect(totalSupply).toStrictEqual([10000000000000000000000000000n]);
diff --git a/docs/examples/transactions/simulation.ts b/docs/examples/transactions/simulation.ts
@@ -1,6 +1,7 @@
 import { expect } from 'expect';
 import { ThorClient } from '@vechain/sdk-network';
 import { clauseBuilder, unitsUtils } from '@vechain/sdk-core';
+import { stringifyData } from '@vechain/sdk-errors';
 
 // START_SNIPPET: SimulationSnippet
 
@@ -107,4 +108,4 @@ const expected2 = [
 ];
 
 // 3 - Check the result
-expect(JSON.stringify(simulatedTx2)).toStrictEqual(JSON.stringify(expected2));
+expect(stringifyData(simulatedTx2)).toStrictEqual(stringifyData(expected2));
diff --git a/packages/core/src/contract/coder.ts b/packages/core/src/contract/coder.ts
@@ -1,5 +1,10 @@
 import { Interface as EthersInterface, type InterfaceAbi } from 'ethers';
-import { ABI, buildError, ERROR_CODES } from '@vechain/sdk-errors';
+import {
+    ABI,
+    buildError,
+    ERROR_CODES,
+    stringifyData
+} from '@vechain/sdk-errors';
 import type { BytesLike, Interface, Log, Result } from '../abi';
 import { abi } from '../abi';
 
@@ -36,7 +41,7 @@ function encodeFunctionInput(
             ERROR_CODES.ABI.INVALID_DATA_TO_ENCODE,
             `Method 'encodeFunctionInput' failed while encoding input for function '${functionName}'. ` +
                 `Input must match ABI specifications and be correctly formatted.\n` +
-                `Parameters: ${JSON.stringify(functionData)}.\n` +
+                `Parameters: ${stringifyData(functionData)}.\n` +
                 `Ethers' error message: ${(e as Error).message}.`,
             { functionName, functionData },
             e

diff --git a/packages/core/src/keystore/cryptography/ethers/keystore.ts b/packages/core/src/keystore/cryptography/ethers/keystore.ts
@@ -3,7 +3,12 @@
  */
 import { ethers } from 'ethers';
 import { type Keystore, type KeystoreAccount } from '../../types';
-import { assert, buildError, KEYSTORE } from '@vechain/sdk-errors';
+import {
+    assert,
+    buildError,
+    KEYSTORE,
+    stringifyData
+} from '@vechain/sdk-errors';
 import { secp256k1 } from '../../../secp256k1';
 import { addressUtils } from '../../../address';
 import { Hex0x } from '../../../utils';
@@ -76,7 +81,7 @@ async function decrypt(
 
     try {
         return (await ethers.decryptKeystoreJson(
-            JSON.stringify(keystore),
+            stringifyData(keystore),
             password
         )) as KeystoreAccount;
     } catch (e) {
@@ -100,7 +105,7 @@ async function decrypt(
  * @returns A boolean indicating whether the keystore is valid or not.
  */
 function isValid(keystore: Keystore): boolean {
-    return ethers.isKeystoreJson(JSON.stringify(keystore));
+    return ethers.isKeystoreJson(stringifyData(keystore));
 }
 
 /**

diff --git a/packages/core/src/keystore/cryptography/experimental/keystore.ts b/packages/core/src/keystore/cryptography/experimental/keystore.ts
@@ -4,7 +4,7 @@
  * encryption, decryption, and validation functionality.
  */
 import * as utils from '@noble/curves/abstract/utils';
-import { assert, KEYSTORE } from '@vechain/sdk-errors';
+import { assert, KEYSTORE, stringifyData } from '@vechain/sdk-errors';
 import { ctr } from '@noble/ciphers/aes';
 import { scrypt } from '@noble/hashes/scrypt';
 import { type Keystore, type KeystoreAccount } from '../../types';
@@ -550,7 +550,7 @@ function decryptKeystore(
  */
 function isValid(keystore: Keystore): boolean {
     try {
-        const copy = JSON.parse(JSON.stringify(keystore)) as Keystore;
+        const copy = JSON.parse(stringifyData(keystore)) as Keystore;
         if (
             copy.crypto.cipher.toLowerCase() === KEYSTORE_CRYPTO_CIPHER &&
             copy.crypto.kdf.toLowerCase() === KEYSTORE_CRYPTO_KDF &&

diff --git a/packages/core/src/utils/const/abi.ts b/packages/core/src/utils/const/abi.ts
@@ -1,9 +1,11 @@
+import { stringifyData } from '@vechain/sdk-errors';
+
 /**
  * ABI of the Params built-in contract.
  *
  * @link see [params.sol](https://docs.vechain.org/developer-resources/built-in-contracts#params-sol)
  */
-const PARAMS_ABI = JSON.stringify([
+const PARAMS_ABI = stringifyData([
     {
         constant: false,
         inputs: [
@@ -79,7 +81,7 @@ const PARAMS_ABI = JSON.stringify([
  *
  * @see [VIP 180](https://github.com/vechain/VIPs/blob/master/vips/VIP-180.md)
  */
-const VIP180_ABI = JSON.stringify([
+const VIP180_ABI = stringifyData([
     {
         constant: true,
         inputs: [],
@@ -338,7 +340,7 @@ const VIP180_ABI = JSON.stringify([
     }
 ]);
 
-const ERC721_ABI = JSON.stringify([
+const ERC721_ABI = stringifyData([
     {
         inputs: [],
         stateMutability: 'nonpayable',

diff --git a/packages/core/tests/abi/abi.unit.test.ts b/packages/core/tests/abi/abi.unit.test.ts
@@ -16,7 +16,8 @@ import {
     InvalidAbiDataToEncodeError,
     InvalidAbiEventError,
     InvalidAbiFormatTypeError,
-    InvalidAbiFunctionError
+    InvalidAbiFunctionError,
+    stringifyData
 } from '@vechain/sdk-errors';
 
 /**
@@ -432,7 +433,7 @@ describe('Abi - Function & Event', () => {
         topicsEventTestCases.forEach(
             ({ event, valuesToEncode, expectedTopics }) => {
                 test(`Encode Event topics - ${
-                    typeof event === 'string' ? event : JSON.stringify(event)
+                    typeof event === 'string' ? event : stringifyData(event)
                 }`, () => {
                     const ev = new abi.Event(event);
 
@@ -448,7 +449,7 @@ describe('Abi - Function & Event', () => {
          */
         invalidTopicsEventTestCases.forEach(
             ({ event, valuesToEncode, expectedError }) => {
-                test(`Encode Event topics - ${JSON.stringify(event)}`, () => {
+                test(`Encode Event topics - ${stringifyData(event)}`, () => {
                     const ev = new abi.Event(event);
 
                     expect(() =>

diff --git a/packages/core/tests/abi/fixture.ts b/packages/core/tests/abi/fixture.ts
@@ -1,6 +1,9 @@
 import { addressUtils, Hex0x } from '../../src';
 import { generateRandomValidAddress } from '../fixture';
-import { InvalidAbiDataToEncodeError } from '@vechain/sdk-errors';
+import {
+    InvalidAbiDataToEncodeError,
+    stringifyData
+} from '@vechain/sdk-errors';
 
 /**
  * Simple functions fixtures
@@ -438,7 +441,7 @@ const encodedDecodedInvalidValues = [
     }
 ];
 
-const contractABI = JSON.stringify([
+const contractABI = stringifyData([
     {
         constant: false,
         inputs: [
@@ -469,7 +472,7 @@ const contractABI = JSON.stringify([
     }
 ]);
 
-const contractABIWithEvents = JSON.stringify([
+const contractABIWithEvents = stringifyData([
     {
         constant: false,
         inputs: [
@@ -517,7 +520,7 @@ const contractABIWithEvents = JSON.stringify([
     }
 ]);
 
-const contractStorageABI = JSON.stringify([
+const contractStorageABI = stringifyData([
     {
         inputs: [],
         name: 'getValue',

diff --git a/packages/core/tests/bloom/bloom.unit.test.ts b/packages/core/tests/bloom/bloom.unit.test.ts
@@ -2,7 +2,11 @@ import * as utils from '@noble/curves/abstract/utils';
 import { describe, expect, test } from '@jest/globals';
 import { bloom, Hex } from '../../src';
 import { bloomKTestCases } from './fixture';
-import { InvalidBloomError, InvalidKError } from '../../../errors';
+import {
+    InvalidBloomError,
+    InvalidKError,
+    stringifyData
+} from '../../../errors';
 
 /**
  * Bloom filter tests
@@ -286,8 +290,8 @@ describe('Bloom Filter', () => {
         expect(filter.bits.byteLength).toBe(25);
         expect(filter.k).toBe(k);
 
-        expect(JSON.stringify(filter.bits)).toBe(
-            JSON.stringify(
+        expect(stringifyData(filter.bits)).toBe(
+            stringifyData(
                 utils.hexToBytes(
                     'a4d641159d68d829345f86f40d50676cf042f6265072075a94'
                 )

diff --git a/packages/core/tests/keystore/keystore.unit.test.ts b/packages/core/tests/keystore/keystore.unit.test.ts
@@ -10,7 +10,8 @@ import { encryptionPassword } from './fixture';
 import {
     InvalidKeystoreError,
     InvalidKeystorePasswordError,
-    InvalidSecp256k1PrivateKeyError
+    InvalidSecp256k1PrivateKeyError,
+    stringifyData
 } from '@vechain/sdk-errors';
 
 /**
@@ -125,7 +126,7 @@ import {
             );
 
             // Verify keystore -> False
-            const invalidKeystore: string = JSON.stringify({
+            const invalidKeystore: string = stringifyData({
                 ...myKeystore,
                 version: 4
             });
@@ -157,7 +158,7 @@ import {
             expect(keystore.isValid(myKeystore)).toBe(true);
 
             // Verify keystore -> False
-            const invalidKeystore: string = JSON.stringify({
+            const invalidKeystore: string = stringifyData({
                 ...myKeystore,
                 version: 4
             });
Title	Tests	Time
core	484	1m 5s ⏱️
network	660	3m 50s ⏱️
errors	48	11.279s ⏱️