Merge pull request #198 from vechainfoundation/thor-client-accounts

feat(Thor Client): Accounts
vechain · Nov 7, 2023 · e3bb8bd · e3bb8bd · github-actions · Nov 7, 2023
2 parents f9944f7 + e431e7a
commit e3bb8bd
Show file tree

Hide file tree

Showing 42 changed files with 755 additions and 156 deletions.
diff --git a/docs/certificates.md b/docs/certificates.md
@@ -39,7 +39,7 @@ import {
     certificate,
     secp256k1,
     blake2b256,
-    address
+    addressUtils
 } from '@vechain-sdk/core';
 
 // In this example we create a certificate and
@@ -48,7 +48,7 @@ import {
 // Generate a private key and address for the signer
 const privateKey = secp256k1.generatePrivateKey();
 const publicKey = secp256k1.derivePublicKey(privateKey);
-const signerAddress = address.fromPublicKey(publicKey);
+const signerAddress = addressUtils.fromPublicKey(publicKey);
 
 // Create a certificate
 const cert: Certificate = {

diff --git a/docs/cryptography.md b/docs/cryptography.md
@@ -58,7 +58,7 @@ Secp256k1 is mainly used for generating public and private key pairs in cryptogr
 import {
     keccak256,
     secp256k1,
-    address,
+    addressUtils,
     type HashInput
 } from '@vechain-sdk/core';
 import { expect } from 'expect';
@@ -70,7 +70,7 @@ console.log('Private key:', privateKey.toString('hex'));
 
 // Public key and address from private key
 const publicKey = secp256k1.derivePublicKey(privateKey);
-const userAddress = address.fromPublicKey(publicKey);
+const userAddress = addressUtils.fromPublicKey(publicKey);
 console.log('User address:', userAddress);
 // User address: 0x...SOME_ADDRESS...
 

diff --git a/docs/examples/certificates/sign_verify.ts b/docs/examples/certificates/sign_verify.ts
@@ -3,7 +3,7 @@ import {
     certificate,
     secp256k1,
     blake2b256,
-    address
+    addressUtils
 } from '@vechain-sdk/core';
 
 // In this example we create a certificate and
@@ -12,7 +12,7 @@ import {
 // Generate a private key and address for the signer
 const privateKey = secp256k1.generatePrivateKey();
 const publicKey = secp256k1.derivePublicKey(privateKey);
-const signerAddress = address.fromPublicKey(publicKey);
+const signerAddress = addressUtils.fromPublicKey(publicKey);
 
 // Create a certificate
 const cert: Certificate = {

diff --git a/docs/examples/cryptography/secp256k1.ts b/docs/examples/cryptography/secp256k1.ts
@@ -1,7 +1,7 @@
 import {
     keccak256,
     secp256k1,
-    address,
+    addressUtils,
     type HashInput
 } from '@vechain-sdk/core';
 import { expect } from 'expect';
@@ -13,7 +13,7 @@ console.log('Private key:', privateKey.toString('hex'));
 
 // Public key and address from private key
 const publicKey = secp256k1.derivePublicKey(privateKey);
-const userAddress = address.fromPublicKey(publicKey);
+const userAddress = addressUtils.fromPublicKey(publicKey);
 console.log('User address:', userAddress);
 // User address: 0x...SOME_ADDRESS...
 

diff --git a/packages/core/src/address/address.ts b/packages/core/src/address/address.ts
@@ -50,4 +50,4 @@ function toChecksumed(address: string): string {
     return ethers.getAddress(address);
 }
 
-export const address = { fromPublicKey, isAddress, toChecksumed };
+export const addressUtils = { fromPublicKey, isAddress, toChecksumed };
diff --git a/packages/core/src/certificate/certificate.ts b/packages/core/src/certificate/certificate.ts
@@ -1,4 +1,4 @@
-import { address } from '../address';
+import { addressUtils } from '../address';
 import { blake2b256 } from '../hash';
 import { secp256k1 } from '../secp256k1';
 import fastJsonStableStringify from 'fast-json-stable-stringify';
@@ -55,7 +55,7 @@ function verify(cert: Certificate): void {
     );
 
     // Signature does not match with the signer's public key
-    if (address.fromPublicKey(pubKey) !== cert.signer) {
+    if (addressUtils.fromPublicKey(pubKey) !== cert.signer) {
         throw buildError(
             CERTIFICATE.CERTIFICATE_INVALID_SIGNER,
             "Signature does not match with the signer's public key."

diff --git a/packages/core/src/hdnode/hdnode.ts b/packages/core/src/hdnode/hdnode.ts
@@ -7,7 +7,7 @@ import {
     X_PUB_PREFIX
 } from '../utils';
 import { type IHDNode } from './types';
-import { address } from '../address';
+import { addressUtils } from '../address';
 import { sha256 } from '../hash';
 import { secp256k1 } from '../secp256k1';
 import { type WordlistSizeType } from '../mnemonic';
@@ -142,7 +142,7 @@ function ethersNodeToOurHDNode(ethersNode: ethers.HDNodeWallet): IHDNode {
         )
     );
     const cc = Buffer.from(ethersNode.chainCode.slice(2), 'hex');
-    const addr = address.fromPublicKey(pub);
+    const addr = addressUtils.fromPublicKey(pub);
 
     return {
         get publicKey() {

diff --git a/packages/core/src/keystore/keystore.ts b/packages/core/src/keystore/keystore.ts
@@ -1,7 +1,7 @@
 /**
  * Implements the JSON Keystore v3 Wallet encryption, decryption, and validation functionality.
  */
-import { address } from '../address';
+import { addressUtils } from '../address';
 import { secp256k1 } from '../secp256k1';
 import { ethers } from 'ethers';
 import { SCRYPT_PARAMS } from '../utils';
@@ -21,7 +21,7 @@ async function encrypt(
 ): Promise<Keystore> {
     // Public and Address are derived from private key
     const derivePublicKey = secp256k1.derivePublicKey(privateKey);
-    const deriveAddress = address.fromPublicKey(derivePublicKey);
+    const deriveAddress = addressUtils.fromPublicKey(derivePublicKey);
 
     // Create keystore account compatible with ethers
     const keystoreAccount: ethers.KeystoreAccount = {

diff --git a/packages/core/src/transaction/handlers/sign.ts b/packages/core/src/transaction/handlers/sign.ts
@@ -1,4 +1,4 @@
-import { address } from '../../address';
+import { addressUtils } from '../../address';
 import { secp256k1 } from '../../secp256k1';
 import { Transaction } from '../transaction';
 import { buildError, SECP256K1, TRANSACTION } from '@vechain-sdk/errors';
@@ -88,7 +88,7 @@ function signWithDelegator(
 
     const transactionHash = transactionToSign.getSignatureHash();
     const delegatedHash = transactionToSign.getSignatureHash(
-        address.fromPublicKey(secp256k1.derivePublicKey(signerPrivateKey))
+        addressUtils.fromPublicKey(secp256k1.derivePublicKey(signerPrivateKey))
     );
     const signature = Buffer.concat([
         secp256k1.sign(transactionHash, signerPrivateKey),

diff --git a/packages/core/src/transaction/transaction.ts b/packages/core/src/transaction/transaction.ts
@@ -1,4 +1,4 @@
-import { address } from '../address';
+import { addressUtils } from '../address';
 import { type RLPValidObject } from '../encoding';
 import { blake2b256 } from '../hash';
 import { secp256k1 } from '../secp256k1';
@@ -126,7 +126,7 @@ class Transaction {
         );
 
         // Address from public key
-        return address.fromPublicKey(delegatorPublicKey);
+        return addressUtils.fromPublicKey(delegatorPublicKey);
     }
 
     /**
@@ -188,7 +188,7 @@ class Transaction {
      */
     public getSignatureHash(delegateFor?: string): Buffer {
         // Correct delegateFor address
-        if (delegateFor !== undefined && !address.isAddress(delegateFor))
+        if (delegateFor !== undefined && !addressUtils.isAddress(delegateFor))
             throw buildError(
                 ADDRESS.INVALID_ADDRESS,
                 'Invalid address given as input as delegateFor parameter.'
@@ -244,7 +244,7 @@ class Transaction {
         );
 
         // Address from public key
-        return address.fromPublicKey(originPublicKey);
+        return addressUtils.fromPublicKey(originPublicKey);
     }
 
     /**

diff --git a/packages/core/src/utils/bloom/bloom.ts b/packages/core/src/utils/bloom/bloom.ts
@@ -1,7 +1,7 @@
 import { bloom as bloomInstance } from '../../bloom';
 import { dataUtils } from '../data';
 import { type HexString } from '../types';
-import { address } from '../../address';
+import { addressUtils } from '../../address';
 import { BLOOM_REGEX_LOWERCASE, BLOOM_REGEX_UPPERCASE } from '../const';
 import { ADDRESS, BLOOM, buildError, DATA } from '@vechain-sdk/errors';
 
@@ -108,7 +108,7 @@ const isAddressInBloom = (
     k: number,
     addressToCheck: HexString
 ): boolean => {
-    if (!address.isAddress(addressToCheck)) {
+    if (!addressUtils.isAddress(addressToCheck)) {
         throw buildError(
             ADDRESS.INVALID_ADDRESS,
             'Invalid address given as input in Bloom filter.'

diff --git a/packages/core/src/utils/transaction/transaction.ts b/packages/core/src/utils/transaction/transaction.ts
@@ -1,4 +1,4 @@
-import { address } from '../../address';
+import { addressUtils } from '../../address';
 import { type TransactionClause } from '../../transaction';
 import { TRANSACTIONS_GAS_CONSTANTS } from '../const';
 import { dataUtils } from '../data';
@@ -26,7 +26,7 @@ function intrinsicGas(clauses: TransactionClause[]): number {
     return clauses.reduce((sum, clause: TransactionClause) => {
         if (clause.to !== null) {
             // Invalid address
-            if (!address.isAddress(clause.to)) {
+            if (!addressUtils.isAddress(clause.to)) {
                 throw buildError(
                     DATA.INVALID_DATA_TYPE,
                     'Invalid data type. Data should be an address.'

diff --git a/packages/core/tests/abi/fixture.ts b/packages/core/tests/abi/fixture.ts
@@ -1,4 +1,4 @@
-import { address } from '../../src';
+import { addressUtils } from '../../src';
 
 /**
  * Simple functions fixtures
@@ -97,21 +97,21 @@ const functions = [
  */
 const simpleParametersDataForFunction2 = [
     {
-        master: address.toChecksumed(
+        master: addressUtils.toChecksumed(
             '0x0e8fd586e022f825a109848832d7e552132bc332'
         ),
-        endorsor: address.toChecksumed(
+        endorsor: addressUtils.toChecksumed(
             '0x224626926a7a12225a60e127cec119c939db4a5c'
         ),
         identity:
             '0xdbf2712e19af00dc4d376728f7cb06cc215c8e7c53b94cb47cefb4a26ada2a6c',
         active: false
     },
     {
-        master: address.toChecksumed(
+        master: addressUtils.toChecksumed(
             '0x4977d68df97bb313b23238520580d8d3a59939bf'
         ),
-        endorsor: address.toChecksumed(
+        endorsor: addressUtils.toChecksumed(
             '0x7ad1d568b3fe5bad3fc264aca70bc7bcd5e4a6ff'
         ),
         identity:

diff --git a/packages/core/tests/address/address.test.ts b/packages/core/tests/address/address.test.ts
@@ -1,5 +1,5 @@
 import { describe, expect, test } from '@jest/globals';
-import { address, secp256k1 } from '../../src';
+import { addressUtils, secp256k1 } from '../../src';
 import {
     checksumedAndUnchecksumedAddresses,
     invalidPrivateKey,
@@ -25,12 +25,16 @@ describe('Address', () => {
          * Valid and invalid address check
          */
         test('validate address', () => {
-            expect(address.isAddress('not an address')).toEqual(false);
+            expect(addressUtils.isAddress('not an address')).toEqual(false);
             expect(
-                address.isAddress('52908400098527886E0F7030069857D2E4169EE7')
+                addressUtils.isAddress(
+                    '52908400098527886E0F7030069857D2E4169EE7'
+                )
             ).toEqual(false);
             expect(
-                address.isAddress('0x52908400098527886E0F7030069857D2E4169EE7')
+                addressUtils.isAddress(
+                    '0x52908400098527886E0F7030069857D2E4169EE7'
+                )
             ).toEqual(true);
         });
     });
@@ -47,7 +51,7 @@ describe('Address', () => {
             expect(secp256k1.derivePublicKey(simplePrivateKey)).toEqual(
                 simplePublicKey
             );
-            expect(address.fromPublicKey(simplePublicKey)).toEqual(
+            expect(addressUtils.fromPublicKey(simplePublicKey)).toEqual(
                 simpleAddress
             );
 
@@ -67,10 +71,10 @@ describe('Address', () => {
          */
         test('invalid input should throw error', () => {
             expect(() => {
-                address.toChecksumed('invalid data');
+                addressUtils.toChecksumed('invalid data');
             }).toThrowError(InvalidAddressError);
             expect(() => {
-                address.toChecksumed(
+                addressUtils.toChecksumed(
                     '52908400098527886E0F7030069857D2E4169EE7'
                 );
             }).toThrowError(InvalidAddressError);
@@ -81,9 +85,9 @@ describe('Address', () => {
          */
         test('valid input', () => {
             checksumedAndUnchecksumedAddresses.forEach((addressPair) => {
-                expect(address.toChecksumed(addressPair.unchecksumed)).toEqual(
-                    addressPair.checksumed
-                );
+                expect(
+                    addressUtils.toChecksumed(addressPair.unchecksumed)
+                ).toEqual(addressPair.checksumed);
             });
         });
     });

diff --git a/packages/core/tests/certificate/fixture.ts b/packages/core/tests/certificate/fixture.ts
@@ -1,4 +1,4 @@
-import { secp256k1, address, blake2b256, certificate } from '../../src';
+import { secp256k1, addressUtils, blake2b256, certificate } from '../../src';
 
 /**
  * Private Key used for digital signature during certificate creation
@@ -19,7 +19,7 @@ const cert = {
     },
     domain: 'localhost',
     timestamp: 1545035330,
-    signer: address.fromPublicKey(secp256k1.derivePublicKey(privKey))
+    signer: addressUtils.fromPublicKey(secp256k1.derivePublicKey(privKey))
 };
 
 /**

diff --git a/packages/core/tests/hdnode/hdnode.test.ts b/packages/core/tests/hdnode/hdnode.test.ts
@@ -3,7 +3,7 @@ import {
     HDNode,
     type WordlistSizeType,
     ZERO_BUFFER,
-    address,
+    addressUtils,
     mnemonic,
     secp256k1
 } from '../../src';
@@ -32,9 +32,9 @@ describe('Hdnode', () => {
             const child = node.derive(i);
 
             // Correct address
-            expect(address.fromPublicKey(child.publicKey).slice(2)).toEqual(
-                addresses[i]
-            );
+            expect(
+                addressUtils.fromPublicKey(child.publicKey).slice(2)
+            ).toEqual(addresses[i]);
             expect(child.address).toEqual('0x' + addresses[i]);
 
             // Correct public key
@@ -53,9 +53,9 @@ describe('Hdnode', () => {
         for (let i = 0; i < 5; i++) {
             const child = xprivNode.derive(i);
             // Correct address
-            expect(address.fromPublicKey(child.publicKey).slice(2)).toEqual(
-                addresses[i]
-            );
+            expect(
+                addressUtils.fromPublicKey(child.publicKey).slice(2)
+            ).toEqual(addresses[i]);
             expect(child.address).toEqual('0x' + addresses[i]);
 
             // Correct public key
@@ -71,9 +71,9 @@ describe('Hdnode', () => {
         for (let i = 0; i < 5; i++) {
             const child = xpubNode.derive(i);
             // Correct address
-            expect(address.fromPublicKey(child.publicKey).slice(2)).toEqual(
-                addresses[i]
-            );
+            expect(
+                addressUtils.fromPublicKey(child.publicKey).slice(2)
+            ).toEqual(addresses[i]);
             expect(child.address).toEqual('0x' + addresses[i]);
 
             // Null private key
@@ -113,7 +113,7 @@ describe('Hdnode', () => {
 
                 // Address
                 expect(currentHdnode.address).toBeDefined();
-                address.isAddress(currentHdnode.address);
+                addressUtils.isAddress(currentHdnode.address);
             }
         );
     });

diff --git a/packages/core/tests/keystore/keystore.test.ts b/packages/core/tests/keystore/keystore.test.ts
@@ -1,5 +1,5 @@
 import { describe, test, expect } from '@jest/globals';
-import { secp256k1, address, keystore } from '../../src';
+import { secp256k1, addressUtils, keystore } from '../../src';
 import { type Keystore } from '../../src';
 import { encryptionPassword } from './fixture';
 import {
@@ -28,8 +28,10 @@ describe('Keystore', () => {
 
         // Verify keystore
         expect(myKeystore.version).toBe(3);
-        const keyStoreAddress = address.toChecksumed(`0x` + myKeystore.address);
-        const addressFromPrivateKey = address.fromPublicKey(
+        const keyStoreAddress = addressUtils.toChecksumed(
+            `0x` + myKeystore.address
+        );
+        const addressFromPrivateKey = addressUtils.fromPublicKey(
             secp256k1.derivePublicKey(privateKey)
         );
         expect(keyStoreAddress).toEqual(addressFromPrivateKey);
Title	Tests	Time
core	232	1m 2s ⏱️
network	30	8.92s ⏱️
errors	19	9.086s ⏱️