starknet 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [4.2.0](https://github.com/0xs34n/starknet.js/compare/v4.1.0...v4.2.0) (2022-08-09)
+
+### Features
+
+- change checksum address hashing algorithm ([0f32adf](https://github.com/0xs34n/starknet.js/commit/0f32adf217b3d2e55046bbb21980648f0c8cf631))
+
 # [4.1.0](https://github.com/0xs34n/starknet.js/compare/v4.0.1...v4.1.0) (2022-08-03)
 
 ### Features

package/__tests__/utils/address.test.ts

@@ -26,12 +26,12 @@ describe('address checksums', () => {
       '0x2fd23d9182193775423497fc0c472e156c57c69e4089a1967fb288a2d84e914'
     );
     expect(checksumAddress).toEqual(
-      '0x02FD23D9182193775423497Fc0c472E156C57C69E4089a1967fb288a2D84e914'
+      '0x02Fd23d9182193775423497fc0c472E156C57C69E4089A1967fb288A2d84e914'
     );
   });
   test('should be able to verify checksum address', () => {
     const isValid = validateChecksumAddress(
-      '0x02FD23D9182193775423497Fc0c472E156C57C69E4089a1967fb288a2D84e914'
+      '0x02Fd23d9182193775423497fc0c472E156C57C69E4089A1967fb288A2d84e914'
     );
     expect(isValid).toEqual(true);
   });

package/dist/utils/address.js

@@ -23,7 +23,7 @@ exports.validateAndParseAddress = validateAndParseAddress;
 // from https://github.com/ethers-io/ethers.js/blob/fc1e006575d59792fa97b4efb9ea2f8cca1944cf/packages/address/src.ts/index.ts#L12
 function getChecksumAddress(address) {
     var chars = (0, encode_1.removeHexPrefix)(validateAndParseAddress(address)).toLowerCase().split('');
-    var hashed = (0, bytes_1.arrayify)((0, hash_1.pedersen)([0, address]), { hexPad: 'left' }); // as the hash will be 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
+    var hashed = (0, bytes_1.arrayify)((0, hash_1.keccakBn)(address), { hexPad: 'left' }); // in case the hash is 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
     for (var i = 0; i < chars.length; i += 2) {
         if (hashed[i >> 1] >> 4 >= 8) {
             chars[i] = chars[i].toUpperCase();

package/dist/utils/hash.d.ts

@@ -4,6 +4,7 @@ import { RawCalldata } from '../types/lib';
 import { BigNumberish } from './number';
 export declare const transactionVersion = 0;
 export declare const feeTransactionVersion: BN;
+export declare function keccakBn(value: BigNumberish): string;
 /**
  * Function to get the starknet keccak hash from a string
  *

package/dist/utils/hash.js

@@ -28,8 +28,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateContractAddressFromHash = 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.keccakBn = exports.feeTransactionVersion = exports.transactionVersion = void 0;
 var keccak_1 = require("ethereum-cryptography/keccak");
+var utils_1 = require("ethereum-cryptography/utils");
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
 var constants_1 = require("../constants");
 var ellipticCurve_1 = require("./ellipticCurve");
@@ -37,6 +38,12 @@ var encode_1 = require("./encode");
 var number_1 = require("./number");
 exports.transactionVersion = 0;
 exports.feeTransactionVersion = (0, number_1.toBN)(2).pow((0, number_1.toBN)(128)).add((0, number_1.toBN)(exports.transactionVersion));
+function keccakBn(value) {
+    var hexWithoutPrefix = (0, encode_1.removeHexPrefix)((0, number_1.toHex)((0, number_1.toBN)(value)));
+    var evenHex = hexWithoutPrefix.length % 2 === 0 ? hexWithoutPrefix : "0".concat(hexWithoutPrefix);
+    return (0, encode_1.addHexPrefix)((0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, utils_1.hexToBytes)(evenHex))));
+}
+exports.keccakBn = keccakBn;
 function keccakHex(value) {
     return (0, encode_1.addHexPrefix)((0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, encode_1.utf8ToArray)(value))));
 }

package/package.json

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

package/src/utils/address.ts

@@ -3,7 +3,7 @@ import { arrayify } from '@ethersproject/bytes';
 
 import { MASK_251, ZERO } from '../constants';
 import { addHexPrefix, removeHexPrefix } from './encode';
-import { pedersen } from './hash';
+import { keccakBn } from './hash';
 import { BigNumberish, assertInRange, toBN, toHex } from './number';
 
 export function addAddressPadding(address: BigNumberish): string {
@@ -25,7 +25,7 @@ export function validateAndParseAddress(address: BigNumberish): string {
 // from https://github.com/ethers-io/ethers.js/blob/fc1e006575d59792fa97b4efb9ea2f8cca1944cf/packages/address/src.ts/index.ts#L12
 export function getChecksumAddress(address: BigNumberish): string {
   const chars = removeHexPrefix(validateAndParseAddress(address)).toLowerCase().split('');
-  const hashed = arrayify(pedersen([0, address]), { hexPad: 'left' }); // as the hash will be 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
+  const hashed = arrayify(keccakBn(address), { hexPad: 'left' }); // in case the hash is 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
 
   for (let i = 0; i < chars.length; i += 2) {
     if (hashed[i >> 1] >> 4 >= 8) {

package/src/utils/hash.ts

@@ -1,5 +1,6 @@
 import BN from 'bn.js';
 import { keccak256 } from 'ethereum-cryptography/keccak';
+import { hexToBytes } from 'ethereum-cryptography/utils';
 import assert from 'minimalistic-assert';
 
 import {
@@ -13,12 +14,18 @@ import {
 } from '../constants';
 import { RawCalldata } from '../types/lib';
 import { ec } from './ellipticCurve';
-import { addHexPrefix, buf2hex, utf8ToArray } from './encode';
+import { addHexPrefix, buf2hex, removeHexPrefix, utf8ToArray } from './encode';
 import { BigNumberish, toBN, toFelt, toHex } from './number';
 
 export const transactionVersion = 0;
 export const feeTransactionVersion = toBN(2).pow(toBN(128)).add(toBN(transactionVersion));
 
+export function keccakBn(value: BigNumberish): string {
+  const hexWithoutPrefix = removeHexPrefix(toHex(toBN(value)));
+  const evenHex = hexWithoutPrefix.length % 2 === 0 ? hexWithoutPrefix : `0${hexWithoutPrefix}`;
+  return addHexPrefix(buf2hex(keccak256(hexToBytes(evenHex))));
+}
+
 function keccakHex(value: string): string {
   return addHexPrefix(buf2hex(keccak256(utf8ToArray(value))));
 }

package/utils/address.js

@@ -23,7 +23,7 @@ exports.validateAndParseAddress = validateAndParseAddress;
 // from https://github.com/ethers-io/ethers.js/blob/fc1e006575d59792fa97b4efb9ea2f8cca1944cf/packages/address/src.ts/index.ts#L12
 function getChecksumAddress(address) {
     var chars = (0, encode_1.removeHexPrefix)(validateAndParseAddress(address)).toLowerCase().split('');
-    var hashed = (0, bytes_1.arrayify)((0, hash_1.pedersen)([0, address]), { hexPad: 'left' }); // as the hash will be 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
+    var hashed = (0, bytes_1.arrayify)((0, hash_1.keccakBn)(address), { hexPad: 'left' }); // in case the hash is 251 bits (63 chars) we need to pad it to 64 chars without changing the number value ("left")
     for (var i = 0; i < chars.length; i += 2) {
         if (hashed[i >> 1] >> 4 >= 8) {
             chars[i] = chars[i].toUpperCase();

package/utils/hash.d.ts

@@ -4,6 +4,7 @@ import { RawCalldata } from '../types/lib';
 import { BigNumberish } from './number';
 export declare const transactionVersion = 0;
 export declare const feeTransactionVersion: BN;
+export declare function keccakBn(value: BigNumberish): string;
 /**
  * Function to get the starknet keccak hash from a string
  *

package/utils/hash.js

@@ -28,8 +28,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateContractAddressFromHash = 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.keccakBn = exports.feeTransactionVersion = exports.transactionVersion = void 0;
 var keccak_1 = require("ethereum-cryptography/keccak");
+var utils_1 = require("ethereum-cryptography/utils");
 var minimalistic_assert_1 = __importDefault(require("minimalistic-assert"));
 var constants_1 = require("../constants");
 var ellipticCurve_1 = require("./ellipticCurve");
@@ -37,6 +38,12 @@ var encode_1 = require("./encode");
 var number_1 = require("./number");
 exports.transactionVersion = 0;
 exports.feeTransactionVersion = (0, number_1.toBN)(2).pow((0, number_1.toBN)(128)).add((0, number_1.toBN)(exports.transactionVersion));
+function keccakBn(value) {
+    var hexWithoutPrefix = (0, encode_1.removeHexPrefix)((0, number_1.toHex)((0, number_1.toBN)(value)));
+    var evenHex = hexWithoutPrefix.length % 2 === 0 ? hexWithoutPrefix : "0".concat(hexWithoutPrefix);
+    return (0, encode_1.addHexPrefix)((0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, utils_1.hexToBytes)(evenHex))));
+}
+exports.keccakBn = keccakBn;
 function keccakHex(value) {
     return (0, encode_1.addHexPrefix)((0, encode_1.buf2hex)((0, keccak_1.keccak256)((0, encode_1.utf8ToArray)(value))));
 }

package/www/guides/account.md

@@ -14,7 +14,6 @@ Install the latest version of starknet with `npm install starknet@next`
 
 ```javascript
 import fs from "fs";
-import fs from "fs";
 import {
   Account,
   Contract,
@@ -42,12 +41,31 @@ Deploy the Account contract and wait for it to be verified on StarkNet.
 const compiledAccount = json.parse(
   fs.readFileSync("./Account.json").toString("ascii")
 );
+```
+
+> **Note** 
+> 
+> below example uses [Argent's](https://github.com/argentlabs/argent-contracts-starknet/blob/develop/contracts/ArgentAccount.cairo) account contract 
+
+```javascript
 const accountResponse = await defaultProvider.deployContract({
   contract: compiledAccount,
   addressSalt: starkKeyPub,
 });
 ```
 
+> **Note** 
+> 
+> below example uses [OpenZeppelin's](https://github.com/OpenZeppelin/cairo-contracts/blob/main/src/openzeppelin/account/presets/Account.cairo) account contract 
+
+```javascript
+const accountResponse = await defaultProvider.deployContract({
+    contract: compiledAccount,
+    constructorCalldata: [starkKeyPub],
+    addressSalt: starkKeyPub,
+});
+```
+
 ## Use your new account
 
 Wait for the deployment transaction to be accepted and assign the address of the deployed account to the Account object.
@@ -56,7 +74,11 @@ Wait for the deployment transaction to be accepted and assign the address of the
 await defaultProvider.waitForTransaction(accountResponse.transaction_hash);
 ```
 
-Once account contract is deployed [Account](../docs/API/account.md) instance can be created. Use your new account instance to sign transactions, messages or verify signatures! Make sure your Account has enough funds to execute invocations.
+Once account contract is deployed [Account](../docs/API/account.md) instance can be created. Use your new account instance to sign transactions, messages or verify signatures! 
+
+> **Note**
+> 
+> Make sure your Account has enough funds to execute invocations. Use this [faucet](https://faucet.goerli.starknet.io/) for funding on testnet.
 
 ```js
 const account = new Account(