feat: added alias utils for parsing from/to public address

.github/workflows/build.yml

@@ -102,7 +102,7 @@ jobs:
         id: start-local-node
         if: ${{ steps.build-sdk.conclusion == 'success' && !cancelled() && always() }}
         run: |
-          npx @hashgraph/hedera-local start -d --network local
+          npx @hashgraph/hedera-local start -d --network local --balance=100000
           # Wait for the network to fully start
           sleep 30 
 

package.json

@@ -68,7 +68,8 @@
         "pino": "^8.14.1",
         "pino-pretty": "^10.0.0",
         "protobufjs": "^7.2.5",
-        "utf8": "^3.0.0"
+        "utf8": "^3.0.0",
+        "rfc4648": "^1.5.3"
     },
     "devDependencies": {
         "@babel/cli": "^7.23.4",

src/EntityIdHelper.js

@@ -22,6 +22,10 @@
 import * as hex from "./encoding/hex.js";
 import BadEntityIdError from "./BadEntityIdError.js";
 import * as util from "./util.js";
+import base32 from "./base32.js";
+import * as HashgraphProto from "@hashgraph/proto";
+import PublicKey from "./PublicKey.js";
+import { arrayify } from "@ethersproject/bytes";
 
 /**
  * @typedef {import("./client/Client.js").default<*, *>} Client
@@ -408,3 +412,135 @@
 
     return `${string}-${checksum}`;
 }
+
+/**
+ * Append Buffers.
+ * @param {Uint8Array} buffer1
+ * @param {Uint8Array} buffer2
+ * @returns {Uint8Array}
+ */
+function appendBuffer(buffer1, buffer2) {
+    var tmp = new Uint8Array(buffer1.byteLength + buffer2.byteLength);
+    tmp.set(new Uint8Array(buffer1), 0);
+    tmp.set(new Uint8Array(buffer2), buffer1.byteLength);
+    return tmp;
+}
+
+/**
+ * Convert bytes to hex string.
+ * @param {Uint8Array} bytes
+ * @returns {string}
+ */
+function toHexString(bytes) {
+    var s = "0x";
+    bytes.forEach(function (byte) {
+        s += ("0" + (byte & 0xff).toString(16)).slice(-2);
+    });
+    return s;
+}
+
+/**
+ * Deserialize the alias to public key.
+ * Alias is created from ed25519 or ECDSASecp256k1 types of accounts. If hollow account is used, the alias is created from evm address.
+ * For hollow accounts, please use aliasToEvmAddress.
+ *
+ * @param {string} alias
+ * @returns {PublicKey | null}
+ */
+export function aliasToPublicKey(alias) {
+    const bytes = base32.decode(alias);
+    if (!bytes) {
+        return null;
+    }
+    let key;
+    try {
+        key = HashgraphProto.proto.Key.decode(bytes);
+    } catch (e) {
+        throw new Error(
+            "The alias is created with hollow account. Please use aliasToEvmAddress!",
+        );
+    }
+
+    if (key.ed25519 != null && key.ed25519.byteLength > 0) {
+        return PublicKey.fromBytes(key.ed25519);
+    }
+
+    if (key.ECDSASecp256k1 != null && key.ECDSASecp256k1.byteLength > 0) {
+        return PublicKey.fromBytes(key.ECDSASecp256k1);
+    }
+
+    return null;
+}
+
+/**
+ * Deserialize the alias to evm address.
+ * Alias is created from hollow account.
+ * For ed25519 or ECDSASecp256k1 accounts, please use aliasToPublicKey.
+ *
+ * @param {string} alias
+ * @returns {string | null}
+ */
+export function aliasToEvmAddress(alias) {
+    const bytes = base32.decode(alias);
+    if (!bytes) {
+        return null;
+    }
+    try {
+        HashgraphProto.proto.Key.decode(bytes);
+        throw new Error(
+            "The alias is created with ed25519 or ECDSASecp256k1 account. Please use aliasToPublicKey!",
+        );
+    } catch (e) {
+        return toHexString(bytes);
+    }
+}
+
+/**
+ * Serialize the public key to alias.
+ * Alias is created from ed25519 or ECDSASecp256k1 types of accounts. If hollow account is used, the alias is created from evm address.
+ *
+ * @param {string | PublicKey} publicKey
+ * @returns {string | null}
+ */
+export function publicKeyToAlias(publicKey) {
+    if (
+        typeof publicKey === "string" &&
+        ((publicKey.startsWith("0x") && publicKey.length == 42) ||
+            publicKey.length == 40)
+    ) {
+        if (!publicKey.startsWith("0x")) {
+            publicKey = `0x${publicKey}`;
+        }
+
+        const bytes = arrayify(publicKey);
+        if (!bytes) {
+            return null;
+        }
+        return base32.encode(bytes);
+    }
+
+    const publicKeyRaw =
+        typeof publicKey === "string"
+            ? PublicKey.fromString(publicKey)
+            : publicKey;
+    let publicKeyHex = publicKeyRaw.toStringRaw();
+    let leadingHex = "";
+
+    if (publicKeyRaw._key._type === "secp256k1") {
+        leadingHex = "0x3A21"; // LEADING BYTES FROM PROTOBUFS
+    }
+
+    if (publicKeyRaw._key._type === "ED25519") {
+        leadingHex = "0x1220"; // LEADING BYTES FROM PROTOBUFS
+    }
+
+    if (!publicKeyHex.startsWith("0x")) {
+        publicKeyHex = `0x${publicKeyHex}`;
+    }
+
+    const leadingBytes = arrayify(leadingHex);
+    const publicKeyBytes = arrayify(publicKeyHex);
+    const publicKeyInBytes = appendBuffer(leadingBytes, publicKeyBytes);
+    const alias = base32.encode(publicKeyInBytes);
+    return alias;
+}

src/base32.js

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2019-2023 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// HIP-32: https://hips.hedera.com/hip/hip-32
+import { base32 } from "rfc4648";
+
+const decodeOpts = { loose: true };
+const encodeOpts = { pad: false };
+
+/**
+ * Decodes the rfc4648 base32 string into a {@link Uint8Array}. If the input string is null, returns null.
+ * @param {string} str  the base32 string.
+ * @returns {Uint8Array | ''}
+ */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+const decode = (str) => str && base32.parse(str, decodeOpts);
+
+/**
+ * Encodes the byte array into a rfc4648 base32 string without padding. If the input is null, returns null. Note with
+ * the rfc4648 loose = true option, it allows lower case letters, padding, and auto corrects 0 -> O, 1 -> L, 8 -> B
+ * @param {Buffer|Uint8Array} data
+ * @returns {string}
+ */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+const encode = (data) => data && base32.stringify(data, encodeOpts);
+
+export default {
+    decode,
+    encode,
+};

test/integration/ContractBytecodeIntegrationTest.js

@@ -43,7 +43,7 @@ describe("ContractBytecode", function () {
         receipt = await (
             await new ContractCreateTransaction()
                 .setAdminKey(operatorKey)
-                .setGas(100000)
+                .setGas(200000)
                 .setConstructorParameters(
                     new ContractFunctionParameters().addString(
                         "Hello from Hedera.",

test/integration/ContractCallIntegrationTest.js

@@ -45,7 +45,7 @@ describe("ContractCallIntegration", function () {
         receipt = await (
             await new ContractCreateTransaction()
                 .setAdminKey(operatorKey)
-                .setGas(100000)
+                .setGas(200000)
                 .setConstructorParameters(
                     new ContractFunctionParameters().addString(
                         "Hello from Hedera.",
@@ -131,7 +131,7 @@ describe("ContractCallIntegration", function () {
         receipt = await (
             await new ContractCreateTransaction()
                 .setAdminKey(operatorKey)
-                .setGas(100000)
+                .setGas(200000)
                 .setConstructorParameters(
                     new ContractFunctionParameters().addString(
                         "Hello from Hedera.",
@@ -200,7 +200,7 @@ describe("ContractCallIntegration", function () {
         receipt = await (
             await new ContractCreateTransaction()
                 .setAdminKey(operatorKey)
-                .setGas(100000)
+                .setGas(200000)
                 .setConstructorParameters(
                     new ContractFunctionParameters().addString(
                         "Hello from Hedera.",
@@ -268,7 +268,7 @@ describe("ContractCallIntegration", function () {
         receipt = await (
             await new ContractCreateTransaction()
                 .setAdminKey(operatorKey)
-                .setGas(100000)
+                .setGas(200000)
                 .setConstructorParameters(
                     new ContractFunctionParameters().addString(
                         "Hello from Hedera.",

test/integration/ContractCreateFlowIntegrationTest.js

@@ -21,7 +21,7 @@ describe("ContractCreateFlow", function () {
         await new ContractCreateFlow()
             .setBytecode(smartContractBytecode)
             .setAdminKey(operatorKey)
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",

test/integration/ContractCreateIntegrationTest.js

@@ -39,7 +39,7 @@ describe("ContractCreate", function () {
 
         response = await new ContractCreateTransaction()
             .setAdminKey(operatorKey)
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",
@@ -109,7 +109,7 @@ describe("ContractCreate", function () {
         const file = receipt.fileId;
 
         response = await new ContractCreateTransaction()
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",

test/integration/ContractDeleteIntegrationTest.js

@@ -39,7 +39,7 @@ describe("ContractDelete", function () {
 
         response = await new ContractCreateTransaction()
             .setAdminKey(operatorKey)
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",
@@ -110,7 +110,7 @@ describe("ContractDelete", function () {
 
         response = await new ContractCreateTransaction()
             .setAdminKey(operatorKey)
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",

test/integration/ContractExecuteIntegrationTest.js

@@ -38,7 +38,7 @@ describe("ContractExecute", function () {
 
         response = await new ContractCreateTransaction()
             .setAdminKey(operatorKey)
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",
@@ -101,7 +101,7 @@ describe("ContractExecute", function () {
 
         response = await new ContractCreateTransaction()
             .setAdminKey(operatorKey)
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",
@@ -175,7 +175,7 @@ describe("ContractExecute", function () {
 
         response = await new ContractCreateTransaction()
             .setAdminKey(operatorKey)
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",
@@ -244,7 +244,7 @@ describe("ContractExecute", function () {
 
         response = await new ContractCreateTransaction()
             .setAdminKey(operatorKey)
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",
@@ -318,7 +318,7 @@ describe("ContractExecute", function () {
 
         response = await new ContractCreateTransaction()
             .setAdminKey(operatorKey)
-            .setGas(100000)
+            .setGas(200000)
             .setConstructorParameters(
                 new ContractFunctionParameters().addString(
                     "Hello from Hedera.",

test/integration/ContractFunctionParametersIntegrationTest.js

@@ -122,7 +122,7 @@ describe("ContractFunctionParameters", function () {
     let newContractId;
 
     before(async function () {
-        env = await IntegrationTestEnv.new({ balance: 100000 });
+        env = await IntegrationTestEnv.new({ balance: 10000 });
         // Create a file on Hedera and store the bytecode
         const fileCreateTx = new FileCreateTransaction()
             .setKeys([env.operatorKey])
@@ -152,7 +152,7 @@ describe("ContractFunctionParameters", function () {
             //Set the file ID of the Hedera file storing the bytecode
             .setBytecodeFileId(bytecodeFileId)
             //Set the gas to instantiate the contract
-            .setGas(100000)
+            .setGas(500000)
             //Provide the constructor parameters for the contract
             .setConstructorParameters();