starknet 3.15.2 → 3.15.5

package/CHANGELOG.md

@@ -1,3 +1,28 @@
+## [3.15.5](https://github.com/0xs34n/starknet.js/compare/v3.15.4...v3.15.5) (2022-06-27)
+
+### Bug Fixes
+
+- add return statement ([468a0bf](https://github.com/0xs34n/starknet.js/commit/468a0bfbbc1a9c88383ed2ba0f0bc02b0e5e3a9b))
+- don't enforce bigInt ([efef507](https://github.com/0xs34n/starknet.js/commit/efef5071ebceb5247f5f1995d3c1006d422c02ee))
+- **GatewayError:** export from index ([69addd5](https://github.com/0xs34n/starknet.js/commit/69addd5a2eb30816f5e43ffd71e190838ad5a409))
+- **GatewayError:** use ts-custom-error to support "err instanceof GatewayError" ([092abbc](https://github.com/0xs34n/starknet.js/commit/092abbcff5f5270a0be0b79a8e87645637298c56))
+- **test:** error 500 as number instead of bigInt ([b539144](https://github.com/0xs34n/starknet.js/commit/b5391448cf04d93c4d914ad52d850591a423fe42))
+
+## [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
+
+- **dev:** regenerated package-lock.json ([849cb1e](https://github.com/0xs34n/starknet.js/commit/849cb1ea3ffd7ba10b40b232d0ebc46b6599c7ea))
+- use cross-fetch only for jest ([83be37a](https://github.com/0xs34n/starknet.js/commit/83be37a9e3328a44abd9583b8167c3cb8d882790))
+
 ## [3.15.2](https://github.com/0xs34n/starknet.js/compare/v3.15.1...v3.15.2) (2022-06-18)
 
 ### 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__/jest.setup.ts

@@ -1,6 +1,9 @@
 /* eslint-disable no-console */
+import fetch from 'cross-fetch';
 import { register } from 'fetch-intercept';
 
+global.fetch = fetch;
+
 jest.setTimeout(50 * 60 * 1000);
 
 if (process.env.DEBUG === 'true') {

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');
@@ -42,8 +46,16 @@ describe('defaultProvider', () => {
     test(`getBlock(blockHash=undefined, blockNumber=${exampleBlockNumber})`, () => {
       return expect(provider.getBlock(exampleBlockNumber)).resolves.not.toThrow();
     });
-    test('getBlock(blockHash=undefined, blockNumber=null)', () => {
-      return expect(provider.getBlock()).resolves.not.toThrow();
+    test('getBlock(blockHash=undefined, blockNumber=null)', async () => {
+      const block = await provider.getBlock();
+
+      expect(block).not.toBeNull();
+
+      const { block_number, timestamp } = block;
+
+      expect(typeof block_number).toEqual('number');
+
+      return expect(typeof timestamp).toEqual('number');
     });
     test('getBlock() -> { blockNumber }', async () => {
       const block = await provider.getBlock();
@@ -103,6 +115,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 ? `500` : `"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

@@ -67,7 +67,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Provider = void 0;
-var cross_fetch_1 = __importDefault(require("cross-fetch"));
 var url_join_1 = __importDefault(require("url-join"));
 var constants_1 = require("../constants");
 var hash_1 = require("../utils/hash");
@@ -184,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*/, (0, cross_fetch_1.default)(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.parseAlwaysAsBig)(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/index.d.ts

@@ -1,4 +1,5 @@
 import { Provider } from './default';
 export * from './default';
+export { GatewayError } from './utils';
 export * from './interface';
 export declare const defaultProvider: Provider;

package/dist/provider/index.js

@@ -14,8 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultProvider = void 0;
+exports.defaultProvider = exports.GatewayError = void 0;
 var default_1 = require("./default");
 __exportStar(require("./default"), exports);
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "GatewayError", { enumerable: true, get: function () { return utils_1.GatewayError; } });
 __exportStar(require("./interface"), exports);
 exports.defaultProvider = new default_1.Provider();

package/dist/provider/utils.d.ts

@@ -1,3 +1,4 @@
+import { CustomError } from 'ts-custom-error';
 import type { BlockNumber } from '../types';
 import { BigNumberish } from '../utils/number';
 /**
@@ -39,4 +40,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 CustomError {
+    errorCode: string;
+    constructor(message: string, errorCode: string);
+}
 export {};

package/dist/provider/utils.js

@@ -1,6 +1,22 @@
 "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 ts_custom_error_1 = require("ts-custom-error");
 var number_1 = require("../utils/number");
 /**
  *
@@ -77,3 +93,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;
+}(ts_custom_error_1.CustomError));
+exports.GatewayError = GatewayError;

package/dist/utils/json.d.ts

@@ -1,8 +1,11 @@
-declare const parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any, stringify: {
+export declare const parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any, stringify: {
+    (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
+    (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
+};
+export declare const parseAlwaysAsBig: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any, stringifyAlwaysAsBig: {
     (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
     (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
 };
-export { parse, stringify };
 declare const _default: {
     parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
     stringify: {

package/dist/utils/json.js

@@ -2,15 +2,18 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringify = exports.parse = void 0;
+exports.stringifyAlwaysAsBig = exports.parseAlwaysAsBig = exports.stringify = exports.parse = void 0;
 var json_bigint_1 = __importDefault(require("json-bigint"));
-var _a = (0, json_bigint_1.default)({
-    alwaysParseAsBig: true,
-    useNativeBigInt: true,
-    protoAction: 'preserve',
-    constructorAction: 'preserve',
-}), parse = _a.parse, stringify = _a.stringify;
-exports.parse = parse;
-exports.stringify = stringify;
-exports.default = { parse: parse, stringify: stringify };
+var json = function (alwaysParseAsBig) {
+    return (0, json_bigint_1.default)({
+        alwaysParseAsBig: alwaysParseAsBig,
+        useNativeBigInt: true,
+        protoAction: 'preserve',
+        constructorAction: 'preserve',
+    });
+};
+exports.parse = (_a = json(false), _a.parse), exports.stringify = _a.stringify;
+exports.parseAlwaysAsBig = (_b = json(true), _b.parse), exports.stringifyAlwaysAsBig = _b.stringify;
+exports.default = { parse: exports.parse, stringify: exports.stringify };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starknet",
-  "version": "3.15.2",
+  "version": "3.15.5",
   "description": "JavaScript library for StarkNet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -43,14 +43,17 @@
     "@types/minimalistic-assert": "^1.0.1",
     "@types/pako": "^2.0.0",
     "@types/url-join": "^4.0.1",
+    "@types/whatwg-fetch": "^0.0.33",
     "@typescript-eslint/eslint-plugin": "^5.28.0",
     "@typescript-eslint/parser": "^5.28.0",
+    "cross-fetch": "^3.1.5",
     "eslint": "^8.17.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "fetch-intercept": "^2.4.0",
     "husky": "^8.0.1",
     "import-sort-style-module": "^6.0.0",
     "jest": "^28.1.1",
@@ -68,11 +71,11 @@
     "cross-fetch": "^3.1.5",
     "elliptic": "^6.5.4",
     "ethereum-cryptography": "^1.0.3",
-    "fetch-intercept": "^2.4.0",
     "hash.js": "^1.1.7",
     "json-bigint": "^1.0.0",
     "minimalistic-assert": "^1.0.1",
     "pako": "^2.0.4",
+    "ts-custom-error": "^3.2.0",
     "url-join": "^4.0.1"
   },
   "lint-staged": {

package/provider/default.js

@@ -173,7 +173,6 @@ var __importDefault =
   };
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.Provider = void 0;
-var cross_fetch_1 = __importDefault(require('cross-fetch'));
 var url_join_1 = __importDefault(require('url-join'));
 var constants_1 = require('../constants');
 var hash_1 = require('../utils/hash');
@@ -299,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*/,
-          (0, cross_fetch_1.default)(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.parseAlwaysAsBig)(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/index.d.ts

@@ -1,4 +1,5 @@
 import { Provider } from './default';
 export * from './default';
+export { GatewayError } from './utils';
 export * from './interface';
 export declare const defaultProvider: Provider;

package/provider/index.js

@@ -27,8 +27,15 @@ var __exportStar =
         __createBinding(exports, m, p);
   };
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.defaultProvider = void 0;
+exports.defaultProvider = exports.GatewayError = void 0;
 var default_1 = require('./default');
 __exportStar(require('./default'), exports);
+var utils_1 = require('./utils');
+Object.defineProperty(exports, 'GatewayError', {
+  enumerable: true,
+  get: function () {
+    return utils_1.GatewayError;
+  },
+});
 __exportStar(require('./interface'), exports);
 exports.defaultProvider = new default_1.Provider();

package/provider/utils.d.ts

@@ -1,3 +1,5 @@
+import { CustomError } from 'ts-custom-error';
+
 import type { BlockNumber } from '../types';
 import { BigNumberish } from '../utils/number';
 /**
@@ -41,4 +43,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 CustomError {
+  errorCode: string;
+  constructor(message: string, errorCode: string);
+}
 export {};

package/provider/utils.js

@@ -1,10 +1,37 @@
 '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 =
     void 0;
+var ts_custom_error_1 = require('ts-custom-error');
 var number_1 = require('../utils/number');
 /**
  *
@@ -82,3 +109,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;
+})(ts_custom_error_1.CustomError);
+exports.GatewayError = GatewayError;

package/src/provider/default.ts

@@ -1,4 +1,3 @@
-import fetch from 'cross-fetch';
 import urljoin from 'url-join';
 
 import { ONE, StarknetChainId, ZERO } from '../constants';
@@ -21,11 +20,11 @@ import {
   TransactionReceiptResponse,
 } from '../types';
 import { getSelectorFromName } from '../utils/hash';
-import { parse, stringify } from '../utils/json';
+import { parse, parseAlwaysAsBig, 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';
 
@@ -154,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 parseAlwaysAsBig(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/index.ts

@@ -1,6 +1,7 @@
 import { Provider } from './default';
 
 export * from './default';
+export { GatewayError } from './utils';
 export * from './interface';
 
 export const defaultProvider = new Provider();

package/src/provider/utils.ts

@@ -1,3 +1,5 @@
+import { CustomError } from 'ts-custom-error';
+
 import type { BlockNumber } from '../types';
 import { BigNumberish, toBN, toHex } from '../utils/number';
 
@@ -82,3 +84,9 @@ export function getFormattedBlockIdentifier(blockIdentifier: BlockIdentifier = n
   }
   return `blockHash=${toHex(toBN(blockIdentifierObject.data))}`;
 }
+
+export class GatewayError extends CustomError {
+  constructor(message: string, public errorCode: string) {
+    super(message);
+  }
+}

package/src/utils/json.ts

@@ -1,11 +1,15 @@
 import Json from 'json-bigint';
 
-const { parse, stringify } = Json({
-  alwaysParseAsBig: true,
-  useNativeBigInt: true,
-  protoAction: 'preserve',
-  constructorAction: 'preserve',
-});
+const json = (alwaysParseAsBig: boolean) => {
+  return Json({
+    alwaysParseAsBig,
+    useNativeBigInt: true,
+    protoAction: 'preserve',
+    constructorAction: 'preserve',
+  });
+};
+
+export const { parse, stringify } = json(false);
+export const { parse: parseAlwaysAsBig, stringify: stringifyAlwaysAsBig } = json(true);
 
-export { parse, stringify };
 export default { parse, stringify };

package/utils/json.d.ts

@@ -1,4 +1,4 @@
-declare const parse: (
+export declare const parse: (
     text: string,
     reviver?: ((this: any, key: string, value: any) => any) | undefined
   ) => any,
@@ -14,7 +14,22 @@ declare const parse: (
       space?: string | number | undefined
     ): string;
   };
-export { parse, stringify };
+export declare const parseAlwaysAsBig: (
+    text: string,
+    reviver?: ((this: any, key: string, value: any) => any) | undefined
+  ) => any,
+  stringifyAlwaysAsBig: {
+    (
+      value: any,
+      replacer?: ((this: any, key: string, value: any) => any) | undefined,
+      space?: string | number | undefined
+    ): string;
+    (
+      value: any,
+      replacer?: (string | number)[] | null | undefined,
+      space?: string | number | undefined
+    ): string;
+  };
 declare const _default: {
   parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
   stringify: {

package/utils/json.js

@@ -4,17 +4,23 @@ var __importDefault =
   function (mod) {
     return mod && mod.__esModule ? mod : { default: mod };
   };
+var _a, _b;
 Object.defineProperty(exports, '__esModule', { value: true });
-exports.stringify = exports.parse = void 0;
+exports.stringifyAlwaysAsBig =
+  exports.parseAlwaysAsBig =
+  exports.stringify =
+  exports.parse =
+    void 0;
 var json_bigint_1 = __importDefault(require('json-bigint'));
-var _a = (0, json_bigint_1.default)({
-    alwaysParseAsBig: true,
+var json = function (alwaysParseAsBig) {
+  return (0, json_bigint_1.default)({
+    alwaysParseAsBig: alwaysParseAsBig,
     useNativeBigInt: true,
     protoAction: 'preserve',
     constructorAction: 'preserve',
-  }),
-  parse = _a.parse,
-  stringify = _a.stringify;
-exports.parse = parse;
-exports.stringify = stringify;
-exports.default = { parse: parse, stringify: stringify };
+  });
+};
+(exports.parse = ((_a = json(false)), _a.parse)), (exports.stringify = _a.stringify);
+(exports.parseAlwaysAsBig = ((_b = json(true)), _b.parse)),
+  (exports.stringifyAlwaysAsBig = _b.stringify);
+exports.default = { parse: exports.parse, stringify: exports.stringify };

package/www/docs/API/utils.md

@@ -14,6 +14,8 @@ the address helpers can be imported using:
 import { address } from 'starknet.js';
 ```
 
+<br/>
+
 ### `getChecksumAddress(address: BigNumberish): string`
 
 This function accepts an address as a `BigNumberish` and returns the checksummed address as a string.
@@ -29,6 +31,235 @@ const checksummedAddress = address.getChecksumAddress(addressToCheck);
 console.log(checksummedAddress); // 0x02FD23D9182193775423497Fc0c472E156C57C69E4089a1967fb288a2D84e914
 ```
 
+<br/>
+
 ### `validateChecksumAddress(address: string): boolean`
 
 This function validates the checksum address. It returns true if the address is valid, false otherwise.
+
+<hr />
+
+## `stark`
+
+Functions for stark specific manipulations.
+
+<br/>
+
+### `compressProgram(jsonProgram: Program | string): CompressedProgram`
+
+Function to compress compiled cairo program. Accepts a json file representing the compiled cairo program and returns a compressed cairo program.
+
+<br/>
+
+### `randomAddress(): string`
+
+Function that generates a random contract address.
+
+<br/>
+
+### `makeAddress(input: string): string`
+
+Function that turns an incompatible address string into stark address format. Returns a string.
+
+Example: `0xdFD0F27FCe99b50909de0bDD328Aed6eAbe76BC5` -> `0xdfd0f27fce99b50909de0bdd328aed6eabe76bc5`
+
+<br/>
+
+### `formatSignature(sig?: Signature): string[]`
+
+Function that formats a Signature to BigNum and then to string array. Returns a string array.
+
+<br/>
+
+### `compileCalldata(args: RawArgs): Calldata`
+
+Function that creates calldata that gets sent to the contract.
+
+```js
+await this.callContract({
+    contractAddress: this.address,
+    entrypoint: 'is_valid_signature',
+    calldata: compileCalldata({
+        hash: toBN(hash).toString(),
+        signature: signature.map((x) => toBN(x).toString()),
+    }),
+});
+```
+
+<br/>
+
+### `estimatedFeeToMaxFee(estimatedFee: BigNumberish, overhead: number = 0.5): BN`
+
+Function that calculates and returns maximum fee based on the previously estimated one.
+
+Returns a BN.
+
+<hr />
+
+## `number`
+
+Various number formatting functions.
+
+`BN` is the `BigNum` representation imported from `bn.js` library.
+
+```js
+export type BigNumberish = string | number | BN;
+```
+
+<br/>
+
+### `isHex(hex: string): boolean`
+
+Check if number is in hex format.
+
+<br/>
+
+### `toBN(number: BigNumberish, base?: number | 'hex'): BN`
+
+Converts BigNumberish to BN. Returns a BN.
+
+<br/>
+
+### `toHex(number: BN): string`
+
+Converts BN to hex. Returns a string.
+
+<br/>
+
+### `hexToDecimalString(hex: string): string`
+
+Converts hex string to decimal string.
+
+<br/>
+
+### `toFelt(num: BigNumberish): string`
+
+Converts BN to Felt. Returns a string.
+
+<br/>
+
+### `assertInRange(input: BigNumberish, lowerBound: BigNumberish, upperBound: BigNumberish, inputName = '')`
+
+Asserts input is equal to or greater then `lowerBound` and lower then `upperBound`. Assert message specifies inputName.
+`input`, `lowerBound`, and `upperBound` should be of type BN.
+`inputName` should be a string.
+
+<br/>
+
+### `bigNumberishArrayToDecimalStringArray(rawCalldata: BigNumberish[]): string[]`
+
+Convert BigNumberish array to decimal array. Used for signature conversion.
+
+```js
+const signature = await this.signer.signTransaction(transactions, signerDetails);
+
+{
+    contract_address: this.address,
+    entry_point_selector: getSelectorFromName('__execute__'),
+    calldata,
+    version: toHex(version),
+    signature: bigNumberishArrayToDecimalStringArray(signature),
+}
+```
+
+<hr />
+
+## `uint256`
+
+```js
+// Represents an integer in the range [0, 2^256).
+export interface Uint256 {
+  // The low 128 bits of the value.
+  low: BigNumberish;
+  // The high 128 bits of the value.
+  high: BigNumberish;
+}
+```
+
+<br/>
+
+### `uint256ToBN(uint256: Uint256): BN`
+
+Function to convert `Uint256` to `BN` (big number), which uses the `bn.js` library.
+
+<br/>
+
+### `isUint256(bn: BigNumberish): boolean`
+
+Function to check if `BN` is smaller or equal to `2**256-1`.
+
+<br/>
+
+### `bnToUint256(bignumber: BigNumberish): Uint256`
+
+Function to convert `BN` to `Uint256`.
+
+<hr />
+
+## `hash`
+
+Various hashing helpers.
+
+### `starknetKeccak(value: string): BN`
+
+Function to get the starknet keccak hash from a string. Returns starknet keccak hash as BigNumber.
+nction to get the starknet keccak hash from a string. Returns starknet keccak hash as BigNumber.
+
+<br/>
+
+### `getSelectorFromName(funcName: string)`
+
+Function to get the hex selector from a given function name. Returns hex selector of given abi function name.
+
+<br/>
+
+### `pedersen(input: [BigNumberish, BigNumberish])`
+
+<br/>
+
+Function to get the Pedersen hash for two arguments. Returns a string.
+
+### `computeHashOnElements(data: BigNumberish[])`
+
+<br/>
+
+Function to compute a Pedersen hash on a array of elements. Returns a string.
+
+<br/>
+
+### `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.
+
+Called internally in `calculateDeployTransactionHash` and `calculcateTransactionHash`.
+
+<br/>
+
+### `calculateDeployTransactionHash(contractAddress: BigNumberish, constructorCalldata: BigNumberish[], version: BigNumberish, chainId: StarknetChainId): string`
+
+Function that calculates the deployment transaction hash in the StarkNet network.
+
+Internally calls `calculateTransactionHashCommon` with `TransactionHashPrefix.DEPLOY`.
+
+<br/>
+
+### `calculcateTransactionHash(contractAddress: BigNumberish, version: BigNumberish, entryPointSelector: BigNumberish, calldata: BigNumberish[], maxFee: BigNumberish, chainId: StarknetChainId): string`
+
+Function that internally calls `calculateTransactionHashCommon`, with `TransactionHashPrefix.INVOKE`.
+
+```js
+const hashMsg = calculcateTransactionHash(
+  account,
+  transactionVersion,
+  getSelectorFromName('__execute__'),
+  calldata,
+  maxFee,
+  StarknetChainId.TESTNET
+);
+```
+
+<br/>
+
+### `calculateContractAddressFromHash(salt: BigNumberish, classHash: BigNumberish, constructorCalldata: RawCalldata, deployerAddress: BigNumberish)`
+
+Function that calculates contract address from hash. Returns a string.

package/www/guides/account.md

@@ -31,7 +31,7 @@ You can also get a key pair from a private key using `getKeyPair(pk: BigNumberis
 
 ```javascript
 const starkKeyPair = ec.genKeyPair();
-const starkKeyPub = ec.getStarkKey(starkKeyPair);;
+const starkKeyPub = ec.getStarkKey(starkKeyPair);
 ```
 
 ## Deploy Account Contract