@hiero-ledger/sdk 2.70.0

package/src/contract/DelegateContractId.js

@@ -0,0 +1,94 @@
+// SPDX-License-Identifier: Apache-2.0
+
+import CACHE from "../Cache.js";
+import ContractId from "./ContractId.js";
+
+/**
+ * @namespace {proto}
+ * @typedef {import("@hashgraph/proto").proto.IContractID} HieroProto.proto.IContractID
+ * @typedef {import("@hashgraph/proto").proto.IKey} HieroProto.proto.IKey
+ */
+
+/**
+ * @typedef {import("long")} Long
+ * @typedef {import("../client/Client.js").default<*, *>} Client
+ */
+
+/**
+ * epresents a delegatable smart contract ID on the Hedera network.
+ * This class extends ContractId and provides additional functionality for delegatable contracts.
+ */
+export default class DelegateContractId extends ContractId {
+    /**
+     * @param {number | Long | import("../EntityIdHelper").IEntityId} props
+     * @param {(number | Long)=} realm
+     * @param {(number | Long)=} num
+     * @param {Uint8Array=} evmAddress
+     */
+    constructor(props, realm, num, evmAddress) {
+        super(props, realm, num, evmAddress);
+    }
+
+    /**
+     * @param {string} text
+     * @returns {DelegateContractId}
+     */
+    static fromString(text) {
+        return new DelegateContractId(ContractId.fromString(text));
+    }
+
+    /**
+     * @internal
+     * @param {HieroProto.proto.IContractID} id
+     * @returns {DelegateContractId}
+     */
+    static _fromProtobuf(id) {
+        return new DelegateContractId(ContractId._fromProtobuf(id));
+    }
+
+    /**
+     * @param {Uint8Array} bytes
+     * @returns {DelegateContractId}
+     */
+    static fromBytes(bytes) {
+        return new DelegateContractId(ContractId.fromBytes(bytes));
+    }
+
+    /**
+     * @param {string} address
+     * @deprecated - Use `fromEvmAddress` instead
+     * @returns {DelegateContractId}
+     */
+    static fromSolidityAddress(address) {
+        // eslint-disable-next-line deprecation/deprecation
+        return new DelegateContractId(ContractId.fromSolidityAddress(address));
+    }
+
+    /**
+     * @returns {DelegateContractId}
+     */
+    clone() {
+        const id = new DelegateContractId(this);
+        id._checksum = this._checksum;
+        return id;
+    }
+
+    /**
+     * @returns {HieroProto.proto.IKey}
+     */
+    _toProtobufKey() {
+        return {
+            delegatableContractId: this._toProtobuf(),
+        };
+    }
+
+    /**
+     * @param {HieroProto.proto.IContractID} key
+     * @returns {DelegateContractId}
+     */
+    static __fromProtobufKey(key) {
+        return DelegateContractId._fromProtobuf(key);
+    }
+}
+
+CACHE.setDelegateContractId((key) => DelegateContractId.__fromProtobufKey(key));

package/src/contract/StorageChange.js

@@ -0,0 +1,71 @@
+// SPDX-License-Identifier: Apache-2.0
+
+import * as HieroProto from "@hashgraph/proto";
+
+/**
+ * @deprecated - Use mirror node for contract traceability instead
+ */
+export default class StorageChange {
+    /**
+     * @private
+     * @param {object} props
+     * @param {Uint8Array} props.slot
+     * @param {Uint8Array} props.valueRead
+     * @param {Uint8Array?} props.valueWritten
+     */
+    constructor(props) {
+        this.slot = props.slot;
+        this.valueRead = props.valueRead;
+        this.valueWritten = props.valueWritten;
+    }
+
+    /**
+     * @internal
+     * @param {HieroProto.proto.IStorageChange} change
+     * @returns {StorageChange}
+     */
+    static _fromProtobuf(change) {
+        // eslint-disable-next-line deprecation/deprecation
+        return new StorageChange({
+            slot: /** @type {Uint8Array} */ (change.slot),
+            valueRead: /** @type {Uint8Array} */ (change.valueRead),
+            valueWritten:
+                change.valueWritten != null && change.valueWritten.value != null
+                    ? change.valueWritten.value
+                    : null,
+        });
+    }
+
+    /**
+     * @param {Uint8Array} bytes
+     * @returns {StorageChange}
+     */
+    static fromBytes(bytes) {
+        // eslint-disable-next-line deprecation/deprecation
+        return StorageChange._fromProtobuf(
+            HieroProto.proto.StorageChange.decode(bytes),
+        );
+    }
+
+    /**
+     * @internal
+     * @returns {HieroProto.proto.IStorageChange}
+     */
+    _toProtobuf() {
+        return {
+            slot: this.slot,
+            valueRead: this.valueRead,
+            valueWritten:
+                this.valueWritten != null ? { value: this.valueWritten } : null,
+        };
+    }
+
+    /**
+     * @returns {Uint8Array}
+     */
+    toBytes() {
+        return HieroProto.proto.StorageChange.encode(
+            this._toProtobuf(),
+        ).finish();
+    }
+}

package/src/cryptography/keccak.js

@@ -0,0 +1,419 @@
+// SPDX-License-Identifier: Apache-2.0
+
+// Originally sourced from:
+// https://github.com/MaiaVictor/eth-lib/blob/da0971f5b09964d9c8449975fa87933f0c9fef35/src/hash.js
+//  - added type declarations
+//  - switched to es6 module syntax
+//
+// Disable linting for entire file because it's nearly all pure JS
+// eslint-disable
+
+const HEX_CHARS = "0123456789abcdef".split("");
+const KECCAK_PADDING = [1, 256, 65536, 16777216];
+const SHIFT = [0, 8, 16, 24];
+const RC = [
+    1, 0, 32898, 0, 32906, 2147483648, 2147516416, 2147483648, 32907, 0,
+    2147483649, 0, 2147516545, 2147483648, 32777, 2147483648, 138, 0, 136, 0,
+    2147516425, 0, 2147483658, 0, 2147516555, 0, 139, 2147483648, 32905,
+    2147483648, 32771, 2147483648, 32770, 2147483648, 128, 2147483648, 32778, 0,
+    2147483658, 2147483648, 2147516545, 2147483648, 32896, 2147483648,
+    2147483649, 0, 2147516424, 2147483648,
+];
+
+/**
+ * @typedef {object} KeccakT
+ * @property {number[]} blocks
+ * @property {number} blockCount
+ * @property {number} outputBlocks
+ * @property {number[]} s
+ * @property {number} start
+ * @property {number} block
+ * @property {boolean} reset
+ * @property {number=} lastByteIndex
+ */
+
+/** @type {(bits: number) => KeccakT} */
+const Keccak = (bits) => ({
+    blocks: [],
+    reset: true,
+    block: 0,
+    start: 0,
+    blockCount: (1600 - (bits << 1)) >> 5,
+    outputBlocks: bits >> 5,
+    // @ts-ignore
+    s: ((s) => [].concat(s, s, s, s, s))([0, 0, 0, 0, 0, 0, 0, 0, 0, 0]),
+});
+
+/** @type {(state: KeccakT, message: string | number[]) => string} */
+//NOSONAR
+const update = (state, /** @type {string | number[]} */ message) => {
+    var length = message.length,
+        blocks = state.blocks,
+        byteCount = state.blockCount << 2,
+        blockCount = state.blockCount,
+        outputBlocks = state.outputBlocks,
+        s = state.s,
+        index = 0,
+        i,
+        code;
+
+    // update
+    while (index < length) {
+        if (state.reset) {
+            state.reset = false;
+            blocks[0] = state.block;
+            for (i = 1; i < blockCount + 1; ++i) {
+                blocks[i] = 0;
+            }
+        }
+        if (typeof message !== "string") {
+            for (i = state.start; index < length && i < byteCount; ++index) {
+                blocks[i >> 2] |= message[index] << SHIFT[i++ & 3];
+            }
+        } else {
+            for (i = state.start; index < length && i < byteCount; ++index) {
+                code = message.charCodeAt(index);
+                if (code < 0x80) {
+                    blocks[i >> 2] |= code << SHIFT[i++ & 3];
+                } else if (code < 0x800) {
+                    blocks[i >> 2] |= (0xc0 | (code >> 6)) << SHIFT[i++ & 3];
+                    blocks[i >> 2] |= (0x80 | (code & 0x3f)) << SHIFT[i++ & 3];
+                } else if (code < 0xd800 || code >= 0xe000) {
+                    blocks[i >> 2] |= (0xe0 | (code >> 12)) << SHIFT[i++ & 3];
+                    blocks[i >> 2] |=
+                        (0x80 | ((code >> 6) & 0x3f)) << SHIFT[i++ & 3];
+                    blocks[i >> 2] |= (0x80 | (code & 0x3f)) << SHIFT[i++ & 3];
+                } else {
+                    code =
+                        0x10000 +
+                        (((code & 0x3ff) << 10) |
+                            (message.charCodeAt(++index) & 0x3ff)); //NOSONAR
+                    blocks[i >> 2] |= (0xf0 | (code >> 18)) << SHIFT[i++ & 3];
+                    blocks[i >> 2] |=
+                        (0x80 | ((code >> 12) & 0x3f)) << SHIFT[i++ & 3];
+                    blocks[i >> 2] |=
+                        (0x80 | ((code >> 6) & 0x3f)) << SHIFT[i++ & 3];
+                    blocks[i >> 2] |= (0x80 | (code & 0x3f)) << SHIFT[i++ & 3];
+                }
+            }
+        }
+        state.lastByteIndex = i;
+        if (i >= byteCount) {
+            state.start = i - byteCount;
+            state.block = blocks[blockCount];
+            for (i = 0; i < blockCount; ++i) {
+                s[i] ^= blocks[i];
+            }
+            f(s);
+            state.reset = true;
+        } else {
+            state.start = i;
+        }
+    }
+
+    // finalize
+    i = state.lastByteIndex;
+    // @ts-ignore
+    blocks[i >> 2] |= KECCAK_PADDING[i & 3];
+    if (state.lastByteIndex === byteCount) {
+        blocks[0] = blocks[blockCount];
+        for (i = 1; i < blockCount + 1; ++i) {
+            blocks[i] = 0;
+        }
+    }
+    blocks[blockCount - 1] |= 0x80000000;
+    for (i = 0; i < blockCount; ++i) {
+        s[i] ^= blocks[i];
+    }
+    f(s);
+
+    // toString
+    var hex = "";
+    var block;
+    var j = 0;
+    i = 0; //NOSONAR
+    while (j < outputBlocks) {
+        for (i = 0; i < blockCount && j < outputBlocks; ++i, ++j) {
+            block = s[i];
+            hex +=
+                HEX_CHARS[(block >> 4) & 0x0f] +
+                HEX_CHARS[block & 0x0f] +
+                HEX_CHARS[(block >> 12) & 0x0f] +
+                HEX_CHARS[(block >> 8) & 0x0f] +
+                HEX_CHARS[(block >> 20) & 0x0f] +
+                HEX_CHARS[(block >> 16) & 0x0f] +
+                HEX_CHARS[(block >> 28) & 0x0f] +
+                HEX_CHARS[(block >> 24) & 0x0f];
+        }
+        if (j % blockCount === 0) {
+            f(s);
+            i = 0; //NOSONAR
+        }
+    }
+    // @ts-ignore
+    return "0x" + hex;
+};
+
+/** @type {(s: number[]) => void} */
+const f = (s) => {
+    var h,
+        l,
+        n,
+        c0,
+        c1,
+        c2,
+        c3,
+        c4,
+        c5,
+        c6,
+        c7,
+        c8,
+        c9,
+        b0,
+        b1,
+        b2,
+        b3,
+        b4,
+        b5,
+        b6,
+        b7,
+        b8,
+        b9,
+        b10,
+        b11,
+        b12,
+        b13,
+        b14,
+        b15,
+        b16,
+        b17,
+        b18,
+        b19,
+        b20,
+        b21,
+        b22,
+        b23,
+        b24,
+        b25,
+        b26,
+        b27,
+        b28,
+        b29,
+        b30,
+        b31,
+        b32,
+        b33,
+        b34,
+        b35,
+        b36,
+        b37,
+        b38,
+        b39,
+        b40,
+        b41,
+        b42,
+        b43,
+        b44,
+        b45,
+        b46,
+        b47,
+        b48,
+        b49;
+
+    for (n = 0; n < 48; n += 2) {
+        c0 = s[0] ^ s[10] ^ s[20] ^ s[30] ^ s[40];
+        c1 = s[1] ^ s[11] ^ s[21] ^ s[31] ^ s[41];
+        c2 = s[2] ^ s[12] ^ s[22] ^ s[32] ^ s[42];
+        c3 = s[3] ^ s[13] ^ s[23] ^ s[33] ^ s[43];
+        c4 = s[4] ^ s[14] ^ s[24] ^ s[34] ^ s[44];
+        c5 = s[5] ^ s[15] ^ s[25] ^ s[35] ^ s[45];
+        c6 = s[6] ^ s[16] ^ s[26] ^ s[36] ^ s[46];
+        c7 = s[7] ^ s[17] ^ s[27] ^ s[37] ^ s[47];
+        c8 = s[8] ^ s[18] ^ s[28] ^ s[38] ^ s[48];
+        c9 = s[9] ^ s[19] ^ s[29] ^ s[39] ^ s[49];
+
+        h = c8 ^ ((c2 << 1) | (c3 >>> 31));
+        l = c9 ^ ((c3 << 1) | (c2 >>> 31));
+        s[0] ^= h;
+        s[1] ^= l;
+        s[10] ^= h;
+        s[11] ^= l;
+        s[20] ^= h;
+        s[21] ^= l;
+        s[30] ^= h;
+        s[31] ^= l;
+        s[40] ^= h;
+        s[41] ^= l;
+        h = c0 ^ ((c4 << 1) | (c5 >>> 31));
+        l = c1 ^ ((c5 << 1) | (c4 >>> 31));
+        s[2] ^= h;
+        s[3] ^= l;
+        s[12] ^= h;
+        s[13] ^= l;
+        s[22] ^= h;
+        s[23] ^= l;
+        s[32] ^= h;
+        s[33] ^= l;
+        s[42] ^= h;
+        s[43] ^= l;
+        h = c2 ^ ((c6 << 1) | (c7 >>> 31));
+        l = c3 ^ ((c7 << 1) | (c6 >>> 31));
+        s[4] ^= h;
+        s[5] ^= l;
+        s[14] ^= h;
+        s[15] ^= l;
+        s[24] ^= h;
+        s[25] ^= l;
+        s[34] ^= h;
+        s[35] ^= l;
+        s[44] ^= h;
+        s[45] ^= l;
+        h = c4 ^ ((c8 << 1) | (c9 >>> 31));
+        l = c5 ^ ((c9 << 1) | (c8 >>> 31));
+        s[6] ^= h;
+        s[7] ^= l;
+        s[16] ^= h;
+        s[17] ^= l;
+        s[26] ^= h;
+        s[27] ^= l;
+        s[36] ^= h;
+        s[37] ^= l;
+        s[46] ^= h;
+        s[47] ^= l;
+        h = c6 ^ ((c0 << 1) | (c1 >>> 31));
+        l = c7 ^ ((c1 << 1) | (c0 >>> 31));
+        s[8] ^= h;
+        s[9] ^= l;
+        s[18] ^= h;
+        s[19] ^= l;
+        s[28] ^= h;
+        s[29] ^= l;
+        s[38] ^= h;
+        s[39] ^= l;
+        s[48] ^= h;
+        s[49] ^= l;
+
+        b0 = s[0];
+        b1 = s[1];
+        b32 = (s[11] << 4) | (s[10] >>> 28);
+        b33 = (s[10] << 4) | (s[11] >>> 28);
+        b14 = (s[20] << 3) | (s[21] >>> 29);
+        b15 = (s[21] << 3) | (s[20] >>> 29);
+        b46 = (s[31] << 9) | (s[30] >>> 23);
+        b47 = (s[30] << 9) | (s[31] >>> 23);
+        b28 = (s[40] << 18) | (s[41] >>> 14);
+        b29 = (s[41] << 18) | (s[40] >>> 14);
+        b20 = (s[2] << 1) | (s[3] >>> 31);
+        b21 = (s[3] << 1) | (s[2] >>> 31);
+        b2 = (s[13] << 12) | (s[12] >>> 20);
+        b3 = (s[12] << 12) | (s[13] >>> 20);
+        b34 = (s[22] << 10) | (s[23] >>> 22);
+        b35 = (s[23] << 10) | (s[22] >>> 22);
+        b16 = (s[33] << 13) | (s[32] >>> 19);
+        b17 = (s[32] << 13) | (s[33] >>> 19);
+        b48 = (s[42] << 2) | (s[43] >>> 30);
+        b49 = (s[43] << 2) | (s[42] >>> 30);
+        b40 = (s[5] << 30) | (s[4] >>> 2);
+        b41 = (s[4] << 30) | (s[5] >>> 2);
+        b22 = (s[14] << 6) | (s[15] >>> 26);
+        b23 = (s[15] << 6) | (s[14] >>> 26);
+        b4 = (s[25] << 11) | (s[24] >>> 21);
+        b5 = (s[24] << 11) | (s[25] >>> 21);
+        b36 = (s[34] << 15) | (s[35] >>> 17);
+        b37 = (s[35] << 15) | (s[34] >>> 17);
+        b18 = (s[45] << 29) | (s[44] >>> 3);
+        b19 = (s[44] << 29) | (s[45] >>> 3);
+        b10 = (s[6] << 28) | (s[7] >>> 4);
+        b11 = (s[7] << 28) | (s[6] >>> 4);
+        b42 = (s[17] << 23) | (s[16] >>> 9);
+        b43 = (s[16] << 23) | (s[17] >>> 9);
+        b24 = (s[26] << 25) | (s[27] >>> 7);
+        b25 = (s[27] << 25) | (s[26] >>> 7);
+        b6 = (s[36] << 21) | (s[37] >>> 11);
+        b7 = (s[37] << 21) | (s[36] >>> 11);
+        b38 = (s[47] << 24) | (s[46] >>> 8);
+        b39 = (s[46] << 24) | (s[47] >>> 8);
+        b30 = (s[8] << 27) | (s[9] >>> 5);
+        b31 = (s[9] << 27) | (s[8] >>> 5);
+        b12 = (s[18] << 20) | (s[19] >>> 12);
+        b13 = (s[19] << 20) | (s[18] >>> 12);
+        b44 = (s[29] << 7) | (s[28] >>> 25);
+        b45 = (s[28] << 7) | (s[29] >>> 25);
+        b26 = (s[38] << 8) | (s[39] >>> 24);
+        b27 = (s[39] << 8) | (s[38] >>> 24);
+        b8 = (s[48] << 14) | (s[49] >>> 18);
+        b9 = (s[49] << 14) | (s[48] >>> 18);
+
+        s[0] = b0 ^ (~b2 & b4);
+        s[1] = b1 ^ (~b3 & b5);
+        s[10] = b10 ^ (~b12 & b14);
+        s[11] = b11 ^ (~b13 & b15);
+        s[20] = b20 ^ (~b22 & b24);
+        s[21] = b21 ^ (~b23 & b25);
+        s[30] = b30 ^ (~b32 & b34);
+        s[31] = b31 ^ (~b33 & b35);
+        s[40] = b40 ^ (~b42 & b44);
+        s[41] = b41 ^ (~b43 & b45);
+        s[2] = b2 ^ (~b4 & b6);
+        s[3] = b3 ^ (~b5 & b7);
+        s[12] = b12 ^ (~b14 & b16);
+        s[13] = b13 ^ (~b15 & b17);
+        s[22] = b22 ^ (~b24 & b26);
+        s[23] = b23 ^ (~b25 & b27);
+        s[32] = b32 ^ (~b34 & b36);
+        s[33] = b33 ^ (~b35 & b37);
+        s[42] = b42 ^ (~b44 & b46);
+        s[43] = b43 ^ (~b45 & b47);
+        s[4] = b4 ^ (~b6 & b8);
+        s[5] = b5 ^ (~b7 & b9);
+        s[14] = b14 ^ (~b16 & b18);
+        s[15] = b15 ^ (~b17 & b19);
+        s[24] = b24 ^ (~b26 & b28);
+        s[25] = b25 ^ (~b27 & b29);
+        s[34] = b34 ^ (~b36 & b38);
+        s[35] = b35 ^ (~b37 & b39);
+        s[44] = b44 ^ (~b46 & b48);
+        s[45] = b45 ^ (~b47 & b49);
+        s[6] = b6 ^ (~b8 & b0);
+        s[7] = b7 ^ (~b9 & b1);
+        s[16] = b16 ^ (~b18 & b10);
+        s[17] = b17 ^ (~b19 & b11);
+        s[26] = b26 ^ (~b28 & b20);
+        s[27] = b27 ^ (~b29 & b21);
+        s[36] = b36 ^ (~b38 & b30);
+        s[37] = b37 ^ (~b39 & b31);
+        s[46] = b46 ^ (~b48 & b40);
+        s[47] = b47 ^ (~b49 & b41);
+        s[8] = b8 ^ (~b0 & b2);
+        s[9] = b9 ^ (~b1 & b3);
+        s[18] = b18 ^ (~b10 & b12);
+        s[19] = b19 ^ (~b11 & b13);
+        s[28] = b28 ^ (~b20 & b22);
+        s[29] = b29 ^ (~b21 & b23);
+        s[38] = b38 ^ (~b30 & b32);
+        s[39] = b39 ^ (~b31 & b33);
+        s[48] = b48 ^ (~b40 & b42);
+        s[49] = b49 ^ (~b41 & b43);
+
+        s[0] ^= RC[n];
+        s[1] ^= RC[n + 1];
+    }
+};
+
+const keccak = (/** @type {number} */ bits) => (/** @type {string} */ str) => {
+    var msg;
+    if (str.slice(0, 2) === "0x") {
+        msg = [];
+        for (var i = 2, l = str.length; i < l; i += 2)
+            msg.push(parseInt(str.slice(i, i + 2), 16));
+    } else {
+        msg = str;
+    }
+    // @ts-ignore
+    return update(Keccak(bits), msg);
+};
+
+/**
+ * @type {(message: string) => string}
+ */
+export const keccak256 = keccak(256);

package/src/cryptography/sha384.browser.js

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * @param {Uint8Array} data
+ * @returns {Promise<Uint8Array>}
+ */
+export async function digest(data) {
+    // https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/digest
+    // This will be executed in a browser environment so the crypto object should be available if its
+    // in secure context.
+    // eslint-disable-next-line n/no-unsupported-features/node-builtins
+    return new Uint8Array(await window.crypto.subtle.digest("SHA-384", data));
+}

package/src/cryptography/sha384.js

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: Apache-2.0
+
+import crypto from "crypto";
+
+/**
+ * @param {Uint8Array} data
+ * @returns {Promise<Uint8Array>}
+ */
+export function digest(data) {
+    // fallback to trying node-crypto which could be polyfilled by the browser environment
+    return Promise.resolve(crypto.createHash("sha384").update(data).digest());
+}
+
+/**
+ * @param {Uint8Array} data
+ * @returns {Uint8Array}
+ */
+export function digestSync(data) {
+    return crypto.createHash("sha384").update(data).digest();
+}

package/src/cryptography/sha384.native.js

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+
+import CryptoJS from "crypto-js";
+import * as hex from "../encoding/hex.js";
+
+/**
+ * @param {Uint8Array} data
+ * @returns {Promise<Uint8Array>}
+ */
+// eslint-disable-next-line @typescript-eslint/require-await
+export async function digest(data) {
+    return Promise.resolve(
+        hex.decode(
+            CryptoJS.SHA384(CryptoJS.enc.Hex.parse(hex.encode(data))).toString(
+                CryptoJS.enc.Hex,
+            ),
+        ),
+    );
+}

package/src/encoding/base64.native.js

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+
+import { atob, btoa } from "js-base64";
+
+/**
+ * @param {string} text
+ * @returns {Uint8Array}
+ */
+export function decode(text) {
+    return Uint8Array.from(atob(text), (c) => c.charCodeAt(0));
+}
+
+/**
+ * @param {Uint8Array} data
+ * @returns {string};
+ */
+export function encode(data) {
+    return btoa(String.fromCharCode.apply(null, Array.from(data)));
+}