starknet 3.14.1 → 3.15.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [3.15.0](https://github.com/0xs34n/starknet.js/compare/v3.14.1...v3.15.0) (2022-06-16)
+
+### Bug Fixes
+
+- **tests:** update test ([c71f482](https://github.com/0xs34n/starknet.js/commit/c71f482facdaac914c45f4bf91f48e05a930abff))
+
+### Features
+
+- add calculateContractAddressFromHash ([e22c346](https://github.com/0xs34n/starknet.js/commit/e22c3464036f97eee3c617d3790aac35b3d95379))
+
 ## [3.14.1](https://github.com/0xs34n/starknet.js/compare/v3.14.0...v3.14.1) (2022-06-15)
 
 ### Bug Fixes

package/__tests__/utils/utils.test.ts

@@ -1,6 +1,7 @@
 import fs from 'fs';
 
 import { constants, hash, json, number, stark } from '../../src';
+import { pedersen } from '../../src/utils/hash';
 
 const { IS_BROWSER } = constants;
 
@@ -87,3 +88,29 @@ describe('estimatedFeeToMaxFee()', () => {
     expect(res).toBe(11_500);
   });
 });
+
+describe('calculateContractAddressFromHash()', () => {
+  // This test just show how to use calculateContractAddressFromHash for new devs
+
+  test('calculated contract address should match the snapshot', () => {
+    const ethAddress = '0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7';
+
+    const daiAddress = '0x03e85bfbb8e2a42b7bead9e88e9a1b19dbccf661471061807292120462396ec9';
+    const factoryAddress = '0x249827618A01858A72B7D04339C47195A324D20D6037033DFE2829F98AFF4FC';
+    const classHash = '0x55187E68C60664A947048E0C9E5322F9BF55F7D435ECDCF17ED75724E77368F';
+
+    // Any type of salt can be used. It depends on the dApp what kind of salt it wants to use.
+    const salt = pedersen([ethAddress, daiAddress]);
+
+    const res = hash.calculateContractAddressFromHash(
+      salt,
+      classHash,
+      [ethAddress, daiAddress, factoryAddress],
+      factoryAddress
+    );
+
+    expect(res).toMatchInlineSnapshot(
+      `"0x36dc8dcb3440596472ddde11facacc45d0cd250df764ae7c3d1a360c853c324"`
+    );
+  });
+});

package/dist/utils/hash.d.ts

@@ -1,5 +1,6 @@
 import BN from 'bn.js';
 import { StarknetChainId, TransactionHashPrefix } from '../constants';
+import { RawCalldata } from '../types/lib';
 import { BigNumberish } from './number';
 export declare const transactionVersion = 0;
 export declare const feeTransactionVersion: BN;
@@ -24,3 +25,4 @@ export declare function computeHashOnElements(data: BigNumberish[]): string;
 export declare function calculateTransactionHashCommon(txHashPrefix: TransactionHashPrefix, version: BigNumberish, contractAddress: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId, additionalData?: BigNumberish[]): string;
 export declare function calculateDeployTransactionHash(contractAddress: BigNumberish, constructorCalldata: BigNumberish[], version: BigNumberish, chainId: StarknetChainId): string;
 export declare function calculcateTransactionHash(contractAddress: BigNumberish, version: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId): string;
+export declare function calculateContractAddressFromHash(salt: BigNumberish, classHash: BigNumberish, constructorCalldata: RawCalldata, deployerAddress: BigNumberish): string;

package/dist/utils/hash.js

@@ -28,7 +28,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculcateTransactionHash = exports.calculateDeployTransactionHash = exports.calculateTransactionHashCommon = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = exports.feeTransactionVersion = exports.transactionVersion = void 0;
+exports.calculateContractAddressFromHash = exports.calculcateTransactionHash = exports.calculateDeployTransactionHash = exports.calculateTransactionHashCommon = exports.computeHashOnElements = exports.pedersen = exports.getSelectorFromName = exports.starknetKeccak = exports.feeTransactionVersion = exports.transactionVersion = void 0;
 var keccak_1 = require("ethereum-cryptography/keccak");
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
 var constants_1 = require("../constants");
@@ -112,3 +112,16 @@ function calculcateTransactionHash(contractAddress, version, entryPointSelector,
     return calculateTransactionHashCommon(constants_1.TransactionHashPrefix.INVOKE, version, contractAddress, entryPointSelector, calldata, maxFee, chainId);
 }
 exports.calculcateTransactionHash = calculcateTransactionHash;
+function calculateContractAddressFromHash(salt, classHash, constructorCalldata, deployerAddress) {
+    var constructorCalldataHash = computeHashOnElements(constructorCalldata);
+    var CONTRACT_ADDRESS_PREFIX = (0, number_1.toFelt)('0x535441524b4e45545f434f4e54524143545f41444452455353'); // Equivalent to 'STARKNET_CONTRACT_ADDRESS'
+    var dataToHash = [
+        CONTRACT_ADDRESS_PREFIX,
+        deployerAddress,
+        salt,
+        classHash,
+        constructorCalldataHash,
+    ];
+    return computeHashOnElements(dataToHash);
+}
+exports.calculateContractAddressFromHash = calculateContractAddressFromHash;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.14.1",
+  "version": "3.15.0",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/utils/hash.ts

@@ -11,9 +11,10 @@ import {
   TransactionHashPrefix,
   ZERO,
 } from '../constants';
+import { RawCalldata } from '../types/lib';
 import { ec } from './ellipticCurve';
 import { addHexPrefix, buf2hex, utf8ToArray } from './encode';
-import { BigNumberish, toBN, toHex } from './number';
+import { BigNumberish, toBN, toFelt, toHex } from './number';
 
 export const transactionVersion = 0;
 export const feeTransactionVersion = toBN(2).pow(toBN(128)).add(toBN(transactionVersion));
@@ -132,3 +133,24 @@ export function calculcateTransactionHash(
     chainId
   );
 }
+
+export function calculateContractAddressFromHash(
+  salt: BigNumberish,
+  classHash: BigNumberish,
+  constructorCalldata: RawCalldata,
+  deployerAddress: BigNumberish
+) {
+  const constructorCalldataHash = computeHashOnElements(constructorCalldata);
+
+  const CONTRACT_ADDRESS_PREFIX = toFelt('0x535441524b4e45545f434f4e54524143545f41444452455353'); // Equivalent to 'STARKNET_CONTRACT_ADDRESS'
+
+  const dataToHash = [
+    CONTRACT_ADDRESS_PREFIX,
+    deployerAddress,
+    salt,
+    classHash,
+    constructorCalldataHash,
+  ];
+
+  return computeHashOnElements(dataToHash);
+}

package/utils/hash.d.ts

@@ -1,6 +1,7 @@
 import BN from 'bn.js';
 
 import { StarknetChainId, TransactionHashPrefix } from '../constants';
+import { RawCalldata } from '../types/lib';
 import { BigNumberish } from './number';
 export declare const transactionVersion = 0;
 export declare const feeTransactionVersion: BN;
@@ -46,3 +47,9 @@ export declare function calculcateTransactionHash(
   maxFee: BigNumberish,
   chainId: StarknetChainId
 ): string;
+export declare function calculateContractAddressFromHash(
+  salt: BigNumberish,
+  classHash: BigNumberish,
+  constructorCalldata: RawCalldata,
+  deployerAddress: BigNumberish
+): string;

package/utils/hash.js

@@ -39,7 +39,8 @@ var __importDefault =
     return mod && mod.__esModule ? mod : { default: mod };
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.calculcateTransactionHash =
+exports.calculateContractAddressFromHash =
+  exports.calculcateTransactionHash =
   exports.calculateDeployTransactionHash =
   exports.calculateTransactionHashCommon =
   exports.computeHashOnElements =
@@ -174,3 +175,18 @@ function calculcateTransactionHash(
   );
 }
 exports.calculcateTransactionHash = calculcateTransactionHash;
+function calculateContractAddressFromHash(salt, classHash, constructorCalldata, deployerAddress) {
+  var constructorCalldataHash = computeHashOnElements(constructorCalldata);
+  var CONTRACT_ADDRESS_PREFIX = (0, number_1.toFelt)(
+    '0x535441524b4e45545f434f4e54524143545f41444452455353'
+  ); // Equivalent to 'STARKNET_CONTRACT_ADDRESS'
+  var dataToHash = [
+    CONTRACT_ADDRESS_PREFIX,
+    deployerAddress,
+    salt,
+    classHash,
+    constructorCalldataHash,
+  ];
+  return computeHashOnElements(dataToHash);
+}
+exports.calculateContractAddressFromHash = calculateContractAddressFromHash;