starknet 3.15.3 → 3.15.4

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.15.4](https://github.com/0xs34n/starknet.js/compare/v3.15.3...v3.15.4) (2022-06-20)
+
+### Bug Fixes
+
+- **parseResponse:** revert the changes from parseResponse ([d51996f](https://github.com/0xs34n/starknet.js/commit/d51996fa7635428ad4ffe271aa56f202ddcd4179))
+- **provider:** allow the user to handle the contract errors ([5190f7a](https://github.com/0xs34n/starknet.js/commit/5190f7a20fb35382756d86cc67d3fab5c2d541ff))
+- **test:** fix callContract() test ([b11c5da](https://github.com/0xs34n/starknet.js/commit/b11c5daf7fec6e8207dbc0be534aade8e00d5021))
+
 ## [3.15.3](https://github.com/0xs34n/starknet.js/compare/v3.15.2...v3.15.3) (2022-06-20)
 
 ### Bug Fixes

package/__tests__/fixtures.ts

@@ -17,12 +17,13 @@ const DEFAULT_TEST_ACCOUNT_ADDRESS = // run `starknet-devnet --seed 0` and this
   '0x65d53c8ec4178096167b35a08e16e548d8075cb08ad7bc63d07966ca13569dc';
 const DEFAULT_TEST_ACCOUNT_PRIVATE_KEY = '0xe3e70682c2094cac629f6fbed82c07cd';
 
-export const getTestProvider = () => {
-  const baseUrl = process.env.TEST_PROVIDER_BASE_URL || DEFAULT_TEST_PROVIDER_BASE_URL;
+const BASE_URL = process.env.TEST_PROVIDER_BASE_URL || DEFAULT_TEST_PROVIDER_BASE_URL;
+export const IS_DEVNET = !BASE_URL.includes('starknet.io');
 
-  const provider = new Provider({ baseUrl });
+export const getTestProvider = () => {
+  const provider = new Provider({ baseUrl: BASE_URL });
 
-  if (baseUrl.includes('localhost') || baseUrl.includes('127.0.0.1')) {
+  if (IS_DEVNET) {
     // accelerate the tests when running locally
     const originalWaitForTransaction = provider.waitForTransaction.bind(provider);
     provider.waitForTransaction = (txHash, retryInterval) => {
@@ -43,3 +44,7 @@ export const getTestAccount = () => {
 
   return new Account(provider, testAccountAddress, ec.getKeyPair(testAccountPrivateKey));
 };
+
+export const testIf = (condition: boolean) => (condition ? test : test.skip);
+export const testIfDevnet = testIf(IS_DEVNET);
+export const testIfNotDevnet = testIf(!IS_DEVNET);

package/__tests__/provider.test.ts

@@ -1,13 +1,17 @@
 import { BlockNumber, stark } from '../src';
 import { toBN } from '../src/utils/number';
-import { compiledErc20, compiledOpenZeppelinAccount, getTestProvider } from './fixtures';
+import {
+  IS_DEVNET,
+  compiledErc20,
+  compiledOpenZeppelinAccount,
+  getTestProvider,
+  testIfNotDevnet,
+} from './fixtures';
 
 const { compileCalldata } = stark;
 
 const provider = getTestProvider();
 
-const testIf = (condition: boolean) => (condition ? test : test.skip);
-
 describe('defaultProvider', () => {
   let exampleTransactionHash: string;
   let exampleContractAddress: string;
@@ -30,7 +34,7 @@ describe('defaultProvider', () => {
   });
 
   describe('feeder gateway endpoints', () => {
-    testIf(provider.baseUrl.includes('starknet.io'))('getContractAddresses()', async () => {
+    testIfNotDevnet('getContractAddresses()', async () => {
       // not supported in starknet-devnet
       const { GpsStatementVerifier, Starknet } = await provider.getContractAddresses();
       expect(typeof GpsStatementVerifier).toBe('string');
@@ -103,6 +107,28 @@ describe('defaultProvider', () => {
       ).resolves.not.toThrow();
     });
 
+    test('callContract() - gateway error', async () => {
+      const promise = provider.callContract({
+        contractAddress: exampleContractAddress,
+        entrypoint: 'non_existent_entrypoint',
+        calldata: compileCalldata({
+          user: '0xdeadbeef',
+        }),
+      });
+      expect(promise).rejects.toHaveProperty('errorCode');
+      expect(promise).rejects.toThrowErrorMatchingInlineSnapshot(
+        `"Entry point 0x23b0c8b3d98aa73d8a35f5303fe77d132c6d04279e63f6e1d6aac5946e04612 not found in contract with class hash 0x2864c45bd4ba3e66d8f7855adcadf07205c88f43806ffca664f1f624765207e."`
+      );
+
+      try {
+        await promise;
+      } catch (e) {
+        expect(e.errorCode).toMatchInlineSnapshot(
+          IS_DEVNET ? `500n` : `"StarknetErrorCode.ENTRY_POINT_NOT_FOUND_IN_CONTRACT"`
+        );
+      }
+    });
+
     test('transaction trace', async () => {
       const transactionTrace = await provider.getTransactionTrace(exampleTransactionHash);
       expect(transactionTrace).toHaveProperty('function_invocation');

package/__tests__/utils/typedData.test.ts

@@ -1,4 +1,6 @@
 import typedDataExample from '../../__mocks__/typedDataExample.json';
+import { number } from '../../src';
+import { BigNumberish } from '../../src/utils/number';
 import { encodeType, getMessageHash, getStructHash, getTypeHash } from '../../src/utils/typedData';
 
 describe('typedData', () => {
@@ -34,4 +36,66 @@ describe('typedData', () => {
       `"0x6fcff244f63e38b9d88b9e3378d44757710d1b244282b435cb472053c8d78d0"`
     );
   });
+
+  interface StringStruct {
+    len: BigNumberish;
+    data: BigNumberish[];
+  }
+  function stringToStringStruct(str: string): StringStruct {
+    const len = str.length;
+    const data = str.split('').map((char) => number.toHex(number.toBN(char.charCodeAt(0))));
+    return { len, data };
+  }
+
+  const typedDataStringExample = {
+    types: {
+      StarkNetDomain: [
+        { name: 'name', type: 'felt' },
+        { name: 'version', type: 'felt' },
+        { name: 'chainId', type: 'felt' },
+      ],
+      Person: [
+        { name: 'name', type: 'felt' },
+        { name: 'wallet', type: 'felt' },
+      ],
+      String: [
+        { name: 'len', type: 'felt' },
+        { name: 'data', type: 'felt*' },
+      ],
+      Mail: [
+        { name: 'from', type: 'Person' },
+        { name: 'to', type: 'Person' },
+        { name: 'contents', type: 'String' },
+      ],
+    },
+    primaryType: 'Mail',
+    domain: {
+      name: 'StarkNet Mail',
+      version: '1',
+      chainId: 1,
+    },
+    message: {
+      from: {
+        name: 'Cow',
+        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826',
+      },
+      to: {
+        name: 'Bob',
+        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB',
+      },
+      contents: stringToStringStruct(
+        'this is way longer than just 32 characters, to test if that is possible within a typedData struct.'
+      ),
+    },
+  };
+
+  test('should transform strings correctly', () => {
+    const hash = getMessageHash(
+      typedDataStringExample,
+      '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826'
+    );
+    expect(hash).toMatchInlineSnapshot(
+      `"0x70338fb11b8f70b68b261de8a322bcb004bd85e88ac47d9147982c7f5ac66fd"`
+    );
+  });
 });

package/dist/provider/default.js

@@ -183,38 +183,53 @@ var Provider = /** @class */ (function () {
         // typescript type magiuc to create a nice fitting function interface
         var _b = __read(_a, 2), query = _b[0], request = _b[1]; // when both query and request are needed, we cant omit anything
         return __awaiter(this, void 0, void 0, function () {
-            var baseUrl, method, queryString, headers, url;
+            var baseUrl, method, queryString, headers, url, res, textResponse, responseBody, errorCode, err_1;
             return __generator(this, function (_c) {
-                baseUrl = this.getFetchUrl(endpoint);
-                method = this.getFetchMethod(endpoint);
-                queryString = this.getQueryString(query);
-                headers = this.getHeaders(method);
-                url = (0, url_join_1.default)(baseUrl, endpoint, queryString);
-                return [2 /*return*/, fetch(url, {
-                        method: method,
-                        body: (0, json_1.stringify)(request),
-                        headers: headers,
-                    })
-                        .then(function (res) {
-                        if (res.status >= 400) {
-                            throw Error(res.statusText);
+                switch (_c.label) {
+                    case 0:
+                        baseUrl = this.getFetchUrl(endpoint);
+                        method = this.getFetchMethod(endpoint);
+                        queryString = this.getQueryString(query);
+                        headers = this.getHeaders(method);
+                        url = (0, url_join_1.default)(baseUrl, endpoint, queryString);
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 4, , 5]);
+                        return [4 /*yield*/, fetch(url, {
+                                method: method,
+                                body: (0, json_1.stringify)(request),
+                                headers: headers,
+                            })];
+                    case 2:
+                        res = _c.sent();
+                        return [4 /*yield*/, res.text()];
+                    case 3:
+                        textResponse = _c.sent();
+                        if (!res.ok) {
+                            responseBody = (0, json_1.parse)(textResponse);
+                            errorCode = responseBody.code || (responseBody === null || responseBody === void 0 ? void 0 : responseBody.status_code);
+                            throw new utils_1.GatewayError(responseBody.message, errorCode); // Caught locally, and re-thrown for the user
                         }
-                        return res.text();
-                    })
-                        .then(function (res) {
                         if (endpoint === 'estimate_fee') {
-                            return (0, json_1.parse)(res, function (_, v) {
-                                if (v && typeof v === 'bigint') {
-                                    return (0, number_1.toBN)(v.toString());
-                                }
-                                return v;
-                            });
+                            return [2 /*return*/, (0, json_1.parse)(textResponse, function (_, v) {
+                                    if (v && typeof v === 'bigint') {
+                                        return (0, number_1.toBN)(v.toString());
+                                    }
+                                    return v;
+                                })];
                         }
-                        return (0, json_1.parse)(res);
-                    })
-                        .catch(function (err) {
-                        throw Error("Could not ".concat(method, " from endpoint `").concat(url, "`: ").concat(err.message));
-                    })];
+                        return [2 /*return*/, (0, json_1.parse)(textResponse)];
+                    case 4:
+                        err_1 = _c.sent();
+                        if (err_1 instanceof utils_1.GatewayError) {
+                            throw err_1;
+                        }
+                        if (err_1 instanceof Error) {
+                            throw Error("Could not ".concat(method, " from endpoint `").concat(url, "`: ").concat(err_1.message));
+                        }
+                        throw err_1;
+                    case 5: return [2 /*return*/];
+                }
             });
         });
     };

package/dist/provider/utils.d.ts

@@ -39,4 +39,8 @@ export declare function getBlockIdentifier(blockIdentifier: BlockIdentifier): Bl
  * @returns block identifier for API request
  */
 export declare function getFormattedBlockIdentifier(blockIdentifier?: BlockIdentifier): string;
+export declare class GatewayError extends Error {
+    errorCode: string;
+    constructor(message: string, errorCode: string);
+}
 export {};

package/dist/provider/utils.js

@@ -1,6 +1,21 @@
 "use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFormattedBlockIdentifier = exports.getBlockIdentifier = exports.txIdentifier = exports.formatHash = void 0;
+exports.GatewayError = exports.getFormattedBlockIdentifier = exports.getBlockIdentifier = exports.txIdentifier = exports.formatHash = void 0;
 var number_1 = require("../utils/number");
 /**
  *
@@ -77,3 +92,13 @@ function getFormattedBlockIdentifier(blockIdentifier) {
     return "blockHash=".concat((0, number_1.toHex)((0, number_1.toBN)(blockIdentifierObject.data)));
 }
 exports.getFormattedBlockIdentifier = getFormattedBlockIdentifier;
+var GatewayError = /** @class */ (function (_super) {
+    __extends(GatewayError, _super);
+    function GatewayError(message, errorCode) {
+        var _this = _super.call(this, message) || this;
+        _this.errorCode = errorCode;
+        return _this;
+    }
+    return GatewayError;
+}(Error));
+exports.GatewayError = GatewayError;

package/package.json

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

package/provider/default.js

@@ -298,46 +298,78 @@ var Provider = /** @class */ (function () {
       query = _b[0],
       request = _b[1]; // when both query and request are needed, we cant omit anything
     return __awaiter(this, void 0, void 0, function () {
-      var baseUrl, method, queryString, headers, url;
+      var baseUrl,
+        method,
+        queryString,
+        headers,
+        url,
+        res,
+        textResponse,
+        responseBody,
+        errorCode,
+        err_1;
       return __generator(this, function (_c) {
-        baseUrl = this.getFetchUrl(endpoint);
-        method = this.getFetchMethod(endpoint);
-        queryString = this.getQueryString(query);
-        headers = this.getHeaders(method);
-        url = (0, url_join_1.default)(baseUrl, endpoint, queryString);
-        return [
-          2 /*return*/,
-          fetch(url, {
-            method: method,
-            body: (0, json_1.stringify)(request),
-            headers: headers,
-          })
-            .then(function (res) {
-              if (res.status >= 400) {
-                throw Error(res.statusText);
-              }
-              return res.text();
-            })
-            .then(function (res) {
-              if (endpoint === 'estimate_fee') {
-                return (0, json_1.parse)(res, function (_, v) {
+        switch (_c.label) {
+          case 0:
+            baseUrl = this.getFetchUrl(endpoint);
+            method = this.getFetchMethod(endpoint);
+            queryString = this.getQueryString(query);
+            headers = this.getHeaders(method);
+            url = (0, url_join_1.default)(baseUrl, endpoint, queryString);
+            _c.label = 1;
+          case 1:
+            _c.trys.push([1, 4, , 5]);
+            return [
+              4 /*yield*/,
+              fetch(url, {
+                method: method,
+                body: (0, json_1.stringify)(request),
+                headers: headers,
+              }),
+            ];
+          case 2:
+            res = _c.sent();
+            return [4 /*yield*/, res.text()];
+          case 3:
+            textResponse = _c.sent();
+            if (!res.ok) {
+              responseBody = (0, json_1.parse)(textResponse);
+              errorCode =
+                responseBody.code ||
+                (responseBody === null || responseBody === void 0
+                  ? void 0
+                  : responseBody.status_code);
+              throw new utils_1.GatewayError(responseBody.message, errorCode); // Caught locally, and re-thrown for the user
+            }
+            if (endpoint === 'estimate_fee') {
+              return [
+                2 /*return*/,
+                (0, json_1.parse)(textResponse, function (_, v) {
                   if (v && typeof v === 'bigint') {
                     return (0, number_1.toBN)(v.toString());
                   }
                   return v;
-                });
-              }
-              return (0, json_1.parse)(res);
-            })
-            .catch(function (err) {
+                }),
+              ];
+            }
+            return [2 /*return*/, (0, json_1.parse)(textResponse)];
+          case 4:
+            err_1 = _c.sent();
+            if (err_1 instanceof utils_1.GatewayError) {
+              throw err_1;
+            }
+            if (err_1 instanceof Error) {
               throw Error(
                 'Could not '
                   .concat(method, ' from endpoint `')
                   .concat(url, '`: ')
-                  .concat(err.message)
+                  .concat(err_1.message)
               );
-            }),
-        ];
+            }
+            throw err_1;
+          case 5:
+            return [2 /*return*/];
+        }
       });
     });
   };

package/provider/utils.d.ts

@@ -41,4 +41,8 @@ export declare function getBlockIdentifier(blockIdentifier: BlockIdentifier): Bl
  * @returns block identifier for API request
  */
 export declare function getFormattedBlockIdentifier(blockIdentifier?: BlockIdentifier): string;
+export declare class GatewayError extends Error {
+  errorCode: string;
+  constructor(message: string, errorCode: string);
+}
 export {};

package/provider/utils.js

@@ -1,6 +1,32 @@
 'use strict';
+var __extends =
+  (this && this.__extends) ||
+  (function () {
+    var extendStatics = function (d, b) {
+      extendStatics =
+        Object.setPrototypeOf ||
+        ({ __proto__: [] } instanceof Array &&
+          function (d, b) {
+            d.__proto__ = b;
+          }) ||
+        function (d, b) {
+          for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p];
+        };
+      return extendStatics(d, b);
+    };
+    return function (d, b) {
+      if (typeof b !== 'function' && b !== null)
+        throw new TypeError('Class extends value ' + String(b) + ' is not a constructor or null');
+      extendStatics(d, b);
+      function __() {
+        this.constructor = d;
+      }
+      d.prototype = b === null ? Object.create(b) : ((__.prototype = b.prototype), new __());
+    };
+  })();
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.getFormattedBlockIdentifier =
+exports.GatewayError =
+  exports.getFormattedBlockIdentifier =
   exports.getBlockIdentifier =
   exports.txIdentifier =
   exports.formatHash =
@@ -82,3 +108,13 @@ function getFormattedBlockIdentifier(blockIdentifier) {
   return 'blockHash='.concat((0, number_1.toHex)((0, number_1.toBN)(blockIdentifierObject.data)));
 }
 exports.getFormattedBlockIdentifier = getFormattedBlockIdentifier;
+var GatewayError = /** @class */ (function (_super) {
+  __extends(GatewayError, _super);
+  function GatewayError(message, errorCode) {
+    var _this = _super.call(this, message) || this;
+    _this.errorCode = errorCode;
+    return _this;
+  }
+  return GatewayError;
+})(Error);
+exports.GatewayError = GatewayError;

package/src/provider/default.ts

@@ -24,7 +24,7 @@ import { parse, stringify } from '../utils/json';
 import { BigNumberish, bigNumberishArrayToDecimalStringArray, toBN, toHex } from '../utils/number';
 import { compressProgram, randomAddress } from '../utils/stark';
 import { ProviderInterface } from './interface';
-import { BlockIdentifier, getFormattedBlockIdentifier } from './utils';
+import { BlockIdentifier, GatewayError, getFormattedBlockIdentifier } from './utils';
 
 type NetworkName = 'mainnet-alpha' | 'goerli-alpha';
 
@@ -153,31 +153,39 @@ export class Provider implements ProviderInterface {
     const headers = this.getHeaders(method);
     const url = urljoin(baseUrl, endpoint, queryString);
 
-    return fetch(url, {
-      method,
-      body: stringify(request),
-      headers,
-    })
-      .then((res) => {
-        if (res.status >= 400) {
-          throw Error(res.statusText);
-        }
-        return res.text();
-      })
-      .then((res) => {
-        if (endpoint === 'estimate_fee') {
-          return parse(res, (_, v) => {
-            if (v && typeof v === 'bigint') {
-              return toBN(v.toString());
-            }
-            return v;
-          });
-        }
-        return parse(res) as Endpoints[T]['RESPONSE'];
-      })
-      .catch((err) => {
-        throw Error(`Could not ${method} from endpoint \`${url}\`: ${err.message}`);
+    try {
+      const res = await fetch(url, {
+        method,
+        body: stringify(request),
+        headers,
       });
+      const textResponse = await res.text();
+      if (!res.ok) {
+        // This will allow user to handle contract errors
+        const responseBody = parse(textResponse);
+
+        const errorCode = responseBody.code || ((responseBody as any)?.status_code as string); // starknet-devnet uses status_code instead of code; They need to fix that
+        throw new GatewayError(responseBody.message, errorCode); // Caught locally, and re-thrown for the user
+      }
+
+      if (endpoint === 'estimate_fee') {
+        return parse(textResponse, (_, v) => {
+          if (v && typeof v === 'bigint') {
+            return toBN(v.toString());
+          }
+          return v;
+        });
+      }
+      return parse(textResponse) as Endpoints[T]['RESPONSE'];
+    } catch (err) {
+      if (err instanceof GatewayError) {
+        throw err;
+      }
+      if (err instanceof Error) {
+        throw Error(`Could not ${method} from endpoint \`${url}\`: ${err.message}`);
+      }
+      throw err;
+    }
   }
 
   /**

package/src/provider/utils.ts

@@ -82,3 +82,9 @@ export function getFormattedBlockIdentifier(blockIdentifier: BlockIdentifier = n
   }
   return `blockHash=${toHex(toBN(blockIdentifierObject.data))}`;
 }
+
+export class GatewayError extends Error {
+  constructor(message: string, public errorCode: string) {
+    super(message);
+  }
+}

package/www/docs/API/utils.md

@@ -59,7 +59,7 @@ Function that generates a random contract address.
 
 ### `makeAddress(input: string): string`
 
-Function that turns an incompatible address string into stark address format. Returns a string. 
+Function that turns an incompatible address string into stark address format. Returns a string.
 
 Example: `0xdFD0F27FCe99b50909de0bDD328Aed6eAbe76BC5` -> `0xdfd0f27fce99b50909de0bdd328aed6eabe76bc5`
 
@@ -90,7 +90,7 @@ await this.callContract({
 
 ### `estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead: number = 0.5): BN`
 
-Function that calculates and returns maximum fee based on the previously estimated one. 
+Function that calculates and returns maximum fee based on the previously estimated one.
 
 Returns a BN.
 
@@ -150,7 +150,7 @@ Asserts input is equal to or greater then `lowerBound` and lower then `upperBoun
 
 Convert BigNumberish array to decimal array. Used for signature conversion.
 
-``` js
+```js
 const signature = await this.signer.signTransaction(transactions, signerDetails);
 
 {
@@ -229,7 +229,7 @@ Function to compute a Pedersen hash on a array of elements. Returns a string.
 
 ### `calculateTransactionHashCommon(txHashPrefix: TransactionHashPrefix, version: BigNumberish,contractAddress: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId, additionalData: BigNumberish[] = []): string`
 
-Calculates the transaction hash in the StarkNet network - a unique identifier of the transaction. 
+Calculates the transaction hash in the StarkNet network - a unique identifier of the transaction.
 
 Called internally in `calculateDeployTransactionHash` and `calculcateTransactionHash`.
 
@@ -262,4 +262,4 @@ const hashMsg = calculcateTransactionHash(
 
 ### `calculateContractAddressFromHash(salt: BigNumberish, classHash: BigNumberish, constructorCalldata: RawCalldata, deployerAddress: BigNumberish)`
 
-Function that calculates contract address from hash. Returns a string.
+Function that calculates contract address from hash. Returns a string.