feat: account create transaction with key derived alias (#2834)

* feat(account-create-transaction): add new key alias derivation API

Added new APIs to AccountCreateTransaction:
- `setECDSAKeyWithAlias(ECDSAPrivateKey)`: Sets ECDSA private key and alias derived from it.
- `setKeyWithAlias(Key, ECDSAPrivateKey)`: Allows setting account key and a separate ECDSA private key for EVM address derivation.
- `setKeyWithoutAlias(Key)`: Explicitly sets key without alias setting.

Deprecated:
- `setKey(Key)`: Replaced with `setKeyWithoutAlias` method.

Includes unit tests for all new functionality.

Signed-off-by: venilinvasilev <[email protected]>

* test(account-create-transaction): add integration tests

Added integration tests for `AccountCreateTransaction` to validate new key alias APIs

Replaced deprecated `setKey(Key)` references  with `setKeyWithoutAlias(Key)`, aligning with the new API changes.

Signed-off-by: venilinvasilev <[email protected]>

* refactor(tests): replace setKey with setKeyWithoutAlias in tests

Updated all test suites to replace deprecated `setKey(Key)` calls with `setKeyWithoutAlias(Key)`, ensuring compatibility with the latest API changes.

Signed-off-by: venilinvasilev <[email protected]>

* refactor(examples): replace setKey with setKeyWithoutAlias in examples

Replaced all occurrences of `setKey(Key)` with `setKeyWithoutAlias(Key)` in example implementations, ensuring consistency with the latest API updates.

Signed-off-by: venilinvasilev <[email protected]>

* refactor(tck): replace deprecated setKey with setKeyWithoutAlias

Updated a remaining deprecated reference to `setKey(Key)` in tck

Signed-off-by: venilinvasilev <[email protected]>

* feat(examples): add code examples for key alias functionalities

Added code examples demonstrating how to use:
- `setECDSAKeyWithAlias(ECDSAKey)`
- `setKeyWithAlias(Key, ECDSAKey)`
- `setKeyWithoutAlias(Key)`

Signed-off-by: venilinvasilev <[email protected]>

---------

Signed-off-by: venilinvasilev <[email protected]>

Author: venilinvasilev

examples/account-allowance.js

@@ -46,7 +46,7 @@ async function main() {
 
     try {
         let transaction = await new AccountCreateTransaction()
-            .setKey(aliceKey)
+            .setKeyWithoutAlias(aliceKey)
             .setInitialBalance(new Hbar(5))
             .freezeWithSigner(wallet);
         transaction = await transaction.signWithSigner(wallet);
@@ -55,7 +55,7 @@ async function main() {
         const aliceId = (await response.getReceiptWithSigner(wallet)).accountId;
 
         transaction = await new AccountCreateTransaction()
-            .setKey(bobKey)
+            .setKeyWithoutAlias(bobKey)
             .setInitialBalance(new Hbar(5))
             .freezeWithSigner(wallet);
         transaction = await transaction.signWithSigner(wallet);
@@ -67,7 +67,7 @@ async function main() {
         ).accountId;
 
         transaction = await new AccountCreateTransaction()
-            .setKey(charlieKey)
+            .setKeyWithoutAlias(charlieKey)
             .setInitialBalance(new Hbar(5))
             .freezeWithSigner(wallet);
         transaction = await transaction.signWithSigner(wallet);

examples/create-account-with-alias-and-receiver-signature.js

@@ -83,7 +83,7 @@ async function main() {
         const accountCreateTx = new AccountCreateTransaction()
             .setReceiverSignatureRequired(true)
             .setInitialBalance(Hbar.fromTinybars(100))
-            .setKey(adminKey)
+            .setKeyWithoutAlias(adminKey)
             .setAlias(evmAddress)
             .freezeWith(client);
 

examples/create-account-with-alias.js

@@ -4,7 +4,6 @@ import {
     Client,
     Hbar,
     AccountInfoQuery,
-    TransactionReceiptQuery,
     AccountCreateTransaction,
 } from "@hashgraph/sdk";
 
@@ -74,51 +73,181 @@ async function main() {
          *
          * Use the `AccountCreateTransaction`
          *   - Populate `setAlias(evmAddress)` field with the Ethereum public address
+         * Sign the `AccountCreateTransaction` transaction with both the new private key and key paying for the transaction fee
+         * Get the account ID of the newly created account
          */
-        const accountCreateTx = new AccountCreateTransaction()
-            .setInitialBalance(Hbar.fromTinybars(100))
-            .setKey(operatorKey)
-            .setAlias(evmAddress)
-            .freezeWith(client);
+        const receipt = await (
+            await (
+                await new AccountCreateTransaction()
+                    .setInitialBalance(Hbar.fromTinybars(100))
+                    .setKeyWithoutAlias(operatorKey)
+                    .setAlias(evmAddress)
+                    .freezeWith(client)
+                    .sign(privateKey)
+            ).execute(client)
+        ).getReceipt(client);
+
+        const newAccountId = receipt.accountId.toString();
+        console.log(`Account ID of the newly created account: ${newAccountId}`);
 
         /**
          *
          * Step 5
          *
-         * Sign the `AccountCreateTransaction` transaction with both the new private key and key paying for the transaction fee
+         * Get the `AccountInfo` and show that the account has contractAccountId
          */
-        const accountCreateTxSign = await accountCreateTx.sign(privateKey);
-        const accountCreateTxResponse =
-            await accountCreateTxSign.execute(client);
+        const accountInfo = await new AccountInfoQuery()
+            .setAccountId(newAccountId)
+            .execute(client);
 
+        console.log(
+            `The newly created account has an alias: ${accountInfo.contractAccountId}`,
+        );
+    } catch (error) {
+        console.error(error);
+    }
+
+    /* Create an account with derived EVM alias from private ECDSA account key
+     *
+     * Reference: [Streamline key and alias specifications for AccountCreateTransaction #2795](https://github.com/hiero-ledger/hiero-sdk-js/issues/2795)
+     */
+    console.log(
+        "---Create an account with derived EVM alias from private ECDSA account key---",
+    );
+
+    try {
         /**
+         * Step 1
          *
-         * Step 6
+         * Create an ECSDA private key
+         */
+        const privateKey = PrivateKey.generateECDSA();
+        console.log(`Private key: ${privateKey.toStringDer()}`);
+
+        /**
+         *
+         * Step 2
          *
+         * Use the `AccountCreateTransaction`
+         *   - Populate `setECDSAKeyWithAlias(privateKey)` field with the generated ECDSA private key
+         * Sign the `AccountCreateTransaction` transaction with the generated private key and execute it
          * Get the account ID of the newly created account
          */
-        const receipt = await new TransactionReceiptQuery()
-            .setTransactionId(accountCreateTxResponse.transactionId)
+
+        const receipt = await (
+            await (
+                await new AccountCreateTransaction()
+                    .setInitialBalance(Hbar.fromTinybars(100))
+                    .setECDSAKeyWithAlias(privateKey)
+                    .freezeWith(client)
+                    .sign(privateKey)
+            ).execute(client)
+        ).getReceipt(client);
+
+        const newAccountId = receipt.accountId.toString();
+        console.log(`Account ID of the newly created account: ${newAccountId}`);
+
+        /**
+         *
+         * Step 3
+         *
+         * Get the `AccountInfo` and examine the created account key and alias
+         */
+        const accountInfo = await new AccountInfoQuery()
+            .setAccountId(newAccountId)
             .execute(client);
 
+        console.log(
+            `Account's key ${accountInfo.key.toString()} is the same as ${privateKey.publicKey.toStringDer()}`,
+        );
+
+        if (
+            !accountInfo.contractAccountId.startsWith(
+                "000000000000000000000000",
+            )
+        ) {
+            console.log(
+                `Initial EVM address: ${privateKey.publicKey.toEvmAddress()} is the same as ${
+                    accountInfo.contractAccountId
+                }`,
+            );
+        } else {
+            console.log(`The new account doesn't have an EVM alias`);
+        }
+    } catch (error) {
+        console.error(error);
+    }
+
+    /* Create an account with derived EVM alias from private ECDSA alias key
+     *
+     * Reference: [Streamline key and alias specifications for AccountCreateTransaction #2795](https://github.com/hiero-ledger/hiero-sdk-js/issues/2795)
+     */
+
+    console.log(
+        "---Create an account with derived EVM alias from private ECDSA alias key---",
+    );
+
+    try {
+        /**
+         * Step 1
+         *
+         * Create an account key and an ECSDA private alias key
+         */
+        const key = PrivateKey.generateED25519();
+        const aliasKey = PrivateKey.generateECDSA();
+        console.log(`Alias key: ${aliasKey.toStringDer()}`);
+
+        /**
+         *
+         * Step 2
+         *
+         * Use the `AccountCreateTransaction`
+         *   - Populate `setKeyWithAlias(key, privateKey)` fields with the generated account key and the alias ECDSA private key
+         * Sign the `AccountCreateTransaction` transaction with both keys and execute.
+         * Get the account ID of the newly created account
+         *
+         */
+
+        const receipt = await (
+            await (
+                await (
+                    await new AccountCreateTransaction()
+                        .setInitialBalance(Hbar.fromTinybars(100))
+                        .setKeyWithAlias(key, aliasKey)
+                        .freezeWith(client)
+                        .sign(key)
+                ).sign(aliasKey)
+            ).execute(client)
+        ).getReceipt(client);
+
         const newAccountId = receipt.accountId.toString();
         console.log(`Account ID of the newly created account: ${newAccountId}`);
 
         /**
          *
-         * Step 7
+         * Step 3
          *
-         * Get the `AccountInfo` and show that the account has contractAccountId
+         * Get the `AccountInfo` and examine the created account key and alias
          */
         const accountInfo = await new AccountInfoQuery()
             .setAccountId(newAccountId)
             .execute(client);
 
-        accountInfo.contractAccountId !== null
-            ? console.log(
-                  `The newly created account has an alias: ${accountInfo.contractAccountId}`,
-              )
-            : console.log(`The new account doesn't have an alias`);
+        console.log(
+            `Account's key ${accountInfo.key.toString()} is the same as ${key.publicKey.toString()}`,
+        );
+
+        if (
+            !accountInfo.contractAccountId.startsWith(
+                "000000000000000000000000",
+            )
+        ) {
+            console.log(
+                `Initial EVM address: ${accountInfo.contractAccountId} is the same as ${aliasKey.publicKey.toEvmAddress()}`,
+            );
+        } else {
+            console.log(`The new account doesn't have an alias`);
+        }
     } catch (error) {
         console.error(error);
     }

examples/create-account-with-thresholdkey.js

@@ -82,7 +82,7 @@ async function main() {
          */
         console.log("Creating new account...");
         const accountCreateTxResponse = await new AccountCreateTransaction()
-            .setKey(thresholdKey)
+            .setKeyWithoutAlias(thresholdKey)
             .setInitialBalance(new Hbar(100))
             .execute(client);
 

examples/create-account.js

@@ -37,7 +37,7 @@ async function main() {
     try {
         let transaction = await new AccountCreateTransaction()
             .setInitialBalance(new Hbar(10)) // 10 h
-            .setKey(newKey.publicKey)
+            .setKeyWithoutAlias(newKey.publicKey)
             .freezeWithSigner(wallet);
 
         transaction = await transaction.signWithSigner(wallet);

examples/delete-account.js

@@ -38,7 +38,7 @@ async function main() {
     try {
         let transaction = await new AccountCreateTransaction()
             .setInitialBalance(new Hbar(10)) // 10 h
-            .setKey(newKey.publicKey)
+            .setKeyWithoutAlias(newKey.publicKey)
             .freezeWithSigner(wallet);
         transaction = await transaction.signWithSigner(wallet);
         const response = await transaction.executeWithSigner(wallet);

examples/exempt-custom-fees.js

@@ -62,7 +62,7 @@ async function main() {
     let firstAccountPublicKey = firstAccountPrivateKey.publicKey;
 
     let createAccountAtx = await new AccountCreateTransaction()
-        .setKey(firstAccountPublicKey)
+        .setKeyWithoutAlias(firstAccountPublicKey)
         .setInitialBalance(Hbar.fromString("1000"))
         .freezeWithSigner(wallet);
     createAccountAtx = await createAccountAtx.signWithSigner(wallet);
@@ -81,7 +81,7 @@ async function main() {
     let secondAccountPublicKey = secondAccountPrivateKey.publicKey;
 
     let createAccountBtx = await new AccountCreateTransaction()
-        .setKey(secondAccountPublicKey)
+        .setKeyWithoutAlias(secondAccountPublicKey)
         .setInitialBalance(Hbar.fromString("1000"))
         .freezeWithSigner(wallet);
     createAccountBtx = await createAccountBtx.signWithSigner(wallet);
@@ -100,7 +100,7 @@ async function main() {
     let thirdAccountPublicKey = thirdAccountPrivateKey.publicKey;
 
     let createAccountCtx = await new AccountCreateTransaction()
-        .setKey(thirdAccountPublicKey)
+        .setKeyWithoutAlias(thirdAccountPublicKey)
         .setInitialBalance(Hbar.fromString("1000"))
         .freezeWithSigner(wallet);
     createAccountCtx = await createAccountCtx.signWithSigner(wallet);

examples/generate-txid-on-demand.js

@@ -80,7 +80,7 @@ async function main() {
 
         const accountCreateTx = await new AccountCreateTransaction()
             .setInitialBalance(new Hbar(10)) // 10 h
-            .setKey(newKey.publicKey)
+            .setKeyWithoutAlias(newKey.publicKey)
             .freezeWith(client)
             .execute(client);
 

examples/initialize-client-with-mirror-node-adress-book.js

@@ -39,7 +39,7 @@ async function main() {
     try {
         let transaction = new AccountCreateTransaction()
             .setInitialBalance(new Hbar(1))
-            .setKey(accountKey)
+            .setKeyWithoutAlias(accountKey)
             .freezeWith(client);
 
         transaction = await transaction.sign(accountKey);

examples/long-term-schedule-transaction.js

@@ -48,7 +48,7 @@ async function main() {
     const aliceId = (
         await (
             await new AccountCreateTransaction()
-                .setKey(thresholdKey)
+                .setKeyWithoutAlias(thresholdKey)
                 .setInitialBalance(new Hbar(2))
                 .execute(client)
         ).getReceipt(client)

examples/multi-node-multi-signature-remove.js

@@ -62,7 +62,7 @@ async function main() {
 
     const createAccountTransaction = new AccountCreateTransaction()
         .setInitialBalance(new Hbar(2))
-        .setKey(keyList);
+        .setKeyWithoutAlias(keyList);
 
     const createResponse = await createAccountTransaction.execute(client);
     const createReceipt = await createResponse.getReceipt(client);

examples/multi-node-multi-signature-removeAll.js

@@ -63,7 +63,7 @@ async function main() {
      */
     const createAccountTransaction = new AccountCreateTransaction()
         .setInitialBalance(new Hbar(2))
-        .setKey(keyList);
+        .setKeyWithoutAlias(keyList);
 
     const createResponse = await createAccountTransaction.execute(client);
     const createReceipt = await createResponse.getReceipt(client);

examples/multi-node-multi-signature.js

@@ -57,7 +57,7 @@ async function main() {
 
     const createAccountTransaction = new AccountCreateTransaction()
         .setInitialBalance(new Hbar(2))
-        .setKey(keyList);
+        .setKeyWithoutAlias(keyList);
 
     const createResponse = await createAccountTransaction.execute(client);
     const createReceipt = await createResponse.getReceipt(client);

examples/multi-sig-offline.js

@@ -48,7 +48,7 @@ async function main() {
 
     const createAccountTransaction = new AccountCreateTransaction()
         .setInitialBalance(new Hbar(2)) // 5 h
-        .setKey(keyList);
+        .setKeyWithoutAlias(keyList);
 
     const response = await createAccountTransaction.execute(client);