starknet 3.16.3 → 3.18.1

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [3.18.1](https://github.com/0xs34n/starknet.js/compare/v3.18.0...v3.18.1) (2022-07-23)
+
+### Bug Fixes
+
+- struct array hashing ([e1f82df](https://github.com/0xs34n/starknet.js/commit/e1f82dfd575be4c84b291c33f8169bf367493603))
+
+# [3.18.0](https://github.com/0xs34n/starknet.js/compare/v3.17.0...v3.18.0) (2022-07-23)
+
+### Features
+
+- **cairo-0.9.1:** starknet_version in block response ([e88154d](https://github.com/0xs34n/starknet.js/commit/e88154d5f6fcd6695dca5d29da04d18d0a65cdf6))
+
+# [3.17.0](https://github.com/0xs34n/starknet.js/compare/v3.16.3...v3.17.0) (2022-07-15)
+
+### Features
+
+- support SN 0.9.1 estimate_fee response ([9302aab](https://github.com/0xs34n/starknet.js/commit/9302aab9cbbe5eaa3a9933b19f8f46b2dd6d6a1d))
+
 ## [3.16.3](https://github.com/0xs34n/starknet.js/compare/v3.16.2...v3.16.3) (2022-07-15)
 
 ### Bug Fixes

package/__mocks__/typedDataStructArrayExample.json

@@ -0,0 +1,44 @@
+{
+  "types": {
+    "StarkNetDomain": [
+      { "name": "name", "type": "felt" },
+      { "name": "version", "type": "felt" },
+      { "name": "chainId", "type": "felt" }
+    ],
+    "Person": [
+      { "name": "name", "type": "felt" },
+      { "name": "wallet", "type": "felt" }
+    ],
+    "Post": [
+      { "name": "title", "type": "felt" },
+      { "name": "content", "type": "felt" }
+    ],
+    "Mail": [
+      { "name": "from", "type": "Person" },
+      { "name": "to", "type": "Person" },
+      { "name": "posts_len", "type": "felt" },
+      { "name": "posts", "type": "Post*" }
+    ]
+  },
+  "primaryType": "Mail",
+  "domain": {
+    "name": "StarkNet Mail",
+    "version": "1",
+    "chainId": 1
+  },
+  "message": {
+    "from": {
+      "name": "Cow",
+      "wallet": "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"
+    },
+    "to": {
+      "name": "Bob",
+      "wallet": "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB"
+    },
+    "posts_len": 2,
+    "posts": [
+      { "title": "Greeting", "content": "Hello, Bob!" },
+      { "title": "Farewell", "content": "Goodbye, Bob!" }
+    ]
+  }
+}

package/__tests__/utils/typedData.test.ts

@@ -1,4 +1,5 @@
 import typedDataExample from '../../__mocks__/typedDataExample.json';
+import typedDataStructArrayExample from '../../__mocks__/typedDataStructArrayExample.json';
 import { number } from '../../src';
 import { BigNumberish } from '../../src/utils/number';
 import { encodeType, getMessageHash, getStructHash, getTypeHash } from '../../src/utils/typedData';
@@ -9,7 +10,12 @@ describe('typedData', () => {
     expect(typeEncoding).toMatchInlineSnapshot(
       `"Mail(from:Person,to:Person,contents:felt)Person(name:felt,wallet:felt)"`
     );
+    const typeEncodingStructArr = encodeType(typedDataStructArrayExample, 'Mail');
+    expect(typeEncodingStructArr).toMatchInlineSnapshot(
+      `"Mail(from:Person,to:Person,posts_len:felt,posts:Post*)Person(name:felt,wallet:felt)Post(title:felt,content:felt)"`
+    );
   });
+
   test('should get right type hash', () => {
     const typeHashDomain = getTypeHash(typedDataExample, 'StarkNetDomain');
     expect(typeHashDomain).toMatchInlineSnapshot(
@@ -23,18 +29,36 @@ describe('typedData', () => {
     expect(typeHashMail).toMatchInlineSnapshot(
       `"0x13d89452df9512bf750f539ba3001b945576243288137ddb6c788457d4b2f79"`
     );
+    const typeHashPost = getTypeHash(typedDataStructArrayExample, 'Post');
+    expect(typeHashPost).toMatchInlineSnapshot(
+      `"0x1d71e69bf476486b43cdcfaf5a85c00bb2d954c042b281040e513080388356d"`
+    );
+    const typeHashMailWithStructArray = getTypeHash(typedDataStructArrayExample, 'Mail');
+    expect(typeHashMailWithStructArray).toMatchInlineSnapshot(
+      `"0x873b878e35e258fc99e3085d5aaad3a81a0c821f189c08b30def2cde55ff27"`
+    );
   });
+
   test('should get right hash for StarkNetDomain', () => {
     const hash = getStructHash(typedDataExample, 'StarkNetDomain', typedDataExample.domain as any);
     expect(hash).toMatchInlineSnapshot(
       `"0x54833b121883a3e3aebff48ec08a962f5742e5f7b973469c1f8f4f55d470b07"`
     );
   });
+
   test('should get right hash for entire message', () => {
     const hash = getMessageHash(typedDataExample, '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826');
     expect(hash).toMatchInlineSnapshot(
       `"0x6fcff244f63e38b9d88b9e3378d44757710d1b244282b435cb472053c8d78d0"`
     );
+
+    const hashStructArr = getMessageHash(
+      typedDataStructArrayExample,
+      '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826'
+    );
+    expect(hashStructArr).toMatchInlineSnapshot(
+      `"0x5914ed2764eca2e6a41eb037feefd3d2e33d9af6225a9e7fe31ac943ff712c"`
+    );
   });
 
   interface StringStruct {

package/account/default.js

@@ -24,20 +24,6 @@ var __extends =
       d.prototype = b === null ? Object.create(b) : ((__.prototype = b.prototype), new __());
     };
   })();
-var __assign =
-  (this && this.__assign) ||
-  function () {
-    __assign =
-      Object.assign ||
-      function (t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-          s = arguments[i];
-          for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
-        }
-        return t;
-      };
-    return __assign.apply(this, arguments);
-  };
 var __awaiter =
   (this && this.__awaiter) ||
   function (thisArg, _arguments, P, generator) {
@@ -251,34 +237,36 @@ var Account = /** @class */ (function (_super) {
     });
   };
   Account.prototype.estimateFee = function (calls, _a) {
-    var _b = _a === void 0 ? {} : _a,
-      providedNonce = _b.nonce,
-      _c = _b.blockIdentifier,
-      blockIdentifier = _c === void 0 ? 'pending' : _c;
+    var _b;
+    var _c = _a === void 0 ? {} : _a,
+      providedNonce = _c.nonce,
+      _d = _c.blockIdentifier,
+      blockIdentifier = _d === void 0 ? 'pending' : _d;
     return __awaiter(this, void 0, void 0, function () {
       var transactions,
         nonce,
-        _d,
+        _e,
         version,
         signerDetails,
         signature,
         calldata,
         fetchedEstimate,
+        fee,
         suggestedMaxFee;
-      return __generator(this, function (_e) {
-        switch (_e.label) {
+      return __generator(this, function (_f) {
+        switch (_f.label) {
           case 0:
             transactions = Array.isArray(calls) ? calls : [calls];
             if (!(providedNonce !== null && providedNonce !== void 0)) return [3 /*break*/, 1];
-            _d = providedNonce;
+            _e = providedNonce;
             return [3 /*break*/, 3];
           case 1:
             return [4 /*yield*/, this.getNonce()];
           case 2:
-            _d = _e.sent();
-            _e.label = 3;
+            _e = _f.sent();
+            _f.label = 3;
           case 3:
-            nonce = _d;
+            nonce = _e;
             version = (0, number_1.toBN)(hash_1.feeTransactionVersion);
             signerDetails = {
               walletAddress: this.address,
@@ -289,7 +277,7 @@ var Account = /** @class */ (function (_super) {
             };
             return [4 /*yield*/, this.signer.signTransaction(transactions, signerDetails)];
           case 4:
-            signature = _e.sent();
+            signature = _f.sent();
             calldata = (0, transaction_1.fromCallsToExecuteCalldataWithNonce)(transactions, nonce);
             return [
               4 /*yield*/,
@@ -306,11 +294,22 @@ var Account = /** @class */ (function (_super) {
               ),
             ];
           case 5:
-            fetchedEstimate = _e.sent();
-            suggestedMaxFee = (0, stark_1.estimatedFeeToMaxFee)(fetchedEstimate.amount);
+            fetchedEstimate = _f.sent();
+            fee =
+              (_b = fetchedEstimate.overall_fee) !== null && _b !== void 0
+                ? _b
+                : fetchedEstimate.amount;
+            if (fee === undefined) {
+              throw new Error('Expected either amount or overall_fee in estimate_fee response');
+            }
+            suggestedMaxFee = (0, stark_1.estimatedFeeToMaxFee)(fee);
             return [
               2 /*return*/,
-              __assign(__assign({}, fetchedEstimate), { suggestedMaxFee: suggestedMaxFee }),
+              {
+                amount: fee,
+                unit: fetchedEstimate.unit,
+                suggestedMaxFee: suggestedMaxFee,
+              },
             ];
         }
       });

package/dist/account/default.js

@@ -14,17 +14,6 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -128,22 +117,23 @@ var Account = /** @class */ (function (_super) {
         });
     };
     Account.prototype.estimateFee = function (calls, _a) {
-        var _b = _a === void 0 ? {} : _a, providedNonce = _b.nonce, _c = _b.blockIdentifier, blockIdentifier = _c === void 0 ? 'pending' : _c;
+        var _b;
+        var _c = _a === void 0 ? {} : _a, providedNonce = _c.nonce, _d = _c.blockIdentifier, blockIdentifier = _d === void 0 ? 'pending' : _d;
         return __awaiter(this, void 0, void 0, function () {
-            var transactions, nonce, _d, version, signerDetails, signature, calldata, fetchedEstimate, suggestedMaxFee;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
+            var transactions, nonce, _e, version, signerDetails, signature, calldata, fetchedEstimate, fee, suggestedMaxFee;
+            return __generator(this, function (_f) {
+                switch (_f.label) {
                     case 0:
                         transactions = Array.isArray(calls) ? calls : [calls];
                         if (!(providedNonce !== null && providedNonce !== void 0)) return [3 /*break*/, 1];
-                        _d = providedNonce;
+                        _e = providedNonce;
                         return [3 /*break*/, 3];
                     case 1: return [4 /*yield*/, this.getNonce()];
                     case 2:
-                        _d = (_e.sent());
-                        _e.label = 3;
+                        _e = (_f.sent());
+                        _f.label = 3;
                     case 3:
-                        nonce = _d;
+                        nonce = _e;
                         version = (0, number_1.toBN)(hash_1.feeTransactionVersion);
                         signerDetails = {
                             walletAddress: this.address,
@@ -154,7 +144,7 @@ var Account = /** @class */ (function (_super) {
                         };
                         return [4 /*yield*/, this.signer.signTransaction(transactions, signerDetails)];
                     case 4:
-                        signature = _e.sent();
+                        signature = _f.sent();
                         calldata = (0, transaction_1.fromCallsToExecuteCalldataWithNonce)(transactions, nonce);
                         return [4 /*yield*/, this.fetchEndpoint('estimate_fee', { blockIdentifier: blockIdentifier }, {
                                 contract_address: this.address,
@@ -164,9 +154,17 @@ var Account = /** @class */ (function (_super) {
                                 signature: (0, number_1.bigNumberishArrayToDecimalStringArray)(signature),
                             })];
                     case 5:
-                        fetchedEstimate = _e.sent();
-                        suggestedMaxFee = (0, stark_1.estimatedFeeToMaxFee)(fetchedEstimate.amount);
-                        return [2 /*return*/, __assign(__assign({}, fetchedEstimate), { suggestedMaxFee: suggestedMaxFee })];
+                        fetchedEstimate = _f.sent();
+                        fee = (_b = fetchedEstimate.overall_fee) !== null && _b !== void 0 ? _b : fetchedEstimate.amount;
+                        if (fee === undefined) {
+                            throw new Error('Expected either amount or overall_fee in estimate_fee response');
+                        }
+                        suggestedMaxFee = (0, stark_1.estimatedFeeToMaxFee)(fee);
+                        return [2 /*return*/, {
+                                amount: fee,
+                                unit: fetchedEstimate.unit,
+                                suggestedMaxFee: suggestedMaxFee,
+                            }];
                 }
             });
         });

package/dist/types/account.d.ts

@@ -1,8 +1,9 @@
 import BN from 'bn.js';
 import { BlockIdentifier } from '../provider/utils';
 import { BigNumberish } from '../utils/number';
-import { EstimateFeeResponse } from './api';
-export interface EstimateFee extends EstimateFeeResponse {
+export interface EstimateFee {
+    amount: BN;
+    unit: string;
     suggestedMaxFee: BN;
 }
 export interface EstimateFeeDetails {

package/dist/types/api.d.ts

@@ -167,6 +167,7 @@ export declare type GetBlockResponse = {
     parent_block_hash: string;
     status: Status;
     gas_price: string;
+    starknet_version?: string;
 };
 export declare type GetCodeResponse = {
     bytecode: string[];
@@ -240,8 +241,11 @@ export declare type FailedTransactionReceiptResponse = {
 };
 export declare type TransactionReceiptResponse = SuccessfulTransactionReceiptResponse | FailedTransactionReceiptResponse;
 export declare type EstimateFeeResponse = {
-    amount: BN;
+    overall_fee?: BN;
+    amount?: BN;
     unit: string;
+    gas_price?: BN;
+    gas_usage?: BigNumberish;
 };
 export declare type RawArgs = {
     [inputName: string]: string | string[] | {

package/dist/utils/typedData/index.js

@@ -71,6 +71,11 @@ var getDependencies = function (typedData, type, dependencies) {
     if (!(0, utils_1.validateTypedData)(typedData)) {
         throw new Error('Typed data does not match JSON schema');
     }
+    // Include pointers (struct arrays)
+    if (type[type.length - 1] === '*') {
+        // eslint-disable-next-line no-param-reassign
+        type = type.slice(0, -1);
+    }
     if (dependencies.includes(type)) {
         return dependencies;
     }
@@ -124,6 +129,15 @@ var encodeValue = function (typedData, type, data) {
         // eslint-disable-next-line @typescript-eslint/no-use-before-define
         return [type, (0, exports.getStructHash)(typedData, type, data)];
     }
+    if (Object.keys(typedData.types)
+        .map(function (x) { return "".concat(x, "*"); })
+        .includes(type)) {
+        var structHashes = data.map(function (struct) {
+            // eslint-disable-next-line @typescript-eslint/no-use-before-define
+            return (0, exports.getStructHash)(typedData, type.slice(0, -1), struct);
+        });
+        return [type, (0, hash_1.computeHashOnElements)(structHashes)];
+    }
     if (type === 'felt*') {
         return ['felt*', (0, hash_1.computeHashOnElements)(data)];
     }

package/package.json

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

package/src/account/default.ts

@@ -83,10 +83,15 @@ export class Account extends Provider implements AccountInterface {
         signature: bigNumberishArrayToDecimalStringArray(signature),
       }
     );
-    const suggestedMaxFee = estimatedFeeToMaxFee(fetchedEstimate.amount);
+    const fee = fetchedEstimate.overall_fee ?? fetchedEstimate.amount;
+    if (fee === undefined) {
+      throw new Error('Expected either amount or overall_fee in estimate_fee response');
+    }
+    const suggestedMaxFee = estimatedFeeToMaxFee(fee);
 
     return {
-      ...fetchedEstimate,
+      amount: fee,
+      unit: fetchedEstimate.unit,
       suggestedMaxFee,
     };
   }

package/src/types/account.ts

@@ -2,9 +2,10 @@ import BN from 'bn.js';
 
 import { BlockIdentifier } from '../provider/utils';
 import { BigNumberish } from '../utils/number';
-import { EstimateFeeResponse } from './api';
 
-export interface EstimateFee extends EstimateFeeResponse {
+export interface EstimateFee {
+  amount: BN;
+  unit: string;
   suggestedMaxFee: BN;
 }
 

package/src/types/api.ts

@@ -195,6 +195,7 @@ export type GetBlockResponse = {
   parent_block_hash: string;
   status: Status;
   gas_price: string;
+  starknet_version?: string;
 };
 
 export type GetCodeResponse = {
@@ -280,9 +281,13 @@ export type TransactionReceiptResponse =
   | SuccessfulTransactionReceiptResponse
   | FailedTransactionReceiptResponse;
 
+// Support 0.9.1 changes in a backward-compatible way
 export type EstimateFeeResponse = {
-  amount: BN;
+  overall_fee?: BN;
+  amount?: BN;
   unit: string;
+  gas_price?: BN;
+  gas_usage?: BigNumberish;
 };
 
 export type RawArgs = {

package/src/utils/typedData/index.ts

@@ -36,6 +36,12 @@ export const getDependencies = (
     throw new Error('Typed data does not match JSON schema');
   }
 
+  // Include pointers (struct arrays)
+  if (type[type.length - 1] === '*') {
+    // eslint-disable-next-line no-param-reassign
+    type = type.slice(0, -1);
+  }
+
   if (dependencies.includes(type)) {
     return dependencies;
   }
@@ -102,6 +108,18 @@ const encodeValue = (typedData: TypedData, type: string, data: unknown): [string
     return [type, getStructHash(typedData, type, data as Record<string, unknown>)];
   }
 
+  if (
+    Object.keys(typedData.types)
+      .map((x) => `${x}*`)
+      .includes(type)
+  ) {
+    const structHashes: string[] = (data as unknown[]).map((struct) => {
+      // eslint-disable-next-line @typescript-eslint/no-use-before-define
+      return getStructHash(typedData, type.slice(0, -1), struct as Record<string, unknown>);
+    });
+    return [type, computeHashOnElements(structHashes)];
+  }
+
   if (type === 'felt*') {
     return ['felt*', computeHashOnElements(data as string[])];
   }

package/types/account.d.ts

@@ -2,8 +2,9 @@ import BN from 'bn.js';
 
 import { BlockIdentifier } from '../provider/utils';
 import { BigNumberish } from '../utils/number';
-import { EstimateFeeResponse } from './api';
-export interface EstimateFee extends EstimateFeeResponse {
+export interface EstimateFee {
+  amount: BN;
+  unit: string;
   suggestedMaxFee: BN;
 }
 export interface EstimateFeeDetails {

package/types/api.d.ts

@@ -186,6 +186,7 @@ export declare type GetBlockResponse = {
   parent_block_hash: string;
   status: Status;
   gas_price: string;
+  starknet_version?: string;
 };
 export declare type GetCodeResponse = {
   bytecode: string[];
@@ -263,8 +264,11 @@ export declare type TransactionReceiptResponse =
   | SuccessfulTransactionReceiptResponse
   | FailedTransactionReceiptResponse;
 export declare type EstimateFeeResponse = {
-  amount: BN;
+  overall_fee?: BN;
+  amount?: BN;
   unit: string;
+  gas_price?: BN;
+  gas_usage?: BigNumberish;
 };
 export declare type RawArgs = {
   [inputName: string]:

package/utils/typedData/index.js

@@ -100,6 +100,11 @@ var getDependencies = function (typedData, type, dependencies) {
   if (!(0, utils_1.validateTypedData)(typedData)) {
     throw new Error('Typed data does not match JSON schema');
   }
+  // Include pointers (struct arrays)
+  if (type[type.length - 1] === '*') {
+    // eslint-disable-next-line no-param-reassign
+    type = type.slice(0, -1);
+  }
   if (dependencies.includes(type)) {
     return dependencies;
   }
@@ -174,6 +179,19 @@ var encodeValue = function (typedData, type, data) {
     // eslint-disable-next-line @typescript-eslint/no-use-before-define
     return [type, (0, exports.getStructHash)(typedData, type, data)];
   }
+  if (
+    Object.keys(typedData.types)
+      .map(function (x) {
+        return ''.concat(x, '*');
+      })
+      .includes(type)
+  ) {
+    var structHashes = data.map(function (struct) {
+      // eslint-disable-next-line @typescript-eslint/no-use-before-define
+      return (0, exports.getStructHash)(typedData, type.slice(0, -1), struct);
+    });
+    return [type, (0, hash_1.computeHashOnElements)(structHashes)];
+  }
   if (type === 'felt*') {
     return ['felt*', (0, hash_1.computeHashOnElements)(data)];
   }

package/www/docs/API/provider.md

@@ -85,6 +85,7 @@ Gets the block information.
   transation: Transaction[];
   timestamp: number;
   transaction_receipts: [];
+  starknet_version: string;
 }
 ```